MatrixClient.setAccountData: await remote echo. (#4695)

* Rewrite `deleteAccountData` test

use fetch-mock rather than whatever this was

* `MatrixClient.setAccountData`: await remote echo

Wait for the echo to come back from the server before we assume the account
data has been successfully set

* Update integration tests

Fix up the integ tests which call `setAccountData` and now need a sync
response.

* Address review comment

Author: richvdh

spec/integ/crypto/cross-signing.spec.ts

@@ -269,7 +269,7 @@ describe("cross-signing", () => {
             // a *different* device. Then, when we call `bootstrapCrossSigning` again, it should do the honours.
 
             mockSetupCrossSigningRequests();
-            const accountDataAccumulator = new AccountDataAccumulator();
+            const accountDataAccumulator = new AccountDataAccumulator(syncResponder);
             accountDataAccumulator.interceptGetAccountData();
 
             const authDict = { type: "test" };

spec/integ/crypto/crypto.spec.ts

@@ -1760,7 +1760,7 @@ describe("crypto", () => {
 
         beforeEach(async () => {
             createSecretStorageKey.mockClear();
-            accountDataAccumulator = new AccountDataAccumulator();
+            accountDataAccumulator = new AccountDataAccumulator(syncResponder);
             expectAliceKeyQuery({ device_keys: { "@alice:localhost": {} }, failures: {} });
             await startClientAndAwaitFirstSync();
         });
@@ -1787,28 +1787,18 @@ describe("crypto", () => {
                     repeat: 1,
                     overwriteRoutes: true,
                 });
-                accountDataAccumulator.sendSyncResponseWithUpdatedAccountData(syncResponder);
                 if (content.key) {
                     return content.key;
                 }
             }
         }
 
-        function awaitMegolmBackupKeyUpload(): Promise<Record<string, {}>> {
-            return new Promise((resolve) => {
-                // Called when the megolm backup key is uploaded
-                fetchMock.put(
-                    `express:/_matrix/client/v3/user/:userId/account_data/m.megolm_backup.v1`,
-                    (url: string, options: RequestInit) => {
-                        const content = JSON.parse(options.body as string);
-                        // update account data for sync response
-                        accountDataAccumulator.accountDataEvents.set("m.megolm_backup.v1", content);
-                        resolve(content.encrypted);
-                        return {};
-                    },
-                    { overwriteRoutes: true },
-                );
+        async function awaitMegolmBackupKeyUpload(): Promise<Record<string, {}>> {
+            const content = await accountDataAccumulator.interceptSetAccountData("m.megolm_backup.v1", {
+                repeat: 1,
+                overwriteRoutes: true,
             });
+            return content.encrypted;
         }
 
         function awaitAccountDataUpdate(type: string): Promise<void> {
@@ -1866,9 +1856,6 @@ describe("crypto", () => {
             // wait for bootstrapSecretStorage to finished
             await bootstrapPromise;
 
-            // Return the newly created key in the sync response
-            accountDataAccumulator.sendSyncResponseWithUpdatedAccountData(syncResponder);
-
             // Finally ensure backup is working
             await aliceClient.getCrypto()!.checkKeyBackupAndEnable();
 
@@ -1928,9 +1915,6 @@ describe("crypto", () => {
                 expect(keyContent.iv).toBeDefined();
                 expect(keyContent.mac).toBeDefined();
 
-                // Return the newly created key in the sync response
-                accountDataAccumulator.sendSyncResponseWithUpdatedAccountData(syncResponder);
-
                 // Finally, wait for bootstrapSecretStorage to finished
                 await bootstrapPromise;
 
@@ -1950,9 +1934,6 @@ describe("crypto", () => {
                 // Wait for the key to be uploaded in the account data
                 await awaitSecretStorageKeyStoredInAccountData();
 
-                // Return the newly created key in the sync response
-                accountDataAccumulator.sendSyncResponseWithUpdatedAccountData(syncResponder);
-
                 // Wait for bootstrapSecretStorage to finished
                 await bootstrapPromise;
 
@@ -1971,9 +1952,6 @@ describe("crypto", () => {
                 // Wait for the key to be uploaded in the account data
                 await awaitSecretStorageKeyStoredInAccountData();
 
-                // Return the newly created key in the sync response
-                accountDataAccumulator.sendSyncResponseWithUpdatedAccountData(syncResponder);
-
                 // Wait for bootstrapSecretStorage to finished
                 await bootstrapPromise;
 
@@ -1985,9 +1963,6 @@ describe("crypto", () => {
                 // Wait for the key to be uploaded in the account data
                 await awaitSecretStorageKeyStoredInAccountData();
 
-                // Return the newly created key in the sync response
-                accountDataAccumulator.sendSyncResponseWithUpdatedAccountData(syncResponder);
-
                 // Wait for bootstrapSecretStorage to finished
                 await bootstrapPromise;
 
@@ -2009,9 +1984,6 @@ describe("crypto", () => {
                 // Wait for the key to be uploaded in the account data
                 const secretStorageKey = await awaitSecretStorageKeyStoredInAccountData();
 
-                // Return the newly created key in the sync response
-                accountDataAccumulator.sendSyncResponseWithUpdatedAccountData(syncResponder);
-
                 // Wait for the cross signing keys to be uploaded
                 const [masterKey, userSigningKey, selfSigningKey] = await Promise.all([
                     awaitCrossSigningKeyUpload("master"),

spec/test-utils/AccountDataAccumulator.ts

@@ -19,16 +19,23 @@ import fetchMock from "fetch-mock-jest";
 import { type ISyncResponder } from "./SyncResponder";
 
 /**
- *  An object which intercepts `account_data` get and set requests via fetch-mock.
+ * An object which intercepts `account_data` get and set requests via fetch-mock.
+ *
+ * To use this, call {@link interceptSetAccountData} for each type of account date that should be handled. The updated
+ * account data will be stored in {@link accountDataEvents}; it will also trigger a sync response echoing the updated
+ * data.
+ *
+ * Optionally, you can also call {@link interceptGetAccountData}.
  */
 export class AccountDataAccumulator {
     /**
      * The account data events to be returned by the sync.
      * Will be updated when fetchMock intercepts calls to PUT `/_matrix/client/v3/user/:userId/account_data/`.
-     * Will be used by `sendSyncResponseWithUpdatedAccountData`
      */
     public accountDataEvents: Map<string, any> = new Map();
 
+    public constructor(private syncResponder: ISyncResponder) {}
+
     /**
      * Intercept requests to set a particular type of account data.
      *
@@ -53,6 +60,9 @@ export class AccountDataAccumulator {
                     // update account data for sync response
                     this.accountDataEvents.set(type!, content);
                     resolve(content);
+
+                    // return a sync response
+                    this.sendSyncResponseWithUpdatedAccountData();
                     return {};
                 },
                 opts,
@@ -90,9 +100,9 @@ export class AccountDataAccumulator {
     /**
      * Send a sync response the current account data events.
      */
-    public sendSyncResponseWithUpdatedAccountData(syncResponder: ISyncResponder): void {
+    private sendSyncResponseWithUpdatedAccountData(): void {
         try {
-            syncResponder.sendOrQueueSyncResponse({
+            this.syncResponder.sendOrQueueSyncResponse({
                 next_batch: 1,
                 account_data: {
                     events: Array.from(this.accountDataEvents, ([type, content]) => ({

spec/test-utils/mockEndpoints.ts

@@ -22,8 +22,9 @@ import { type KeyBackupInfo } from "../../src/crypto-api";
  * Mock out the endpoints that the js-sdk calls when we call `MatrixClient.start()`.
  *
  * @param homeserverUrl - the homeserver url for the client under test
+ * @param userId - the local user's ID. Defaults to `@alice:localhost`.
  */
-export function mockInitialApiRequests(homeserverUrl: string) {
+export function mockInitialApiRequests(homeserverUrl: string, userId: string = "@alice:localhost") {
     fetchMock.getOnce(
         new URL("/_matrix/client/versions", homeserverUrl).toString(),
         { versions: ["v1.1"] },
@@ -35,7 +36,7 @@ export function mockInitialApiRequests(homeserverUrl: string) {
         { overwriteRoutes: true },
     );
     fetchMock.postOnce(
-        new URL("/_matrix/client/v3/user/%40alice%3Alocalhost/filter", homeserverUrl).toString(),
+        new URL(`/_matrix/client/v3/user/${encodeURIComponent(userId)}/filter`, homeserverUrl).toString(),
         { filter_id: "fid" },
         { overwriteRoutes: true },
     );