Add order triggered notification and tests

indexer/packages/notifications/__tests__/localization.test.ts

@@ -41,19 +41,4 @@ describe('deriveLocalizedNotificationMessage', () => {
     const result = deriveLocalizedNotificationMessage(notification);
     expect(result).toEqual(expected);
   });
-
-  test('should throw an error for unknown notification type', () => {
-    const unknownNotification = {
-      type: 'UNKNOWN_TYPE' as NotificationType,
-      titleKey: LocalizationKey.DEPOSIT_SUCCESS_TITLE,
-      bodyKey: LocalizationKey.DEPOSIT_SUCCESS_BODY,
-      deeplink: Deeplink.DEPOSIT,
-      dynamicValues: {
-        [NotificationDynamicFieldKey.AMOUNT]: '1000',
-        [NotificationDynamicFieldKey.MARKET]: 'USDT',
-      },
-    } as Notification;
-
-    expect(() => deriveLocalizedNotificationMessage(unknownNotification)).toThrowError('Unknown notification type');
-  });
 });

indexer/packages/notifications/src/localization.ts

@@ -2,7 +2,6 @@ import {
   LocalizationKey,
   Notification,
   NotificationMesage,
-  NotificationType,
 } from './types';
 
 function replacePlaceholders(template: string, variables: Record<string, string>): string {
@@ -16,30 +15,18 @@ export function deriveLocalizedNotificationMessage(notification: Notification):
     [LocalizationKey.ORDER_FILLED_BODY]: 'Order Filled',
     // eslint-disable-next-line no-template-curly-in-string
     [LocalizationKey.ORDER_FILLED_TITLE]: 'Your order for {AMOUNT} {MARKET} was filled at ${AVERAGE_PRICE}',
+    // eslint-disable-next-line no-template-curly-in-string
+    [LocalizationKey.ORDER_TRIGGERED_BODY]: 'Your order for {AMOUNT} {MARKET} was triggered at ${PRICE}',
+    [LocalizationKey.ORDER_TRIGGERED_TITLE]: '{MARKET} Order Triggered',
   };
 
-  switch (notification.type) {
-    case NotificationType.DEPOSIT_SUCCESS:
-      return {
-        title: replacePlaceholders(
-          tempLocalizationFields[notification.titleKey],
-          notification.dynamicValues),
-        body: replacePlaceholders(
-          tempLocalizationFields[notification.bodyKey],
-          notification.dynamicValues,
-        ),
-      };
-    case NotificationType.ORDER_FILLED:
-      return {
-        title: replacePlaceholders(
-          tempLocalizationFields[notification.titleKey],
-          notification.dynamicValues),
-        body: replacePlaceholders(
-          tempLocalizationFields[notification.bodyKey],
-          notification.dynamicValues,
-        ),
-      };
-    default:
-      throw new Error('Unknown notification type');
-  }
+  return {
+    title: replacePlaceholders(
+      tempLocalizationFields[notification.titleKey],
+      notification.dynamicValues),
+    body: replacePlaceholders(
+      tempLocalizationFields[notification.bodyKey],
+      notification.dynamicValues,
+    ),
+  };
 }

indexer/packages/notifications/src/message.ts

@@ -17,7 +17,7 @@ export async function sendFirebaseMessage(
 
   const tokens = await getUserRegistrationTokens(address);
   if (tokens.length === 0) {
-    throw new Error('User has no registration tokens');
+    throw new Error(`User has no registration tokens: ${address}`);
   }
 
   const { title, body } = deriveLocalizedNotificationMessage(notification);

indexer/packages/notifications/src/types.ts

@@ -1,21 +1,16 @@
 export enum NotificationType {
   DEPOSIT_SUCCESS = 'DEPOSIT_SUCCESS',
-  FAST_WITHDRAW_SUCCESS = 'FAST_WITHDRAW_SUCCESS',
-  SLOW_WITHDRAWAL_PENDING = 'SLOW_WITHDRAWAL_PENDING',
-  SLOW_WITHDRAWAL_SUCCESS = 'SLOW_WITHDRAWAL_SUCCESS',
-  ORDER_CANCEL = 'ORDER_CANCEL',
   ORDER_FILLED = 'ORDER_FILLED',
-  ORDER_PARTIAL_FILL = 'ORDER_PARTIAL_FILL',
   ORDER_TRIGGERED = 'ORDER_TRIGGERED',
   LIQUIDATION = 'LIQUIDATION',
-  VOLATILITY = 'VOLATILITY',
 }
 
 // Keys for the dynamic values that are used in the notification messages
 // Each key corresponds to a placeholder in the localizable strings for each notification
 export enum NotificationDynamicFieldKey {
   AMOUNT = 'AMOUNT',
   AVERAGE_PRICE = 'AVERAGE_PRICE',
+  PRICE = 'PRICE',
   FILLED_AMOUNT = 'FILLED_AMOUNT',
   MARKET = 'MARKET',
   SIDE = 'SIDE',
@@ -28,12 +23,15 @@ export enum LocalizationKey {
   DEPOSIT_SUCCESS_BODY = 'DEPOSIT_SUCCESS_BODY',
   ORDER_FILLED_TITLE = 'ORDER_FILLED_TITLE',
   ORDER_FILLED_BODY = 'ORDER_FILLED_BODY',
+  ORDER_TRIGGERED_TITLE = 'ORDER_TRIGGERED_TITLE',
+  ORDER_TRIGGERED_BODY = 'ORDER_TRIGGERED_BODY',
 }
 
 // Deeplinks for each notification
 export enum Deeplink {
   DEPOSIT = '/profile',
   ORDER_FILLED = '/profile',
+  ORDER_TRIGGERED = '/profile',
 }
 
 export enum Topic {
@@ -79,20 +77,39 @@ interface OrderFilledNotification extends BaseNotification <{
   };
 }
 
+interface OrderTriggeredNotification extends BaseNotification <{
+  [NotificationDynamicFieldKey.MARKET]: string;
+  [NotificationDynamicFieldKey.PRICE]: string;
+}>{
+  type: NotificationType.ORDER_TRIGGERED;
+  titleKey: LocalizationKey.ORDER_TRIGGERED_TITLE;
+  bodyKey: LocalizationKey.ORDER_TRIGGERED_BODY;
+  topic: Topic.TRADING;
+  dynamicValues: {
+    [NotificationDynamicFieldKey.MARKET]: string;
+    [NotificationDynamicFieldKey.AMOUNT]: string;
+    [NotificationDynamicFieldKey.PRICE]: string;
+  };
+}
+
 export type NotificationMesage = {
   title: string;
   body: string;
 };
 
-export type Notification = DepositSuccessNotification | OrderFilledNotification;
+export type Notification =
+DepositSuccessNotification |
+OrderFilledNotification |
+OrderTriggeredNotification;
 
 export function createNotification<T extends NotificationType>(
   type: T,
   dynamicValues: T extends NotificationType.DEPOSIT_SUCCESS
     ? DepositSuccessNotification['dynamicValues']
     : T extends NotificationType.ORDER_FILLED
       ? OrderFilledNotification['dynamicValues']
-      : never,
+      : T extends NotificationType.ORDER_TRIGGERED
+        ? OrderTriggeredNotification['dynamicValues'] : never,
 ): Notification {
   switch (type) {
     case NotificationType.DEPOSIT_SUCCESS:
@@ -104,7 +121,6 @@ export function createNotification<T extends NotificationType>(
         deeplink: Deeplink.DEPOSIT,
         dynamicValues: dynamicValues as DepositSuccessNotification['dynamicValues'],
       };
-
     case NotificationType.ORDER_FILLED:
       return {
         type: NotificationType.ORDER_FILLED,
@@ -114,9 +130,17 @@ export function createNotification<T extends NotificationType>(
         deeplink: Deeplink.ORDER_FILLED,
         dynamicValues: dynamicValues as OrderFilledNotification['dynamicValues'],
       };
+    case NotificationType.ORDER_TRIGGERED:
+      return {
+        type: NotificationType.ORDER_TRIGGERED,
+        titleKey: LocalizationKey.ORDER_TRIGGERED_TITLE,
+        bodyKey: LocalizationKey.ORDER_TRIGGERED_BODY,
+        topic: Topic.TRADING,
+        deeplink: Deeplink.ORDER_TRIGGERED,
+        dynamicValues: dynamicValues as OrderTriggeredNotification['dynamicValues'],
+      };
 
       // Add other cases for new notification types here
-
     default:
       throw new Error('Unknown notification type');
   }

indexer/packages/postgres/__tests__/helpers/constants.ts

@@ -900,7 +900,7 @@ export const defaultLeaderboardPnlOneDayToUpsert: LeaderboardPnlCreateObject = {
 // ==============  Tokens  =============
 
 export const defaultToken = {
-  token: '01234ABCD',
+  token: 'DEFAULT_TOKEN',
   address: defaultAddress,
   updatedAt: createdDateTime.toISO(),
 };

indexer/packages/postgres/__tests__/helpers/mock-generators.ts

@@ -5,6 +5,7 @@ import * as MarketTable from '../../src/stores/market-table';
 import * as PerpetualMarketTable from '../../src/stores/perpetual-market-table';
 import * as SubaccountTable from '../../src/stores/subaccount-table';
 import * as TendermintEventTable from '../../src/stores/tendermint-event-table';
+import * as TokenTable from '../../src/stores/token-table';
 import * as WalletTable from '../../src/stores/wallet-table';
 import {
   defaultAsset,
@@ -26,6 +27,7 @@ import {
   defaultTendermintEvent2,
   defaultTendermintEvent3,
   defaultTendermintEvent4,
+  defaultToken,
   defaultWallet,
   isolatedMarket,
   isolatedMarket2,
@@ -78,4 +80,7 @@ export async function seedData() {
   await Promise.all([
     WalletTable.create(defaultWallet),
   ]);
+  await Promise.all([
+    TokenTable.create(defaultToken),
+  ]);
 }