Merge pull request #5349 from 50Wliu/users/winstonliu/observers-nullability

Observer nullability fixes

Author: JoeRobich

src/observers/BackgroundWorkStatusBarObserver.ts

@@ -15,12 +15,11 @@ export class BackgroundWorkStatusBarObserver extends BaseStatusBarItemObserver {
 
             if (asProjectEvent.message.Status === DiagnosticStatus.Processing) {
                 let projectFile = asProjectEvent.message.ProjectFilePath.replace(/^.*[\\\/]/, '');
-                this.SetAndShowStatusBar(`$(sync~spin) Analyzing ${projectFile}`, 'o.showOutput', null, `Analyzing ${projectFile}`);
+                this.SetAndShowStatusBar(`$(sync~spin) Analyzing ${projectFile}`, 'o.showOutput', undefined, `Analyzing ${projectFile}`);
             }
             else {
                 this.ResetAndHideStatusBar();
             }
         }
     }
 }
-

src/observers/BaseStatusBarItemObserver.ts

@@ -20,12 +20,12 @@ export abstract class BaseStatusBarItemObserver {
     }
 
     public ResetAndHideStatusBar() {
-        this.statusBarItem.text = undefined;
+        this.statusBarItem.text = '';
         this.statusBarItem.command = undefined;
         this.statusBarItem.color = undefined;
         this.statusBarItem.tooltip = undefined;
         this.statusBarItem.hide();
     }
 
     abstract post: (event: BaseEvent) => void;
-}
+}

src/observers/CsharpLoggerObserver.ts

@@ -9,7 +9,7 @@ import { PackageError } from "../packageManager/PackageError";
 import { EventType } from "../omnisharp/EventType";
 
 export class CsharpLoggerObserver extends BaseLoggerObserver {
-    private dots: number;
+    private dots: number = 0;
 
     public post = (event: Event.BaseEvent) => {
         switch (event.type) {
@@ -146,4 +146,4 @@ export class CsharpLoggerObserver extends BaseLoggerObserver {
     private handleDocumentSynchronizationFailure(event: Event.DocumentSynchronizationFailure) {
         this.logger.appendLine(`Failed to synchronize document '${event.documentPath}': ${event.errorMessage}`);
     }
-}
+}

src/observers/OmnisharpLoggerObserver.ts

@@ -83,7 +83,7 @@ export class OmnisharpLoggerObserver extends BaseLoggerObserver {
         this.logger.append(`OmniSharp server started`);
         if (event.hostVersion) {
             this.logger.append(` with ${event.hostIsMono ? 'Mono' : '.NET'} ${event.hostVersion}`);
-            if (event.hostPath?.length > 0) {
+            if (event.hostPath && event.hostPath.length > 0) {
                 this.logger.append(` (${event.hostPath})`);
             }
         }

src/observers/OptionProvider.ts

@@ -6,7 +6,7 @@
 import { Options } from "../omnisharp/options";
 import { Subscription, Observable } from "rxjs";
 export default class OptionProvider {
-    private options: Options;
+    private options?: Options;
     private subscription: Subscription;
 
     constructor(optionObservable: Observable<Options>) {
@@ -24,4 +24,4 @@ export default class OptionProvider {
     public dispose = () => {
         this.subscription.unsubscribe();
     }
-}
+}

src/observers/TelemetryObserver.ts

@@ -19,8 +19,8 @@ export interface ITelemetryReporter {
 export class TelemetryObserver {
     private reporter: ITelemetryReporter;
     private platformInfo: PlatformInformation;
-    private solutionId: string;
-    private dotnetInfo: DotnetInfo;
+    private solutionId?: string;
+    private dotnetInfo?: DotnetInfo;
 
     constructor(platformInfo: PlatformInformation, reporterCreator: () => ITelemetryReporter) {
         this.platformInfo = platformInfo;
@@ -64,7 +64,7 @@ export class TelemetryObserver {
     }
 
     private handleTelemetryEventMeasures(event: TelemetryEventWithMeasures) {
-        this.reporter.sendTelemetryEvent(event.eventName, null, event.measures);
+        this.reporter.sendTelemetryEvent(event.eventName, undefined, event.measures);
     }
 
     private async handleOmnisharpInitialisation(event: OmnisharpInitialisation) {
@@ -90,16 +90,16 @@ export class TelemetryObserver {
 
     private handleTestExecutionCountReport(event: TestExecutionCountReport) {
         if (event.debugCounts) {
-            this.reporter.sendTelemetryEvent('DebugTest', null, event.debugCounts);
+            this.reporter.sendTelemetryEvent('DebugTest', undefined, event.debugCounts);
         }
         if (event.runCounts) {
-            this.reporter.sendTelemetryEvent('RunTest', null, event.runCounts);
+            this.reporter.sendTelemetryEvent('RunTest', undefined, event.runCounts);
         }
     }
 
     private handleProjectConfigurationReceived(event: ProjectConfiguration, telemetryProps: { [key: string]: string }) {
         let projectConfig = event.projectConfiguration;
-        telemetryProps['SolutionId'] = this.solutionId;
+        telemetryProps['SolutionId'] = this.solutionId ?? "";
         telemetryProps['ProjectId'] = projectConfig.ProjectId;
         telemetryProps['SessionId'] = projectConfig.SessionId;
         telemetryProps['OutputType'] = projectConfig.OutputKind?.toString() ?? "";

src/observers/utils/ShowInformationMessage.ts

@@ -8,12 +8,12 @@ import MessageItemWithCommand from "./MessageItemWithCommand";
 
 export default async function showInformationMessage(vscode: vscode, message: string, ...items: MessageItemWithCommand[]) {
     try {
-        let value = await vscode.window.showInformationMessage<MessageItemWithCommand>(message, ...items);
-        if (value && value.command) {
+        const value = await vscode.window.showInformationMessage<MessageItemWithCommand>(message, ...items);
+        if (value?.command) {
             vscode.commands.executeCommand(value.command);
         }
     }
     catch (err) {
         console.log(err);
     }
-}
+}

src/observers/utils/ShowWarningMessage.ts

@@ -8,12 +8,12 @@ import MessageItemWithCommand from "./MessageItemWithCommand";
 
 export default async function showWarningMessage(vscode: vscode, message: string, ...items: MessageItemWithCommand[]) {
     try {
-        let value = await vscode.window.showWarningMessage<MessageItemWithCommand>(message, ...items);
-        if (value && value.command) {
+        const value = await vscode.window.showWarningMessage<MessageItemWithCommand>(message, ...items);
+        if (value?.command) {
             await vscode.commands.executeCommand<string>(value.command);
         }
     }
     catch (err) {
         console.log(err);
     }
-}
+}

test/unitTests/logging/BackgroundWorkStatusBarObserver.test.ts

@@ -38,6 +38,6 @@ suite('BackgroundWorkStatusBarObserver', () => {
         observer.post(event);
         expect(hideCalled).to.be.true;
         expect(showCalled).to.be.false;
-        expect(statusBarItem.text).to.be.undefined;
+        expect(statusBarItem.text).to.be.equal('');
     });
-});
+});

test/unitTests/logging/OmnisharpStatusBarObserver.test.ts

@@ -14,7 +14,7 @@ suite('OmnisharpStatusBarObserver', () => {
     let hideCalled: boolean;
 
     setup(() => {
-        statusBarItem.text = undefined;
+        statusBarItem.text = '';
         statusBarItem.color = undefined;
         statusBarItem.command = undefined;
         statusBarItem.tooltip = undefined;
@@ -84,7 +84,7 @@ suite('OmnisharpStatusBarObserver', () => {
         let event = new OmnisharpServerOnStop();
         observer.post(event);
         expect(hideCalled).to.be.true;
-        expect(statusBarItem.text).to.be.undefined;
+        expect(statusBarItem.text).to.be.equal('');
         expect(statusBarItem.command).to.be.undefined;
         expect(statusBarItem.color).to.be.undefined;
     });
@@ -118,8 +118,8 @@ suite('OmnisharpStatusBarObserver', () => {
         observer.post(successEvent);
 
         expect(hideCalled).to.be.true;
-        expect(statusBarItem.text).to.be.undefined;
+        expect(statusBarItem.text).to.be.equal('');
         expect(statusBarItem.command).to.be.undefined;
         expect(statusBarItem.color).to.be.undefined;
     });
-});
+});