wip

Author: silesky

packages/signals/signals/src/core/buffer/index.ts

@@ -25,6 +25,9 @@ interface IDBPObjectStoreSignals
     'readonly' | 'readwrite' | 'versionchange'
   > {}
 
+interface StoreSettings {
+  maxBufferSize: number
+}
 export class SignalStoreIndexDB implements SignalPersistentStorage {
   static readonly DB_NAME = 'Segment Signals Buffer'
   static readonly STORE_NAME = 'signals'
@@ -46,8 +49,8 @@ export class SignalStoreIndexDB implements SignalPersistentStorage {
     return store
   }
 
-  constructor(settings: { maxBufferSize?: number } = {}) {
-    this.maxBufferSize = settings.maxBufferSize ?? 10
+  constructor(settings: StoreSettings) {
+    this.maxBufferSize = settings.maxBufferSize
     this.db = this.initSignalDB()
   }
 
@@ -129,6 +132,37 @@ export class SignalStoreIndexDB implements SignalPersistentStorage {
   }
 }
 
+export class SignalStoreSessionStorage implements SignalPersistentStorage {
+  private readonly storageKey = 'segment_signals_buffer'
+  private maxBufferSize: number
+
+  constructor(settings: StoreSettings) {
+    this.maxBufferSize = settings.maxBufferSize
+  }
+
+  add(signal: Signal): void {
+    const signals = this.getAllSync()
+    signals.push(signal)
+    if (signals.length > this.maxBufferSize) {
+      signals.splice(0, signals.length - this.maxBufferSize)
+    }
+    sessionStorage.setItem(this.storageKey, JSON.stringify(signals))
+  }
+
+  getAll(): Promise<Signal[]> {
+    return Promise.resolve(this.getAllSync())
+  }
+
+  private getAllSync(): Signal[] {
+    const signals = sessionStorage.getItem(this.storageKey)
+    return signals ? JSON.parse(signals).reverse() : []
+  }
+
+  clear(): void {
+    sessionStorage.removeItem(this.storageKey)
+  }
+}
+
 export class SignalBuffer<
   T extends SignalPersistentStorage = SignalPersistentStorage
 > {
@@ -165,14 +199,33 @@ export class SignalBuffer<
 export interface SignalBufferSettingsConfig<
   T extends SignalPersistentStorage = SignalPersistentStorage
 > {
+  /**
+   * Maximum number of signals to store. Only applies if no custom storage implementation is provided.
+   */
   maxBufferSize?: number
+  /**
+   * Choose between sessionStorage and indexDB. Only applies if no custom storage implementation is provided.
+   * @default 'indexDB'
+   */
+  storageType?: 'session' | 'indexDB'
+  /**
+   * Custom storage implementation
+   * @default SignalStoreIndexDB
+   */
   signalStorage?: T
 }
 export const getSignalBuffer = <
   T extends SignalPersistentStorage = SignalPersistentStorage
 >(
   settings: SignalBufferSettingsConfig<T>
 ) => {
-  const store = settings.signalStorage ?? new SignalStoreIndexDB(settings)
+  const settingsWithDefaults: StoreSettings = {
+    maxBufferSize: 50,
+    ...settings,
+  }
+  const store =
+    settings.signalStorage ?? settings.storageType === 'session'
+      ? new SignalStoreSessionStorage(settingsWithDefaults)
+      : new SignalStoreIndexDB(settingsWithDefaults)
   return new SignalBuffer(store)
 }

packages/signals/signals/src/core/signals/settings.ts

@@ -19,6 +19,7 @@ export type SignalsSettingsConfig = Pick<
   | 'networkSignalsAllowList'
   | 'networkSignalsDisallowList'
   | 'networkSignalsAllowSameDomain'
+  | 'signalStorageType'
 > & {
   signalStorage?: SignalPersistentStorage
   processSignal?: string
@@ -52,6 +53,7 @@ export class SignalGlobalSettings {
 
     this.signalBuffer = {
       signalStorage: settings.signalStorage,
+      storageType: settings.signalStorageType,
       maxBufferSize: settings.maxBufferSize,
     }
     this.ingestClient = {

packages/signals/signals/src/types/settings.ts

@@ -72,6 +72,15 @@ export interface SignalsPluginSettingsConfig {
    * Custom signal storage implementation
    */
   signalStorage?: SignalStorage | undefined
+
+  /**
+   * Choose between sessionStorage and indexDB.
+   * IndexDB is more performant and has no size requirements, but signals will be stored across sessions (cleared on new session, but still technically accessible)
+   * Session storage is cleared on new session, but has a size limit of 5MB.
+   * Signals are stored in indexDB by default.
+   * @default 'indexDB'
+   */
+  signalStorageType?: 'session' | 'indexDB' | undefined
 }
 
 export type RegexLike = RegExp | string