Better logging #43

mootz12 · 2025-12-31T21:48:10Z

No description provided.

Copilot

Pull request overview

This PR introduces a notification level filtering system to control which notifications are sent to external services (Slack/Discord) or logged to the console. The filtering system has three levels: HIGH (critical alerts), MED (successful operations and moderate warnings), and LOW (informational messages).

Key changes include:

Added NotificationLevel enum (HIGH, MED, LOW) with filtering logic in the sendNotification function
Updated all sendNotification calls throughout the codebase to specify appropriate notification levels
Added getNotificationLevelForAuction helper function to determine notification levels based on auction type and fill status
Added configuration validation and documentation for the new notificationLevel config option

Reviewed changes

Copilot reviewed 17 out of 18 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
src/utils/notifier.ts	Added NotificationLevel enum, implemented level-based filtering in sendNotification, and added getNotificationLevelForAuction helper function
src/utils/config.ts	Added notificationLevel field to AppConfig interface and validation logic
src/work_submitter.ts	Updated sendNotification calls to use appropriate notification levels; fixed spelling error "transfering" → "transferring"
src/work_handler.ts	Updated sendNotification call to use NotificationLevel.MED
src/pool_event_handler.ts	Updated multiple sendNotification calls to use getNotificationLevelForAuction for appropriate level assignment
src/liquidations.ts	Updated sendNotification call to use NotificationLevel.MED
src/bidder_submitter.ts	Updated sendNotification calls throughout to use getNotificationLevelForAuction and appropriate levels
src/bidder_handler.ts	Updated sendNotification call to use getNotificationLevelForAuction
src/utils/soroban_helper.ts	Adjusted transaction timeout from 6 seconds to 12 seconds; moved submitStartTime initialization
test/utils/notifier.test.ts	Added comprehensive test suite for notification filtering, webhook integration, and getNotificationLevelForAuction function
test/utils/config.test.ts	Added test for notification level validation
test/bidder_submitter.test.ts	Updated test expectations to include notification level parameter
example.config.json	Added example notificationLevel configuration
README.md	Added documentation for the new notificationLevel configuration option
start.sh	Removed extra blank lines
example.env	Removed example environment file

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-31T21:51:48Z

test/utils/notifier.test.ts

+  describe('notification level filtering', () => {
+    beforeEach(() => {
+      (APP_CONFIG as any).slackWebhook = 'https://hooks.slack.com/test';
+      mockFetch.mockResolvedValue({
+        ok: true,
+        status: 200,
+      } as Response);
+    });
+
+    it('should send HIGH level notifications when config is set to HIGH', async () => {
+      (APP_CONFIG as any).notificationLevel = NotificationLevel.HIGH;
+
+      await sendNotification('High priority message', NotificationLevel.HIGH);
+
+      expect(mockFetch).toHaveBeenCalledTimes(1);
+      expect(mockFetch).toHaveBeenCalledWith(
+        'https://hooks.slack.com/test',
+        expect.objectContaining({
+          method: 'POST',
+          headers: { 'Content-Type': 'application/json' },
+        })
+      );
+    });
+
+    it('should NOT send MED level notifications when config is set to HIGH', async () => {
+      (APP_CONFIG as any).notificationLevel = NotificationLevel.HIGH;
+
+      await sendNotification('Medium priority message', NotificationLevel.MED);
+
+      expect(mockFetch).not.toHaveBeenCalled();
+    });
+
+    it('should NOT send LOW level notifications when config is set to HIGH', async () => {
+      (APP_CONFIG as any).notificationLevel = NotificationLevel.HIGH;
+
+      await sendNotification('Low priority message', NotificationLevel.LOW);
+
+      expect(mockFetch).not.toHaveBeenCalled();
+    });
+
+    it('should send HIGH and MED notifications when config is set to MED', async () => {
+      (APP_CONFIG as any).notificationLevel = NotificationLevel.MED;
+
+      await sendNotification('High priority message', NotificationLevel.HIGH);
+      expect(mockFetch).toHaveBeenCalledTimes(1);
+
+      mockFetch.mockClear();
+
+      await sendNotification('Medium priority message', NotificationLevel.MED);
+      expect(mockFetch).toHaveBeenCalledTimes(1);
+    });
+
+    it('should NOT send LOW notifications when config is set to MED', async () => {
+      (APP_CONFIG as any).notificationLevel = NotificationLevel.MED;
+
+      await sendNotification('Low priority message', NotificationLevel.LOW);
+
+      expect(mockFetch).not.toHaveBeenCalled();
+    });
+
+    it('should send all notifications when config level is undefined (defaults to MED)', async () => {
+      (APP_CONFIG as any).notificationLevel = undefined;
+
+      await sendNotification('High priority', NotificationLevel.HIGH);
+      expect(mockFetch).toHaveBeenCalledTimes(1);
+
+      mockFetch.mockClear();
+      await sendNotification('Medium priority', NotificationLevel.MED);
+      expect(mockFetch).toHaveBeenCalledTimes(1);
+
+      mockFetch.mockClear();
+      await sendNotification('Low priority', NotificationLevel.LOW);
+      expect(mockFetch).not.toHaveBeenCalled(); // MED level filters out LOW
+    });
+  });


Missing test coverage for the notification level filtering behavior when the config is set to NotificationLevel.LOW. Tests should verify that when config is set to LOW, all notification levels (HIGH, MED, and LOW) are sent.

Copilot · 2025-12-31T21:51:48Z

src/utils/notifier.ts

+  if (isBotFill) {
+    switch (auctionType) {
+      case 0: // Liquidation
+        return NotificationLevel.MED;
+      case 1: // Bad Debt
+        return NotificationLevel.HIGH;
+      case 2: // Interest
+        return NotificationLevel.MED;
+      default:
+        return NotificationLevel.MED;
+    }
+  } else {
+    switch (auctionType) {
+      case 0: // Liquidation
+        return NotificationLevel.LOW;
+      case 1: // Bad Debt
+        return NotificationLevel.HIGH;
+      case 2: // Interest
+        return NotificationLevel.LOW;
+      default:
+        return NotificationLevel.LOW;
+    }


Using hardcoded numeric values (0, 1, 2) instead of the AuctionType enum constants makes the code less maintainable and harder to understand. Consider using AuctionType.Liquidation, AuctionType.BadDebt, and AuctionType.Interest instead of the numeric values.

Copilot · 2025-12-31T21:51:48Z

src/utils/notifier.ts

@@ -1,7 +1,25 @@
+import { AuctionType } from '@blend-capital/blend-sdk';


There's an inconsistency in AuctionType imports. The getNotificationLevelForAuction function imports AuctionType from '@blend-capital/blend-sdk', but callers like work_submitter.ts import it from './utils/db.js'. While they may have compatible numeric values, this creates a type mismatch and potential maintenance issues if either definition changes. Consider using a single source of truth for AuctionType throughout the codebase.

Copilot · 2025-12-31T21:51:48Z

src/work_submitter.ts

-        `Error transfering bad debt\n` +
+        `Error transferring bad debt\n` +
        `Pool: ${badDebtTransfer.poolId}\n` +
        `User: ${badDebtTransfer.user}` +


Missing newline character in the error message. The string concatenation on line 152 should end with \n to properly format the error message, otherwise "User: " and "Error: " will appear on the same line.

Suggested change

`User: ${badDebtTransfer.user}` +

`User: ${badDebtTransfer.user}\n` +

Copilot · 2025-12-31T21:51:49Z

src/utils/soroban_helper.ts

    let txResponse = await stellarRpc.sendTransaction(transaction);
    if (txResponse.status === 'TRY_AGAIN_LATER') {
      await new Promise((resolve) => setTimeout(resolve, 4000));
      txResponse = await stellarRpc.sendTransaction(transaction);
    }
+    let submitStartTime = Date.now();


The submitStartTime is now initialized after the retry logic (lines 488-492), which means if a transaction retry occurs, the wait time won't include the 4-second delay. This could cause the timeout check on line 503 to wait longer than intended. The timer should be initialized before attempting to send the transaction to accurately measure the total wait time.

Suggested change

let txResponse = await stellarRpc.sendTransaction(transaction);

if (txResponse.status === 'TRY_AGAIN_LATER') {

await new Promise((resolve) => setTimeout(resolve, 4000));

txResponse = await stellarRpc.sendTransaction(transaction);

}

let submitStartTime = Date.now();

let submitStartTime = Date.now();

let txResponse = await stellarRpc.sendTransaction(transaction);

if (txResponse.status === 'TRY_AGAIN_LATER') {

await new Promise((resolve) => setTimeout(resolve, 4000));

txResponse = await stellarRpc.sendTransaction(transaction);

}

Copilot · 2025-12-31T21:51:49Z

src/utils/notifier.ts

+ * filled it.
+ * @param auctionType - The auction type to determine the notification level for
+ * @param isBotFill - Whether the bot successfully filled the auction
+ * @returns


Missing return type documentation in the JSDoc comment. The @returns tag is present but has no description of what the function returns.

Suggested change

* @returns

* @returns The notification level to use for the given auction type and fill status.

Copilot · 2025-12-31T21:51:49Z

README.md

 | `blndAddress` | The address of the BLND token contract. |
 | `interestFillerAddress` | A contract address used to help fill interest auctions. Must implement the same interface as [this example](https://github.com/script3/interest-auction-filler). |
 | `workerKeypair` | The secret key for the bot's auction creating account. This should be different from the filler as auction creation and auction bidding can happen simultaneously. **Keep this secret and secure!** |
 | `fillerKeypair` | The securet key for the bot's auction filler account. This should be different from the worker as auction creation and auction bidding can happen simultaneously. **Keep this secret and secure!** |


There's a spelling error in "securet" which should be "secret".

Suggested change

| `fillerKeypair` | The securet key for the bot's auction filler account. This should be different from the worker as auction creation and auction bidding can happen simultaneously. **Keep this secret and secure!** |

| `fillerKeypair` | The secret key for the bot's auction filler account. This should be different from the worker as auction creation and auction bidding can happen simultaneously. **Keep this secret and secure!** |

Copilot · 2025-12-31T21:51:49Z

src/utils/notifier.ts

+      if (level === NotificationLevel.LOW) {
+        return;
+      }
+      break;


The notification level filtering logic is missing a case for when the config is set to NotificationLevel.LOW. Currently, if the config is set to LOW, it falls through to the default case which treats it as MED, filtering out LOW notifications. There should be a case for NotificationLevel.LOW that allows all notifications to be sent.

Suggested change

break;

break;

case NotificationLevel.LOW:

// LOW threshold: allow all notifications (HIGH, MED, and LOW)

break;

mootz12 added 2 commits December 31, 2025 13:00

feat: add levels to external notifications

7e4b155

fix: increase timeout check for txs

ccb40f5

mootz12 requested review from Ryang-21 and Copilot December 31, 2025 21:48

Copilot started reviewing on behalf of mootz12 December 31, 2025 21:48 View session

chore: rev version

ee32eb0

Copilot AI reviewed Dec 31, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Better logging #43

Better logging #43

Uh oh!

mootz12 commented Dec 31, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 31, 2025

Uh oh!

Copilot AI Dec 31, 2025

Uh oh!

Copilot AI Dec 31, 2025

Uh oh!

Copilot AI Dec 31, 2025

Uh oh!

Copilot AI Dec 31, 2025

Uh oh!

Copilot AI Dec 31, 2025

Uh oh!

Copilot AI Dec 31, 2025

Uh oh!

Copilot AI Dec 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -1,7 +1,25 @@
		import { AuctionType } from '@blend-capital/blend-sdk';

	`User: ${badDebtTransfer.user}` +
	`User: ${badDebtTransfer.user}\n` +

	* @returns
	* @returns The notification level to use for the given auction type and fill status.

	\| `fillerKeypair` \| The securet key for the bot's auction filler account. This should be different from the worker as auction creation and auction bidding can happen simultaneously. Keep this secret and secure! \|
	\| `fillerKeypair` \| The secret key for the bot's auction filler account. This should be different from the worker as auction creation and auction bidding can happen simultaneously. Keep this secret and secure! \|

-      break;
+      break;
+    case NotificationLevel.LOW:
+      // LOW threshold: allow all notifications (HIGH, MED, and LOW)
+      break;

Better logging #43

Are you sure you want to change the base?

Better logging #43

Uh oh!

Conversation

mootz12 commented Dec 31, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants