fix: format integration settings correctly in the event integrations

Co-authored-by: Alan Charles <alancharles@Alans-MacBook-Pro-2.local>
Co-authored-by: Oscar Bazaldua <511911+oscb@users.noreply.github.com>

Author: 3 people

packages/core/src/__tests__/internal/fetchSettings.test.ts

@@ -30,7 +30,7 @@ describe('internal #getSettings', () => {
   });
 
   it('fetches the settings succesfully ', async () => {
-    const mockJSONResponse = { foo: 'bar' };
+    const mockJSONResponse = { integrations: { foo: 'bar' } };
     const mockResponse = Promise.resolve({
       json: () => mockJSONResponse,
     });
@@ -43,10 +43,10 @@ describe('internal #getSettings', () => {
       'https://cdn-settings.segment.com/v1/projects/123-456/settings'
     );
 
-    expect(setSettingsSpy).toHaveBeenCalledWith(mockJSONResponse);
-    expect(store.settings.get()).toEqual(mockJSONResponse);
+    expect(setSettingsSpy).toHaveBeenCalledWith(mockJSONResponse.integrations);
+    expect(store.settings.get()).toEqual(mockJSONResponse.integrations);
     expect(client.settings.get()).toEqual({
-      ...mockJSONResponse,
+      ...mockJSONResponse.integrations,
     });
   });
 

packages/core/src/analytics.ts

@@ -239,8 +239,9 @@ export class SegmentClient {
     try {
       const res = await fetch(settingsEndpoint);
       const resJson = await res.json();
+      const integrations = resJson.integrations;
       this.logger.info(`Received settings from Segment succesfully.`);
-      this.store.settings.set(resJson);
+      this.store.settings.set(integrations);
     } catch {
       this.logger.warn(
         `Could not receive settings from Segment. ${

packages/core/src/plugins/SegmentDestination.ts

@@ -29,20 +29,20 @@ export class SegmentDestination extends DestinationPlugin {
     // Disable all destinations that have a device mode plugin
     const deviceModePlugins =
       plugins?.map((plugin) => (plugin as DestinationPlugin).key) ?? [];
-    const cloudSettings: SegmentAPIIntegrations = {
-      ...pluginSettings,
-    };
-    for (const key of deviceModePlugins) {
-      if (key in cloudSettings) {
-        cloudSettings[key] = false;
+    const disabledCloudIntegrations: SegmentAPIIntegrations = {};
+    if (pluginSettings !== undefined) {
+      for (const key of deviceModePlugins) {
+        if (key in pluginSettings) {
+          disabledCloudIntegrations[key] = false;
+        }
       }
     }
 
     // User/event defined integrations override the cloud/device mode merge
     const mergedEvent = {
       ...event,
       integrations: {
-        ...cloudSettings,
+        ...disabledCloudIntegrations,
         ...event?.integrations,
       },
     };

packages/core/src/timeline.ts

@@ -26,9 +26,21 @@ export class Timeline {
       this.plugins[type] = [plugin];
     }
     const settings = plugin.analytics?.settings.get();
-    if (settings) {
+    let hasInitialSettings = false;
+    if (settings !== undefined) {
       plugin.update({ integrations: settings }, UpdateType.initial);
+      hasInitialSettings = true;
     }
+
+    plugin.analytics?.settings.onChange((newSettings) => {
+      if (newSettings !== undefined) {
+        plugin.update(
+          { integrations: newSettings },
+          hasInitialSettings ? UpdateType.refresh : UpdateType.initial
+        );
+        hasInitialSettings = true;
+      }
+    });
   }
 
   remove(plugin: Plugin) {

packages/plugins/plugin-amplitudeSession/src/AmplitudeSessionPlugin.tsx

@@ -78,14 +78,12 @@ export class AmplitudeSessionPlugin extends EventPlugin {
   private insertSession = (event: SegmentEvent) => {
     const returnEvent = event;
     const integrations = event.integrations;
-    if (integrations) {
-      returnEvent.integrations = {
-        ...integrations,
-        [this.key]: {
-          session_id: this.sessionId,
-        },
-      };
-    }
+    returnEvent.integrations = {
+      ...integrations,
+      [this.key]: {
+        session_id: this.sessionId,
+      },
+    };
     return returnEvent;
   };