make fetch priority and headers configurable

.changeset/chilly-mugs-applaud.md

@@ -0,0 +1,5 @@
+---
+'@segment/analytics-core': patch
+---
+
+Fix integration type

.changeset/heavy-taxis-suffer.md

@@ -0,0 +1,23 @@
+---
+'@segment/analytics-next': minor
+---
+Add new `headers` setting, along with `fetchPriority`.
+
+```ts
+analytics.load("<YOUR_WRITE_KEY>",
+  {
+    integrations: {
+      'Segment.io': {
+        deliveryStrategy: {
+          strategy: "standard" // also works for 'batching'
+          config: {
+            headers: { 'x-api-key': 'foo' } or () => {...}
+            fetchPriority: 'low' | 'high', // new setting
+          },
+        },
+      },
+    },
+  }
+)
+
+```

packages/browser/src/browser/__tests__/integration.test.ts

@@ -1533,3 +1533,37 @@ describe('Options', () => {
     })
   })
 })
+
+describe('setting headers', () => {
+  it('allows setting headers', async () => {
+    const [ajs] = await AnalyticsBrowser.load(
+      {
+        writeKey,
+      },
+      {
+        integrations: {
+          'Segment.io': {
+            deliveryStrategy: {
+              config: {
+                headers: {
+                  'X-Test': 'foo',
+                },
+              },
+            },
+          },
+        },
+      }
+    )
+
+    await ajs.track('sup')
+
+    await sleep(10)
+    const [call] = fetchCalls.filter((el) =>
+      el.url.toString().includes('api.segment.io')
+    )
+    expect(call.headers).toEqual({
+      'Content-Type': 'text/plain',
+      'X-Test': 'foo',
+    })
+  })
+})

packages/browser/src/browser/index.ts

@@ -301,7 +301,7 @@ async function registerPlugins(
     basePlugins.push(
       await segmentio(
         analytics,
-        mergedSettings['Segment.io'] as SegmentioSettings,
+        mergedSettings['Segment.io'],
         cdnSettings.integrations
       )
     )

packages/browser/src/core/analytics/index.ts

@@ -18,7 +18,7 @@ import { Emitter } from '@segment/analytics-generic-utils'
 import {
   Callback,
   EventFactory,
-  Integrations,
+  IntegrationsOptions,
   Plan,
   EventProperties,
   SegmentEvent,
@@ -135,7 +135,7 @@ export interface InitOptions {
   storage?: StorageSettings
   user?: UserOptions
   group?: UserOptions
-  integrations?: Integrations
+  integrations?: IntegrationsOptions
   plan?: Plan
   retryQueue?: boolean
   obfuscate?: boolean
@@ -197,7 +197,7 @@ export class Analytics
   private _universalStorage: UniversalStorage
 
   initialized = false
-  integrations: Integrations
+  integrations: IntegrationsOptions
   options: InitOptions
   queue: EventQueue
 

packages/browser/src/core/events/index.ts

@@ -2,7 +2,7 @@ import { v4 as uuid } from '@lukeed/uuid'
 import { ID, User } from '../user'
 import {
   Options,
-  Integrations,
+  IntegrationsOptions,
   EventProperties,
   Traits,
   SegmentEvent,
@@ -53,7 +53,7 @@ export class EventFactory extends CoreEventFactory {
     event: string,
     properties?: EventProperties,
     options?: Options,
-    globalIntegrations?: Integrations,
+    globalIntegrations?: IntegrationsOptions,
     pageCtx?: PageContext
   ): SegmentEvent {
     const ev = super.track(event, properties, options, globalIntegrations)
@@ -66,7 +66,7 @@ export class EventFactory extends CoreEventFactory {
     page: string | null,
     properties?: EventProperties,
     options?: Options,
-    globalIntegrations?: Integrations,
+    globalIntegrations?: IntegrationsOptions,
     pageCtx?: PageContext
   ): SegmentEvent {
     const ev = super.page(
@@ -85,7 +85,7 @@ export class EventFactory extends CoreEventFactory {
     screen: string | null,
     properties?: EventProperties,
     options?: Options,
-    globalIntegrations?: Integrations,
+    globalIntegrations?: IntegrationsOptions,
     pageCtx?: PageContext
   ): SegmentEvent {
     const ev = super.screen(
@@ -103,7 +103,7 @@ export class EventFactory extends CoreEventFactory {
     userId: ID,
     traits?: Traits,
     options?: Options,
-    globalIntegrations?: Integrations,
+    globalIntegrations?: IntegrationsOptions,
     pageCtx?: PageContext
   ): SegmentEvent {
     const ev = super.identify(userId, traits, options, globalIntegrations)
@@ -115,7 +115,7 @@ export class EventFactory extends CoreEventFactory {
     groupId: ID,
     traits?: Traits,
     options?: Options,
-    globalIntegrations?: Integrations,
+    globalIntegrations?: IntegrationsOptions,
     pageCtx?: PageContext
   ): SegmentEvent {
     const ev = super.group(groupId, traits, options, globalIntegrations)
@@ -127,7 +127,7 @@ export class EventFactory extends CoreEventFactory {
     to: string,
     from: string | null,
     options?: Options,
-    globalIntegrations?: Integrations,
+    globalIntegrations?: IntegrationsOptions,
     pageCtx?: PageContext
   ): SegmentEvent {
     const ev = super.alias(to, from, options, globalIntegrations)

packages/browser/src/core/events/interfaces.ts

@@ -2,7 +2,7 @@ import {
   CoreOptions,
   CoreSegmentEvent,
   Callback,
-  Integrations,
+  IntegrationsOptions,
   Plan,
   TrackPlan,
   PlanEvent,
@@ -24,7 +24,7 @@ export type EventProperties = Record<string, any>
 export interface SegmentEvent extends CoreSegmentEvent {}
 
 export type {
-  Integrations,
+  IntegrationsOptions,
   Plan,
   TrackPlan,
   PlanEvent,

packages/browser/src/lib/merged-options.ts

@@ -1,4 +1,4 @@
-import { JSONObject, Options } from '../core/events/interfaces'
+import { Options } from '../core/events/interfaces'
 import { CDNSettings } from '../browser'
 
 /**
@@ -13,7 +13,7 @@ import { CDNSettings } from '../browser'
 export function mergedOptions(
   cdnSettings: CDNSettings,
   options: Options
-): Record<string, JSONObject> {
+): Record<string, any> {
   const optionOverrides = Object.entries(options.integrations ?? {}).reduce(
     (overrides, [integration, options]) => {
       if (typeof options === 'object') {
@@ -28,7 +28,7 @@ export function mergedOptions(
         [integration]: {},
       }
     },
-    {} as Record<string, JSONObject>
+    {} as Record<string, any>
   )
 
   return Object.entries(cdnSettings.integrations).reduce(
@@ -41,6 +41,6 @@ export function mergedOptions(
         },
       }
     },
-    {} as Record<string, JSONObject>
+    {} as Record<string, any>
   )
 }

packages/browser/src/plugins/ajs-destination/index.ts

@@ -1,4 +1,4 @@
-import { Integrations, JSONObject } from '../../core/events'
+import { IntegrationsOptions, JSONObject } from '../../core/events'
 import { Alias, Facade, Group, Identify, Page, Track } from '@segment/facade'
 import { Analytics, InitOptions } from '../../core/analytics'
 import { CDNSettings } from '../../browser'
@@ -332,7 +332,7 @@
 export function ajsDestinations(
   writeKey: string,
   settings: CDNSettings,
-  globalIntegrations: Integrations = {},
+  globalIntegrations: IntegrationsOptions = {},
   options: InitOptions = {},
   routingMiddleware?: DestinationMiddlewareFunction,
   legacyIntegrationSources?: ClassicIntegrationSource[]

packages/browser/src/plugins/ajs-destination/utils.ts

@@ -1,4 +1,4 @@
-import { Integrations } from '@segment/analytics-core'
+import { IntegrationsOptions } from '@segment/analytics-core'
 import { RemoteIntegrationSettings } from '../..'
 
 export const isInstallableIntegration = (
@@ -20,7 +20,7 @@
 
 export const isDisabledIntegration = (
   integrationName: string,
-  globalIntegrations: Integrations
+  globalIntegrations: IntegrationsOptions
 ) => {
   const allDisableAndNotDefined =
     globalIntegrations.All === false &&

packages/browser/src/plugins/remote-loader/index.ts

@@ -1,4 +1,4 @@
-import type { Integrations } from '../../core/events/interfaces'
+import type { IntegrationsOptions } from '../../core/events/interfaces'
 import { CDNSettings } from '../../browser'
 import { JSONObject, JSONValue } from '../../core/events'
 import { Plugin, InternalPluginWithAddMiddleware } from '../../core/plugin'
@@ -198,7 +198,7 @@
 }
 
 function isPluginDisabled(
-  userIntegrations: Integrations,
+  userIntegrations: IntegrationsOptions,
   remotePlugin: RemotePlugin
 ) {
   const creationNameEnabled = userIntegrations[remotePlugin.creationName]
@@ -260,7 +260,7 @@
 
 export async function remoteLoader(
   settings: CDNSettings,
-  userIntegrations: Integrations,
+  userIntegrations: IntegrationsOptions,
   mergedIntegrations: Record<string, JSONObject>,
   options?: InitOptions,
   routingMiddleware?: DestinationMiddlewareFunction,
@@ -281,9 +281,10 @@
           ) || (await loadPluginFactory(remotePlugin, options?.obfuscate))
 
         if (pluginFactory) {
+          const intg = mergedIntegrations[remotePlugin.name]
           const plugin = await pluginFactory({
             ...remotePlugin.settings,
-            ...mergedIntegrations[remotePlugin.name],
+            ...intg,
           })
           const plugins = Array.isArray(plugin) ? plugin : [plugin]
 

packages/browser/src/plugins/segmentio/__tests__/index.test.ts

@@ -65,7 +65,95 @@ describe('Segment.io', () => {
     })
   })
 
-  describe('configuring a keep alive', () => {
+  describe('configuring headers', () => {
+    it('should accept additional headers', async () => {
+      const analytics = new Analytics({ writeKey: 'foo' })
+
+      await analytics.register(
+        await segmentio(analytics, {
+          apiKey: '',
+          deliveryStrategy: {
+            config: {
+              headers: {
+                'X-My-Header': 'foo',
+              },
+            },
+          },
+        })
+      )
+
+      await analytics.track('foo')
+      const [_, params] = spyMock.mock.lastCall
+      expect(params.headers['X-My-Header']).toBe('foo')
+      expect(params.headers['Content-Type']).toBe('text/plain')
+    })
+
+    it('should allow additional headers to be a function', async () => {
+      const analytics = new Analytics({ writeKey: 'foo' })
+
+      await analytics.register(
+        await segmentio(analytics, {
+          apiKey: '',
+          deliveryStrategy: {
+            config: {
+              headers: () => ({
+                'X-My-Header': 'foo',
+              }),
+            },
+          },
+        })
+      )
+
+      await analytics.track('foo')
+      const [_, params] = spyMock.mock.lastCall
+      expect(params.headers['X-My-Header']).toBe('foo')
+      expect(params.headers['Content-Type']).toBe('text/plain')
+    })
+
+    it('should allow content type to be overridden', async () => {
+      const analytics = new Analytics({ writeKey: 'foo' })
+
+      await analytics.register(
+        await segmentio(analytics, {
+          apiKey: '',
+          deliveryStrategy: {
+            config: {
+              headers: () => ({
+                'Content-Type': 'bar',
+              }),
+            },
+          },
+        })
+      )
+
+      await analytics.track('foo')
+      const [_, params] = spyMock.mock.lastCall
+      expect(params.headers['Content-Type']).toBe('bar')
+    })
+  })
+
+  describe('configuring fetch priority', () => {
+    it('should accept fetch priority configuration', async () => {
+      const analytics = new Analytics({ writeKey: 'foo' })
+
+      await analytics.register(
+        await segmentio(analytics, {
+          apiKey: '',
+          deliveryStrategy: {
+            config: {
+              fetchPriority: 'high',
+            },
+          },
+        })
+      )
+
+      await analytics.track('foo')
+      const [_, params] = spyMock.mock.lastCall
+      expect(params.priority).toBe('high')
+    })
+  })
+
+  describe('configuring keepalive', () => {
     it('should accept keepalive configuration', async () => {
       const analytics = new Analytics({ writeKey: 'foo' })