Support Regional endpoints returned via the CDN (#721)

* feat: add support for endpoint returned via the cdn

* feat: add support for endpoint returned via the cdn

* feat: add support for endpoint returned via the cdn

* feat: add support for endpoint returned via the cdn

* fix: fix e2e tests, update endpoints in constants

* fix: remove console.log from mock server

Co-authored-by: Niall Brennan <[email protected]>
Co-authored-by: Alan Charles <[email protected]>

Author: 3 people

packages/core/src/__tests__/api.test.ts

@@ -1,5 +1,4 @@
 import {
-  Config,
   Context,
   EventType,
   SegmentAPIIntegrations,
@@ -8,7 +7,6 @@ import {
 } from '../types';
 import { uploadEvents } from '../api';
 import * as context from '../context';
-import { batchApi } from '../constants';
 
 describe('#sendEvents', () => {
   beforeEach(() => {
@@ -28,7 +26,7 @@ describe('#sendEvents', () => {
       .mockReturnValue('2001-01-01T00:00:00.000Z');
   });
 
-  async function sendAnEventPer(config: Config, toUrl: string) {
+  async function sendAnEventPer(writeKey: string, toUrl: RequestInfo) {
     const mockResponse = Promise.resolve('MANOS');
     // @ts-ignore
     global.fetch = jest.fn(() => Promise.resolve(mockResponse));
@@ -59,7 +57,8 @@ describe('#sendEvents', () => {
     };
 
     await uploadEvents({
-      config,
+      writeKey,
+      url: toUrl,
       events: [event],
     });
 
@@ -78,19 +77,16 @@ describe('#sendEvents', () => {
   }
 
   it('sends an event', async () => {
-    const toSegmentBatchApi = batchApi;
-    const config = {
-      writeKey: 'SEGMENT_KEY',
-    };
-    await sendAnEventPer(config, toSegmentBatchApi);
+    const toSegmentBatchApi = 'https://api.segment.io/v1.b';
+    const writeKey = 'SEGMENT_KEY';
+
+    await sendAnEventPer(writeKey, toSegmentBatchApi);
   });
 
   it('sends an event to proxy', async () => {
     const toProxyUrl = 'https://myprox.io/b';
-    const config = {
-      writeKey: 'SEGMENT_KEY',
-      proxy: toProxyUrl,
-    };
-    await sendAnEventPer(config, toProxyUrl);
+    const writeKey = 'SEGMENT_KEY';
+
+    await sendAnEventPer(writeKey, toProxyUrl);
   });
 });

packages/core/src/api.ts

@@ -1,24 +1,24 @@
-import type { Config, SegmentEvent } from './types';
+import type { SegmentEvent } from './types';
 import { Base64 } from 'js-base64';
-import { batchApi } from './constants';
 
 export const uploadEvents = async ({
-  config,
+  writeKey,
+  url,
   events,
 }: {
-  config: Config;
+  writeKey: String;
+  url: RequestInfo;
   events: SegmentEvent[];
 }) => {
-  const requestUrl = config.proxy || batchApi;
-  return await fetch(requestUrl, {
+  return await fetch(url, {
     method: 'POST',
     body: JSON.stringify({
       batch: events,
       sentAt: new Date().toISOString(),
-      writeKey: config.writeKey,
+      writeKey: writeKey,
     }),
     headers: {
-      'Authorization': `Basic ${Base64.encode(`${config.writeKey}:`)}`,
+      'Authorization': `Basic ${Base64.encode(`${writeKey}:`)}`,
       'Content-Type': 'text/plain',
     },
   });

packages/core/src/constants.e2e.mock.ts

@@ -1,17 +1,15 @@
 import { Platform } from 'react-native';
 import type { Config } from '.';
 
-export const batchApi = Platform.select({
-  ios: 'http://localhost:9091/events',
-  android: 'http://10.0.2.2:9091/events',
-});
-
 export const settingsCDN = Platform.select({
   ios: 'http://localhost:9091/settings',
   android: 'http://10.0.2.2:9091/settings',
 });
 
-export const defaultApiHost = 'api.segment.io/v1';
+export const defaultApiHost = Platform.select({
+  ios: 'http://localhost:9091/events',
+  android: 'http://10.0.2.2:9091/events',
+});
 
 export const defaultConfig: Config = {
   writeKey: '',

packages/core/src/constants.ts

@@ -1,7 +1,6 @@
 import type { Config } from './types';
 
-export const batchApi = 'https://api.segment.io/v1/b';
-export const defaultApiHost = 'api.segment.io/v1';
+export const defaultApiHost = 'https://api.segment.io/v1/b';
 
 export const settingsCDN = 'https://cdn-settings.segment.com/v1/projects';
 

packages/core/src/plugins/SegmentDestination.ts

@@ -5,6 +5,7 @@ import { uploadEvents } from '../api';
 import type { SegmentClient } from '../analytics';
 import { DestinationMetadataEnrichment } from './DestinationMetadataEnrichment';
 import { QueueFlushingPlugin } from './QueueFlushingPlugin';
+import { defaultApiHost } from '../constants';
 import { checkResponseForErrors, translateHTTPError } from '../errors';
 
 const MAX_EVENTS_PER_BATCH = 100;
@@ -29,12 +30,14 @@ export class SegmentDestination extends DestinationPlugin {
 
     let sentEvents: SegmentEvent[] = [];
     let numFailedEvents = 0;
+    const config = this.analytics?.getConfig();
 
     await Promise.all(
       chunkedEvents.map(async (batch: SegmentEvent[]) => {
         try {
           const res = await uploadEvents({
-            config: this.analytics?.getConfig()!,
+            writeKey: config!.writeKey,
+            url: this.getEndpoint(),
             events: batch,
           });
           checkResponseForErrors(res);
@@ -64,6 +67,29 @@ export class SegmentDestination extends DestinationPlugin {
 
   private readonly queuePlugin = new QueueFlushingPlugin(this.sendEvents);
 
+  getEndpoint(): RequestInfo {
+    const config = this.analytics?.getConfig();
+    const settings = this.analytics?.settings.get();
+    let api;
+    let requestUrl;
+
+    if (
+      settings !== undefined &&
+      Object.keys(settings).includes(SEGMENT_DESTINATION_KEY)
+    ) {
+      const segmentInfo = settings[SEGMENT_DESTINATION_KEY] as Record<
+        string,
+        any
+      >;
+      if (segmentInfo.apiHost !== undefined && segmentInfo.apiHost !== null) {
+        api = `https://${segmentInfo.apiHost}/b`;
+      }
+    }
+
+    requestUrl = config?.proxy ?? api ?? defaultApiHost;
+    return requestUrl;
+  }
+
   configure(analytics: SegmentClient): void {
     super.configure(analytics);
 

packages/core/src/plugins/__tests__/SegmentDestination.test.ts

@@ -245,19 +245,15 @@ describe('SegmentDestination', () => {
 
     expect(sendEventsSpy).toHaveBeenCalledTimes(2);
     expect(sendEventsSpy).toHaveBeenCalledWith({
-      config: {
-        maxBatchSize: 2,
-        writeKey: '123-456',
-      },
+      writeKey: '123-456',
+      url: 'https://api.segment.io/v1/b',
       events: events.slice(0, 2).map((e) => ({
         ...e,
       })),
     });
     expect(sendEventsSpy).toHaveBeenCalledWith({
-      config: {
-        maxBatchSize: 2,
-        writeKey: '123-456',
-      },
+      writeKey: '123-456',
+      url: 'https://api.segment.io/v1/b',
       events: events.slice(2, 4).map((e) => ({
         ...e,
       })),