Fixed storage, improved settings management

Author: niemyjski

example/browser/index.js

@@ -2,14 +2,14 @@ import { Exceptionless } from "../../node_modules/@exceptionless/browser/dist/in
 import { divide } from "./math.js";
 import { TextAreaLogger } from "./text-area-logger.js";
 
-Exceptionless.startup(c => {
+await Exceptionless.startup(c => {
   c.useDebugLogger();
   c.services.log = new TextAreaLogger("logs", c.services.log);
 
   c.apiKey = "LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw";
   c.serverUrl = "http://localhost:5000";
   c.updateSettingsWhenIdleInterval = 15000;
-  c.useLocalStorage();
+  c.usePersistedQueueStorage = true;
   c.setUserIdentity("12345678", "Blake");
   c.useSessions();
 

example/browser/text-area-logger.js

@@ -35,10 +35,11 @@ export class TextAreaLogger {
   }
 
   log(level, message) {
+    const formattedMessage = `${new Date().toISOString()} [${level}] ${message}`;
     if (this.element) {
-      this.element.innerHTML += `\n[${level}] ${message}`;
+      this.element.innerHTML += `\n${formattedMessage}`;
     } else {
-      this.messageBuffer.push(`[${level}] ${message}`)
+      this.messageBuffer.push(formattedMessage)
     }
   }
 }

example/express/app.js

@@ -3,11 +3,10 @@ const app = express()
 
 import { Exceptionless } from "../../node_modules/@exceptionless/node/dist/index.js";
 
-Exceptionless.startup(c => {
+await Exceptionless.startup(c => {
   c.apiKey = "LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw";
   c.serverUrl = "http://localhost:5000";
   c.useDebugLogger();
-  c.useLocalStorage();
 
   c.defaultTags.push("Example", "Node");
 

package-lock.json

@@ -27,13 +27,13 @@
     "packages/*"
   ],
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "4.19.0",
-    "@typescript-eslint/parser": "4.19.0",
-    "eslint": "7.22.0",
+    "@typescript-eslint/eslint-plugin": "4.21.0",
+    "@typescript-eslint/parser": "4.21.0",
+    "eslint": "7.23.0",
     "eslint-plugin-eslint-comments": "3.2.0",
     "eslint-plugin-eslint-plugin": "2.3.0",
     "eslint-plugin-import": "2.22.1",
-    "eslint-plugin-jest": "24.3.2",
+    "eslint-plugin-jest": "24.3.4",
     "eslint-plugin-jsdoc": "32.3.0",
     "jest": "26.6.3",
     "jest-ts-webcompat-resolver": "1.0.0",

package.json

@@ -33,14 +33,24 @@
     ".": "./dist/index.js",
     "./package.json": "./package.json"
   },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "ts"
+    ],
+    "moduleNameMapper": {
+      "^@exceptionless/(.*)$": "<rootDir>/../$1/src"
+    },
+    "preset": "ts-jest",
+    "resolver": "jest-ts-webcompat-resolver",
+    "testEnvironment": "jsdom"
+  },
   "scripts": {
     "build": "tsc -p tsconfig.json && esbuild src/index.ts --bundle --minify --sourcemap --target=es2020 --format=esm --outfile=dist/index.min.js",
     "watch": "tsc -p tsconfig.json -w --preserveWatchOutput",
     "test": "jest"
   },
-  "sideEffects": [
-    "dist/index.js"
-  ],
+  "sideEffects": false,
   "devDependencies": {
     "@jest/globals": "26.6.2",
     "esbuild": "0.8.49",

packages/browser/package.json

@@ -9,37 +9,37 @@ export class BrowserLocalStorage implements IStorage {
 
   public clear(): Promise<void> {
     for (const key of this.getKeys()) {
-      window.localStorage.removeItem(key);
+      localStorage.removeItem(this.getKey(key));
     }
 
     return Promise.resolve();
   }
 
   public getItem(key: string): Promise<string> {
-    return Promise.resolve(window.localStorage.getItem(this.getKey(key)));
+    return Promise.resolve(localStorage.getItem(this.getKey(key)));
   }
 
   public key(index: number): Promise<string> {
     const keys = this.getKeys();
-    return Promise.resolve(keys[index]);
+    return Promise.resolve(index < keys.length ? keys[index] : null);
   }
 
   public keys(): Promise<string[]> {
     return Promise.resolve(this.getKeys());
   }
 
   public removeItem(key: string): Promise<void> {
-    window.localStorage.removeItem(this.getKey(key));
+    localStorage.removeItem(this.getKey(key));
     return Promise.resolve();
   }
 
   public setItem(key: string, value: string): Promise<void> {
-    window.localStorage.setItem(this.getKey(key), value);
+    localStorage.setItem(this.getKey(key), value);
     return Promise.resolve();
   }
 
   private getKeys(): string[] {
-    return Object.keys(window.localStorage)
+    return Object.keys(localStorage)
       .filter(key => key.startsWith(this.prefix))
       .map(key => key?.substr(this.prefix.length));
   }

packages/browser/src/storage/BrowserLocalStorage.ts

@@ -1,5 +1,5 @@
-import { describeStorage } from "@exceptionless/core/test/storage/InMemoryStorage.test";
-import { IStorage } from "@exceptionless/core/src/storage/IStorage";
+import { IStorage } from "@exceptionless/core";
+import { describeStorage } from "../../../core/test/storage/StorageTestBase.js";
 import { BrowserLocalStorage } from "../../src/storage/BrowserLocalStorage.js";
 
 function resetLocalStorage() {

packages/browser/test/storage/BrowserLocalStorage.test.ts

@@ -26,42 +26,55 @@ export class ExceptionlessClient {
       }
 
       this.config.services.queue.onEventsPosted(() => Promise.resolve(this.updateSettingsTimer()));
+      await SettingsManager.applySavedServerSettings(this.config);
     }
 
-    this.updateSettingsTimer(configurationOrApiKey ? 5000 : 0);
+    this.updateSettingsTimer(!!configurationOrApiKey);
     await EventPluginManager.startup(new PluginContext(this));
-    await this.processQueue();
+    const { queue } = this.config.services;
+    await queue.startup();
+    if (this.config.usePersistedQueueStorage) {
+      // TODO: Can we schedule this as part of startup?
+      await queue.process();
+    }
   }
 
   /** Submit events, pause any timers and go into low power mode. */
   public async suspend(): Promise<void> {
     await EventPluginManager.suspend(new PluginContext(this));
-    await this.processQueue();
-    await this.config.services.queue.suspend();
-    this.updateSettingsTimer(0, -1);
+    const { queue } = this.config.services;
+    await queue.suspend();
+    await queue.process();
+    this.suspendSettingsTimer();
+  }
+
+  private suspendSettingsTimer(): void {
+    this._timeoutId = clearTimeout(this._timeoutId);
+    this._intervalId = clearInterval(this._intervalId);
   }
 
   public async processQueue(): Promise<void> {
     await this.config.services.queue.process();
   }
 
-  // TODO: Look into better async scheduling..
-  private updateSettingsTimer(initialDelay: number = 0, updateWhenIdleInterval?: number) {
-    this._timeoutId = clearTimeout(this._timeoutId);
-    this._intervalId = clearInterval(this._intervalId);
+  private updateSettingsTimer(startingUp: boolean = false) {
+    this.suspendSettingsTimer();
 
-    const interval = updateWhenIdleInterval || this.config.updateSettingsWhenIdleInterval;
+    const interval = this.config.updateSettingsWhenIdleInterval;
     if (interval > 0) {
+      let initialDelay: number = interval;
+      if (startingUp) {
+        initialDelay = this.config.settingsVersion > 0 ? 15000 : 5000;
+      }
+
       this.config.services.log.info(`Update settings every ${interval}ms (${initialDelay || 0}ms delay)`);
-      // TODO: Fix awaiting promise.
+      // TODO: Look into better async scheduling..
       const updateSettings = () => void SettingsManager.updateSettings(this.config);
-      if (initialDelay > 0) {
+      if (initialDelay < interval) {
         this._timeoutId = setTimeout(updateSettings, initialDelay);
       }
 
       this._intervalId = setInterval(updateSettings, interval);
-    } else {
-      this.config.services.log.info("Turning off update settings");
     }
   }
 

packages/core/src/ExceptionlessClient.ts

@@ -81,6 +81,7 @@ export class Configuration {
    * the client and will be automatically updated from the server.
    */
   public settings: Record<string, string> = {};
+  public settingsVersion: number = 0;
 
   /**
    * The API key that will be used when sending events to the server.