@wireapp/core 27.1.0 → 27.2.2

package/CHANGELOG.md

@@ -3,6 +3,36 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [27.2.2](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@27.2.1...@wireapp/core@27.2.2) (2022-05-31)
+
+
+### Bug Fixes
+
+* Ensure websocket messages are not handled while handling notification stream ([#4277](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4277)) ([e858923](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/e858923b13d47accf95c31881aeae4c370c73dbb))
+
+
+
+
+
+## [27.2.1](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@27.2.0...@wireapp/core@27.2.1) (2022-05-31)
+
+**Note:** Version bump only for package @wireapp/core
+
+
+
+
+
+# [27.2.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@27.1.0...@wireapp/core@27.2.0) (2022-05-30)
+
+
+### Features
+
+* Add missed notifications hook ([#4275](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4275)) ([f81217b](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/f81217bad53fed2e4fb163c6ae871b39ca16cf58))
+
+
+
+
+
 # [27.1.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@27.0.5...@wireapp/core@27.1.0) (2022-05-30)
 
 

package/package.json

@@ -5,7 +5,7 @@
   "dependencies": {
     "@types/long": "4.0.1",
     "@types/node": "~14",
-    "@wireapp/api-client": "19.2.5",
+    "@wireapp/api-client": "19.3.1",
     "@wireapp/cryptobox": "12.8.0",
     "bazinga64": "5.10.0",
     "hash.js": "1.1.7",
@@ -69,6 +69,6 @@
     "test:project": "yarn dist && yarn test",
     "test:node": "nyc jasmine --config=jasmine.json"
   },
-  "version": "27.1.0",
-  "gitHead": "fbbc85c85cd536d34c2e32a3fa63ae649dfd559e"
+  "version": "27.2.2",
+  "gitHead": "765718b967368720fad3ed83f12d497c48de5bdd"
 }

package/src/main/Account.d.ts

@@ -150,7 +150,7 @@ export declare class Account extends EventEmitter {
      * @param callbacks callbacks that will be called to handle different events
      * @returns close a function that will disconnect from the websocket
      */
-    listen({ onEvent, onConnected, onConnectionStateChanged, onNotificationStreamProgress, }?: {
+    listen({ onEvent, onConnected, onConnectionStateChanged, onNotificationStreamProgress, onMissedNotifications, }?: {
         /**
          * Called when a new event arrives from backend
          * @param payload the payload of the event. Contains the raw event received and the decrypted data (if event was encrypted)
@@ -172,6 +172,14 @@ export declare class Account extends EventEmitter {
          * called when the connection stateh with the backend has changed
          */
         onConnectionStateChanged?: (state: WEBSOCKET_STATE) => void;
+        /**
+         * called when we detect lost notification from backend.
+         * When a client doesn't log in for a while (28 days, as of now) notifications that are older than 28 days will be deleted from backend.
+         * If the client query the backend for the notifications since a particular notification ID and this ID doesn't exist anymore on the backend, we deduce that some messages were not sync before they were removed from backend.
+         * We can then detect that something was wrong and warn the consumer that there might be some missing old messages
+         * @param  {string} notificationId
+         */
+        onMissedNotifications?: (notificationId: string) => void;
     }): Promise<() => void>;
     private initEngine;
 }

package/src/main/Account.js

@@ -284,7 +284,7 @@ class Account extends events_1.EventEmitter {
      * @param callbacks callbacks that will be called to handle different events
      * @returns close a function that will disconnect from the websocket
      */
-    async listen({ onEvent = () => { }, onConnected = () => { }, onConnectionStateChanged = () => { }, onNotificationStreamProgress = () => { }, } = {}) {
+    async listen({ onEvent = () => { }, onConnected = () => { }, onConnectionStateChanged = () => { }, onNotificationStreamProgress = () => { }, onMissedNotifications = () => { }, } = {}) {
         if (!this.apiClient.context) {
             throw new Error('Context is not set - please login first');
         }
@@ -329,10 +329,14 @@ class Account extends events_1.EventEmitter {
         this.apiClient.transport.ws.on(tcp_1.WebSocketClient.TOPIC.ON_MESSAGE, notification => handleNotification(notification, conversation_1.PayloadBundleSource.WEBSOCKET));
         this.apiClient.transport.ws.on(tcp_1.WebSocketClient.TOPIC.ON_STATE_CHANGE, onConnectionStateChanged);
         const onBeforeConnect = async () => {
+            // Lock websocket in order to buffer any message that arrives while we handle the notification stream
+            this.apiClient.transport.ws.lock();
             await this.service.notification.handleNotificationStream(async (notification, source, progress) => {
                 await handleNotification(notification, source);
                 onNotificationStreamProgress(progress);
-            });
+            }, onMissedNotifications);
+            // We can now unlock the websocket and let the new messages being handled and decrypted
+            this.apiClient.transport.ws.unlock();
             onConnected();
         };
         await this.apiClient.connect(onBeforeConnect);

package/src/main/notification/NotificationBackendRepository.d.ts

@@ -3,6 +3,9 @@ import type { Notification } from '@wireapp/api-client/src/notification/';
 export declare class NotificationBackendRepository {
     private readonly apiClient;
     constructor(apiClient: APIClient);
-    getAllNotifications(clientId?: string, lastNotificationId?: string): Promise<Notification[]>;
+    getAllNotifications(clientId?: string, lastNotificationId?: string): Promise<{
+        notifications: Notification[];
+        missedNotification?: string | undefined;
+    }>;
     getLastNotification(clientId?: string): Promise<Notification>;
 }

package/src/main/notification/NotificationService.d.ts

@@ -42,7 +42,7 @@ export declare class NotificationService extends EventEmitter {
     getNotificationEventList(): Promise<Events.BackendEvent[]>;
     setLastEventDate(eventDate: Date): Promise<Date>;
     setLastNotificationId(lastNotification: Notification): Promise<string>;
-    handleNotificationStream(notificationHandler: NotificationHandler): Promise<void>;
+    handleNotificationStream(notificationHandler: NotificationHandler, onMissedNotifications: (notificationId: string) => void): Promise<void>;
     handleNotification(notification: Notification, source: PayloadBundleSource): AsyncGenerator<HandledEventPayload>;
     private cleanupPayloadBundle;
     private handleEvent;

package/src/main/notification/NotificationService.js

@@ -118,8 +118,11 @@ class NotificationService extends events_1.EventEmitter {
     async setLastNotificationId(lastNotification) {
         return this.database.updateLastNotificationId(lastNotification);
     }
-    async handleNotificationStream(notificationHandler) {
-        const notifications = await this.getAllNotifications();
+    async handleNotificationStream(notificationHandler, onMissedNotifications) {
+        const { notifications, missedNotification } = await this.getAllNotifications();
+        if (missedNotification) {
+            onMissedNotifications(missedNotification);
+        }
         for (const [index, notification] of notifications.entries()) {
             await notificationHandler(notification, conversation_1.PayloadBundleSource.NOTIFICATION_STREAM, {
                 done: index + 1,