wip

Author: silesky

packages/signals/signals-runtime/src/index.ts

@@ -1,3 +1,6 @@
-export * as Web from './web/web-signals-types'
-export * as Mobile from './mobile/mobile-signals-types'
+export * from './web/web-signals-types'
 export * from './shared/signals-runtime'
+export * from './shared/shared-types'
+
+// there's not really a good reason to use these in an npm package yet, but we might want to in the future
+export * as Mobile from './mobile/mobile-signals-types'

packages/signals/signals/src/core/processor/sandbox.ts

@@ -2,8 +2,8 @@ import { logger } from '../../lib/logger'
 import { createWorkerBox, WorkerBoxAPI } from '../../lib/workerbox'
 import { resolvers } from './arg-resolvers'
 import { AnalyticsRuntimePublicApi, Signal, AnalyticsEnums } from '../../types'
-import { createSignalsRuntime } from './signals-runtime'
 import { replaceBaseUrl } from '../../lib/replace-base-url'
+import { SignalsRuntime } from '@segment/analytics-signals-runtime'
 
 export type MethodName =
   | 'page'
@@ -212,8 +212,8 @@ export class Sandbox {
     logger.debug('processing signal', { signal, scope, signals })
     const code = [
       await this.settings.processSignal,
-      `const createSignalsRuntime = ${createSignalsRuntime.toString()}`,
-      `const signals = createSignalsRuntime(${JSON.stringify(signals)})`,
+      `${SignalsRuntime.toString()}`,
+      `const signals = new SignalsRuntime(${JSON.stringify(signals)})`,
       'try { processSignal(' +
         JSON.stringify(signal) +
         ', { analytics, signals, SignalType, EventType, NavigationAction }); } catch(err) { console.error("Process signal failed.", err); }',

packages/signals/signals/src/core/processor/signals-runtime.ts

@@ -1,47 +1,13 @@
 // could be the buffered signals object?
 
-import { Signal, SignalType, SignalOfType, SignalsRuntime } from '../../types'
+import { SignalsRuntime, Signal } from '@segment/analytics-signals-runtime'
 
 // This needs to use the function keyword so that it can be stringified and run in a sandbox
 /**
  * @param signals - List of signals, with the most recent signals first (LIFO).
  */
-export function createSignalsRuntime(signals: Signal[]): SignalsRuntime {
-  /**
-   * @param fromSignal - signal to start searching from
-   * @param signalType - type of signal to find (e.g. 'interaction')
-   * @param predicate - optional predicate function to filter the signals (search domain only includes signals after the signal defined in `fromSignal`)
-   * @returns First signal that matches the criteria, or undefined
-   */
-  function find<T extends SignalType>(
-    fromSignal: Signal,
-    signalType: T,
-    predicate?: (signal: SignalOfType<T>) => boolean
-  ): SignalOfType<T> | undefined {
-    const results = filter(fromSignal, signalType, predicate)
-    return results[0]
-  }
-
-  /**
-   * @param fromSignal - signal to start searching from
-   * @param predicate - optional predicate function to filter the signals
-   * @returns signals after the current one.
-   */
-  function filter<T extends SignalType>(
-    fromSignal: Signal,
-    signalType: T,
-    predicate?: (signal: SignalOfType<T>) => boolean
-  ): SignalOfType<T>[] {
-    const _isSignalOfType = (signal: Signal): signal is SignalOfType<T> =>
-      signal.type === signalType
-    return signals
-      .slice(signals.indexOf(fromSignal) + 1)
-      .filter(_isSignalOfType)
-      .filter((signal) => (predicate ? predicate(signal) : () => true))
-  }
-
-  return {
-    find,
-    filter,
-  }
+export function createSignalsRuntime(
+  signals: Signal[]
+): SignalsRuntime<Signal> {
+  return new SignalsRuntime(signals)
 }

packages/signals/signals/src/types/process-signal.ts

@@ -1,4 +1,4 @@
-import { SignalsRuntime } from '../core/processor/signals-runtime'
+import { ISignalsRuntime } from '@segment/analytics-signals-runtime'
 import { Signal } from './signals'
 
 /**
@@ -15,7 +15,7 @@ export interface AnalyticsRuntimePublicApi {
 
 export type ProcessSignalScope = {
   analytics: AnalyticsRuntimePublicApi
-  signals: SignalsRuntime
+  signals: ISignalsRuntime<Signal>
 } & typeof AnalyticsEnums
 
 export interface ProcessSignal {

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

@@ -1,3 +1,5 @@
+import { ISignalsRuntime } from '@segment/analytics-signals-runtime'
+
 export type JSONPrimitive = string | number | boolean | null
 export type JSONValue = JSONPrimitive | JSONObject | JSONArray
 export type JSONObject = { [member: string]: JSONValue }
@@ -113,15 +115,4 @@ export interface SegmentEvent {
   [key: string]: any
 }
 
-export type SignalsRuntime = {
-  find: <T extends SignalType>(
-    fromSignal: Signal,
-    signalType: T,
-    predicate?: (signal: SignalOfType<T>) => boolean
-  ) => SignalOfType<T> | undefined
-  filter: <T extends SignalType>(
-    fromSignal: Signal,
-    signalType: T,
-    predicate?: (signal: SignalOfType<T>) => boolean
-  ) => SignalOfType<T>[]
-}
+export type SignalsRuntime = ISignalsRuntime<Signal>