TF-2298 Add document adr for register firebase registration token flow

Signed-off-by: dab246 <tdvu@linagora.com> (cherry picked from commit 121384a5b8af06e21d470962c31b0096feed455d)
2023-12-04 10:55:28 +07:00
parent 8aac206468
commit 5061fcaced
1 changed files with 28 additions and 0 deletions
@@ -0,0 +1,28 @@
+# 17. Register firebase registration token guideline
+
+Date: 2023-11-24
+
+## Status
+
+Accepted
+
+## Context
+
+The logic of firebase registration is complicated to follow by all developers
+
+## Decision
+
+Brief the logic flows to easier in following the changes of firebase registration implementation
+
+- `onFcmTokenChanged`: Listen for token changes from FCM (Firebase Cloud Message)
+- If there is a new `token`, we will send a request to the jmap server to check if this token has been registered `GetFirebaseRegistrationByDeviceIdInteractor`.
+`deviceClientId` is a unique key generated based on `token` and `platform`
+- On the contrary, if no new token is generated, we will retrieve the `deviceClientId` stored in `cache` to call back the request to the above jmap server.
+- If the status after sending the request to the jmap server returns successful `GetFirebaseRegistrationByDeviceIdSuccesss`. 
+We perform a check to see if `FirebaseRegistrationTokenExpired` has expired or not (The check is performed before `3 days`). 
+If it expires, we will send a request to update `expires` for this `FirebaseRegistration` to increase the lifetime by `7 more days`.
+- Conversely, if we receive `GetFirebaseRegistrationByDeviceIdFailure` we will send a request to register a new `FirebaseRegistration`
+
+## Consequences
+
+- Any change to `Push notifcation` should be updated in this ADR