utneque 1.0.0

package/packages/browser/src/plugins/hightouchio/__tests__/batched-dispatcher.test.ts

@@ -0,0 +1,299 @@
+const fetch = jest.fn()
+
+jest.mock('unfetch', () => {
+  return fetch
+})
+
+import batch from '../batched-dispatcher'
+
+const fatEvent = {
+  _id: '609c0e91fe97b680e384d6e4',
+  index: 5,
+  guid: 'ca7fac24-41c9-45db-bc53-59b544e43943',
+  isActive: false,
+  balance: '$2,603.43',
+  picture: 'http://placehold.it/32x32',
+  age: 36,
+  eyeColor: 'blue',
+  name: 'Myers Hoover',
+  gender: 'male',
+  company: 'SILODYNE',
+  email: 'myershoover@silodyne.com',
+  phone: '+1 (986) 580-3562',
+  address: '240 Ryder Avenue, Belva, Nebraska, 929',
+  about:
+    'Non eu nulla exercitation consectetur reprehenderit culpa mollit non consectetur magna tempor. Do et duis occaecat eu culpa dolor elit et est pariatur qui. Veniam dolore amet minim veniam quis esse. Aute commodo sint officia velit dolor. Sit enim nisi eu exercitation dolore nulla dolor occaecat. Sunt eu pariatur reprehenderit ipsum et nulla cillum culpa ea.\r\n',
+  registered: '2019-04-13T09:29:21 +05:00',
+  latitude: 68.879515,
+  longitude: -46.670697,
+  tags: ['magna', 'ex', 'nostrud', 'mollit', 'laborum', 'exercitation', 'sit'],
+  friends: [
+    {
+      id: 0,
+      name: 'Lynn Brock',
+    },
+    {
+      id: 1,
+      name: 'May Hull',
+    },
+    {
+      id: 2,
+      name: 'Elena Henderson',
+    },
+  ],
+  greeting: 'Hello, Myers Hoover! You have 5 unread messages.',
+  favoriteFruit: 'strawberry',
+}
+
+describe('Batching', () => {
+  beforeEach(() => {
+    jest.resetAllMocks()
+    jest.restoreAllMocks()
+    jest.useFakeTimers({
+      now: new Date('9 Jun 1993 00:00:00Z').getTime(),
+    })
+  })
+
+  afterEach(() => {
+    // clear any pending sendBatch calls
+    jest.runAllTimers()
+    jest.useRealTimers()
+  })
+
+  it('does not send requests right away', async () => {
+    const { dispatch } = batch(`https://us-east-1.hightouch-events.com`)
+
+    await dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+      hello: 'world',
+    })
+
+    expect(fetch).not.toHaveBeenCalled()
+  })
+
+  it('sends requests after a batch limit is hit', async () => {
+    const { dispatch } = batch(`https://us-east-1.hightouch-events.com`, {
+      size: 3,
+    })
+
+    await dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+      event: 'first',
+    })
+    expect(fetch).not.toHaveBeenCalled()
+
+    await dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+      event: 'second',
+    })
+    expect(fetch).not.toHaveBeenCalled()
+
+    await dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+      event: 'third',
+    })
+
+    expect(fetch).toHaveBeenCalledTimes(1)
+    expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
+      Array [
+        "https://https://us-east-1.hightouch-events.com/v1/batch",
+        Object {
+          "body": "{\\"batch\\":[{\\"event\\":\\"first\\"},{\\"event\\":\\"second\\"},{\\"event\\":\\"third\\"}],\\"sentAt\\":\\"1993-06-09T00:00:00.000Z\\"}",
+          "headers": Object {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+          },
+          "keepalive": false,
+          "method": "post",
+        },
+      ]
+    `)
+  })
+
+  it('sends requests if the size of events exceeds tracking API limits', async () => {
+    const { dispatch } = batch(`https://us-east-1.hightouch-events.com`, {
+      size: 600,
+    })
+
+    // fatEvent is about ~1kb in size
+    for (let i = 0; i < 250; i++) {
+      await dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+        event: 'fat event',
+        properties: fatEvent,
+      })
+    }
+    expect(fetch).not.toHaveBeenCalled()
+
+    for (let i = 0; i < 250; i++) {
+      await dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+        event: 'fat event',
+        properties: fatEvent,
+      })
+    }
+
+    // still called, even though our batch limit is 600 events
+    expect(fetch).toHaveBeenCalledTimes(1)
+  })
+
+  it('sends requests when the timeout expires', async () => {
+    const { dispatch } = batch(`https://us-east-1.hightouch-events.com`, {
+      size: 100,
+      timeout: 10000, // 10 seconds
+    })
+
+    await dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+      event: 'first',
+    })
+    expect(fetch).not.toHaveBeenCalled()
+
+    await dispatch(`https://us-east-1.hightouch-events.com/v1/i`, {
+      event: 'second',
+    })
+
+    jest.advanceTimersByTime(11000) // 11 seconds
+
+    expect(fetch).toHaveBeenCalledTimes(1)
+    expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
+      Array [
+        "https://https://us-east-1.hightouch-events.com/v1/batch",
+        Object {
+          "body": "{\\"batch\\":[{\\"event\\":\\"first\\"},{\\"event\\":\\"second\\"}],\\"sentAt\\":\\"1993-06-09T00:00:10.000Z\\"}",
+          "headers": Object {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+          },
+          "keepalive": false,
+          "method": "post",
+        },
+      ]
+    `)
+  })
+
+  it('clears the buffer between flushes', async () => {
+    const { dispatch } = batch(`https://us-east-1.hightouch-events.com`, {
+      size: 100,
+      timeout: 10000, // 10 seconds
+    })
+
+    await dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+      event: 'first',
+    })
+
+    jest.advanceTimersByTime(11000) // 11 seconds
+
+    await dispatch(`https://us-east-1.hightouch-events.com/v1/i`, {
+      event: 'second',
+    })
+
+    jest.advanceTimersByTime(11000) // 11 seconds
+
+    expect(fetch).toHaveBeenCalledTimes(2)
+
+    expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
+      Array [
+        "https://https://us-east-1.hightouch-events.com/v1/batch",
+        Object {
+          "body": "{\\"batch\\":[{\\"event\\":\\"first\\"}],\\"sentAt\\":\\"1993-06-09T00:00:10.000Z\\"}",
+          "headers": Object {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+          },
+          "keepalive": false,
+          "method": "post",
+        },
+      ]
+    `)
+
+    expect(fetch.mock.calls[1]).toMatchInlineSnapshot(`
+      Array [
+        "https://https://us-east-1.hightouch-events.com/v1/batch",
+        Object {
+          "body": "{\\"batch\\":[{\\"event\\":\\"second\\"}],\\"sentAt\\":\\"1993-06-09T00:00:21.000Z\\"}",
+          "headers": Object {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+          },
+          "keepalive": false,
+          "method": "post",
+        },
+      ]
+    `)
+  })
+
+  it('removes sentAt from individual events', async () => {
+    const { dispatch } = batch(`https://us-east-1.hightouch-events.com`, {
+      size: 2,
+    })
+
+    await dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+      event: 'first',
+      sentAt: new Date('11 Jun 1993 00:01:00Z'),
+    })
+
+    await dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+      event: 'second',
+      sentAt: new Date('11 Jun 1993 00:02:00Z'),
+    })
+
+    expect(fetch).toHaveBeenCalledTimes(1)
+    expect(fetch.mock.calls[0]).toMatchInlineSnapshot(`
+      Array [
+        "https://https://us-east-1.hightouch-events.com/v1/batch",
+        Object {
+          "body": "{\\"batch\\":[{\\"event\\":\\"first\\"},{\\"event\\":\\"second\\"}],\\"sentAt\\":\\"1993-06-09T00:00:00.000Z\\"}",
+          "headers": Object {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+          },
+          "keepalive": false,
+          "method": "post",
+        },
+      ]
+    `)
+  })
+
+  describe('on unload', () => {
+    it('flushes the batch', async () => {
+      const { dispatch } = batch(`https://us-east-1.hightouch-events.com`)
+
+      dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+        hello: 'world',
+      }).catch(console.error)
+
+      dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+        bye: 'world',
+      }).catch(console.error)
+
+      expect(fetch).not.toHaveBeenCalled()
+
+      window.dispatchEvent(new Event('pagehide'))
+
+      expect(fetch).toHaveBeenCalledTimes(1)
+
+      // any dispatch attempts after the page has unloaded are flushed immediately
+      // this can happen if analytics.track is called right before page is navigated away
+      dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+        afterlife: 'world',
+      }).catch(console.error)
+
+      // no queues, no waiting, instatneous
+      expect(fetch).toHaveBeenCalledTimes(2)
+    })
+
+    it('flushes in batches of no more than 64kb', async () => {
+      const { dispatch } = batch(`https://us-east-1.hightouch-events.com`, {
+        size: 1000,
+      })
+
+      // fatEvent is about ~1kb in size
+      for (let i = 0; i < 80; i++) {
+        await dispatch(`https://us-east-1.hightouch-events.com/v1/t`, {
+          event: 'fat event',
+          properties: fatEvent,
+        })
+      }
+
+      expect(fetch).not.toHaveBeenCalled()
+
+      window.dispatchEvent(new Event('pagehide'))
+
+      expect(fetch).toHaveBeenCalledTimes(2)
+    })
+  })
+})

package/packages/browser/src/plugins/hightouchio/__tests__/index.test.ts

@@ -0,0 +1,317 @@
+import assert from 'assert'
+import unfetch from 'unfetch'
+import { hightouchio, HightouchioSettings } from '..'
+import { Analytics } from '../../../core/analytics'
+import { Plugin } from '../../../core/plugin'
+import { envEnrichment } from '../../env-enrichment'
+import cookie from 'js-cookie'
+
+jest.mock('unfetch', () => {
+  return jest.fn()
+})
+
+describe('Hightouch.io', () => {
+  let options: HightouchioSettings
+  let analytics: Analytics
+  let hightouch: Plugin
+  let spyMock: jest.SpyInstance
+
+  beforeEach(async () => {
+    jest.resetAllMocks()
+    jest.restoreAllMocks()
+
+    options = { apiKey: 'foo' }
+    analytics = new Analytics({ writeKey: options.apiKey })
+    hightouch = await hightouchio(analytics, options, {})
+
+    await analytics.register(hightouch, envEnrichment)
+
+    window.localStorage.clear()
+
+    spyMock = jest.mocked(unfetch).mockResolvedValue({
+      ok: true,
+    } as Response)
+  })
+
+  function resetCookies(): void {
+    Object.keys(cookie.get()).map((key) => cookie.remove(key))
+  }
+
+  afterEach(async () => {
+    analytics.reset()
+    resetCookies()
+
+    window.localStorage.clear()
+  })
+
+  describe('using a custom protocol', () => {
+    it('should be able to send http requests', async () => {
+      const options: {
+        apiKey: string
+        protocol: 'http' | 'https'
+      } = {
+        apiKey: 'foo',
+        protocol: 'http',
+      }
+      const analytics = new Analytics({ writeKey: options.apiKey })
+      const hightouch = await hightouchio(analytics, options, {})
+      await analytics.register(hightouch, envEnrichment)
+
+      // @ts-ignore test a valid ajsc page call
+      await analytics.page(null, { foo: 'bar' })
+
+      const [url] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"http://us-east-1.hightouch-events.com/v1/page"`
+      )
+    })
+  })
+
+  describe('configuring a keep alive', () => {
+    it('should accept keepalive configuration', async () => {
+      const analytics = new Analytics({ writeKey: 'foo' })
+
+      await analytics.register(
+        await hightouchio(analytics, {
+          apiKey: '',
+          deliveryStrategy: {
+            config: {
+              keepalive: true,
+            },
+          },
+        })
+      )
+
+      await analytics.track('foo')
+      const [_, params] = spyMock.mock.lastCall
+      expect(params.keepalive).toBe(true)
+    })
+
+    it('should default to no keepalive', async () => {
+      const analytics = new Analytics({ writeKey: 'foo' })
+
+      const hightouch = await hightouchio(analytics, {
+        apiKey: '',
+      })
+      await analytics.register(await hightouch)
+      await analytics.track('foo')
+
+      const [_, params] = spyMock.mock.lastCall
+      expect(params.keepalive).toBeUndefined()
+    })
+  })
+
+  describe('#page', () => {
+    it('should enqueue section, name and properties', async () => {
+      await analytics.page('section', 'name', { property: true }, { opt: true })
+
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/page"`
+      )
+
+      const body = JSON.parse(params.body)
+
+      assert(body.name === 'name')
+      assert(body.category === 'section')
+      assert(body.properties.property === true)
+      assert(body.context.opt === true)
+      assert(body.timestamp)
+    })
+
+    it('sets properties when name and category are null', async () => {
+      // @ts-ignore test a valid ajsc page call
+      await analytics.page(null, { foo: 'bar' })
+
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/page"`
+      )
+
+      const body = JSON.parse(params.body)
+
+      assert(body.properties.foo === 'bar')
+    })
+  })
+
+  describe('#identify', () => {
+    it('should enqueue an id and traits', async () => {
+      await analytics.identify('id', { trait: true }, { opt: true })
+
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/identify"`
+      )
+
+      const body = JSON.parse(params.body)
+      assert(body.userId === 'id')
+      assert(body.traits.trait === true)
+      assert(body.context.opt === true)
+      assert(body.timestamp)
+    })
+
+    it('should set traits with null id', async () => {
+      await analytics.identify(null, { trait: true }, { opt: true })
+
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/identify"`
+      )
+
+      const body = JSON.parse(params.body)
+      assert(body.userId === null)
+      assert(body.traits.trait === true)
+      assert(!body.context.trait)
+      assert(body.context.opt === true)
+      assert(body.timestamp)
+    })
+  })
+
+  describe('#track', () => {
+    it('should enqueue an event and properties', async () => {
+      await analytics.track('event', { prop: true }, { opt: true })
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/track"`
+      )
+
+      const body = JSON.parse(params.body)
+
+      assert(body.event === 'event')
+      assert(body.context.opt === true)
+      assert(body.properties.prop === true)
+      assert(body.traits == null)
+      assert(body.timestamp)
+    })
+  })
+
+  describe('#group', () => {
+    it('should enqueue groupId and traits', async () => {
+      await analytics.group('id', { trait: true }, { opt: true })
+
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/group"`
+      )
+
+      const body = JSON.parse(params.body)
+
+      assert(body.groupId === 'id')
+      assert(body.context.opt === true)
+      assert(body.traits.trait === true)
+      assert(body.timestamp)
+    })
+
+    it('should set traits with null id', async () => {
+      await analytics.group(null, { trait: true }, { opt: true })
+
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/group"`
+      )
+
+      const body = JSON.parse(params.body)
+
+      assert(body.groupId === null)
+      assert(body.context.opt === true)
+      assert(body.traits.trait === true)
+      assert(!body.context.trait)
+      assert(body.timestamp)
+    })
+  })
+
+  describe('#alias', () => {
+    it('should enqueue .userId and .previousId', async () => {
+      await analytics.alias('to', 'from')
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/alias"`
+      )
+
+      const body = JSON.parse(params.body)
+      assert(body.previousId === 'from')
+      assert(body.userId === 'to')
+      assert(body.timestamp)
+    })
+
+    it('should fallback to user.anonymousId if .previousId is omitted', async () => {
+      analytics.user().anonymousId('anon-id')
+      await analytics.alias('to')
+
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/alias"`
+      )
+
+      const body = JSON.parse(params.body)
+      assert(body.previousId === 'anon-id')
+      assert(body.userId === 'to')
+      assert(body.timestamp)
+    })
+
+    it('should fallback to user.anonymousId if .previousId and user.id are falsey', async () => {
+      await analytics.alias('to')
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/alias"`
+      )
+
+      const body = JSON.parse(params.body)
+      assert(body.previousId)
+      assert(body.previousId.length === 36)
+      assert(body.userId === 'to')
+    })
+
+    it('should rename `.from` and `.to` to `.previousId` and `.userId`', async () => {
+      await analytics.alias('user-id', 'previous-id')
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/alias"`
+      )
+
+      const body = JSON.parse(params.body)
+      assert(body.previousId === 'previous-id')
+      assert(body.userId === 'user-id')
+      assert(body.from == null)
+      assert(body.to == null)
+    })
+  })
+
+  describe('#screen', () => {
+    it('should enqueue section, name and properties', async () => {
+      await analytics.screen(
+        'section',
+        'name',
+        { property: true },
+        { opt: true }
+      )
+
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/screen"`
+      )
+
+      const body = JSON.parse(params.body)
+
+      assert(body.name === 'name')
+      assert(body.category === 'section')
+      assert(body.properties.property === true)
+      assert(body.context.opt === true)
+      assert(body.timestamp)
+    })
+
+    it('sets properties when name and category are null', async () => {
+      // @ts-ignore test a valid ajsc page call
+      await analytics.screen(null, { foo: 'bar' })
+
+      const [url, params] = spyMock.mock.calls[0]
+      expect(url).toMatchInlineSnapshot(
+        `"https://us-east-1.hightouch-events.com/v1/screen"`
+      )
+
+      const body = JSON.parse(params.body)
+
+      assert(body.properties.foo === 'bar')
+    })
+  })
+})