feat(notifications): add label to action types for bulletin button

bats/core/notifications/notifications.bats

@@ -239,3 +239,172 @@ setup_file() {
   count=$(graphql_output '.data.me.unacknowledgedStatefulNotificationsWithoutBulletinEnabledCount')
   [[ $count -eq 2 ]] || exit 1
 }
+
+@test "notifications: bulletin with label and external url action" {
+  admin_token="$(read_value 'admin.token')"
+
+  variables=$(
+    jq -n \
+    '{
+      input: {
+        localizedNotificationContents: [
+          {
+            language: "en",
+            title: "New feature available",
+            body: "Check out our latest update"
+          }
+        ],
+        shouldSendPush: false,
+        shouldAddToHistory: true,
+        shouldAddToBulletin: true,
+        openExternalUrl: {
+          url: "https://example.com/update",
+          label: "Learn more"
+        },
+        icon: "BELL"
+      }
+    }'
+  )
+
+  exec_admin_graphql "$admin_token" 'marketing-notification-trigger' "$variables"
+
+  local action_label
+  local action_url
+  local icon
+  for i in {1..10}; do
+    exec_graphql 'alice' 'list-unacknowledged-stateful-notifications-with-bulletin-enabled'
+    action_label=$(graphql_output '.data.me.unacknowledgedStatefulNotificationsWithBulletinEnabled.nodes[0].action.label')
+    [[ "$action_label" = "Learn more" ]] && break;
+    sleep 1
+  done
+  [[ "$action_label" = "Learn more" ]] || exit 1
+
+  action_url=$(graphql_output '.data.me.unacknowledgedStatefulNotificationsWithBulletinEnabled.nodes[0].action.url')
+  [[ "$action_url" = "https://example.com/update" ]] || exit 1
+
+  icon=$(graphql_output '.data.me.unacknowledgedStatefulNotificationsWithBulletinEnabled.nodes[0].icon')
+  [[ "$icon" = "BELL" ]] || exit 1
+}
+
+@test "notifications: bulletin without label has null action label" {
+  admin_token="$(read_value 'admin.token')"
+
+  variables=$(
+    jq -n \
+    '{
+      input: {
+        localizedNotificationContents: [
+          {
+            language: "en",
+            title: "Simple notification",
+            body: "No label here"
+          }
+        ],
+        shouldSendPush: false,
+        shouldAddToHistory: true,
+        shouldAddToBulletin: true,
+      }
+    }'
+  )
+
+  exec_admin_graphql "$admin_token" 'marketing-notification-trigger' "$variables"
+
+  local action
+  local title
+  for i in {1..10}; do
+    exec_graphql 'alice' 'list-stateful-notifications' '{"first": 1}'
+    title=$(graphql_output '.data.me.statefulNotifications.nodes[0].title')
+    [[ "$title" = "Simple notification" ]] && break;
+    sleep 1
+  done
+  [[ "$title" = "Simple notification" ]] || exit 1
+
+  action=$(graphql_output '.data.me.statefulNotifications.nodes[0].action')
+  [[ "$action" = "null" ]] || exit 1
+}
+
+@test "notifications: bulletin with label and deep link action" {
+  admin_token="$(read_value 'admin.token')"
+
+  variables=$(
+    jq -n \
+    '{
+      input: {
+        localizedNotificationContents: [
+          {
+            language: "en",
+            title: "Complete your profile",
+            body: "Set up your account to get started"
+          }
+        ],
+        shouldSendPush: false,
+        shouldAddToHistory: true,
+        shouldAddToBulletin: true,
+        openDeepLink: {
+          screen: "SETTINGS",
+          label: "Go to settings"
+        }
+      }
+    }'
+  )
+
+  exec_admin_graphql "$admin_token" 'marketing-notification-trigger' "$variables"
+
+  local action_label
+  local deep_link
+  for i in {1..10}; do
+    exec_graphql 'alice' 'list-unacknowledged-stateful-notifications-with-bulletin-enabled'
+    action_label=$(graphql_output '.data.me.unacknowledgedStatefulNotificationsWithBulletinEnabled.nodes[0].action.label')
+    [[ "$action_label" = "Go to settings" ]] && break;
+    sleep 1
+  done
+  [[ "$action_label" = "Go to settings" ]] || exit 1
+
+  deep_link=$(graphql_output '.data.me.unacknowledgedStatefulNotificationsWithBulletinEnabled.nodes[0].action.deepLink')
+  [[ "$deep_link" = "/settings" ]] || exit 1
+}
+
+@test "notifications: bulletin with label on both deep link and external url uses deep link" {
+  admin_token="$(read_value 'admin.token')"
+
+  variables=$(
+    jq -n \
+    '{
+      input: {
+        localizedNotificationContents: [
+          {
+            language: "en",
+            title: "Both actions label",
+            body: "Deep link label should take priority"
+          }
+        ],
+        shouldSendPush: false,
+        shouldAddToHistory: true,
+        shouldAddToBulletin: true,
+        openDeepLink: {
+          screen: "SETTINGS",
+          label: "Deep link label"
+        },
+        openExternalUrl: {
+          url: "https://example.com/fallback",
+          label: "External label"
+        }
+      }
+    }'
+  )
+
+  exec_admin_graphql "$admin_token" 'marketing-notification-trigger' "$variables"
+
+  local action_label
+  local action_url
+  for i in {1..10}; do
+    exec_graphql 'alice' 'list-unacknowledged-stateful-notifications-with-bulletin-enabled'
+    action_label=$(graphql_output '.data.me.unacknowledgedStatefulNotificationsWithBulletinEnabled.nodes[0].action.label')
+    [[ "$action_label" = "External label" ]] && break;
+    sleep 1
+  done
+  [[ "$action_label" = "External label" ]] || exit 1
+
+  action_url=$(graphql_output '.data.me.unacknowledgedStatefulNotificationsWithBulletinEnabled.nodes[0].action.url')
+  [[ "$action_url" = "https://example.com/fallback" ]] || exit 1
+}

bats/gql/list-stateful-notifications-without-bulletin-enabled.gql

@@ -14,6 +14,17 @@ query listStatefulNotificationsWithoutBulletinEnabled($first: Int = 2, $after: S
         acknowledgedAt
         createdAt
         bulletinEnabled
+        action {
+          ... on OpenDeepLinkAction {
+            deepLink
+            label
+          }
+          ... on OpenExternalLinkAction {
+            url
+            label
+          }
+        }
+        icon
       }
     }
   }

bats/gql/list-stateful-notifications.gql

@@ -14,6 +14,17 @@ query listStatefulNotifications($first: Int = 2, $after: String = null) {
         acknowledgedAt
         createdAt
         bulletinEnabled
+        action {
+          ... on OpenDeepLinkAction {
+            deepLink
+            label
+          }
+          ... on OpenExternalLinkAction {
+            url
+            label
+          }
+        }
+        icon
       }
     }
   }

bats/gql/list-unacknowledged-stateful-notifications-with-bulletin-enabled.gql

@@ -13,6 +13,17 @@ query listUnacknowledgedStatefulNotificationsWithBulletinEnabled($first: Int = 2
         deepLink
         acknowledgedAt
         createdAt
+        action {
+          ... on OpenDeepLinkAction {
+            deepLink
+            label
+          }
+          ... on OpenExternalLinkAction {
+            url
+            label
+          }
+        }
+        icon
       }
     }
   }

core/api/src/app/admin/index.types.d.ts

@@ -5,11 +5,13 @@ type AdminTriggerMarketingNotificationArgs = {
     | {
         screen: DeepLinkScreen | undefined
         action: DeepLinkAction | undefined
+        label: string | undefined
       }
     | undefined
   openExternalUrl:
     | {
         url: string
+        label: string | undefined
       }
     | undefined
   shouldSendPush: boolean

core/api/src/domain/notifications/index.types.d.ts

@@ -145,11 +145,13 @@ type TriggerMarketingNotificationArgs = {
     | {
         screen: DeepLinkScreen | undefined
         action: DeepLinkAction | undefined
+        label: string | undefined
       }
     | undefined
   openExternalUrl:
     | {
         url: string
+        label: string | undefined
       }
     | undefined
   shouldSendPush: boolean

core/api/src/graphql/admin/root/mutation/marketing-notification-trigger.ts

@@ -33,6 +33,9 @@ const OpenDeepLinkInput = GT.Input({
     action: {
       type: DeepLinkAction,
     },
+    label: {
+      type: GT.String,
+    },
   }),
 })
 
@@ -42,6 +45,9 @@ const OpenExternalUrlInput = GT.Input({
     url: {
       type: GT.NonNull(ExternalUrl),
     },
+    label: {
+      type: GT.String,
+    },
   }),
 })
 
@@ -93,9 +99,10 @@ const MarketingNotificationTriggerMutation = GT.Field<
         | {
             screen: DeepLinkScreen | Error | undefined
             action: DeepLinkAction | Error | undefined
+            label: string | undefined
           }
         | undefined
-      openExternalUrl: { url: string | Error } | undefined
+      openExternalUrl: { url: string | Error; label: string | undefined } | undefined
       localizedNotificationContents: {
         title: string
         body: string
@@ -145,6 +152,7 @@ const MarketingNotificationTriggerMutation = GT.Field<
       nonErrorOpenDeepLink = {
         screen: openDeepLink.screen,
         action: openDeepLink.action,
+        label: openDeepLink.label,
       }
     }
 
@@ -159,6 +167,7 @@ const MarketingNotificationTriggerMutation = GT.Field<
       }
       nonErrorOpenExternalUrl = {
         url: openExternalUrl.url,
+        label: openExternalUrl.label,
       }
     }
 

core/api/src/graphql/admin/schema.graphql

@@ -426,10 +426,12 @@ scalar OnChainTxHash
 
 input OpenDeepLinkInput {
   action: DeepLinkAction
+  label: String
   screen: DeepLinkScreen
 }
 
 input OpenExternalUrlInput {
+  label: String
   url: ExternalUrl!
 }
 

core/api/src/services/notifications/index.ts

@@ -662,6 +662,11 @@ export const NotificationsService = (): INotificationsService => {
         if (externalUrl !== undefined) action.setExternalUrl(externalUrl)
       }
 
+      const label = openExternalUrl?.label || openDeepLink?.label
+      if (action && typeof label === "string" && label.trim()) {
+        action.setLabel(label)
+      }
+
       const protoIcon = icon ? iconToGrpcIcon(icon) : undefined
 
       const marketingNotificationRequests: Promise<HandleNotificationEventResponse>[] = []

core/api/src/services/notifications/proto/notifications.proto

@@ -255,6 +255,7 @@ message Action {
     DeepLink deep_link = 1;
     string external_url = 2;
   }
+  optional string label = 3;
 }
 
 message DeepLink {

core/api/src/services/notifications/proto/notifications_grpc_pb.js

@@ -371,4 +371,4 @@ var NotificationsServiceService = exports.NotificationsServiceService = {
   },
 };
 
-exports.NotificationsServiceClient = grpc.makeGenericClientConstructor(NotificationsServiceService);
+exports.NotificationsServiceClient = grpc.makeGenericClientConstructor(NotificationsServiceService, 'NotificationsService');

core/api/src/services/notifications/proto/notifications_pb.d.ts

@@ -973,6 +973,11 @@ export class Action extends jspb.Message {
     getExternalUrl(): string;
     setExternalUrl(value: string): Action;
 
+    hasLabel(): boolean;
+    clearLabel(): void;
+    getLabel(): string | undefined;
+    setLabel(value: string): Action;
+
     getDataCase(): Action.DataCase;
 
     serializeBinary(): Uint8Array;
@@ -989,6 +994,7 @@ export namespace Action {
     export type AsObject = {
         deepLink?: DeepLink.AsObject,
         externalUrl: string,
+        label?: string,
     }
 
     export enum DataCase {