Moved config services, removed node storage prefix and more

Author: niemyjski

packages/browser/src/BrowserExceptionlessClient.ts

@@ -1,5 +1,4 @@
 import {
-  Configuration,
   ExceptionlessClient,
   parseQueryString
 } from "@exceptionless/core";
@@ -15,7 +14,7 @@ export class BrowserExceptionlessClient extends ExceptionlessClient {
     super(new BrowserConfiguration());
   }
 
-  public async startup(configurationOrApiKey?: (config: Configuration) => void | string): Promise<void> {
+  public async startup(configurationOrApiKey?: (config: BrowserConfiguration) => void | string): Promise<void> {
     if (configurationOrApiKey) {
       const settings = this.getDefaultsSettingsFromScriptTag();
       if (settings?.apiKey) {
@@ -34,10 +33,10 @@ export class BrowserExceptionlessClient extends ExceptionlessClient {
         this.config.includePrivateInformation = settings.includePrivateInformation === "true";
       }
 
-      this.config.errorParser = new BrowserErrorParser();
-      this.config.moduleCollector = new BrowserModuleCollector();
-      this.config.requestInfoCollector = new BrowserRequestInfoCollector();
-      this.config.submissionClient = new BrowserFetchSubmissionClient(this.config);
+      this.config.services.errorParser = new BrowserErrorParser();
+      this.config.services.moduleCollector = new BrowserModuleCollector();
+      this.config.services.requestInfoCollector = new BrowserRequestInfoCollector();
+      this.config.services.submissionClient = new BrowserFetchSubmissionClient(this.config);
 
       // TODO: Register platform specific plugins.
     }

packages/browser/src/configuration/BrowserConfiguration.ts

@@ -5,7 +5,7 @@ import { BrowserLocalStorageProvider } from "../storage/BrowserLocalStorageProvi
 export class BrowserConfiguration extends Configuration {
   public useLocalStorage(): void {
     if (BrowserLocalStorage.isAvailable()) {
-      this.storage = new BrowserLocalStorageProvider();
+      this.services.storage = new BrowserLocalStorageProvider();
       SettingsManager.applySavedServerSettings(this);
       super.changed();
     }

packages/core/src/ExceptionlessClient.ts

@@ -27,7 +27,7 @@ export class ExceptionlessClient {
 
       SettingsManager.applySavedServerSettings(this.config);
       this.config.onChanged(() => this.updateSettingsTimer(this._timeoutId > 0 ? 5000 : 0));
-      this.config.queue.onEventsPosted(() => this.updateSettingsTimer());
+      this.config.services.queue.onEventsPosted(() => this.updateSettingsTimer());
     }
 
     this.updateSettingsTimer(configurationOrApiKey ? 5000 : 0);
@@ -39,12 +39,12 @@ export class ExceptionlessClient {
   public async suspend(): Promise<void> {
     await EventPluginManager.suspend(new PluginContext(this));
     await this.processQueue();
-    await this.config.queue.suspend();
+    await this.config.services.queue.suspend();
     this.updateSettingsTimer(0, -1);
   }
 
   public async processQueue(): Promise<void> {
-    await this.config.queue.process();
+    await this.config.services.queue.process();
   }
 
   // TODO: Look into better async scheduling..
@@ -54,7 +54,7 @@ export class ExceptionlessClient {
 
     const interval = updateWhenIdleInterval || this.config.updateSettingsWhenIdleInterval;
     if (interval > 0) {
-      this.config.log.info(`Update settings every ${interval}ms (${initialDelay || 0}ms delay)`);
+      this.config.services.log.info(`Update settings every ${interval}ms (${initialDelay || 0}ms delay)`);
       // TODO: Fix awaiting promise.
       const updateSettings = () => void SettingsManager.updateSettings(this.config);
       if (initialDelay > 0) {
@@ -63,7 +63,7 @@ export class ExceptionlessClient {
 
       this._intervalId = setInterval(updateSettings, interval);
     } else {
-      this.config.log.info("Turning off update settings");
+      this.config.services.log.info("Turning off update settings");
     }
   }
 
@@ -77,21 +77,15 @@ export class ExceptionlessClient {
     return this.createException(exception).submit();
   }
 
-  public createUnhandledException(
-    exception: Error,
-    submissionMethod?: string,
-  ): EventBuilder {
+  public createUnhandledException(exception: Error, submissionMethod?: string): EventBuilder {
     const builder = this.createException(exception);
     builder.pluginContextData.markAsUnhandledError();
     builder.pluginContextData.setSubmissionMethod(submissionMethod);
 
     return builder;
   }
 
-  public submitUnhandledException(
-    exception: Error,
-    submissionMethod?: string,
-  ): Promise<EventPluginContext> {
+  public submitUnhandledException(exception: Error, submissionMethod?: string): Promise<EventPluginContext> {
     return this.createUnhandledException(exception, submissionMethod).submit();
   }
 
@@ -105,16 +99,8 @@ 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(
-    sourceOrMessage: string,
-    message?: string,
-    level?: string,
-  ): EventBuilder {
+  public createLog(source: string, message: string, level: string): EventBuilder;
+  public createLog(sourceOrMessage: string, message?: string, level?: string): EventBuilder {
     let builder = this.createEvent().setType("log");
 
     if (level) {
@@ -132,7 +118,7 @@ export class ExceptionlessClient {
           caller && caller.caller && caller.caller.name,
         );
       } catch (e) {
-        this.config.log.trace("Unable to resolve log source: " + e.message);
+        this.config.services.log.trace("Unable to resolve log source: " + e.message);
       }
     }
 
@@ -141,16 +127,8 @@ 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(
-    sourceOrMessage: string,
-    message?: string,
-    level?: string,
-  ): Promise<EventPluginContext> {
+  public submitLog(source: string, message: string, level: string): Promise<EventPluginContext>;
+  public submitLog(sourceOrMessage: string, message?: string, level?: string): Promise<EventPluginContext> {
     return this.createLog(sourceOrMessage, message, level).submit();
   }
 
@@ -172,15 +150,15 @@ export class ExceptionlessClient {
 
   public async submitSessionEnd(sessionIdOrUserId: string): Promise<void> {
     if (sessionIdOrUserId && this.config.enabled && this.config.isValid) {
-      this.config.log.info(`Submitting session end: ${sessionIdOrUserId}`);
-      await this.config.submissionClient.submitHeartbeat(sessionIdOrUserId, true);
+      this.config.services.log.info(`Submitting session end: ${sessionIdOrUserId}`);
+      await this.config.services.submissionClient.submitHeartbeat(sessionIdOrUserId, true);
     }
   }
 
   public async submitSessionHeartbeat(sessionIdOrUserId: string): Promise<void> {
     if (sessionIdOrUserId && this.config.enabled && this.config.isValid) {
-      this.config.log.info(`Submitting session heartbeat: ${sessionIdOrUserId}`);
-      await this.config.submissionClient.submitHeartbeat(sessionIdOrUserId, false);
+      this.config.services.log.info(`Submitting session heartbeat: ${sessionIdOrUserId}`);
+      await this.config.services.submissionClient.submitHeartbeat(sessionIdOrUserId, false);
     }
   }
 
@@ -203,7 +181,7 @@ export class ExceptionlessClient {
     }
 
     if (!this.config.enabled || !this.config.isValid) {
-      this.config.log.info("Event submission is currently disabled.");
+      this.config.services.log.info("Event submission is currently disabled.");
       context.cancelled = true;
       return context;
     }
@@ -233,11 +211,11 @@ export class ExceptionlessClient {
       ev.date = new Date();
     }
 
-    config.queue.enqueue(ev);
+    config.services.queue.enqueue(ev);
 
     if (ev.reference_id && ev.reference_id.length > 0) {
       context.log.info(`Setting last reference id "${ev.reference_id}"`);
-      config.lastReferenceIdManager.setLast(ev.reference_id);
+      config.services.lastReferenceIdManager.setLast(ev.reference_id);
     }
   }
 
@@ -257,9 +235,9 @@ export class ExceptionlessClient {
       email_address: email,
       description
     };
-    const response = await this.config.submissionClient.submitUserDescription(referenceId, userDescription);
+    const response = await this.config.services.submissionClient.submitUserDescription(referenceId, userDescription);
     if (!response.success) {
-      this.config.log.error(
+      this.config.services.log.error(
         `Failed to submit user email and description for event "${referenceId}": ${response.status} ${response.message}`,
       );
     }
@@ -270,6 +248,6 @@ export class ExceptionlessClient {
    * @returns {string} The event client id.
    */
   public getLastReferenceId(): string {
-    return this.config.lastReferenceIdManager.getLast();
+    return this.config.services.lastReferenceIdManager.getLast();
   }
 }

packages/core/src/Utils.ts

@@ -155,7 +155,7 @@ export function isMatch(input: string, patterns: string[], ignoreCase: boolean =
   });
 }
 
-export function isEmpty(input: Record<string, unknown>) {
+export function isEmpty(input: Record<string, unknown> | unknown) {
   return input === null || (typeof (input) === "object" && Object.keys(input).length === 0);
 }
 

packages/core/src/configuration/Configuration.ts

@@ -21,6 +21,8 @@ import { guid } from "../Utils.js";
 import { KnownEventDataKeys } from "../models/Event.js";
 
 export class Configuration {
+  // TODO: add flag if your suspended.
+  // change version to be a string.
   /**
    * A default list of tags that will automatically be added to every
    * report submitted to the server.
@@ -45,30 +47,34 @@ export class Configuration {
    */
   public enabled: boolean = true;
 
-  // TODO: Move this into services sub object
-  public environmentInfoCollector: IEnvironmentInfoCollector;
-  public errorParser: IErrorParser;
-  public lastReferenceIdManager: ILastReferenceIdManager = new DefaultLastReferenceIdManager();
-  public log: ILog = new NullLog();
-  public moduleCollector: IModuleCollector;
-  public requestInfoCollector: IRequestInfoCollector;
+  public services: {
+    environmentInfoCollector?: IEnvironmentInfoCollector,
+    errorParser?: IErrorParser,
+    lastReferenceIdManager: ILastReferenceIdManager,
+    log: ILog,
+    moduleCollector?: IModuleCollector,
+    requestInfoCollector?: IRequestInfoCollector,
+    submissionClient?: ISubmissionClient,
+    storage: IStorageProvider,
+    queue: IEventQueue
+  } = {
+      lastReferenceIdManager: new DefaultLastReferenceIdManager(),
+      log: new NullLog(),
+      storage: new InMemoryStorageProvider(),
+      queue: new DefaultEventQueue(this)
+    }
 
   /**
    * Maximum number of events that should be sent to the server together in a batch. (Defaults to 50)
    */
   public submissionBatchSize: number = 50;
-  public submissionClient: ISubmissionClient;
 
   /**
    * Contains a dictionary of custom settings that can be used to control
    * the client and will be automatically updated from the server.
    */
   public settings: Record<string, string> = {};
 
-  public storage: IStorageProvider = new InMemoryStorageProvider();
-
-  public queue: IEventQueue = new DefaultEventQueue(this);
-
   /**
    * The API key that will be used when sending events to the server.
    * @type {string}
@@ -154,7 +160,7 @@ export class Configuration {
    */
   public set apiKey(value: string) {
     this._apiKey = value || null;
-    this.log.info(`apiKey: ${this._apiKey}`);
+    this.services.log.info(`apiKey: ${this._apiKey}`);
     this.changed();
   }
 
@@ -183,7 +189,7 @@ export class Configuration {
       this._serverUrl = value;
       this._configServerUrl = value;
       this._heartbeatServerUrl = value;
-      this.log.info(`serverUrl: ${value}`);
+      this.services.log.info(`serverUrl: ${value}`);
       this.changed();
     }
   }
@@ -203,7 +209,7 @@ export class Configuration {
   public set configServerUrl(value: string) {
     if (value) {
       this._configServerUrl = value;
-      this.log.info(`configServerUrl: ${value}`);
+      this.services.log.info(`configServerUrl: ${value}`);
       this.changed();
     }
   }
@@ -223,7 +229,7 @@ export class Configuration {
   public set heartbeatServerUrl(value: string) {
     if (value) {
       this._heartbeatServerUrl = value;
-      this.log.info(`heartbeatServerUrl: ${value}`);
+      this.services.log.info(`heartbeatServerUrl: ${value}`);
       this.changed();
     }
   }
@@ -252,7 +258,7 @@ export class Configuration {
     }
 
     this._updateSettingsWhenIdleInterval = value;
-    this.log.info(`updateSettingsWhenIdleInterval: ${value}`);
+    this.services.log.info(`updateSettingsWhenIdleInterval: ${value}`);
     this.changed();
   }
 
@@ -307,7 +313,7 @@ export class Configuration {
     this._includeCookies = val;
     this._includePostData = val;
     this._includeQueryString = val;
-    this.log.info(`includePrivateInformation: ${val}`);
+    this.services.log.info(`includePrivateInformation: ${val}`);
     this.changed();
   }
 
@@ -485,7 +491,7 @@ export class Configuration {
       ? { name: pluginOrName as string, priority, run: pluginAction }
       : pluginOrName as IEventPlugin;
     if (!plugin || !plugin.run) {
-      this.log.error("Add plugin failed: Run method not defined");
+      this.services.log.error("Add plugin failed: Run method not defined");
       return;
     }
 
@@ -526,7 +532,7 @@ export class Configuration {
       ? pluginOrName
       : pluginOrName.name;
     if (!name) {
-      this.log.error("Remove plugin failed: Plugin name not defined");
+      this.services.log.error("Remove plugin failed: Plugin name not defined");
       return;
     }
 
@@ -568,7 +574,7 @@ export class Configuration {
       this.defaultData[KnownEventDataKeys.UserInfo] = userInfo;
     }
 
-    this.log.info(
+    this.services.log.info(
       `user identity: ${shouldRemove ? "null" : userInfo.identity}`,
     );
   }
@@ -602,7 +608,7 @@ export class Configuration {
 
   // TODO: Support a min log level.
   public useDebugLogger(): void {
-    this.log = new ConsoleLog();
+    this.services.log = new ConsoleLog();
   }
 
   public onChanged(handler: (config: Configuration) => void): void {
@@ -615,7 +621,7 @@ export class Configuration {
       try {
         handler(this);
       } catch (ex) {
-        this.log.error(`Error calling onChanged handler: ${ex}`);
+        this.services.log.error(`Error calling onChanged handler: ${ex}`);
       }
     }
   }