Device manager - use deleteAccountData to prune device manager client…

… information events (#9734)
matrix-org · Dec 14, 2022 · aeb9f43 · aeb9f43
1 parent 85d43ff
commit aeb9f43
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/src/utils/device/clientInformation.ts b/src/utils/device/clientInformation.ts
@@ -75,9 +75,9 @@ export const removeClientInformation = async (matrixClient: MatrixClient): Promi
     const type = getClientInformationEventType(deviceId);
     const clientInformation = getDeviceClientInformation(matrixClient, deviceId);
 
-    // if a non-empty client info event exists, overwrite to remove the content
+    // if a non-empty client info event exists, remove it
     if (clientInformation.name || clientInformation.version || clientInformation.url) {
-        await matrixClient.setAccountData(type, {});
+        await matrixClient.deleteAccountData(type);
     }
 };
 

diff --git a/test/DeviceListener-test.ts b/test/DeviceListener-test.ts
@@ -96,6 +96,7 @@ describe("DeviceListener", () => {
             getDeviceId: jest.fn().mockReturnValue(deviceId),
             setAccountData: jest.fn(),
             getAccountData: jest.fn(),
+            deleteAccountData: jest.fn(),
             checkDeviceTrust: jest.fn().mockReturnValue(new DeviceTrustLevel(false, false, false, false)),
         });
         jest.spyOn(MatrixClientPeg, "get").mockReturnValue(mockClient);
@@ -188,17 +189,16 @@ describe("DeviceListener", () => {
                 mockClient!.getAccountData.mockReturnValue(clientInfoEvent);
                 await createAndStart();
 
-                expect(mockClient!.setAccountData).toHaveBeenCalledWith(
+                expect(mockClient!.deleteAccountData).toHaveBeenCalledWith(
                     `io.element.matrix_client_information.${deviceId}`,
-                    {},
                 );
             });
 
             it("does not try to remove client info event that are already empty", async () => {
                 mockClient!.getAccountData.mockReturnValue(emptyClientInfoEvent);
                 await createAndStart();
 
-                expect(mockClient!.setAccountData).not.toHaveBeenCalled();
+                expect(mockClient!.deleteAccountData).not.toHaveBeenCalled();
             });
 
             it("does not save client information on logged in action", async () => {