First draft of a client for signals using segmentio (#1094)

Author: MichaelGHSeg

packages/browser/src/index.ts

@@ -16,3 +16,4 @@ export type { AnalyticsSnippet } from './browser/standalone-interface'
 export type { MiddlewareFunction } from './plugins/middleware'
 export { getGlobalAnalytics } from './lib/global-analytics-helper'
 export { UniversalStorage, Store, StorageObject } from './core/storage'
+export { segmentio } from './plugins/segmentio'

packages/signals/browser-signals/src/core/signals/__tests__/client.test.ts

@@ -0,0 +1,36 @@
+import { SignalsClient } from '../client'
+
+import { createSuccess } from '../../../../../../browser/src/test-helpers/factories'
+import unfetch from 'unfetch'
+jest.mock('unfetch')
+jest
+  .mocked(unfetch)
+  .mockImplementation(() => createSuccess({ integrations: {} }))
+
+describe(SignalsClient, () => {
+  let client: SignalsClient
+
+  beforeEach(() => {
+    client = new SignalsClient('Test')
+  })
+
+  it('return a ctx from track call', () => {
+    expect(client).toBeTruthy()
+    return expect(client.send('Test', 'Test')).resolves.toMatchObject({
+      event: {
+        anonymousId: expect.any(String),
+        context: expect.any(Object),
+        event: 'Segment Signal Generated',
+        integrations: {},
+        messageId: expect.any(String),
+        properties: {
+          data: 'Test',
+          index: expect.any(Number),
+          type: 'Test',
+        },
+        timestamp: expect.any(Date),
+        type: 'track',
+      },
+    })
+  })
+})

packages/signals/browser-signals/src/core/signals/client.ts

@@ -0,0 +1,35 @@
+import { Analytics, segmentio } from '@segment/analytics-next'
+
+export class SignalsClient {
+  private index = 0
+  private analytics: Analytics
+
+  constructor(writeKey: any) {
+    this.analytics = new Analytics({ writeKey })
+    void this.analytics.register(
+      segmentio(this.analytics, {
+        apiHost: 'https://signals.segment.io/v1',
+        apiKey: writeKey,
+        deliveryStrategy: {
+          strategy: 'batching',
+          config: {
+            size: 100,
+            timeout: 30 * 1000,
+          },
+        },
+      })
+    )
+  }
+
+  public send(type: any, data: any): Promise<any> {
+    return this.analytics
+      .track('Segment Signal Generated', {
+        type,
+        index: this.index++,
+        data,
+      })
+      .then((ctx) => {
+        return ctx
+      })
+  }
+}