Iterate typing to work towards noImplicitAny (#2061)

Author: t3chguy

spec/unit/models/MSC3089Branch.spec.ts

@@ -312,7 +312,7 @@ describe("MSC3089Branch", () => {
         } as MatrixEvent);
 
         const events = [await branch.getFileEvent(), await branch2.getFileEvent(), {
-            replacingEventId: () => null,
+            replacingEventId: (): string => null,
             getId: () => "$unknown",
         }];
         staticRoom.getLiveTimeline = () => ({ getEvents: () => events }) as EventTimeline;

src/@types/global.d.ts

@@ -62,12 +62,6 @@ declare global {
         };
     }
 
-    interface HTMLAudioElement {
-        // sinkId & setSinkId are experimental and typescript doesn't know about them
-        sinkId: string;
-        setSinkId(outputId: string);
-    }
-
     interface DummyInterfaceWeShouldntBeUsingThis {}
 
     interface Navigator {

src/client.ts

@@ -621,7 +621,7 @@ export interface IMyDevice {
     last_seen_ts?: number;
 }
 
-interface IDownloadKeyResult {
+export interface IDownloadKeyResult {
     failures: { [serverName: string]: object };
     device_keys: {
         [userId: string]: {
@@ -632,13 +632,42 @@ interface IDownloadKeyResult {
             };
         };
     };
+    // the following three fields were added in 1.1
+    master_keys?: {
+        [userId: string]: {
+            keys: { [keyId: string]: string };
+            usage: string[];
+            user_id: string;
+        };
+    };
+    self_signing_keys?: {
+        [userId: string]: {
+            keys: { [keyId: string]: string };
+            signatures: ISignatures;
+            usage: string[];
+            user_id: string;
+        };
+    };
+    user_signing_keys?: {
+        [userId: string]: {
+            keys: { [keyId: string]: string };
+            signatures: ISignatures;
+            usage: string[];
+            user_id: string;
+        };
+    };
 }
 
-interface IClaimOTKsResult {
+export interface IClaimOTKsResult {
     failures: { [serverName: string]: object };
     one_time_keys: {
         [userId: string]: {
-            [deviceId: string]: string;
+            [deviceId: string]: {
+                [keyId: string]: {
+                    key: string;
+                    signatures: ISignatures;
+                };
+            };
         };
     };
 }
@@ -1421,14 +1450,12 @@ export class MatrixClient extends EventEmitter {
             }
         }
 
-        // We swallow errors because we need a default object anyhow
         return this.http.authedRequest(
             undefined, "GET", "/capabilities",
-        ).catch((e: Error) => {
+        ).catch((e: Error): void => {
+            // We swallow errors because we need a default object anyhow
             logger.error(e);
-            return null; // otherwise consume the error
-        }).then((r) => {
-            if (!r) r = {};
+        }).then((r: { capabilities?: ICapabilities } = {}) => {
             const capabilities: ICapabilities = r["capabilities"] || {};
 
             // If the capabilities missed the cache, cache it for a shorter amount
@@ -2836,7 +2863,7 @@ export class MatrixClient extends EventEmitter {
         }
 
         let totalKeyCount = 0;
-        let keys = [];
+        let keys: IMegolmSessionData[] = [];
 
         const path = this.makeKeyBackupPath(targetRoomId, targetSessionId, backupInfo.version);
 
@@ -5692,18 +5719,14 @@ export class MatrixClient extends EventEmitter {
         searchResults.count = roomEvents.count;
         searchResults.next_batch = roomEvents.next_batch;
 
-        // combine the highlight list with our existing list; build an object
-        // to avoid O(N^2) fail
-        const highlights = {};
-        roomEvents.highlights.forEach((hl) => {
-            highlights[hl] = 1;
-        });
+        // combine the highlight list with our existing list;
+        const highlights = new Set<string>(roomEvents.highlights);
         searchResults.highlights.forEach((hl) => {
-            highlights[hl] = 1;
+            highlights.add(hl);
         });
 
         // turn it back into a list.
-        searchResults.highlights = Object.keys(highlights);
+        searchResults.highlights = Array.from(highlights);
 
         // append the new results to our existing results
         const resultsLength = roomEvents.results ? roomEvents.results.length : 0;
@@ -5794,11 +5817,9 @@ export class MatrixClient extends EventEmitter {
 
         return this.http.authedRequest(
             undefined, "GET", path, undefined, undefined,
-        ).then((response) => {
+        ).then((response: IFilterDefinition) => {
             // persist the filter
-            const filter = Filter.fromJson(
-                userId, filterId, response,
-            );
+            const filter = Filter.fromJson(userId, filterId, response);
             this.store.storeFilter(filter);
             return filter;
         });
@@ -6096,7 +6117,7 @@ export class MatrixClient extends EventEmitter {
             {
                 prefix: '',
             },
-        ).catch((e) => {
+        ).catch((e: Error) => {
             // Need to unset this if it fails, otherwise we'll never retry
             this.serverVersionsPromise = null;
             // but rethrow the exception to anything that was waiting
@@ -6420,7 +6441,7 @@ export class MatrixClient extends EventEmitter {
     public isUsernameAvailable(username: string): Promise<true> {
         return this.http.authedRequest(
             undefined, "GET", '/register/available', { username: username },
-        ).then((response) => {
+        ).then((response: { available: boolean }) => {
             return response.available;
         });
     }
@@ -7741,11 +7762,11 @@ export class MatrixClient extends EventEmitter {
      *     an error response ({@link module:http-api.MatrixError}).
      */
     public claimOneTimeKeys(
-        devices: string[],
+        devices: [string, string][],
         keyAlgorithm = "signed_curve25519",
         timeout?: number,
     ): Promise<IClaimOTKsResult> {
-        const queries = {};
+        const queries: Record<string, Record<string, string>> = {};
 
         if (keyAlgorithm === undefined) {
             keyAlgorithm = "signed_curve25519";

src/crypto/CrossSigning.ts

@@ -33,6 +33,7 @@ import { OlmDevice } from "./OlmDevice";
 import { ICryptoCallbacks } from "../matrix";
 import { ISignatures } from "../@types/signed";
 import { CryptoStore } from "./store/base";
+import { ISecretStorageKeyInfo } from "./api";
 
 const KEY_REQUEST_TIMEOUT_MS = 1000 * 60;
 
@@ -175,7 +176,7 @@ export class CrossSigningInfo extends EventEmitter {
         // check what SSSS keys have encrypted the master key (if any)
         const stored = await secretStorage.isStored("m.cross_signing.master", false) || {};
         // then check which of those SSSS keys have also encrypted the SSK and USK
-        function intersect(s) {
+        function intersect(s: Record<string, ISecretStorageKeyInfo>) {
             for (const k of Object.keys(stored)) {
                 if (!s[k]) {
                     delete stored[k];

src/crypto/DeviceList.ts

@@ -28,7 +28,7 @@ import { CrossSigningInfo, ICrossSigningInfo } from './CrossSigning';
 import * as olmlib from './olmlib';
 import { IndexedDBCryptoStore } from './store/indexeddb-crypto-store';
 import { chunkPromises, defer, IDeferred, sleep } from '../utils';
-import { MatrixClient } from "../client";
+import { IDownloadKeyResult, MatrixClient } from "../client";
 import { OlmDevice } from "./OlmDevice";
 import { CryptoStore } from "./store/base";
 
@@ -756,17 +756,21 @@ class DeviceListUpdateSerialiser {
             opts.token = this.syncToken;
         }
 
-        const factories = [];
+        const factories: Array<() => Promise<IDownloadKeyResult>> = [];
         for (let i = 0; i < downloadUsers.length; i += this.deviceList.keyDownloadChunkSize) {
             const userSlice = downloadUsers.slice(i, i + this.deviceList.keyDownloadChunkSize);
             factories.push(() => this.baseApis.downloadKeysForUsers(userSlice, opts));
         }
 
-        chunkPromises(factories, 3).then(async (responses: any[]) => {
-            const dk = Object.assign({}, ...(responses.map(res => res.device_keys || {})));
-            const masterKeys = Object.assign({}, ...(responses.map(res => res.master_keys || {})));
-            const ssks = Object.assign({}, ...(responses.map(res => res.self_signing_keys || {})));
-            const usks = Object.assign({}, ...(responses.map(res => res.user_signing_keys || {})));
+        chunkPromises(factories, 3).then(async (responses: IDownloadKeyResult[]) => {
+            const dk: IDownloadKeyResult["device_keys"]
+                = Object.assign({}, ...(responses.map(res => res.device_keys || {})));
+            const masterKeys: IDownloadKeyResult["master_keys"]
+                = Object.assign({}, ...(responses.map(res => res.master_keys || {})));
+            const ssks: IDownloadKeyResult["self_signing_keys"]
+                = Object.assign({}, ...(responses.map(res => res.self_signing_keys || {})));
+            const usks: IDownloadKeyResult["user_signing_keys"]
+                = Object.assign({}, ...(responses.map(res => res.user_signing_keys || {})));
 
             // yield to other things that want to execute in between users, to
             // avoid wedging the CPU
@@ -811,8 +815,12 @@ class DeviceListUpdateSerialiser {
 
     private async processQueryResponseForUser(
         userId: string,
-        dkResponse: object,
-        crossSigningResponse: any, // TODO types
+        dkResponse: IDownloadKeyResult["device_keys"]["user_id"],
+        crossSigningResponse: {
+            master: IDownloadKeyResult["master_keys"]["user_id"];
+            self_signing: IDownloadKeyResult["master_keys"]["user_id"]; // eslint-disable-line camelcase
+            user_signing: IDownloadKeyResult["user_signing_keys"]["user_id"]; // eslint-disable-line camelcase
+        },
     ): Promise<void> {
         logger.log('got device keys for ' + userId + ':', dkResponse);
         logger.log('got cross-signing keys for ' + userId + ':', crossSigningResponse);
@@ -869,7 +877,7 @@ async function updateStoredDeviceKeysForUser(
     olmDevice: OlmDevice,
     userId: string,
     userStore: Record<string, DeviceInfo>,
-    userResult: object,
+    userResult: IDownloadKeyResult["device_keys"]["user_id"],
     localUserId: string,
     localDeviceId: string,
 ): Promise<boolean> {

src/crypto/backup.ts

@@ -33,6 +33,7 @@ import { encryptAES, decryptAES, calculateKeyCheck } from './aes';
 import { getCrypto } from '../utils';
 import { ICurve25519AuthData, IAes256AuthData, IKeyBackupInfo, IKeyBackupSession } from "./keybackup";
 import { UnstableValue } from "../NamespacedValue";
+import { IMegolmSessionData } from "./index";
 
 const KEY_BACKUP_KEYS_PER_REQUEST = 200;
 
@@ -87,7 +88,7 @@ interface BackupAlgorithmClass {
 interface BackupAlgorithm {
     untrusted: boolean;
     encryptSession(data: Record<string, any>): Promise<any>;
-    decryptSessions(ciphertexts: Record<string, IKeyBackupSession>): Promise<Record<string, any>[]>;
+    decryptSessions(ciphertexts: Record<string, IKeyBackupSession>): Promise<IMegolmSessionData[]>;
     authData: AuthData;
     keyMatches(key: ArrayLike<number>): Promise<boolean>;
     free(): void;
@@ -300,7 +301,7 @@ export class BackupManager {
         const ret = {
             usable: false,
             trusted_locally: false,
-            sigs: [],
+            sigs: [] as SigInfo[],
         };
 
         if (
@@ -320,7 +321,7 @@ export class BackupManager {
             ret.trusted_locally = true;
         }
 
-        const mySigs = backupInfo.auth_data.signatures[this.baseApis.getUserId()] || [];
+        const mySigs = backupInfo.auth_data.signatures[this.baseApis.getUserId()] || {};
 
         for (const keyId of Object.keys(mySigs)) {
             const keyIdParts = keyId.split(':');
@@ -645,9 +646,7 @@ export class Curve25519 implements BackupAlgorithm {
         return this.publicKey.encrypt(JSON.stringify(plainText));
     }
 
-    public async decryptSessions(
-        sessions: Record<string, IKeyBackupSession>,
-    ): Promise<Record<string, any>[]> {
+    public async decryptSessions(sessions: Record<string, IKeyBackupSession>): Promise<IMegolmSessionData[]> {
         const privKey = await this.getKey();
         const decryption = new global.Olm.PkDecryption();
         try {
@@ -658,7 +657,7 @@ export class Curve25519 implements BackupAlgorithm {
                 throw { errcode: MatrixClient.RESTORE_BACKUP_ERROR_BAD_KEY };
             }
 
-            const keys = [];
+            const keys: IMegolmSessionData[] = [];
 
             for (const [sessionId, sessionData] of Object.entries(sessions)) {
                 try {
@@ -777,8 +776,8 @@ export class Aes256 implements BackupAlgorithm {
         return await encryptAES(JSON.stringify(plainText), this.key, data.session_id);
     }
 
-    async decryptSessions(sessions: Record<string, IKeyBackupSession>): Promise<Record<string, any>[]> {
-        const keys = [];
+    async decryptSessions(sessions: Record<string, IKeyBackupSession>): Promise<IMegolmSessionData[]> {
+        const keys: IMegolmSessionData[] = [];
 
         for (const [sessionId, sessionData] of Object.entries(sessions)) {
             try {

src/crypto/dehydration.ts

@@ -22,9 +22,7 @@ import { decryptAES, encryptAES } from './aes';
 import { logger } from '../logger';
 import { ISecretStorageKeyInfo } from "./api";
 import { Crypto } from "./index";
-
-// FIXME: these types should eventually go in a different file
-type Signatures = Record<string, Record<string, string>>;
+import { ISignatures } from "../@types/signed";
 
 export interface IDehydratedDevice {
     device_id: string; // eslint-disable-line camelcase
@@ -43,13 +41,13 @@ export interface IDeviceKeys {
     device_id: string; // eslint-disable-line camelcase
     user_id: string; // eslint-disable-line camelcase
     keys: Record<string, string>;
-    signatures?: Signatures;
+    signatures?: ISignatures;
 }
 
 export interface IOneTimeKey {
     key: string;
     fallback?: boolean;
-    signatures?: Signatures;
+    signatures?: ISignatures;
 }
 
 export const DEHYDRATION_ALGORITHM = "org.matrix.msc2697.v1.olm.libolm_pickle";
@@ -244,7 +242,7 @@ export class DehydrationManager {
             }
 
             logger.log("Preparing one-time keys");
-            const oneTimeKeys = {};
+            const oneTimeKeys: Record<string, IOneTimeKey> = {};
             for (const [keyId, key] of Object.entries(otks.curve25519)) {
                 const k: IOneTimeKey = { key };
                 const signature = account.sign(anotherjson.stringify(k));