@wireapp/core 28.3.6 → 28.4.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [28.4.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@28.3.6...@wireapp/core@28.4.0) (2022-07-08)
+
+
+### Features
+
+* **core:** Send MLS messages (FS-560) ([#4314](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4314)) ([2f29052](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/2f2905233b29c31294ec64e97c1e84998e28821f))
+
+
+
+
+
 ## [28.3.6](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@28.3.5...@wireapp/core@28.3.6) (2022-07-08)
 
 **Note:** Version bump only for package @wireapp/core

package/package.json

@@ -8,7 +8,9 @@
     "@types/long": "4.0.1",
     "@types/node": "~14",
     "@wireapp/api-client": "19.13.0",
+    "@wireapp/commons": "4.3.0",
     "@wireapp/cryptobox": "12.8.0",
+    "@wireapp/store-engine-dexie": "1.6.10",
     "bazinga64": "5.10.0",
     "hash.js": "1.1.7",
     "http-status-codes": "2.1.4",
@@ -22,6 +24,7 @@
     "@types/faker": "5.5.7",
     "@types/jasmine": "3.8.2",
     "@types/karma": "6.3.1",
+    "@types/tough-cookie": "4.0.2",
     "@wireapp/commons": "4.3.0",
     "@wireapp/store-engine-dexie": "1.6.10",
     "commander": "8.0.0",
@@ -39,6 +42,7 @@
     "karma-spec-reporter": "0.0.32",
     "mock-socket": "9.0.3",
     "nock": "13.1.1",
+    "nodemon": "2.0.19",
     "nyc": "15.1.0",
     "rimraf": "3.0.2",
     "typescript": "4.4.2",
@@ -71,8 +75,10 @@
     "test": "yarn test:node && yarn test:browser",
     "test:browser": "webpack --mode=development && karma start",
     "test:project": "yarn dist && yarn test",
-    "test:node": "nyc jasmine --config=jasmine.json"
+    "test:node": "nyc jasmine --config=jasmine.json",
+    "watch": "tsc ---watch",
+    "test:watch": "nodemon --ext ts --exec 'yarn test:node'"
   },
-  "version": "28.3.6",
-  "gitHead": "b374ca750b1a9dc012f3c3fc68928385c83a6477"
+  "version": "28.4.0",
+  "gitHead": "deae9ec404db67616d8ef3680953a13ff00be257"
 }

package/src/main/conversation/ConversationService.d.ts

@@ -1,6 +1,6 @@
 import type { CoreCrypto } from '@otak/core-crypto';
 import type { APIClient } from '@wireapp/api-client';
-import { MessageSendingStatus, Conversation, DefaultConversationRoleName, MutedStatus, NewConversation, QualifiedUserClients, UserClients, ClientMismatch } from '@wireapp/api-client/src/conversation';
+import { MessageSendingStatus, Conversation, DefaultConversationRoleName, MutedStatus, NewConversation, QualifiedUserClients, UserClients, ClientMismatch, ConversationProtocol } from '@wireapp/api-client/src/conversation';
 import type { ConversationMemberLeaveEvent } from '@wireapp/api-client/src/event';
 import type { QualifiedId, UserPreKeyBundleMap } from '@wireapp/api-client/src/user';
 import { GenericMessage } from '@wireapp/protocol-messaging';
@@ -8,11 +8,25 @@ import { MessageTimer } from '../conversation/';
 import type { RemoteData } from '../conversation/content/';
 import type { CryptographyService } from '../cryptography/';
 import type { ClearConversationMessage, DeleteMessage, HideMessage, OtrMessage } from './message/OtrMessage';
+import { XOR } from '@wireapp/commons/src/main/util/TypeUtil';
 export declare enum MessageTargetMode {
     NONE = 0,
     USERS = 1,
     USERS_CLIENTS = 2
 }
+interface SendCommonParams<T> {
+    protocol: ConversationProtocol;
+    payload: T;
+    onStart?: (message: GenericMessage) => void | boolean | Promise<boolean>;
+    onSuccess?: (message: GenericMessage, sentTime?: string) => void;
+}
+declare type SendProteusMessageParams<T> = SendCommonParams<T> & MessageSendingOptions & {
+    userIds?: string[] | QualifiedId[] | UserClients | QualifiedUserClients;
+    onClientMismatch?: (status: ClientMismatch | MessageSendingStatus, wasSent: boolean) => void | boolean | Promise<boolean>;
+};
+declare type SendMlsMessageParams<T> = SendCommonParams<T> & {
+    groupId: string;
+};
 interface MessageSendingOptions {
     /**
      * The federated domain the server runs on. Should only be set for federation enabled envs
@@ -103,6 +117,7 @@ export declare class ConversationService {
     private generateFileDataGenericMessage;
     private generateFileMetaDataGenericMessage;
     private generateFileAbortGenericMessage;
+    private generateAsset;
     private generateImageGenericMessage;
     private generateLocationGenericMessage;
     private generatePingGenericMessage;
@@ -177,26 +192,35 @@ export declare class ConversationService {
     addUser(conversationId: QualifiedId, userIds: string | string[] | QualifiedId | QualifiedId[]): Promise<QualifiedId[]>;
     removeUser(conversationId: string, userId: string): Promise<string>;
     /**
-     * Sends a message to a conversation
+     * Sends a mls message to a conversation
      *
-     * @param params.payloadBundle The message to send to the conversation
-     * @param params.userIds? Can be either a QualifiedId[], string[], UserClients or QualfiedUserClients. The type has some effect on the behavior of the method.
+     * @param params.payload The message to send to the conversation
+     * @param params.protocol The protocol to use to send the message (MLS or Proteus)
+     * @param params.groupId? The groupId of the conversation to send the message to (Needed only for MLS)
+     * @return resolves with the sent message
+     */
+    private sendMlsMessage;
+    /**
+     * Sends a proteus message to a conversation
+     * @param params.userIds? Can be either a QualifiedId[], string[], UserClients or QualfiedUserClients. The type has some effect on the behavior of the method. (Needed only for Proteus)
      *    When given a QualifiedId[] or string[] the method will fetch the freshest list of devices for those users (since they are not given by the consumer). As a consequence no ClientMismatch error will trigger and we will ignore missing clients when sending
      *    When given a QualifiedUserClients or UserClients the method will only send to the clients listed in the userIds. This could lead to ClientMismatch (since the given list of devices might not be the freshest one and new clients could have been created)
      *    When given a QualifiedId[] or QualifiedUserClients the method will send the message through the federated API endpoint
      *    When given a string[] or UserClients the method will send the message through the old API endpoint
      * @return resolves with the sent message
      */
-    send<T extends OtrMessage = OtrMessage>({ payloadBundle, userIds, sendAsProtobuf, conversationDomain, nativePush, targetMode, callbacks, }: {
-        payloadBundle: T;
-        userIds?: string[] | QualifiedId[] | UserClients | QualifiedUserClients;
-        callbacks?: MessageSendingCallbacks;
-    } & MessageSendingOptions): Promise<T>;
+    private sendProteusMessage;
+    /**
+     * Sends a message to a conversation
+     * @return resolves with the sent message
+     */
+    send<T extends OtrMessage>(params: XOR<SendMlsMessageParams<T>, SendProteusMessageParams<T>>): Promise<T>;
     sendTypingStart(conversationId: string): Promise<void>;
     sendTypingStop(conversationId: string): Promise<void>;
     setConversationMutedStatus(conversationId: string, status: MutedStatus, muteTimestamp: number | Date): Promise<void>;
     toggleArchiveConversation(conversationId: string, archived: boolean, archiveTimestamp?: number | Date): Promise<void>;
     setMemberConversationRole(conversationId: string, userId: string, conversationRole: DefaultConversationRoleName | string): Promise<void>;
     private isClearFromMismatch;
+    private generateGenericMessage;
 }
 export {};

package/src/main/conversation/ConversationService.js

@@ -35,6 +35,9 @@ var MessageTargetMode;
     MessageTargetMode[MessageTargetMode["USERS"] = 1] = "USERS";
     MessageTargetMode[MessageTargetMode["USERS_CLIENTS"] = 2] = "USERS_CLIENTS";
 })(MessageTargetMode = exports.MessageTargetMode || (exports.MessageTargetMode = {}));
+function isMLS(params) {
+    return params.protocol === conversation_1.ConversationProtocol.MLS;
+}
 class ConversationService {
     constructor(apiClient, cryptographyService, config, coreCryptoClientProvider) {
         this.apiClient = apiClient;
@@ -335,7 +338,7 @@ class ConversationService {
         const expireAfterMillis = this.messageTimer.getMessageTimer(payloadBundle.conversation);
         return expireAfterMillis > 0 ? this.createEphemeral(genericMessage, expireAfterMillis) : genericMessage;
     }
-    generateImageGenericMessage(payloadBundle) {
+    generateAsset(payloadBundle) {
         if (!payloadBundle.content) {
             throw new Error('No content for sendImage provided.');
         }
@@ -364,15 +367,19 @@ class ConversationService {
             uploaded: remoteData,
         });
         assetMessage.status = conversation_2.AssetTransferState.UPLOADED;
+        return assetMessage;
+    }
+    generateImageGenericMessage(payloadBundle) {
+        const imageAsset = this.generateAsset(payloadBundle);
         let genericMessage = protocol_messaging_1.GenericMessage.create({
-            [conversation_2.GenericMessageType.ASSET]: assetMessage,
+            [conversation_2.GenericMessageType.ASSET]: imageAsset,
             messageId: payloadBundle.id,
         });
         const expireAfterMillis = this.messageTimer.getMessageTimer(payloadBundle.conversation);
         if (expireAfterMillis) {
             genericMessage = this.createEphemeral(genericMessage, expireAfterMillis);
         }
-        return { content: assetMessage, genericMessage };
+        return { genericMessage, content: imageAsset };
     }
     generateLocationGenericMessage(payloadBundle) {
         const { expectsReadConfirmation, latitude, legalHoldStatus, longitude, name, zoom } = payloadBundle.content;
@@ -714,95 +721,71 @@ class ConversationService {
         return userId;
     }
     /**
-     * Sends a message to a conversation
+     * Sends a mls message to a conversation
      *
-     * @param params.payloadBundle The message to send to the conversation
-     * @param params.userIds? Can be either a QualifiedId[], string[], UserClients or QualfiedUserClients. The type has some effect on the behavior of the method.
+     * @param params.payload The message to send to the conversation
+     * @param params.protocol The protocol to use to send the message (MLS or Proteus)
+     * @param params.groupId? The groupId of the conversation to send the message to (Needed only for MLS)
+     * @return resolves with the sent message
+     */
+    async sendMlsMessage(params, genericMessage, content) {
+        var _a, _b;
+        const { groupId, onSuccess, payload } = params;
+        const groupIdBytes = bazinga64_1.Decoder.fromBase64(groupId).asBytes;
+        const coreCryptoClient = this.coreCryptoClientProvider();
+        const encrypted = await coreCryptoClient.encryptMessage(groupIdBytes, protocol_messaging_1.GenericMessage.encode(genericMessage).finish());
+        try {
+            await this.apiClient.api.conversation.postMlsMessage(encrypted);
+            onSuccess === null || onSuccess === void 0 ? void 0 : onSuccess(genericMessage, new Date().toISOString());
+            return Object.assign(Object.assign({}, payload), { content, messageTimer: ((_a = genericMessage.ephemeral) === null || _a === void 0 ? void 0 : _a.expireAfterMillis) || 0, state: conversation_2.PayloadBundleState.OUTGOING_SENT });
+        }
+        catch (_c) {
+            return Object.assign(Object.assign({}, payload), { content, messageTimer: ((_b = genericMessage.ephemeral) === null || _b === void 0 ? void 0 : _b.expireAfterMillis) || 0, state: conversation_2.PayloadBundleState.CANCELLED });
+        }
+    }
+    /**
+     * Sends a proteus message to a conversation
+     * @param params.userIds? Can be either a QualifiedId[], string[], UserClients or QualfiedUserClients. The type has some effect on the behavior of the method. (Needed only for Proteus)
      *    When given a QualifiedId[] or string[] the method will fetch the freshest list of devices for those users (since they are not given by the consumer). As a consequence no ClientMismatch error will trigger and we will ignore missing clients when sending
      *    When given a QualifiedUserClients or UserClients the method will only send to the clients listed in the userIds. This could lead to ClientMismatch (since the given list of devices might not be the freshest one and new clients could have been created)
      *    When given a QualifiedId[] or QualifiedUserClients the method will send the message through the federated API endpoint
      *    When given a string[] or UserClients the method will send the message through the old API endpoint
      * @return resolves with the sent message
      */
-    async send({ payloadBundle, userIds, sendAsProtobuf, conversationDomain, nativePush, targetMode, callbacks, }) {
-        var _a, _b, _c, _d;
-        let genericMessage;
-        let processedContent = undefined;
-        switch (payloadBundle.type) {
-            case conversation_2.PayloadBundleType.ASSET:
-                genericMessage = this.generateFileDataGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.ASSET_ABORT:
-                genericMessage = this.generateFileAbortGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.ASSET_META:
-                genericMessage = this.generateFileMetaDataGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.ASSET_IMAGE:
-                const res = this.generateImageGenericMessage(payloadBundle);
-                genericMessage = res.genericMessage;
-                processedContent = res.content;
-                break;
-            case conversation_2.PayloadBundleType.BUTTON_ACTION:
-                genericMessage = this.generateButtonActionGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.BUTTON_ACTION_CONFIRMATION:
-                genericMessage = this.generateButtonActionConfirmationGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.CALL:
-                genericMessage = this.generateCallGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.CLIENT_ACTION: {
-                if (payloadBundle.content.clientAction !== protocol_messaging_1.ClientAction.RESET_SESSION) {
-                    throw new Error(`No send method implemented for "${payloadBundle.type}" and ClientAction "${payloadBundle.content}".`);
-                }
-                genericMessage = this.generateSessionResetGenericMessage(payloadBundle);
-                break;
-            }
-            case conversation_2.PayloadBundleType.COMPOSITE:
-                genericMessage = this.generateCompositeGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.CONFIRMATION:
-                genericMessage = this.generateConfirmationGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.LOCATION:
-                genericMessage = this.generateLocationGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.MESSAGE_EDIT:
-                genericMessage = this.generateEditedTextGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.PING:
-                genericMessage = this.generatePingGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.REACTION:
-                genericMessage = this.generateReactionGenericMessage(payloadBundle);
-                break;
-            case conversation_2.PayloadBundleType.TEXT:
-                genericMessage = this.generateTextGenericMessage(payloadBundle);
-                break;
-            default:
-                throw new Error(`No send method implemented for "${payloadBundle['type']}".`);
-        }
-        if ((await ((_a = callbacks === null || callbacks === void 0 ? void 0 : callbacks.onStart) === null || _a === void 0 ? void 0 : _a.call(callbacks, genericMessage))) === false) {
-            // If the onStart call returns false, it means the consumer wants to cancel the message sending
-            return Object.assign(Object.assign({}, payloadBundle), { state: conversation_2.PayloadBundleState.CANCELLED });
-        }
-        const response = await this.sendGenericMessage(this.apiClient.validatedClientId, payloadBundle.conversation, genericMessage, {
+    async sendProteusMessage(params, genericMessage, content) {
+        var _a;
+        const { userIds, sendAsProtobuf, conversationDomain, nativePush, targetMode, payload, onClientMismatch, onSuccess } = params;
+        const response = await this.sendGenericMessage(this.apiClient.validatedClientId, payload.conversation, genericMessage, {
             userIds,
             sendAsProtobuf,
             conversationDomain,
             nativePush,
             targetMode,
-            onClientMismatch: callbacks === null || callbacks === void 0 ? void 0 : callbacks.onClientMismatch,
+            onClientMismatch,
         });
         if (!response.errored) {
             if (!this.isClearFromMismatch(response)) {
                 // We warn the consumer that there is a mismatch that did not prevent message sending
-                await ((_b = callbacks === null || callbacks === void 0 ? void 0 : callbacks.onClientMismatch) === null || _b === void 0 ? void 0 : _b.call(callbacks, response, true));
+                await (onClientMismatch === null || onClientMismatch === void 0 ? void 0 : onClientMismatch(response, true));
             }
-            (_c = callbacks === null || callbacks === void 0 ? void 0 : callbacks.onSuccess) === null || _c === void 0 ? void 0 : _c.call(callbacks, genericMessage, response.time);
+            onSuccess === null || onSuccess === void 0 ? void 0 : onSuccess(genericMessage, response.time);
         }
-        return Object.assign(Object.assign({}, payloadBundle), { content: processedContent || payloadBundle.content, messageTimer: ((_d = genericMessage.ephemeral) === null || _d === void 0 ? void 0 : _d.expireAfterMillis) || 0, state: response.errored ? conversation_2.PayloadBundleState.CANCELLED : conversation_2.PayloadBundleState.OUTGOING_SENT });
+        return Object.assign(Object.assign({}, payload), { content, messageTimer: ((_a = genericMessage.ephemeral) === null || _a === void 0 ? void 0 : _a.expireAfterMillis) || 0, state: response.errored ? conversation_2.PayloadBundleState.CANCELLED : conversation_2.PayloadBundleState.OUTGOING_SENT });
+    }
+    /**
+     * Sends a message to a conversation
+     * @return resolves with the sent message
+     */
+    async send(params) {
+        const { payload, onStart } = params;
+        const { genericMessage, content } = this.generateGenericMessage(payload);
+        if ((await (onStart === null || onStart === void 0 ? void 0 : onStart(genericMessage))) === false) {
+            // If the onStart call returns false, it means the consumer wants to cancel the message sending
+            return Object.assign(Object.assign({}, payload), { state: conversation_2.PayloadBundleState.CANCELLED });
+        }
+        return isMLS(params)
+            ? this.sendMlsMessage(params, genericMessage, content)
+            : this.sendProteusMessage(params, genericMessage, content);
     }
     sendTypingStart(conversationId) {
         return this.apiClient.api.conversation.postTyping(conversationId, { status: data_1.CONVERSATION_TYPING.STARTED });
@@ -842,6 +825,65 @@ class ConversationService {
         const hasFailed = Object.keys(mismatch.failed_to_send || {}).length > 0;
         return !hasMissing && !hasDeleted && !hasRedundant && !hasFailed;
     }
+    generateGenericMessage(payload) {
+        let genericMessage;
+        const content = payload.content;
+        switch (payload.type) {
+            case conversation_2.PayloadBundleType.ASSET:
+                genericMessage = this.generateFileDataGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.ASSET_ABORT:
+                genericMessage = this.generateFileAbortGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.ASSET_META:
+                genericMessage = this.generateFileMetaDataGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.ASSET_IMAGE:
+                return this.generateImageGenericMessage(payload);
+            case conversation_2.PayloadBundleType.BUTTON_ACTION:
+                genericMessage = this.generateButtonActionGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.BUTTON_ACTION_CONFIRMATION:
+                genericMessage = this.generateButtonActionConfirmationGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.CALL:
+                genericMessage = this.generateCallGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.CLIENT_ACTION: {
+                if (payload.content.clientAction !== protocol_messaging_1.ClientAction.RESET_SESSION) {
+                    throw new Error(`No send method implemented for "${payload.type}" and ClientAction "${payload.content}".`);
+                }
+                genericMessage = this.generateSessionResetGenericMessage(payload);
+                return { genericMessage, content };
+            }
+            case conversation_2.PayloadBundleType.COMPOSITE:
+                genericMessage = this.generateCompositeGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.CONFIRMATION:
+                genericMessage = this.generateConfirmationGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.LOCATION:
+                genericMessage = this.generateLocationGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.MESSAGE_EDIT:
+                genericMessage = this.generateEditedTextGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.PING:
+                genericMessage = this.generatePingGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.REACTION:
+                genericMessage = this.generateReactionGenericMessage(payload);
+                return { genericMessage, content };
+            case conversation_2.PayloadBundleType.TEXT:
+                genericMessage = this.generateTextGenericMessage(payload);
+                return { genericMessage, content };
+            /**
+             * ToDo: Create Generic implementation for everything else
+             */
+            default:
+                throw new Error(`No send method implemented for "${payload['type']}".`);
+        }
+    }
 }
 exports.ConversationService = ConversationService;
 //# sourceMappingURL=ConversationService.js.map