fix : xyne thread id correction

* fix : xyne thread id correction

* ench: overlayNotification data in grpc

---------

Co-authored-by: Om Dutt Pandey <omdutt2004@gmail.com>
Co-authored-by: manu johnson <manujohnson2002@gmail.com>

Author: 3 people

lib/mobility-core/src/Kernel/External/Notification/Interface.hs

@@ -68,7 +68,7 @@ notifyPersonWithAllProviders ::
     MonadReader r m,
     HasFlowEnv m r '["maxNotificationShards" ::: Int]
   ) =>
-  NotficationServiceHandler m a c ->
+  NotficationServiceHandler m c ->
   NotificationReq a b ->
   Maybe LiveActivityReq ->
   m () ->

lib/mobility-core/src/Kernel/External/Notification/Interface/FCM.hs

@@ -1,5 +1,6 @@
 module Kernel.External.Notification.Interface.FCM where
 
+import Data.Aeson (Value (..), object, (.=))
 import qualified Kernel.External.Notification.FCM.Flow as FCM
 import qualified Kernel.External.Notification.FCM.Types as FCM
 import qualified Kernel.External.Notification.Interface.Types as Interface
@@ -24,7 +25,7 @@ notifyPerson ::
   Maybe FCM.LiveActivityReq ->
   m () ->
   Maybe Text ->
-  (FCM.FCMData a -> FCM.FCMData c) ->
+  (FCM.FCMData Value -> FCM.FCMData c) ->
   m ()
 notifyPerson config req liveAcitvityRequest action mbNotificationId iosModifier = do
   let title = FCM.FCMNotificationTitle req.title
@@ -36,9 +37,9 @@ notifyPerson config req liveAcitvityRequest action mbNotificationId iosModifier
             fcmShowNotification = interfaceShowNotificationToFCMShowNotification req.showNotification,
             fcmEntityType = interfaceEntityTypeToFCMEntityType req.entity.entityType,
             fcmEntityIds = req.entity.entityIds,
-            fcmEntityData = req.entity.entityData,
+            fcmEntityData = mergeEntityWithOverlay (toJSON req.entity.entityData) req.overlayNotificationData,
             fcmNotificationJSON = FCM.createAndroidNotification title body notificationType req.sound,
-            fcmOverlayNotificationJSON = Nothing,
+            fcmOverlayNotificationJSON = overlayNotificationDataToFCM <$> req.overlayNotificationData,
             fcmNotificationId = mbNotificationId
           }
       apnsData = liveAcitvityRequest
@@ -53,6 +54,43 @@ notifyPerson config req liveAcitvityRequest action mbNotificationId iosModifier
     (FCM.FCMNotificationRecipient req.auth.recipientId (FCM.FCMRecipientToken <$> req.auth.fcmToken))
     iosModifier
 
+overlayNotificationDataToFCM :: Interface.OverlayNotificationData -> FCM.FCMOverlayNotificationJSON
+overlayNotificationDataToFCM d =
+  FCM.FCMOverlayNotificationJSON
+    { title = d.title,
+      description = d.description,
+      imageUrl = d.imageUrl,
+      okButtonText = d.okButtonText,
+      cancelButtonText = d.cancelButtonText,
+      actions = d.actions,
+      actions2 = d.actions2,
+      secondaryActions2 = d.secondaryActions2,
+      link = d.link,
+      endPoint = d.endPoint,
+      method = d.method,
+      reqBody = d.reqBody,
+      titleVisibility = d.titleVisibility,
+      descriptionVisibility = d.descriptionVisibility,
+      buttonOkVisibility = d.buttonOkVisibility,
+      buttonCancelVisibility = d.buttonCancelVisibility,
+      buttonLayoutVisibility = d.buttonLayoutVisibility,
+      imageVisibility = d.imageVisibility,
+      delay = d.delay,
+      contactSupportNumber = d.contactSupportNumber,
+      toastMessage = d.toastMessage,
+      secondaryActions = d.secondaryActions,
+      socialMediaLinks = d.socialMediaLinks,
+      showPushNotification = d.showPushNotification
+    }
+
+mergeEntityWithOverlay :: Value -> Maybe Interface.OverlayNotificationData -> Value
+mergeEntityWithOverlay entityJson Nothing = entityJson
+mergeEntityWithOverlay entityJson (Just overlay) =
+  let overlayObj = object ["driver_notification_payload" .= toJSON overlay]
+   in case (entityJson, overlayObj) of
+        (Object eo, Object oo) -> Object (eo <> oo)
+        _ -> entityJson
+
 interfaceMessagePriorityToFCMMessagePriority :: Interface.MessagePriority -> FCM.FCMAndroidMessagePriority
 interfaceMessagePriorityToFCMMessagePriority = \case
   Interface.NORMAL -> FCM.NORMAL

lib/mobility-core/src/Kernel/External/Notification/Interface/GRPC.hs

@@ -14,6 +14,7 @@
 
 module Kernel.External.Notification.Interface.GRPC where
 
+import Data.Aeson (Value (..), object, (.=))
 import EulerHS.Prelude
 import qualified Kernel.External.Notification.GRPC.Flow as GRPC
 import qualified Kernel.External.Notification.GRPC.Types as GRPC
@@ -39,15 +40,26 @@ notifyPerson config req notificationId = do
   let title = GRPC.GRPCNotificationTitle req.title
       body = GRPC.GRPCNotificationBody req.body
       notificationType = show req.category
+      entityDataJson = mergeEntityWithOverlay (toJSON req.entity.entityData) req.overlayNotificationData
       notificationData =
         GRPC.GrpcNotificationData
           { entityId = req.entity.entityIds,
             entityType = show req.entity.entityType,
-            entityData = req.entity.entityData,
+            entityData = entityDataJson,
             category = notificationType,
             showNotification = show req.showNotification,
             ttl = fromMaybe defaultTtlTime req.ttl,
             streamId = req.auth.recipientId,
             ..
           }
   GRPC.notifyPerson config notificationData
+
+-- | Embed overlay data as \"driver_notification_payload\" inside the entity
+-- data JSON so GRPC consumers read it the same way as FCM consumers do.
+mergeEntityWithOverlay :: Value -> Maybe Interface.OverlayNotificationData -> Value
+mergeEntityWithOverlay entityJson Nothing = entityJson
+mergeEntityWithOverlay entityJson (Just overlay) =
+  let overlayObj = object ["driver_notification_payload" .= toJSON overlay]
+   in case (entityJson, overlayObj) of
+        (Object eo, Object oo) -> Object (eo <> oo)
+        _ -> entityJson

lib/mobility-core/src/Kernel/External/Notification/Interface/Types.hs

@@ -17,6 +17,7 @@
 
 module Kernel.External.Notification.Interface.Types where
 
+import Data.Aeson (Value)
 import Kernel.Beam.Lib.UtilsTH (mkBeamInstancesForEnum)
 import Kernel.External.Notification.FCM.Types
 import qualified Kernel.External.Notification.FCM.Types as FCM
@@ -177,6 +178,34 @@ data Entity a = Entity
   }
   deriving (Show, Eq, Read, Generic, ToJSON, FromJSON)
 
+data OverlayNotificationData = OverlayNotificationData
+  { title :: Maybe Text,
+    description :: Maybe Text,
+    imageUrl :: Maybe Text,
+    okButtonText :: Maybe Text,
+    cancelButtonText :: Maybe Text,
+    actions :: [Text],
+    actions2 :: [FCMActions],
+    secondaryActions2 :: Maybe [FCMActions],
+    link :: Maybe Text,
+    endPoint :: Maybe Text,
+    method :: Maybe Text,
+    reqBody :: Value,
+    titleVisibility :: Bool,
+    descriptionVisibility :: Bool,
+    buttonOkVisibility :: Bool,
+    buttonCancelVisibility :: Bool,
+    buttonLayoutVisibility :: Bool,
+    imageVisibility :: Bool,
+    delay :: Maybe Int,
+    contactSupportNumber :: Maybe Text,
+    toastMessage :: Maybe Text,
+    secondaryActions :: Maybe [Text],
+    socialMediaLinks :: Maybe [FCMMediaLink],
+    showPushNotification :: Maybe Bool
+  }
+  deriving (Eq, Show, Generic, ToJSON, FromJSON)
+
 data NotificationReq a b = NotificationReq
   { auth :: Auth,
     category :: Category,
@@ -188,12 +217,13 @@ data NotificationReq a b = NotificationReq
     body :: Text,
     title :: Text,
     ttl :: Maybe UTCTime,
-    sound :: Maybe Text
+    sound :: Maybe Text,
+    overlayNotificationData :: Maybe OverlayNotificationData
   }
-  deriving (Show, Eq, Read, Generic, ToJSON, FromJSON)
+  deriving (Show, Eq, Generic, ToJSON, FromJSON)
 
-data NotficationServiceHandler m a b = NotficationServiceHandler
+data NotficationServiceHandler m b = NotficationServiceHandler
   { getNotificationServiceList :: m [Interface.NotificationService],
     getServiceConfig :: Interface.NotificationService -> m NotificationServiceConfig,
-    iosModifier :: FCMData a -> FCMData b
+    iosModifier :: FCMData Value -> FCMData b
   }

lib/mobility-core/src/Kernel/External/Ticket/Interface/XyneSpaces.hs

@@ -33,10 +33,13 @@
 -- @rideDescription@ (preferring customer over driver). Email is left
 -- @Nothing@ for now — 'IssueManagement.Common.Person' has no email field.
 --
--- Note on the returned @ticketId@: we echo back the threadId (= IssueReport id)
--- rather than Xyne's opaque ticketId so that the existing IssueManagement
--- caller can pass it back unchanged on subsequent updateTicket calls. Xyne's
--- own ticketId / xyneId / conversationId are logged but not propagated.
+-- Note on the returned @ticketId@: both 'createTicket' and 'updateTicket'
+-- return Xyne's own opaque ticketId (from the @appDeskInbound@ response),
+-- not our @threadId@ (= IssueReport id). The threadId is still required on
+-- every @appDeskInbound@ call to keep appending to the same Xyne thread, so
+-- callers must keep passing it separately via @req.issueDetails.issueId@ on
+-- 'updateTicket' (see 'IT.UpdateTicketReq'); the opaque ticketId travels via
+-- @req.ticketId@ / @IssueReport.ticketId@ as with the other providers.
 module Kernel.External.Ticket.Interface.XyneSpaces
   ( createTicket,
     updateTicket,
@@ -117,7 +120,7 @@ createTicket config req = do
       <> show resp.isNew
   pure
     IT.CreateTicketResp
-      { ticketId = threadId,
+      { ticketId = resp.ticketId,
         status = IT.Open,
         requesterId = Nothing
       }
@@ -132,8 +135,14 @@ updateTicket ::
   IT.UpdateTicketReq ->
   m IT.UpdateTicketResp
 updateTicket config req = do
-  -- req.ticketId is the value createTicket returned (= our threadId).
-  let threadId = req.ticketId
+  -- req.ticketId is now Xyne's opaque ticketId (see the module-level note),
+  -- not our threadId, so it cannot be used to correlate the appDeskInbound
+  -- call to the existing thread. The threadId (= IssueReport id) must come
+  -- from req.issueDetails.issueId, which callers are expected to keep
+  -- populated across the create/update lifecycle.
+  threadId <- case req.issueDetails >>= (.issueId) of
+    Just t -> pure t
+    Nothing -> throwError (InternalError "Xyne updateTicket requires issueDetails.issueId (used as threadId)")
   token <- decrypt config.token
   let (mbRideName, _) = senderInfoFromRide req.rideDescription
       mbSenderName = req.name <|> mbRideName
@@ -161,9 +170,11 @@ updateTicket config req = do
       <> " isNew="
       <> show resp.isNew
   -- Mirror Zendesk: return req.status (caller intent), not the parsed response.
+  -- ticketId echoes back Xyne's opaque id (resp.ticketId), consistent with
+  -- createTicket and with how Kapture/Zendesk report their own ticket id.
   pure
     IT.UpdateTicketResp
-      { ticketId = threadId,
+      { ticketId = resp.ticketId,
         status = req.status,
         message = "Ticket updated"
       }