Conform more code to strict null checking (#10153)

* Conform more code to strict null checking

* Conform more code to strict null checking

* Iterate

* Iterate

Author: t3chguy

src/BasePlatform.ts

@@ -193,7 +193,7 @@ export default abstract class BasePlatform {
     public displayNotification(
         title: string,
         msg: string,
-        avatarUrl: string,
+        avatarUrl: string | null,
         room: Room,
         ev?: MatrixEvent,
     ): Notification {

src/Modal.tsx

@@ -33,7 +33,7 @@ export interface IModal<T extends any[]> {
     beforeClosePromise?: Promise<boolean>;
     closeReason?: string;
     onBeforeClose?(reason?: string): Promise<boolean>;
-    onFinished(...args: T): void;
+    onFinished?(...args: T): void;
     close(...args: T): void;
     hidden?: boolean;
 }
@@ -68,11 +68,11 @@ export class ModalManager extends TypedEventEmitter<ModalManagerEvent, HandlerMa
     // The modal to prioritise over all others. If this is set, only show
     // this modal. Remove all other modals from the stack when this modal
     // is closed.
-    private priorityModal: IModal<any> = null;
+    private priorityModal: IModal<any> | null = null;
     // The modal to keep open underneath other modals if possible. Useful
     // for cases like Settings where the modal should remain open while the
     // user is prompted for more information/errors.
-    private staticModal: IModal<any> = null;
+    private staticModal: IModal<any> | null = null;
     // A list of the modals we have stacked up, with the most recent at [0]
     // Neither the static nor priority modal will be in this list.
     private modals: IModal<any>[] = [];
@@ -144,17 +144,14 @@ export class ModalManager extends TypedEventEmitter<ModalManagerEvent, HandlerMa
         closeDialog: IHandle<T>["close"];
         onFinishedProm: IHandle<T>["finished"];
     } {
-        const modal: IModal<T> = {
-            onFinished: props ? props.onFinished : null,
-            onBeforeClose: options.onBeforeClose,
-            beforeClosePromise: null,
-            closeReason: null,
+        const modal = {
+            onFinished: props?.onFinished,
+            onBeforeClose: options?.onBeforeClose,
             className,
 
             // these will be set below but we need an object reference to pass to getCloseFn before we can do that
             elem: null,
-            close: null,
-        };
+        } as IModal<T>;
 
         // never call this from onFinished() otherwise it will loop
         const [closeDialog, onFinishedProm] = this.getCloseFn<T>(modal, props);
@@ -173,7 +170,7 @@ export class ModalManager extends TypedEventEmitter<ModalManagerEvent, HandlerMa
 
     private getCloseFn<T extends any[]>(
         modal: IModal<T>,
-        props: IProps<T>,
+        props?: IProps<T>,
     ): [IHandle<T>["close"], IHandle<T>["finished"]] {
         const deferred = defer<T>();
         return [
@@ -183,13 +180,13 @@ export class ModalManager extends TypedEventEmitter<ModalManagerEvent, HandlerMa
                 } else if (modal.onBeforeClose) {
                     modal.beforeClosePromise = modal.onBeforeClose(modal.closeReason);
                     const shouldClose = await modal.beforeClosePromise;
-                    modal.beforeClosePromise = null;
+                    modal.beforeClosePromise = undefined;
                     if (!shouldClose) {
                         return;
                     }
                 }
                 deferred.resolve(args);
-                if (props && props.onFinished) props.onFinished.apply(null, args);
+                if (props?.onFinished) props.onFinished.apply(null, args);
                 const i = this.modals.indexOf(modal);
                 if (i >= 0) {
                     this.modals.splice(i, 1);
@@ -317,7 +314,7 @@ export class ModalManager extends TypedEventEmitter<ModalManagerEvent, HandlerMa
         // so, pass the reason to close through a member variable
         modal.closeReason = "backgroundClick";
         modal.close();
-        modal.closeReason = null;
+        modal.closeReason = undefined;
     };
 
     private getCurrentModal(): IModal<any> {

src/Notifier.ts

@@ -68,7 +68,7 @@ Override both the content body and the TextForEvent handler for specific msgtype
 This is useful when the content body contains fallback text that would explain that the client can't handle a particular
 type of tile.
 */
-const msgTypeHandlers: Record<string, (event: MatrixEvent) => string> = {
+const msgTypeHandlers: Record<string, (event: MatrixEvent) => string | null> = {
     [MsgType.KeyVerificationRequest]: (event: MatrixEvent) => {
         const name = (event.sender || {}).name;
         return _t("%(name)s is requesting verification", { name });
@@ -156,7 +156,7 @@ class NotifierClass {
             msg = "";
         }
 
-        let avatarUrl = null;
+        let avatarUrl: string | null = null;
         if (ev.sender && !SettingsStore.getValue("lowBandwidth")) {
             avatarUrl = Avatar.avatarUrlForMember(ev.sender, 40, 40, "crop");
         }
@@ -166,8 +166,8 @@ class NotifierClass {
         // if displayNotification returns non-null,  the platform supports
         // clearing notifications later, so keep track of this.
         if (notif) {
-            if (this.notifsByRoom[ev.getRoomId()] === undefined) this.notifsByRoom[ev.getRoomId()] = [];
-            this.notifsByRoom[ev.getRoomId()].push(notif);
+            if (this.notifsByRoom[ev.getRoomId()!] === undefined) this.notifsByRoom[ev.getRoomId()!] = [];
+            this.notifsByRoom[ev.getRoomId()!].push(notif);
         }
     }
 
@@ -219,7 +219,7 @@ class NotifierClass {
                 sound ? `audio[src='${sound.url}']` : "#messageAudio",
             );
             let audioElement = selector;
-            if (!selector) {
+            if (!audioElement) {
                 if (!sound) {
                     logger.error("No audio element or sound to play for notification");
                     return;
@@ -378,11 +378,11 @@ class NotifierClass {
             return global.localStorage.getItem("notifications_hidden") === "true";
         }
 
-        return this.toolbarHidden;
+        return !!this.toolbarHidden;
     }
 
     // XXX: Exported for tests
-    public onSyncStateChange = (state: SyncState, prevState?: SyncState, data?: ISyncStateData): void => {
+    public onSyncStateChange = (state: SyncState, prevState: SyncState | null, data?: ISyncStateData): void => {
         if (state === SyncState.Syncing) {
             this.isSyncing = true;
         } else if (state === SyncState.Stopped || state === SyncState.Error) {
@@ -411,7 +411,7 @@ class NotifierClass {
         // If it's an encrypted event and the type is still 'm.room.encrypted',
         // it hasn't yet been decrypted, so wait until it is.
         if (ev.isBeingDecrypted() || ev.isDecryptionFailure()) {
-            this.pendingEncryptedEventIds.push(ev.getId());
+            this.pendingEncryptedEventIds.push(ev.getId()!);
             // don't let the list fill up indefinitely
             while (this.pendingEncryptedEventIds.length > MAX_PENDING_ENCRYPTED) {
                 this.pendingEncryptedEventIds.shift();
@@ -427,7 +427,7 @@ class NotifierClass {
         // in which case it might decrypt soon if the keys arrive
         if (ev.isDecryptionFailure()) return;
 
-        const idx = this.pendingEncryptedEventIds.indexOf(ev.getId());
+        const idx = this.pendingEncryptedEventIds.indexOf(ev.getId()!);
         if (idx === -1) return;
 
         this.pendingEncryptedEventIds.splice(idx, 1);
@@ -456,7 +456,7 @@ class NotifierClass {
     public evaluateEvent(ev: MatrixEvent): void {
         // Mute notifications for broadcast info events
         if (ev.getType() === VoiceBroadcastInfoEventType) return;
-        let roomId = ev.getRoomId();
+        let roomId = ev.getRoomId()!;
         if (LegacyCallHandler.instance.getSupportsVirtualRooms()) {
             // Attempt to translate a virtual room to a native one
             const nativeRoomId = VoipUserMapper.sharedInstance().nativeRoomForVirtualRoom(roomId);
@@ -492,7 +492,7 @@ class NotifierClass {
                 this.displayPopupNotification(ev, room);
             }
             if (actions.tweaks.sound && this.isAudioEnabled()) {
-                PlatformPeg.get().loudNotification(ev, room);
+                PlatformPeg.get()?.loudNotification(ev, room);
                 this.playAudioNotification(ev, room);
             }
         }
@@ -504,7 +504,7 @@ class NotifierClass {
     private performCustomEventHandling(ev: MatrixEvent): void {
         if (ElementCall.CALL_EVENT_TYPE.names.includes(ev.getType()) && SettingsStore.getValue("feature_group_calls")) {
             ToastStore.sharedInstance().addOrReplaceToast({
-                key: getIncomingCallToastKey(ev.getStateKey()),
+                key: getIncomingCallToastKey(ev.getStateKey()!),
                 priority: 100,
                 component: IncomingCallToast,
                 bodyClassName: "mx_IncomingCallToast",

src/PosthogAnalytics.ts

@@ -238,19 +238,19 @@ export class PosthogAnalytics {
         }
     }
 
-    private static async getPlatformProperties(): Promise<PlatformProperties> {
+    private static async getPlatformProperties(): Promise<Partial<PlatformProperties>> {
         const platform = PlatformPeg.get();
-        let appVersion: string;
+        let appVersion: string | undefined;
         try {
-            appVersion = await platform.getAppVersion();
+            appVersion = await platform?.getAppVersion();
         } catch (e) {
             // this happens if no version is set i.e. in dev
             appVersion = "unknown";
         }
 
         return {
             appVersion,
-            appPlatform: platform.getHumanReadableName(),
+            appPlatform: platform?.getHumanReadableName(),
         };
     }
 
@@ -411,7 +411,7 @@ export class PosthogAnalytics {
         // All other scenarios should not track a user before they have given
         // explicit consent that they are ok with their analytics data being collected
         const options: IPostHogEventOptions = {};
-        const registrationTime = parseInt(window.localStorage.getItem("mx_registration_time"), 10);
+        const registrationTime = parseInt(window.localStorage.getItem("mx_registration_time")!, 10);
         if (!isNaN(registrationTime)) {
             options.timestamp = new Date(registrationTime);
         }

src/RoomInvite.tsx

@@ -142,7 +142,7 @@ export function showAnyInviteErrors(
         });
         return false;
     } else {
-        const errorList = [];
+        const errorList: string[] = [];
         for (const addr of failedUsers) {
             if (states[addr] === "error") {
                 const reason = inviter.getErrorText(addr);
@@ -173,8 +173,11 @@ export function showAnyInviteErrors(
                                 <div key={addr} className="mx_InviteDialog_tile mx_InviteDialog_tile--inviterError">
                                     <div className="mx_InviteDialog_tile_avatarStack">
                                         <BaseAvatar
-                                            url={avatarUrl ? mediaFromMxc(avatarUrl).getSquareThumbnailHttp(24) : null}
-                                            name={name}
+                                            url={
+                                                (avatarUrl && mediaFromMxc(avatarUrl).getSquareThumbnailHttp(24)) ??
+                                                undefined
+                                            }
+                                            name={name!}
                                             idName={user?.userId}
                                             width={36}
                                             height={36}

src/ScalarAuthClient.ts

@@ -32,8 +32,8 @@ const imApiVersion = "1.1";
 // TODO: Generify the name of this class and all components within - it's not just for Scalar.
 
 export default class ScalarAuthClient {
-    private scalarToken: string;
-    private termsInteractionCallback: TermsInteractionCallback;
+    private scalarToken: string | null;
+    private termsInteractionCallback?: TermsInteractionCallback;
     private isDefaultManager: boolean;
 
     public constructor(private apiUrl: string, private uiUrl: string) {
@@ -59,15 +59,15 @@ export default class ScalarAuthClient {
         }
     }
 
-    private readTokenFromStore(): string {
+    private readTokenFromStore(): string | null {
         let token = window.localStorage.getItem("mx_scalar_token_at_" + this.apiUrl);
         if (!token && this.isDefaultManager) {
             token = window.localStorage.getItem("mx_scalar_token");
         }
         return token;
     }
 
-    private readToken(): string {
+    private readToken(): string | null {
         if (this.scalarToken) return this.scalarToken;
         return this.readTokenFromStore();
     }

src/ScalarMessaging.ts

@@ -358,7 +358,7 @@ function inviteUser(event: MessageEvent<any>, roomId: string, userId: string): v
     if (room) {
         // if they are already invited or joined we can resolve immediately.
         const member = room.getMember(userId);
-        if (member && ["join", "invite"].includes(member.membership)) {
+        if (member && ["join", "invite"].includes(member.membership!)) {
             sendResponse(event, {
                 success: true,
             });
@@ -389,7 +389,7 @@ function kickUser(event: MessageEvent<any>, roomId: string, userId: string): voi
     if (room) {
         // if they are already not in the room we can resolve immediately.
         const member = room.getMember(userId);
-        if (!member || getEffectiveMembership(member.membership) === EffectiveMembership.Leave) {
+        if (!member || getEffectiveMembership(member.membership!) === EffectiveMembership.Leave) {
             sendResponse(event, {
                 success: true,
             });
@@ -472,7 +472,7 @@ function setWidget(event: MessageEvent<any>, roomId: string | null): void {
     } else {
         // Room widget
         if (!roomId) {
-            sendError(event, _t("Missing roomId."), null);
+            sendError(event, _t("Missing roomId."));
             return;
         }
         WidgetUtils.setRoomWidget(
@@ -675,7 +675,7 @@ function canSendEvent(event: MessageEvent<any>, roomId: string): void {
         sendError(event, _t("You are not in this room."));
         return;
     }
-    const me = client.credentials.userId;
+    const me = client.credentials.userId!;
 
     let canSend = false;
     if (isState) {