@wireapp/core 31.3.6 → 32.0.1

package/package.json

@@ -3,7 +3,7 @@
     "./src/main/cryptography/AssetCryptography/crypto.node": "./src/main/cryptography/AssetCryptography/crypto.browser.js"
   },
   "dependencies": {
-    "@wireapp/api-client": "^20.6.4",
+    "@wireapp/api-client": "^20.6.5",
     "@wireapp/commons": "^4.4.6",
     "@wireapp/core-crypto": "0.5.2",
     "@wireapp/cryptobox": "12.8.0",
@@ -81,6 +81,6 @@
     "test": "jest",
     "watch": "tsc ---watch"
   },
-  "version": "31.3.6",
-  "gitHead": "4578099d3d63d9e9e28e43911c72168fb885e2b8"
+  "version": "32.0.1",
+  "gitHead": "6fe9b9fc73ef4d777bfa4e3a37e78d28a49ae099"
 }

package/src/main/Account.d.ts

@@ -21,13 +21,22 @@ import { TeamService } from './team/';
 import { UserService } from './user/';
 import { AccountService } from './account/';
 import { LinkPreviewService } from './linkPreview';
-import { WEBSOCKET_STATE } from '@wireapp/api-client/src/tcp/ReconnectingWebsocket';
 import { MLSService } from './mls';
 import { MLSCallbacks, MLSConfig } from './mls/types';
 export declare type ProcessedEventPayload = HandledEventPayload;
 declare enum TOPIC {
     ERROR = "Account.TOPIC.ERROR"
 }
+export declare enum ConnectionState {
+    /** The websocket is closed and notifications stream is not being processed */
+    CLOSED = "closed",
+    /** The websocket is being opened */
+    CONNECTING = "connecting",
+    /** The websocket is open but locked and notifications stream is being processed */
+    PROCESSING_NOTIFICATIONS = "processing_notifications",
+    /** The websocket is open and message will go through and notifications stream is fully processed */
+    LIVE = "live"
+}
 export interface Account {
     on(event: PayloadBundleType.ASSET, listener: (payload: OtrMessage.FileAssetMessage | OtrMessage.ImageAssetMessage) => void): this;
     on(event: PayloadBundleType.BUTTON_ACTION, listener: (payload: OtrMessage.ButtonActionMessage) => void): this;
@@ -172,7 +181,7 @@ export declare class Account<T = any> 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, onMissedNotifications, dryRun, }?: {
+    listen({ onEvent, onConnectionStateChanged, onNotificationStreamProgress, onMissedNotifications, dryRun, }?: {
         /**
          * 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)
@@ -186,14 +195,10 @@ export declare class Account<T = any> extends EventEmitter {
             done: number;
             total: number;
         }) => void;
-        /**
-         * called when the connection to the websocket is established and the notification stream has been processed
-         */
-        onConnected?: () => void;
         /**
          * called when the connection stateh with the backend has changed
          */
-        onConnectionStateChanged?: (state: WEBSOCKET_STATE) => void;
+        onConnectionStateChanged?: (state: ConnectionState) => 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.

package/src/main/Account.js

@@ -51,7 +51,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Account = void 0;
+exports.Account = exports.ConnectionState = void 0;
 const http_status_codes_1 = require("http-status-codes");
 const api_client_1 = require("@wireapp/api-client");
 const auth_1 = require("@wireapp/api-client/src/auth/");
@@ -74,6 +74,7 @@ const team_1 = require("./team/");
 const user_1 = require("./user/");
 const account_1 = require("./account/");
 const linkPreview_1 = require("./linkPreview");
+const ReconnectingWebsocket_1 = require("@wireapp/api-client/src/tcp/ReconnectingWebsocket");
 const encryptedStore_1 = require("./util/encryptedStore");
 const bazinga64_1 = require("bazinga64");
 const mls_1 = require("./mls");
@@ -82,6 +83,17 @@ var TOPIC;
 (function (TOPIC) {
     TOPIC["ERROR"] = "Account.TOPIC.ERROR";
 })(TOPIC || (TOPIC = {}));
+var ConnectionState;
+(function (ConnectionState) {
+    /** The websocket is closed and notifications stream is not being processed */
+    ConnectionState["CLOSED"] = "closed";
+    /** The websocket is being opened */
+    ConnectionState["CONNECTING"] = "connecting";
+    /** The websocket is open but locked and notifications stream is being processed */
+    ConnectionState["PROCESSING_NOTIFICATIONS"] = "processing_notifications";
+    /** The websocket is open and message will go through and notifications stream is fully processed */
+    ConnectionState["LIVE"] = "live";
+})(ConnectionState = exports.ConnectionState || (exports.ConnectionState = {}));
 const coreDefaultClient = {
     classification: client_1.ClientClassification.DESKTOP,
     cookieLabel: 'default',
@@ -365,7 +377,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 = () => { }, onMissedNotifications = () => { }, dryRun = false, } = {}) {
+    async listen({ onEvent = () => { }, onConnectionStateChanged = () => { }, onNotificationStreamProgress = () => { }, onMissedNotifications = () => { }, dryRun = false, } = {}) {
         if (!this.apiClient.context) {
             throw new Error('Context is not set - please login first');
         }
@@ -408,9 +420,19 @@ class Account extends events_1.EventEmitter {
         };
         this.apiClient.transport.ws.removeAllListeners(tcp_1.WebSocketClient.TOPIC.ON_MESSAGE);
         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 (abortHandler) => {
+        this.apiClient.transport.ws.on(tcp_1.WebSocketClient.TOPIC.ON_STATE_CHANGE, wsState => {
+            const mapping = {
+                [ReconnectingWebsocket_1.WEBSOCKET_STATE.CLOSED]: ConnectionState.CLOSED,
+                [ReconnectingWebsocket_1.WEBSOCKET_STATE.CONNECTING]: ConnectionState.CONNECTING,
+            };
+            const connectionState = mapping[wsState];
+            if (connectionState) {
+                onConnectionStateChanged(connectionState);
+            }
+        });
+        const processNotificationStream = async (abortHandler) => {
             // Lock websocket in order to buffer any message that arrives while we handle the notification stream
+            onConnectionStateChanged(ConnectionState.PROCESSING_NOTIFICATIONS);
             this.apiClient.transport.ws.lock();
             await this.service.notification.handleNotificationStream(async (notification, source, progress) => {
                 await handleNotification(notification, source);
@@ -421,12 +443,13 @@ class Account extends events_1.EventEmitter {
             // We need to wait for the notification stream to be fully handled before releasing the message sending queue.
             // This is due to the nature of how message are encrypted, any change in mls epoch needs to happen before we start encrypting any kind of messages
             (0, messageSender_1.resumeMessageSending)();
-            onConnected();
+            onConnectionStateChanged(ConnectionState.LIVE);
         };
-        await this.apiClient.connect(onBeforeConnect);
+        this.apiClient.connect(processNotificationStream);
         return () => {
-            this.apiClient.transport.ws.removeAllListeners();
             this.apiClient.disconnect();
+            onConnectionStateChanged(ConnectionState.CLOSED);
+            this.apiClient.transport.ws.removeAllListeners();
         };
     }
     generateDbName(context) {