compile with strict mode

Author: niemyjski

.vscode/settings.json

@@ -24,6 +24,7 @@
     "eslintignore",
     "jsdelivr",
     "lage",
+    "localstorage",
     "maxcdn",
     "ncaught",
     "npmrc",

package-lock.json

@@ -28,16 +28,16 @@
     "example/*"
   ],
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "4.25.0",
-    "@typescript-eslint/parser": "4.25.0",
+    "@typescript-eslint/eslint-plugin": "4.26.0",
+    "@typescript-eslint/parser": "4.26.0",
     "eslint": "7.27.0",
     "eslint-plugin-eslint-comments": "3.2.0",
     "eslint-plugin-eslint-plugin": "3.0.3",
-    "eslint-plugin-import": "2.23.3",
+    "eslint-plugin-import": "2.23.4",
     "eslint-plugin-jest": "24.3.6",
-    "eslint-plugin-jsdoc": "35.0.0",
+    "eslint-plugin-jsdoc": "35.1.2",
     "lage": "^0.29.3",
     "rimraf": "3.0.2",
-    "typescript": "4.2.4"
+    "typescript": "4.3.2"
   }
 }

package.json

@@ -2,7 +2,8 @@
   "extends": "../../tsconfig.json",
   "compilerOptions": {
     "outDir": "dist",
-    "rootDir": "src"
+    "rootDir": "src",
+    "strict": false
   },
   "include": ["src"],
   "types": ["angular", "angular-mock"]

packages/angularjs/tsconfig.json

@@ -24,7 +24,7 @@ export class BrowserErrorPlugin implements IEventPlugin {
     if (exception) {
       context.event.type = "error";
 
-      if (!context.event.data[KnownEventDataKeys.Error]) {
+      if (context.event.data && !context.event.data[KnownEventDataKeys.Error]) {
         const result = await this.parse(exception);
         if (result) {
           const exclusions = context.client.config.dataExclusions.concat(IgnoredErrorProperties);

packages/browser/src/plugins/BrowserErrorPlugin.ts

@@ -10,7 +10,7 @@ export class BrowserGlobalHandlerPlugin implements IEventPlugin {
   public priority: number = 100;
   public name: string = "BrowserGlobalHandlerPlugin";
 
-  private _client: ExceptionlessClient = null;
+  private _client: ExceptionlessClient | undefined;
 
   public startup(context: PluginContext): Promise<void> {
     if (this._client) {
@@ -21,7 +21,7 @@ export class BrowserGlobalHandlerPlugin implements IEventPlugin {
 
     // TODO: Discus if we want to unwire this handler in suspend?
     window.addEventListener("error", event => {
-      void this._client.submitUnhandledException(this.getError(event), "onerror");
+      void this._client?.submitUnhandledException(this.getError(event), "onerror");
     });
 
     window.addEventListener("unhandledrejection", event => {
@@ -35,18 +35,18 @@ export class BrowserGlobalHandlerPlugin implements IEventPlugin {
         // eslint-disable-next-line no-empty
       } catch (ex) { }
 
-      void this._client.submitUnhandledException(error, "onunhandledrejection");
+      void this._client?.submitUnhandledException(error, "onunhandledrejection");
     });
 
 
     if (typeof $ !== "undefined" && $(document)) {
       $(document).ajaxError((event: Event, xhr: { responseText: string, status: number }, settings: { data: unknown, url: string }, error: string) => {
         if (xhr.status === 404) {
           // TODO: Handle async
-          void this._client.submitNotFound(settings.url);
+          void this._client?.submitNotFound(settings.url);
         } else if (xhr.status !== 401) {
           // TODO: Handle async
-          void this._client.createUnhandledException(new Error(error), "JQuery.ajaxError")
+          void this._client?.createUnhandledException(new Error(error), "JQuery.ajaxError")
             .setSource(settings.url)
             .setProperty("status", xhr.status)
             .setProperty("request", settings.data)
@@ -69,12 +69,15 @@ export class BrowserGlobalHandlerPlugin implements IEventPlugin {
     let msg: string = message || event.error;
     if (msg) {
       const errorNameRegex: RegExp = /^(?:[Uu]ncaught (?:exception: )?)?(?:((?:Aggregate|Eval|Internal|Range|Reference|Syntax|Type|URI|)Error): )?(.*)$/i;
-      const [_, errorName, errorMessage] = errorNameRegex.exec(msg);
-      if (errorName) {
-        name = errorName;
-      }
-      if (errorMessage) {
-        msg = errorMessage;
+      const regexResult = errorNameRegex.exec(msg);
+      if (regexResult) {
+        const [_, errorName, errorMessage] = regexResult;
+        if (errorName) {
+          name = errorName;
+        }
+        if (errorMessage) {
+          msg = errorMessage;
+        }
       }
     }
 

packages/browser/src/plugins/BrowserGlobalHandlerPlugin.ts

@@ -8,7 +8,7 @@ export class BrowserLifeCyclePlugin implements IEventPlugin {
   public priority: number = 105;
   public name: string = "BrowserLifeCyclePlugin";
 
-  private _client: ExceptionlessClient = null;
+  private _client: ExceptionlessClient | undefined;
 
   public startup(context: PluginContext): Promise<void> {
     if (this._client) {
@@ -17,12 +17,12 @@ export class BrowserLifeCyclePlugin implements IEventPlugin {
 
     this._client = context.client;
 
-    globalThis.addEventListener("beforeunload", () => void this._client.suspend());
+    globalThis.addEventListener("beforeunload", () => void this._client?.suspend());
     document.addEventListener("visibilitychange", () => {
       if (document.visibilityState === 'visible') {
-        void this._client.startup()
+        void this._client?.startup()
       } else {
-        void this._client.suspend()
+        void this._client?.suspend()
       }
     });
 

packages/browser/src/plugins/BrowserLifeCyclePlugin.ts

@@ -11,7 +11,7 @@ import {
 export class BrowserModuleInfoPlugin implements IEventPlugin {
   public priority: number = 50;
   public name: string = "BrowserModuleInfoPlugin";
-  private _modules: ModuleInfo[] = null;
+  private _modules: ModuleInfo[] | undefined;
 
   public startup(context: PluginContext): Promise<void> {
     if (!this._modules) {
@@ -22,17 +22,17 @@ export class BrowserModuleInfoPlugin implements IEventPlugin {
   }
 
   public run(context: EventPluginContext): Promise<void> {
-    const error = context.event.data[KnownEventDataKeys.Error];
-    if (this._modules?.length > 0 && !error?.modules) {
+    const error = context.event.data?.[KnownEventDataKeys.Error];
+    if (error && !error?.modules && this._modules?.length) {
       error.modules = this._modules;
     }
 
     return Promise.resolve();
   }
 
-  private getModules(): ModuleInfo[] {
+  private getModules(): ModuleInfo[] | undefined {
     if (!document || !document.getElementsByTagName) {
-      return null;
+      return;
     }
 
     const modules: ModuleInfo[] = [];
@@ -44,7 +44,7 @@ export class BrowserModuleInfoPlugin implements IEventPlugin {
           modules.push({
             module_id: index,
             name: scripts[index].src.split("?")[0],
-            version: parseVersion(scripts[index].src),
+            version: <string>parseVersion(scripts[index].src),
           });
         } else if (scripts[index].innerHTML) {
           modules.push({

packages/browser/src/plugins/BrowserModuleInfoPlugin.ts

@@ -13,8 +13,8 @@ export class BrowserRequestInfoPlugin implements IEventPlugin {
   public name: string = "BrowserRequestInfoPlugin";
 
   public run(context: EventPluginContext): Promise<void> {
-    if (!context.event.data[KnownEventDataKeys.RequestInfo]) {
-      const requestInfo: RequestInfo = this.getRequestInfo(context);
+    if (context.event.data && !context.event.data[KnownEventDataKeys.RequestInfo]) {
+      const requestInfo: RequestInfo | undefined = this.getRequestInfo(context);
       if (requestInfo) {
         if (isMatch(requestInfo.user_agent, context.client.config.userAgentBotPatterns)) {
           context.log.info("Cancelling event as the request user agent matches a known bot pattern");
@@ -28,9 +28,9 @@ export class BrowserRequestInfoPlugin implements IEventPlugin {
     return Promise.resolve();
   }
 
-  private getRequestInfo(context: EventPluginContext): RequestInfo {
+  private getRequestInfo(context: EventPluginContext): RequestInfo | undefined {
     if (!document || !navigator || !location) {
-      return null;
+      return;
     }
 
     const config = context.client.config;
@@ -47,7 +47,7 @@ export class BrowserRequestInfoPlugin implements IEventPlugin {
     };
 
     if (config.includeCookies) {
-      requestInfo.cookies = getCookies(document.cookie, exclusions);
+      requestInfo.cookies = getCookies(document.cookie, exclusions) as Record<string, string>;
     }
 
     if (config.includeQueryString) {

packages/browser/src/plugins/BrowserRequestInfoPlugin.ts

@@ -8,7 +8,7 @@ export class BrowserWrapFunctions implements IEventPlugin {
   public priority: number = 110;
   public name: string = "BrowserWrapFunctions";
 
-  private _client: ExceptionlessClient = null;
+  private _client: ExceptionlessClient | undefined;
 
   public startup(context: PluginContext): Promise<void> {
     if (this._client) {

packages/browser/src/plugins/BrowserWrapFunctions.ts

@@ -2,13 +2,13 @@
 import {
   ErrorInfo,
   Event,
+  EventContext,
   EventPluginContext,
   ExceptionlessClient,
   KnownEventDataKeys
 } from "@exceptionless/core";
 
 import { CapturedExceptions } from "./../../../core/test/plugins/default/exceptions.js";
-
 import { BrowserErrorPlugin } from "../../src/plugins/BrowserErrorPlugin.js";
 
 function BaseTestError() {
@@ -30,19 +30,20 @@ describe("BrowserErrorPlugin", () => {
 
   beforeEach(() => {
     plugin.parse = (exception: Error): Promise<ErrorInfo> => {
-      return Promise.resolve({
+      return Promise.resolve(<ErrorInfo>{
         type: exception.name,
         message: exception.message,
-        stack_trace: null
-      })
+        stack_trace: undefined,
+        modules: undefined
+      });
     };
 
     const client: ExceptionlessClient = new ExceptionlessClient();
     const event: Event = {
       data: {}
     };
 
-    context = new EventPluginContext(client, event);
+    context = new EventPluginContext(client, event, new EventContext());
   });
 
   function processError(error: Error | string | unknown): Promise<void> {
@@ -68,22 +69,22 @@ describe("BrowserErrorPlugin", () => {
       await processError(error);
       const additionalData = getAdditionalData(context.event);
       expect(additionalData).not.toBeNull();
-      expect(additionalData.someProperty).toBe("Test");
+      expect(additionalData?.someProperty).toBe("Test");
     });
 
     test("should support custom exception types", async () => {
       await processError(new BaseTestError());
       const additionalData = getAdditionalData(context.event);
       expect(additionalData).not.toBeNull();
-      expect(additionalData.someProperty).toBe("Test");
+      expect(additionalData?.someProperty).toBe("Test");
     });
 
     test("should support inherited properties", async () => {
       await processError(new DerivedTestError());
       const additionalData = getAdditionalData(context.event);
       expect(additionalData).not.toBeNull();
-      expect(additionalData.someProperty).toBe("Test");
-      expect(additionalData.someOtherProperty).toBe("Test2");
+      expect(additionalData?.someProperty).toBe("Test");
+      expect(additionalData?.someOtherProperty).toBe("Test2");
     });
 
     test("shouldn't set empty additional data", async () => {
@@ -113,13 +114,13 @@ function describeForCapturedExceptions(specDefinitions: (exception: any) => void
   });
 }
 
-function getError(event: Event): ErrorInfo {
+function getError(event: Event): ErrorInfo | undefined {
   return event?.data?.[KnownEventDataKeys.Error];
 }
 
-function getAdditionalData(event: Event): any {
+function getAdditionalData(event: Event): Record<string, unknown> | undefined {
   const error = getError(event);
-  return error?.data?.["@ext"];
+  return error?.data?.["@ext"] as Record<string, unknown>;
 }
 
 function throwAndCatch(error: Error | string | unknown): Error {

packages/browser/test/plugins/BrowserErrorPlugin.test.ts

@@ -164,7 +164,7 @@ export class EventBuilder {
   }
 
   public addTags(...tags: string[]): EventBuilder {
-    this.target.tags = [...this.target.tags, ...tags];
+    this.target.tags = [...this.target.tags || [], ...tags];
     return this;
   }
 

packages/core/src/EventBuilder.ts

@@ -117,7 +117,7 @@ export class ExceptionlessClient {
 
   public createLog(message: string): EventBuilder;
   public createLog(source: string, message: string): EventBuilder;
-  public createLog(source: string, message: string, level: string): EventBuilder;
+  public createLog(source: string | undefined, message: string, level: string): EventBuilder;
   public createLog(sourceOrMessage: string, message?: string, level?: string): EventBuilder {
     let builder = this.createEvent().setType("log");
 
@@ -147,9 +147,9 @@ export class ExceptionlessClient {
 
   public submitLog(message: string): Promise<EventPluginContext>;
   public submitLog(source: string, message: string): Promise<EventPluginContext>;
-  public submitLog(source: string, message: string, level: string): Promise<EventPluginContext>;
+  public submitLog(source: string | undefined, message: string, level: string): Promise<EventPluginContext>;
   public submitLog(sourceOrMessage: string, message?: string, level?: string): Promise<EventPluginContext> {
-    return this.createLog(sourceOrMessage, message, level).submit();
+    return this.createLog(sourceOrMessage, <string>message, <string>level).submit();
   }
 
   public createNotFound(resource: string): EventBuilder {
@@ -203,16 +203,16 @@ export class ExceptionlessClient {
    * @param context Contextual data used by event plugins to enrich the event details
    */
   public async submitEvent(event: Event, context?: EventContext): Promise<EventPluginContext> {
-    const pluginContext = new EventPluginContext(this, event, context);
+    const pluginContext = new EventPluginContext(this, event, context ?? new EventContext());
 
     if (!event) {
-      context.cancelled = true;
+      pluginContext.cancelled = true;
       return pluginContext;
     }
 
     if (!this.config.enabled || !this.config.isValid) {
       this.config.services.log.info("Event submission is currently disabled.");
-      context.cancelled = true;
+      pluginContext.cancelled = true;
       return pluginContext;
     }
 
@@ -225,7 +225,7 @@ export class ExceptionlessClient {
     }
 
     await EventPluginManager.run(pluginContext);
-    if (context.cancelled) {
+    if (pluginContext.cancelled) {
       return pluginContext;
     }
 
@@ -258,19 +258,12 @@ export class ExceptionlessClient {
    * @param callback The submission response.
    */
   public async updateUserEmailAndDescription(referenceId: string, email: string, description: string): Promise<void> {
-    if (
-      !referenceId || !email || !description || !this.config.enabled ||
-      !this.config.isValid
-    ) {
+    if (!referenceId || !email || !description || !this.config.enabled || !this.config.isValid) {
       return;
     }
 
-    const userDescription: UserDescription = {
-      email_address: email,
-      description,
-    };
-    const response = await this.config.services.submissionClient
-      .submitUserDescription(referenceId, userDescription);
+    const userDescription: UserDescription = { email_address: email, description };
+    const response = await this.config.services.submissionClient.submitUserDescription(referenceId, userDescription);
     if (!response.success) {
       this.config.services.log.error(
         `Failed to submit user email and description for event "${referenceId}": ${response.status} ${response.message}`,