Moved module service to browser plugin and cached it.

Author: niemyjski

packages/browser/src/BrowserExceptionlessClient.ts

@@ -6,8 +6,8 @@ import {
 import { BrowserGlobalHandlerPlugin } from "./plugins/BrowserGlobalHandlerPlugin.js";
 import { BrowserLifeCyclePlugin } from "./plugins/BrowserLifeCyclePlugin.js";
 import { BrowserWrapFunctions } from "./plugins/BrowserWrapFunctions.js";
+import { BrowserModuleInfoPlugin } from "./plugins/BrowserModuleInfoPlugin.js";
 import { BrowserErrorParser } from "./services/BrowserErrorParser.js";
-import { BrowserModuleCollector } from "./services/BrowserModuleCollector.js";
 import { BrowserRequestInfoCollector } from "./services/BrowserRequestInfoCollector.js";
 import { BrowserLocalStorage } from "./storage/BrowserLocalStorage.js";
 import { BrowserFetchSubmissionClient } from "./submission/BrowserFetchSubmissionClient.js";
@@ -18,13 +18,13 @@ export class BrowserExceptionlessClient extends ExceptionlessClient {
     if (configurationOrApiKey) {
       config.services.storage = new BrowserLocalStorage();
       config.services.errorParser = new BrowserErrorParser();
-      config.services.moduleCollector = new BrowserModuleCollector();
       config.services.requestInfoCollector = new BrowserRequestInfoCollector();
       config.services.submissionClient = new BrowserFetchSubmissionClient(config);
 
       config.addPlugin(new BrowserGlobalHandlerPlugin());
       config.addPlugin(new BrowserLifeCyclePlugin());
       config.addPlugin(new BrowserWrapFunctions());
+      config.addPlugin(new BrowserModuleInfoPlugin());
     }
 
     await super.startup(configurationOrApiKey);

packages/browser/src/index.ts

@@ -1,8 +1,8 @@
 export { BrowserGlobalHandlerPlugin } from "./plugins/BrowserGlobalHandlerPlugin.js";
 export { BrowserLifeCyclePlugin } from "./plugins/BrowserLifeCyclePlugin.js";
 export { BrowserWrapFunctions } from "./plugins/BrowserWrapFunctions.js";
+export { BrowserModuleInfoPlugin } from "./plugins/BrowserModuleInfoPlugin.js";
 export { BrowserErrorParser } from "./services/BrowserErrorParser.js";
-export { BrowserModuleCollector } from "./services/BrowserModuleCollector.js";
 export { BrowserRequestInfoCollector } from "./services/BrowserRequestInfoCollector.js";
 export { BrowserLocalStorage } from "./storage/BrowserLocalStorage.js";
 export { BrowserFetchSubmissionClient } from "./submission/BrowserFetchSubmissionClient.js";

packages/browser/src/services/BrowserModuleCollector.ts renamed to packages/browser/src/plugins/BrowserModuleInfoPlugin.ts

@@ -1,12 +1,36 @@
 import {
+  EventPluginContext,
   getHashCode,
-  IModuleCollector,
+  IEventPlugin,
+  KnownEventDataKeys,
   ModuleInfo,
   parseVersion,
+  PluginContext
 } from "@exceptionless/core";
 
-export class BrowserModuleCollector implements IModuleCollector {
-  public getModules(): ModuleInfo[] {
+export class BrowserModuleInfoPlugin implements IEventPlugin {
+  public priority: number = 50;
+  public name: string = "BrowserModuleInfoPlugin";
+  private _cachedModules: ModuleInfo[] = null;
+
+  public startup(context: PluginContext): Promise<void> {
+    if (!this._cachedModules) {
+      this._cachedModules = this.getModules();
+    }
+
+    return Promise.resolve();
+  }
+
+  public run(context: EventPluginContext): Promise<void> {
+    const error = context.event.data[KnownEventDataKeys.Error];
+    if (this._cachedModules?.length > 0 && !error?.modules) {
+      error.modules = this._cachedModules;
+    }
+
+    return Promise.resolve();
+  }
+
+  private getModules(): ModuleInfo[] {
     if (!document || !document.getElementsByTagName) {
       return null;
     }

packages/core/src/configuration/Configuration.ts

@@ -12,7 +12,6 @@ import { DefaultEventQueue } from "../queue/DefaultEventQueue.js";
 import { IEventQueue } from "../queue/IEventQueue.js";
 import { IEnvironmentInfoCollector } from "../services/IEnvironmentInfoCollector.js";
 import { IErrorParser } from "../services/IErrorParser.js";
-import { IModuleCollector } from "../services/IModuleCollector.js";
 import { IRequestInfoCollector } from "../services/IRequestInfoCollector.js";
 import { ISubmissionClient } from "../submission/ISubmissionClient.js";
 import { guid } from "../Utils.js";
@@ -64,7 +63,6 @@ export class Configuration {
     errorParser?: IErrorParser,
     lastReferenceIdManager: ILastReferenceIdManager,
     log: ILog,
-    moduleCollector?: IModuleCollector,
     requestInfoCollector?: IRequestInfoCollector,
     submissionClient?: ISubmissionClient,
     storage: IStorage,

packages/core/src/index.ts

@@ -31,7 +31,6 @@ export { EnvironmentInfoPlugin } from "./plugins/default/EnvironmentInfoPlugin.j
 export { ErrorPlugin } from "./plugins/default/ErrorPlugin.js";
 export { EventExclusionPlugin } from "./plugins/default/EventExclusionPlugin.js";
 export { HeartbeatPlugin } from "./plugins/default/HeartbeatPlugin.js";
-export { ModuleInfoPlugin } from "./plugins/default/ModuleInfoPlugin.js";
 export { ReferenceIdPlugin } from "./plugins/default/ReferenceIdPlugin.js";
 export { RequestInfoPlugin } from "./plugins/default/RequestInfoPlugin.js";
 export { SubmissionMethodPlugin } from "./plugins/default/SubmissionMethodPlugin.js";
@@ -46,7 +45,6 @@ export type { IEventQueue } from "./queue/IEventQueue.js";
 
 export type { IEnvironmentInfoCollector } from "./services/IEnvironmentInfoCollector.js";
 export type { IErrorParser } from "./services/IErrorParser.js";
-export type { IModuleCollector } from "./services/IModuleCollector.js";
 export type { IRequestInfoCollector } from "./services/IRequestInfoCollector.js";
 
 export { InMemoryStorage } from "./storage/InMemoryStorage.js";

packages/core/src/plugins/EventPluginManager.ts

@@ -4,7 +4,6 @@ import { DuplicateCheckerPlugin } from "./default/DuplicateCheckerPlugin.js";
 import { EnvironmentInfoPlugin } from "./default/EnvironmentInfoPlugin.js";
 import { ErrorPlugin } from "./default/ErrorPlugin.js";
 import { EventExclusionPlugin } from "./default/EventExclusionPlugin.js";
-import { ModuleInfoPlugin } from "./default/ModuleInfoPlugin.js";
 import { RequestInfoPlugin } from "./default/RequestInfoPlugin.js";
 import { SubmissionMethodPlugin } from "./default/SubmissionMethodPlugin.js";
 import { EventPluginContext } from "./EventPluginContext.js";
@@ -63,7 +62,6 @@ export class EventPluginManager {
     config.addPlugin(new ErrorPlugin());
     config.addPlugin(new DuplicateCheckerPlugin());
     config.addPlugin(new EventExclusionPlugin());
-    config.addPlugin(new ModuleInfoPlugin());
     config.addPlugin(new RequestInfoPlugin());
     config.addPlugin(new EnvironmentInfoPlugin());
     config.addPlugin(new SubmissionMethodPlugin());