matrix-mock-request to 2.0.1 (#2416)

* matrix-mock-request to 2.0.0 Signed-off-by: Kerry Archibald <[email protected]> * track and destroy timeouts from test client Signed-off-by: Kerry Archibald <[email protected]> * remove debug Signed-off-by: Kerry Archibald <[email protected]> * fix bad property refernce caught by ts TestClient Signed-off-by: Kerry Archibald <[email protected]> * Revert "fix bad property refernce caught by ts TestClient" This reverts commit 92c9f6c. * update yarn lock Signed-off-by: Kerry Archibald <[email protected]> * correct IUploadKeysRequest type * fix types in TestClient for typed matrix-mock-request Signed-off-by: Kerry Archibald <[email protected]> * update to matrix-mock-request 2.0.1 Signed-off-by: Kerry Archibald <[email protected]>
matrix-org · Jun 3, 2022 · 518e16e · 518e16e
1 parent 012f6c5
commit 518e16e
Show file tree

Hide file tree

Showing 8 changed files with 64 additions and 217 deletions.
diff --git a/package.json b/package.json
@@ -102,7 +102,7 @@
     "jest-localstorage-mock": "^2.4.6",
     "jest-sonar-reporter": "^2.0.0",
     "jsdoc": "^3.6.6",
-    "matrix-mock-request": "^1.2.3",
+    "matrix-mock-request": "^2.0.1",
     "rimraf": "^3.0.2",
     "terser": "^5.5.1",
     "tsify": "^5.0.2",

diff --git a/spec/TestClient.ts b/spec/TestClient.ts
@@ -31,6 +31,8 @@ import { MockStorageApi } from "./MockStorageApi";
 import { encodeUri } from "../src/utils";
 import { IDeviceKeys, IOneTimeKey } from "../src/crypto/dehydration";
 import { IKeyBackupSession } from "../src/crypto/keybackup";
+import { IHttpOpts } from "../src/http-api";
+import { IKeysUploadResponse, IUploadKeysRequest } from '../src/client';
 
 /**
  * Wrapper for a MockStorageApi, MockHttpBackend and MatrixClient
@@ -61,7 +63,7 @@ export class TestClient {
             accessToken: accessToken,
             deviceId: deviceId,
             sessionStore: sessionStore,
-            request: this.httpBackend.requestFn,
+            request: this.httpBackend.requestFn as IHttpOpts["request"],
             ...options,
         };
         if (!fullOptions.cryptoStore) {
@@ -109,26 +111,27 @@ export class TestClient {
      * stop the client
      * @return {Promise} Resolves once the mock http backend has finished all pending flushes
      */
-    public stop(): Promise<void> {
+    public async stop(): Promise<void> {
         this.client.stopClient();
-        return this.httpBackend.stop();
+        await this.httpBackend.stop();
     }
 
     /**
      * Set up expectations that the client will upload device keys.
      */
     public expectDeviceKeyUpload() {
-        this.httpBackend.when("POST", "/keys/upload").respond(200, (path, content) => {
-            expect(content.one_time_keys).toBe(undefined);
-            expect(content.device_keys).toBeTruthy();
+        this.httpBackend.when("POST", "/keys/upload")
+            .respond<IKeysUploadResponse, IUploadKeysRequest>(200, (_path, content) => {
+                expect(content.one_time_keys).toBe(undefined);
+                expect(content.device_keys).toBeTruthy();
 
-            logger.log(this + ': received device keys');
-            // we expect this to happen before any one-time keys are uploaded.
-            expect(Object.keys(this.oneTimeKeys).length).toEqual(0);
+                logger.log(this + ': received device keys');
+                // we expect this to happen before any one-time keys are uploaded.
+                expect(Object.keys(this.oneTimeKeys).length).toEqual(0);
 
-            this.deviceKeys = content.device_keys;
-            return { one_time_key_counts: { signed_curve25519: 0 } };
-        });
+                this.deviceKeys = content.device_keys;
+                return { one_time_key_counts: { signed_curve25519: 0 } };
+            });
     }
 
     /**
@@ -145,7 +148,7 @@ export class TestClient {
         }
 
         this.httpBackend.when("POST", "/keys/upload")
-            .respond(200, (path, content) => {
+            .respond<IKeysUploadResponse, IUploadKeysRequest>(200, (_path, content: IUploadKeysRequest) => {
                 expect(content.device_keys).toBe(undefined);
                 expect(content.one_time_keys).toBe(undefined);
                 return { one_time_key_counts: {
@@ -154,7 +157,7 @@ export class TestClient {
             });
 
         this.httpBackend.when("POST", "/keys/upload")
-            .respond(200, (path, content) => {
+            .respond<IKeysUploadResponse, IUploadKeysRequest>(200, (_path, content: IUploadKeysRequest) => {
                 expect(content.device_keys).toBe(undefined);
                 expect(content.one_time_keys).toBeTruthy();
                 expect(content.one_time_keys).not.toEqual({});
@@ -181,8 +184,8 @@ export class TestClient {
      * @param {Object} response   response to the query.
      */
     public expectKeyQuery(response: IDownloadKeyResult) {
-        this.httpBackend.when('POST', '/keys/query').respond(
-            200, (path, content) => {
+        this.httpBackend.when('POST', '/keys/query').respond<IDownloadKeyResult>(
+            200, (_path, content) => {
                 Object.keys(response.device_keys).forEach((userId) => {
                     expect(content.device_keys[userId]).toEqual([]);
                 });

diff --git a/spec/unit/crypto/secrets.spec.js b/spec/unit/crypto/secrets.spec.js
@@ -223,7 +223,7 @@ describe("Secrets", function() {
     });
 
     it("should request secrets from other clients", async function() {
-        const [osborne2, vax] = await makeTestClients(
+        const [[osborne2, vax], clearTestClientTimeouts] = await makeTestClients(
             [
                 { userId: "@alice:example.com", deviceId: "Osborne2" },
                 { userId: "@alice:example.com", deviceId: "VAX" },
@@ -280,6 +280,7 @@ describe("Secrets", function() {
         expect(secret).toBe("bar");
         osborne2.stop();
         vax.stop();
+        clearTestClientTimeouts();
     });
 
     describe("bootstrap", function() {

diff --git a/spec/unit/crypto/verification/request.spec.js b/spec/unit/crypto/verification/request.spec.js
@@ -40,7 +40,7 @@ describe("verification request integration tests with crypto layer", function()
     });
 
     it("should request and accept a verification", async function() {
-        const [alice, bob] = await makeTestClients(
+        const [[alice, bob], clearTestClientTimeouts] = await makeTestClients(
             [
                 { userId: "@alice:example.com", deviceId: "Osborne2" },
                 { userId: "@bob:example.com", deviceId: "Dynabook" },
@@ -81,5 +81,6 @@ describe("verification request integration tests with crypto layer", function()
 
         alice.stop();
         bob.stop();
+        clearTestClientTimeouts();
     });
 });
diff --git a/spec/unit/crypto/verification/sas.spec.js b/spec/unit/crypto/verification/sas.spec.js
@@ -75,9 +75,10 @@ describe("SAS verification", function() {
         let bobSasEvent;
         let aliceVerifier;
         let bobPromise;
+        let clearTestClientTimeouts;
 
         beforeEach(async () => {
-            [alice, bob] = await makeTestClients(
+            [[alice, bob], clearTestClientTimeouts] = await makeTestClients(
                 [
                     { userId: "@alice:example.com", deviceId: "Osborne2" },
                     { userId: "@bob:example.com", deviceId: "Dynabook" },
@@ -178,6 +179,8 @@ describe("SAS verification", function() {
                 alice.stop(),
                 bob.stop(),
             ]);
+
+            clearTestClientTimeouts();
         });
 
         it("should verify a key", async () => {
@@ -334,7 +337,7 @@ describe("SAS verification", function() {
     });
 
     it("should send a cancellation message on error", async function() {
-        const [alice, bob] = await makeTestClients(
+        const [[alice, bob], clearTestClientTimeouts] = await makeTestClients(
             [
                 { userId: "@alice:example.com", deviceId: "Osborne2" },
                 { userId: "@bob:example.com", deviceId: "Dynabook" },
@@ -380,6 +383,7 @@ describe("SAS verification", function() {
 
         alice.stop();
         bob.stop();
+        clearTestClientTimeouts();
     });
 
     describe("verification in DM", function() {
@@ -389,9 +393,10 @@ describe("SAS verification", function() {
         let bobSasEvent;
         let aliceVerifier;
         let bobPromise;
+        let clearTestClientTimeouts;
 
         beforeEach(async function() {
-            [alice, bob] = await makeTestClients(
+            [[alice, bob], clearTestClientTimeouts] = await makeTestClients(
                 [
                     { userId: "@alice:example.com", deviceId: "Osborne2" },
                     { userId: "@bob:example.com", deviceId: "Dynabook" },
@@ -491,6 +496,8 @@ describe("SAS verification", function() {
                 alice.stop(),
                 bob.stop(),
             ]);
+
+            clearTestClientTimeouts();
         });
 
         it("should verify a key", async function() {

diff --git a/spec/unit/crypto/verification/util.js b/spec/unit/crypto/verification/util.js
@@ -23,6 +23,7 @@ import { logger } from '../../../../src/logger';
 
 export async function makeTestClients(userInfos, options) {
     const clients = [];
+    const timeouts = [];
     const clientMap = {};
     const sendToDevice = function(type, map) {
         // logger.log(this.getUserId(), "sends", type, map);
@@ -66,7 +67,7 @@ export async function makeTestClients(userInfos, options) {
             },
         }));
 
-        setImmediate(() => {
+        const timeout = setTimeout(() => {
             for (const tc of clients) {
                 if (tc.client === this) { // eslint-disable-line @babel/no-invalid-this
                     logger.log("sending remote echo!!");
@@ -77,6 +78,8 @@ export async function makeTestClients(userInfos, options) {
             }
         });
 
+        timeouts.push(timeout);
+
         return Promise.resolve({ event_id: eventId });
     };
 
@@ -103,7 +106,11 @@ export async function makeTestClients(userInfos, options) {
 
     await Promise.all(clients.map((testClient) => testClient.client.initCrypto()));
 
-    return clients;
+    const destroy = () => {
+        timeouts.forEach((t) => clearTimeout(t));
+    };
+
+    return [clients, destroy];
 }
 
 export function setupWebcrypto() {

diff --git a/src/client.ts b/src/client.ts
@@ -590,13 +590,9 @@ export interface IRequestMsisdnTokenResponse extends IRequestTokenResponse {
     intl_fmt: string;
 }
 
-interface IUploadKeysRequest {
+export interface IUploadKeysRequest {
     device_keys?: Required<IDeviceKeys>;
-    one_time_keys?: {
-        [userId: string]: {
-            [deviceId: string]: number;
-        };
-    };
+    one_time_keys?: Record<string, IOneTimeKey>;
     "org.matrix.msc2732.fallback_keys"?: Record<string, IOneTimeKey>;
 }