@gearbox-protocol/cli-utils 5.71.7 → 5.72.1

package/dist/notifications/NotificationsService.d.ts

@@ -13,7 +13,7 @@ export declare class NotificationsService implements INotificationService {
     #private;
     constructor(options: NotificationsServiceOptions, logger?: ILogger);
     registerRecipient(address: Address, options: NotificationConfig): void;
-    signl(message: string): void;
+    signl(message: string, dedupeKey?: string): void;
     alert(msg: NotificationLike): void;
     notify(msg: NotificationLike): void;
 }

package/dist/notifications/NotificationsService.js

@@ -27,8 +27,8 @@ export class NotificationsService {
             this.#notifiers.upsert(address, notifier);
         }
     }
-    signl(message) {
-        this.#signlNotifier?.alert(message);
+    signl(message, dedupeKey) {
+        this.#signlNotifier?.alert(message, dedupeKey);
     }
     alert(msg) {
         this.#notify(msg, "alert");

package/dist/notifications/SignlNotifier.d.ts

@@ -1,11 +1,13 @@
 import type { ILogger } from "@gearbox-protocol/sdk";
 import type { SignlConfig } from "./schema.js";
+import type { ThrottleFn } from "./types.js";
 export type SignlServiceOptions = SignlConfig & {
     retryInterval?: number;
     retryCount?: number;
+    throttleFn?: ThrottleFn;
 };
 export default class SignlNotifier {
     #private;
     constructor(opts: SignlServiceOptions, logger?: ILogger);
-    alert(message: string): void;
+    alert(message: string, dedupeKey?: string): void;
 }

package/dist/notifications/SignlNotifier.js

@@ -1,4 +1,5 @@
 import { withRetry } from "viem";
+import { ThrottleManager } from "./ThrottleManager.js";
 const DEFAULT_RETRY_INTERVAL = 1000;
 const DEFAULT_RETRY_COUNT = 5;
 export default class SignlNotifier {
@@ -7,18 +8,24 @@ export default class SignlNotifier {
     #teamId;
     #retryInterval;
     #retryCount;
+    #throttleManager = new ThrottleManager();
+    #throttleFn;
     constructor(opts, logger) {
         this.#apiKey = opts.apiKey;
         this.#teamId = opts.teamId;
         this.#retryInterval = opts.retryInterval ?? DEFAULT_RETRY_INTERVAL;
         this.#retryCount = opts.retryCount ?? DEFAULT_RETRY_COUNT;
         this.#logger = logger;
+        this.#throttleFn = opts.throttleFn;
         this.#logger?.info(opts, "signl notifier configured");
     }
-    alert(message) {
-        void this.#sendAlert(message).catch(e => this.#logger?.error(e));
+    alert(message, dedupeKey) {
+        void this.#sendAlert(message, dedupeKey).catch(e => this.#logger?.error(e));
     }
-    async #sendAlert(message) {
+    async #sendAlert(message, dedupeKey) {
+        if (dedupeKey && !this.#throttleManager.canSend(dedupeKey)) {
+            return;
+        }
         const text = message.slice(0, 64); // it's to be shown in mobile notifications anyways
         this.#logger?.debug("sending signl alert");
         await withRetry(async () => {
@@ -44,5 +51,8 @@ export default class SignlNotifier {
                 throw new Error(`signl api error ${resp.status}: ${resp.statusText}`);
             }
         }, { delay: this.#retryInterval, retryCount: this.#retryCount });
+        if (dedupeKey) {
+            this.#throttleManager.onSent(dedupeKey, this.#throttleFn);
+        }
     }
 }

package/dist/notifications/types.d.ts

@@ -56,9 +56,12 @@ export interface INotificationService {
     /**
      * Send an alert to Signl
      * @param message
+     * @param dedupeKey
+     *   Messages with the same dedupe key will be throttled to avoid spam
+     *   If not provided, the message will not be throttled
      * @returns
      */
-    signl: (message: string) => void;
+    signl: (message: string, dedupeKey?: string) => void;
     /**
      * Sends high priority notification
      * @param message

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gearbox-protocol/cli-utils",
   "description": "Utils for creating cli apps",
-  "version": "5.71.7",
+  "version": "5.72.1",
   "homepage": "https://gearbox.fi",
   "keywords": [
     "gearbox"