test: pull forwardToDeviceMessage out to helper.ts

This is a useful helper for other tests.

Author: richvdh

tests/device.test.js

@@ -26,7 +26,7 @@ const {
     QrCode,
     QrCodeScan,
 } = require("@matrix-org/matrix-sdk-crypto-wasm");
-const { zip, addMachineToMachine } = require("./helper");
+const { zip, addMachineToMachine, forwardToDeviceMessage } = require("./helper");
 const { VerificationRequestPhase, QrState } = require("@matrix-org/matrix-sdk-crypto-wasm");
 
 // Uncomment to enable debug logging for tests
@@ -1122,36 +1122,3 @@ describe("VerificationMethod", () => {
         expect(VerificationMethod.ReciprocateV1).toStrictEqual(3);
     });
 });
-
-/**
- * Forward an outgoing to-device message returned by one OlmMachine into another OlmMachine.
- */
-async function forwardToDeviceMessage(sendingUser, recipientMachine, outgoingVerificationRequest) {
-    expect(outgoingVerificationRequest).toBeInstanceOf(ToDeviceRequest);
-    await sendToDeviceMessageIntoMachine(
-        sendingUser,
-        outgoingVerificationRequest.event_type,
-        JSON.parse(outgoingVerificationRequest.body).messages[recipientMachine.userId.toString()][
-            recipientMachine.deviceId.toString()
-        ],
-        recipientMachine,
-    );
-}
-
-/**
- * Send a to-device message into an OlmMachine.
- */
-async function sendToDeviceMessageIntoMachine(sendingUser, eventType, content, recipientMachine) {
-    await recipientMachine.receiveSyncChanges(
-        JSON.stringify([
-            {
-                sender: sendingUser.toString(),
-                type: eventType,
-                content: content,
-            },
-        ]),
-        new DeviceLists(),
-        new Map(),
-        undefined,
-    );
-}

tests/helper.ts

@@ -14,9 +14,17 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { DeviceLists, RequestType, KeysUploadRequest, KeysQueryRequest } from "@matrix-org/matrix-sdk-crypto-wasm";
-
-export function* zip(...arrays) {
+import {
+    DeviceLists,
+    RequestType,
+    KeysUploadRequest,
+    KeysQueryRequest,
+    ToDeviceRequest,
+    OlmMachine,
+    UserId,
+} from "@matrix-org/matrix-sdk-crypto-wasm";
+
+export function* zip(...arrays: Array<Array<any>>): Generator<any> {
     const len = Math.min(...arrays.map((array) => array.length));
 
     for (let nth = 0; nth < len; ++nth) {
@@ -45,9 +53,12 @@ export async function addMachineToMachine(machineToAdd: OlmMachine, machine: Olm
     expect(outgoingRequests).toHaveLength(2);
 
     let keysUploadRequest;
+
     // Read the `KeysUploadRequest`.
     {
         expect(outgoingRequests[0]).toBeInstanceOf(KeysUploadRequest);
+        keysUploadRequest = outgoingRequests[0] as KeysUploadRequest;
+
         expect(outgoingRequests[0].id).toBeDefined();
         expect(outgoingRequests[0].type).toStrictEqual(RequestType.KeysUpload);
         expect(outgoingRequests[0].body).toBeDefined();
@@ -64,27 +75,26 @@ export async function addMachineToMachine(machineToAdd: OlmMachine, machine: Olm
             },
         });
         const marked = await machineToAdd.markRequestAsSent(
-            outgoingRequests[0].id,
+            keysUploadRequest.id,
             outgoingRequests[0].type,
             hypotheticalResponse,
         );
         expect(marked).toStrictEqual(true);
-
-        keysUploadRequest = outgoingRequests[0];
     }
 
     {
         expect(outgoingRequests[1]).toBeInstanceOf(KeysQueryRequest);
+        let keysQueryRequest = outgoingRequests[1] as KeysQueryRequest;
 
         let bootstrapCrossSigningResult = await machineToAdd.bootstrapCrossSigning(true);
         let signingKeysUploadRequest = bootstrapCrossSigningResult.uploadSigningKeysRequest;
 
         // Let's forge a `KeysQuery`'s response.
         let keyQueryResponse = {
-            device_keys: {},
-            master_keys: {},
-            self_signing_keys: {},
-            user_signing_keys: {},
+            device_keys: {} as Record<string, any>,
+            master_keys: {} as Record<string, any>,
+            self_signing_keys: {} as Record<string, any>,
+            user_signing_keys: {} as Record<string, any>,
         };
         const userId = machineToAdd.userId.toString();
         const deviceId = machineToAdd.deviceId.toString();
@@ -97,10 +107,52 @@ export async function addMachineToMachine(machineToAdd: OlmMachine, machine: Olm
         keyQueryResponse.user_signing_keys[userId] = keys.user_signing_key;
 
         const marked = await machine.markRequestAsSent(
-            outgoingRequests[1].id,
-            outgoingRequests[1].type,
+            keysQueryRequest.id,
+            keysQueryRequest.type,
             JSON.stringify(keyQueryResponse),
         );
         expect(marked).toStrictEqual(true);
     }
 }
+
+/**
+ * Forward an outgoing to-device message returned by one OlmMachine into another OlmMachine.
+ */
+export async function forwardToDeviceMessage(
+    sendingUser: UserId,
+    recipientMachine: OlmMachine,
+    toDeviceRequest: ToDeviceRequest,
+): Promise<void> {
+    expect(toDeviceRequest).toBeInstanceOf(ToDeviceRequest);
+    await sendToDeviceMessageIntoMachine(
+        sendingUser,
+        toDeviceRequest.event_type,
+        JSON.parse(toDeviceRequest.body).messages[recipientMachine.userId.toString()][
+            recipientMachine.deviceId.toString()
+        ],
+        recipientMachine,
+    );
+}
+
+/**
+ * Send a to-device message into an OlmMachine.
+ */
+export async function sendToDeviceMessageIntoMachine(
+    sendingUser: UserId,
+    eventType: string,
+    content: object,
+    recipientMachine: OlmMachine,
+): Promise<void> {
+    await recipientMachine.receiveSyncChanges(
+        JSON.stringify([
+            {
+                sender: sendingUser.toString(),
+                type: eventType,
+                content: content,
+            },
+        ]),
+        new DeviceLists(),
+        new Map(),
+        undefined,
+    );
+}