Allow the request "credentials" option to be configured (#1262)

Author: vbetivu-ellation

.changeset/plenty-camels-accept.md

@@ -0,0 +1,5 @@
+---
+'@segment/analytics-next': minor
+---
+
+Add the possibility to configure the Request "credentials" option. Currently, the library only uses the default "same-site" value, which does not include cookies for cross-origin requests.

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

@@ -97,6 +97,7 @@ describe('Batching', () => {
         "https://https://api.segment.io/b",
         {
           "body": "{"batch":[{"event":"first"},{"event":"second"},{"event":"third"}],"sentAt":"1993-06-09T00:00:00.000Z"}",
+          "credentials": undefined,
           "headers": {
             "Content-Type": "text/plain",
           },
@@ -181,6 +182,7 @@ describe('Batching', () => {
         "https://https://api.segment.io/b",
         {
           "body": "{"batch":[{"event":"first"},{"event":"second"}],"sentAt":"1993-06-09T00:00:10.000Z"}",
+          "credentials": undefined,
           "headers": {
             "Content-Type": "text/plain",
           },
@@ -217,6 +219,7 @@ describe('Batching', () => {
         "https://https://api.segment.io/b",
         {
           "body": "{"batch":[{"event":"first"}],"sentAt":"1993-06-09T00:00:10.000Z"}",
+          "credentials": undefined,
           "headers": {
             "Content-Type": "text/plain",
           },
@@ -232,6 +235,7 @@ describe('Batching', () => {
         "https://https://api.segment.io/b",
         {
           "body": "{"batch":[{"event":"second"}],"sentAt":"1993-06-09T00:00:21.000Z"}",
+          "credentials": undefined,
           "headers": {
             "Content-Type": "text/plain",
           },
@@ -264,6 +268,7 @@ describe('Batching', () => {
         "https://https://api.segment.io/b",
         {
           "body": "{"batch":[{"event":"first"},{"event":"second"}],"sentAt":"1993-06-09T00:00:00.000Z"}",
+          "credentials": undefined,
           "headers": {
             "Content-Type": "text/plain",
           },

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

@@ -74,6 +74,27 @@ describe('Segment.io', () => {
     })
   })
 
+  describe('configuring fetch credentials', () => {
+    it('should accept fetch credentials configuration', async () => {
+      const analytics = new Analytics({ writeKey: 'foo' })
+
+      await analytics.register(
+        await segmentio(analytics, {
+          apiKey: '',
+          deliveryStrategy: {
+            config: {
+              credentials: 'include',
+            },
+          },
+        })
+      )
+
+      await analytics.track('foo')
+      const [_, params] = spyMock.mock.lastCall
+      expect(params.credentials).toBe('include')
+    })
+  })
+
   describe('configuring headers', () => {
     it('should accept additional headers', async () => {
       const analytics = new Analytics({ writeKey: 'foo' })

packages/browser/src/plugins/segmentio/batched-dispatcher.ts

@@ -77,6 +77,7 @@ export default function batch(
     })
 
     return fetch(`https://${apiHost}/b`, {
+      credentials: config?.credentials,
       keepalive: config?.keepalive || pageUnloaded,
       headers: createHeaders(config?.headers),
       method: 'post',

packages/browser/src/plugins/segmentio/fetch-dispatcher.ts

@@ -8,6 +8,7 @@ export default function (config?: StandardDispatcherConfig): {
 } {
   function dispatch(url: string, body: object): Promise<unknown> {
     return fetch(url, {
+      credentials: config?.credentials,
       keepalive: config?.keepalive,
       headers: createHeaders(config?.headers),
       method: 'post',

packages/browser/src/plugins/segmentio/shared-dispatcher.ts

@@ -19,12 +19,19 @@ export type AdditionalHeaders =
   | (() => Record<string, string>)
 
 export type RequestPriority = 'high' | 'low' | 'auto'
+export type RequestCredentials = 'include' | 'same-origin' | 'omit'
 
 /**
  * These are the options that can be passed to the fetch dispatcher.
  * They more/less map to the Fetch RequestInit type.
  */
 interface DispatchFetchConfig {
+  /**
+   * Request credentials configuration
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials
+   */
+  credentials?: RequestCredentials
   /**
    * This is useful for ensuring that an event is sent even if the user navigates away from the page.
    * However, it may increase the likelihood of events being lost, as there is a 64kb limit for *all* fetch requests (not just ones to segment) with keepalive (which is why it's disabled by default). So, if you're sending a lot of data, this will likely cause events to be dropped.