@ht-sdks/events-sdk-js-browser 1.0.4

package/src/test-helpers/fixtures/cdn-settings.ts

@@ -0,0 +1,301 @@
+import { AnalyticsBrowserSettings } from '../..'
+import { mockIntegrationName } from './classic-destination'
+
+type CDNSettings = NonNullable<AnalyticsBrowserSettings['cdnSettings']>
+
+export const cdnSettingsKitchenSink: CDNSettings = {
+  integrations: {
+    [mockIntegrationName]: {},
+    'Customer.io': {
+      siteId: 'abc123foofixture', // overwritten
+      versionSettings: {
+        version: '2.2.3',
+        componentTypes: ['browser', 'server'],
+      },
+      type: 'browser',
+      bundlingStatus: 'bundled',
+    },
+    FullStory: {
+      debug: false,
+      org: 'se',
+      trackAllPages: false,
+      trackCategorizedPages: false,
+      trackNamedPages: false,
+      versionSettings: {
+        version: '3.0.1',
+        componentTypes: ['browser'],
+      },
+      type: 'browser',
+      bundlingStatus: 'bundled',
+    },
+    'Google Analytics': {
+      anonymizeIp: false,
+      classic: false,
+      contentGroupings: {},
+      dimensions: {},
+      domain: '',
+      doubleClick: false,
+      enableServerIdentify: false,
+      enhancedEcommerce: false,
+      enhancedLinkAttribution: false,
+      identifyCategory: '',
+      identifyEventName: '',
+      ignoredReferrers: [],
+      includeSearch: false,
+      metrics: {},
+      mobileTrackingId: '',
+      nameTracker: false,
+      nonInteraction: false,
+      optimize: '',
+      protocolMappings: {},
+      reportUncaughtExceptions: false,
+      resetCustomDimensionsOnPage: [],
+      sampleRate: 100,
+      sendUserId: false,
+      setAllMappedProps: true,
+      siteSpeedSampleRate: 1,
+      trackCategorizedPages: true,
+      trackNamedPages: true,
+      trackingId: 'UA-970334309-1',
+      useGoogleAmpClientId: false,
+      versionSettings: {
+        version: '2.18.5',
+        componentTypes: ['browser', 'ios', 'android', 'server'],
+      },
+      type: 'browser',
+      bundlingStatus: 'unbundled',
+    },
+    'Hightouch.io': {
+      apiKey: 'D8frB7upBChqDN9PMWksNvZYDaKJIYo6',
+      unbundledIntegrations: ['Google Analytics'],
+      addBundledMetadata: true,
+      maybeBundledConfigIds: {
+        'Customer.io': ['60104dde8882b933c2006d1f'],
+        FullStory: ['6010547f5a1d4d46c418d68e'],
+      },
+      versionSettings: {
+        version: '4.4.7',
+        componentTypes: ['browser'],
+      },
+    },
+  },
+  plan: {
+    track: {
+      __default: {
+        enabled: true,
+        integrations: {},
+      },
+    },
+    identify: {
+      __default: {
+        enabled: true,
+      },
+      address: {
+        enabled: true,
+      },
+      avatar: {
+        enabled: true,
+      },
+      bs: {
+        enabled: true,
+      },
+      bsAdjective: {
+        enabled: true,
+      },
+      bsBuzz: {
+        enabled: true,
+      },
+      bsNoun: {
+        enabled: true,
+      },
+      catchPhrase: {
+        enabled: true,
+      },
+      catchPhraseAdjective: {
+        enabled: true,
+      },
+      catchPhraseDescriptor: {
+        enabled: true,
+      },
+      catchPhraseNoun: {
+        enabled: true,
+      },
+      color: {
+        enabled: true,
+      },
+      company: {
+        enabled: true,
+      },
+      companyName: {
+        enabled: true,
+      },
+      companySuffix: {
+        enabled: true,
+      },
+      custom: {
+        enabled: true,
+      },
+      department: {
+        enabled: true,
+      },
+      domainName: {
+        enabled: true,
+      },
+      domainSuffix: {
+        enabled: true,
+      },
+      domainWord: {
+        enabled: true,
+      },
+      email: {
+        enabled: true,
+      },
+      exampleEmail: {
+        enabled: true,
+      },
+      findName: {
+        enabled: true,
+      },
+      firstName: {
+        enabled: true,
+      },
+      gender: {
+        enabled: true,
+      },
+      id: {
+        enabled: true,
+      },
+      ip: {
+        enabled: true,
+      },
+      ipv6: {
+        enabled: true,
+      },
+      jobArea: {
+        enabled: true,
+      },
+      jobDescriptor: {
+        enabled: true,
+      },
+      jobTitle: {
+        enabled: true,
+      },
+      jobType: {
+        enabled: true,
+      },
+      lastName: {
+        enabled: true,
+      },
+      mac: {
+        enabled: true,
+      },
+      name: {
+        enabled: true,
+      },
+      person: {
+        enabled: true,
+      },
+      phone: {
+        enabled: true,
+      },
+      prefix: {
+        enabled: true,
+      },
+      price: {
+        enabled: true,
+      },
+      product: {
+        enabled: true,
+      },
+      productAdjective: {
+        enabled: true,
+      },
+      productDescription: {
+        enabled: true,
+      },
+      productMaterial: {
+        enabled: true,
+      },
+      productName: {
+        enabled: true,
+      },
+      protocol: {
+        enabled: true,
+      },
+      suffix: {
+        enabled: true,
+      },
+      suffixes: {
+        enabled: true,
+      },
+      title: {
+        enabled: true,
+      },
+      url: {
+        enabled: true,
+      },
+      userAgent: {
+        enabled: true,
+      },
+      userName: {
+        enabled: true,
+      },
+      username: {
+        enabled: true,
+      },
+      website: {
+        enabled: true,
+      },
+    },
+    group: {
+      __default: {
+        enabled: true,
+      },
+      coolKids: {
+        enabled: true,
+      },
+    },
+  },
+  middlewareSettings: {
+    routingRules: [
+      {
+        matchers: [
+          {
+            ir: '["and",["=","event",{"value":"munanyo"}],["and",["=","type",{"value":"track"}],["=","properties.referrer",{"value":"munyaaaanyo"}]]]',
+            type: 'fql',
+            config: {
+              expr: 'event = "munanyo" and type = "track" and properties.referrer = "munyaaaanyo"',
+            },
+          },
+        ],
+        scope: 'destinations',
+        target_type: 'workspace::project::destination::config',
+        transformers: [
+          [
+            {
+              type: 'drop_properties',
+              config: {
+                drop: {
+                  properties: ['url'],
+                },
+              },
+            },
+          ],
+        ],
+        destinationName: 'Google Analytics',
+      },
+    ],
+  },
+  enabledMiddleware: {},
+  metrics: {
+    sampleRate: 0.1,
+  },
+  legacyVideoPluginsEnabled: true,
+  remotePlugins: [],
+}
+
+export const cdnSettingsMinimal: CDNSettings = {
+  integrations: {
+    [mockIntegrationName]: {},
+  },
+}

package/src/test-helpers/fixtures/classic-destination.ts

@@ -0,0 +1,25 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/**
+ * This is a classic destination, such as:
+ * https://github.com/segmentio/analytics.js-integrations/blob/master/integrations/appcues/lib/index.js
+ */
+
+const integration = require('@segment/analytics.js-integration')
+
+export const mockIntegrationName = 'Fake'
+export const Fake = integration(mockIntegrationName)
+
+Fake.prototype.initialize = function () {
+  this.load(this.ready)
+}
+
+Fake.prototype.loaded = function () {
+  return true
+}
+
+Fake.prototype.track = function () {}
+
+Fake.prototype.load = function (callback: Function) {
+  // this callback is important to actually initialize.
+  callback()
+}

package/src/test-helpers/fixtures/client-hints.ts

@@ -0,0 +1,28 @@
+import {
+  UADataValues,
+  UALowEntropyJSON,
+} from '../../lib/client-hints/interfaces'
+
+export const lowEntropyTestData: UALowEntropyJSON = {
+  brands: [
+    {
+      brand: 'Google Chrome',
+      version: '113',
+    },
+    {
+      brand: 'Chromium',
+      version: '113',
+    },
+    {
+      brand: 'Not-A.Brand',
+      version: '24',
+    },
+  ],
+  mobile: false,
+  platform: 'macOS',
+}
+
+export const highEntropyTestData: UADataValues = {
+  architecture: 'x86',
+  bitness: '64',
+}

package/src/test-helpers/fixtures/create-fetch-method.ts

@@ -0,0 +1,30 @@
+import { LegacySettings } from '../..'
+import { createSuccess } from '../factories'
+import { cdnSettingsMinimal } from './cdn-settings'
+
+export const createMockFetchImplementation = (
+  cdnSettings: Partial<LegacySettings> = cdnSettingsMinimal
+) => {
+  return (...[url, req]: Parameters<typeof fetch>) => {
+    const reqUrl = url.toString()
+    if (
+      !req ||
+      (req.method === 'get' && reqUrl.includes('cdn.hightouch-events.com'))
+    ) {
+      // GET https://cdn.hightouch-events.com/v1/projects/{writeKey}
+      return createSuccess({ ...cdnSettingsMinimal, ...cdnSettings })
+    }
+
+    if (
+      req?.method === 'post' &&
+      reqUrl.includes('us-east-1.hightouch-events.com')
+    ) {
+      // POST https://us-east-1.hightouch-events.com/v1/{event.type}
+      return createSuccess({ success: true }, { status: 201 })
+    }
+
+    throw new Error(
+      `no match found for request (url:${url}, req:${JSON.stringify(req)})`
+    )
+  }
+}

package/src/test-helpers/fixtures/index.ts

@@ -0,0 +1,4 @@
+export * from './page-context'
+export * from './create-fetch-method'
+export * from './classic-destination'
+export * from './cdn-settings'

package/src/test-helpers/fixtures/page-context.ts

@@ -0,0 +1,11 @@
+import {
+  BufferedPageContext,
+  getDefaultBufferedPageContext,
+  getDefaultPageContext,
+  PageContext,
+} from '../../core/page'
+
+export const getPageCtxFixture = (): PageContext => getDefaultPageContext()
+
+export const getBufferedPageCtxFixture = (): BufferedPageContext =>
+  getDefaultBufferedPageContext()

package/src/test-helpers/test-writekeys.ts

@@ -0,0 +1,5 @@
+// Writekeys that are used in different unit/integration tests. These writekeys
+// were created for the purpose of testing AJS and are not used for anything else.
+
+export const TEST_WRITEKEY = 'D8frB7upBChqDN9PMWksNvZYDaKJIYo6' // Test segment writekey
+export const AMPLITUDE_WRITEKEY = 'c56fd8ca27d0f9adfe8ad78d846dfcc8' // Test amplitude writekey

package/src/test-helpers/type-assertions.ts

@@ -0,0 +1,11 @@
+type IsAny<T> = unknown extends T ? (T extends {} ? T : never) : never
+type NotAny<T> = T extends IsAny<T> ? never : T
+type NotUnknown<T> = unknown extends T ? never : T
+
+type NotTopType<T> = NotAny<T> & NotUnknown<T>
+
+// this is not meant to be run, just for type tests
+export function assertNotAny<T>(_val: NotTopType<T>) {}
+
+// this is not meant to be run, just for type tests
+export function assertIs<T extends SomeType, SomeType = any>(_val: T) {}