Device manager - record device client information on app start (PSG-633) (#9314)

* record device client inforamtion events on app start

* matrix-client-information -> matrix_client_information

* fix types

* remove another unused export

* add docs link

* add opt in setting for recording device information

test/utils/device/clientInformation-test.ts

@@ -0,0 +1,86 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import BasePlatform from "../../../src/BasePlatform";
+import { IConfigOptions } from "../../../src/IConfigOptions";
+import { recordClientInformation } from "../../../src/utils/device/clientInformation";
+import { getMockClientWithEventEmitter } from "../../test-utils";
+
+describe('recordClientInformation()', () => {
+    const deviceId = 'my-device-id';
+    const version = '1.2.3';
+    const isElectron = window.electron;
+
+    const mockClient = getMockClientWithEventEmitter({
+        getDeviceId: jest.fn().mockReturnValue(deviceId),
+        setAccountData: jest.fn(),
+    });
+
+    const sdkConfig: IConfigOptions = {
+        brand: 'Test Brand',
+        element_call: { url: '', use_exclusively: false },
+    };
+
+    const platform = {
+        getAppVersion: jest.fn().mockResolvedValue(version),
+    } as unknown as BasePlatform;
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        window.electron = false;
+    });
+
+    afterAll(() => {
+        // restore global
+        window.electron = isElectron;
+    });
+
+    it('saves client information without url for electron clients', async () => {
+        window.electron = true;
+
+        await recordClientInformation(
+            mockClient,
+            sdkConfig,
+            platform,
+        );
+
+        expect(mockClient.setAccountData).toHaveBeenCalledWith(
+            `io.element.matrix_client_information.${deviceId}`,
+            {
+                name: sdkConfig.brand,
+                version,
+                url: undefined,
+            },
+        );
+    });
+
+    it('saves client information with url for non-electron clients', async () => {
+        await recordClientInformation(
+            mockClient,
+            sdkConfig,
+            platform,
+        );
+
+        expect(mockClient.setAccountData).toHaveBeenCalledWith(
+            `io.element.matrix_client_information.${deviceId}`,
+            {
+                name: sdkConfig.brand,
+                version,
+                url: 'localhost',
+            },
+        );
+    });
+});