feat(core): adds flag to allow analytics.ready() to run even if plugin fails on ready

Author: rmachado-studocu

.changeset/rare-pillows-warn.md

@@ -0,0 +1,6 @@
+---
+'@segment/analytics-next': minor
+---
+
+Adds a new option `ignorePluginReadyError` which prevents `analytics.ready` failure when a plugin fails to be ready.
+Also adds another option `onPluginReadyError` which allows developers to handle the plugin failures at ready stage.

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

@@ -207,6 +207,58 @@ describe('Initialization', () => {
     expect(ready).toHaveBeenCalled()
   })
 
+  it('ready method is called plugin errors on ready and `runReadyOnIntegrationError` is true', async () => {
+    const ready = jest.fn()
+    const onPluginReadyError = jest.fn()
+
+    const lazyPlugin1: Plugin = {
+      name: 'Test 2',
+      type: 'destination',
+      version: '1.0',
+
+      load: async (_ctx) => {},
+      ready: async () => {
+        return new Promise((resolve) => setTimeout(resolve, 100))
+      },
+      isLoaded: () => true,
+    }
+
+    const lazyPlugin2: Plugin = {
+      name: 'Test 2',
+      type: 'destination',
+      version: '1.0',
+
+      load: async (_ctx) => {},
+      ready: () => Promise.reject('failed readying'),
+      isLoaded: () => true,
+    }
+
+    jest.spyOn(lazyPlugin1, 'load')
+    jest.spyOn(lazyPlugin2, 'load')
+    const [analytics] = await AnalyticsBrowser.load(
+      {
+        writeKey,
+        plugins: [lazyPlugin1, lazyPlugin2, xt],
+      },
+      {
+        onPluginReadyError,
+        ignorePluginReadyError: true,
+      }
+    )
+
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    const promise = analytics.ready(ready)
+    expect(lazyPlugin1.load).toHaveBeenCalled()
+    expect(lazyPlugin2.load).toHaveBeenCalled()
+    expect(ready).not.toHaveBeenCalled()
+
+    await sleep(100)
+    expect(ready).toHaveBeenCalled()
+    expect(onPluginReadyError).toHaveBeenCalledTimes(1)
+
+    return promise
+  })
+
   describe('cdn', () => {
     it('should get the correct CDN in plugins if the CDN overridden', async () => {
       const overriddenCDNUrl = 'http://cdn.segment.com' // http instead of https

packages/browser/src/browser/settings.ts

@@ -224,6 +224,13 @@ export interface InitOptions {
   plan?: Plan
   retryQueue?: boolean
   obfuscate?: boolean
+
+  /** Enables the possibility to trigger .ready() even in case some integrations fail */
+  ignorePluginReadyError?: boolean
+
+  /** Error handling function for when an integration fails */
+  onPluginReadyError?: (error: Error) => Promise<void>
+
   /**
    * This callback allows you to update/mutate CDN Settings.
    * This is called directly after settings are fetched from the CDN.

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

@@ -534,6 +534,24 @@ export class Analytics
   async ready(
     callback: Function = (res: Promise<unknown>[]): Promise<unknown>[] => res
   ): Promise<unknown> {
+    if (this.options.ignorePluginReadyError) {
+      return Promise.allSettled(
+        this.queue.plugins.map((i) =>
+          i.ready
+            ? i.ready().catch(this.options.onPluginReadyError)
+            : Promise.resolve()
+        )
+      ).then((results) => {
+        const res = results.map((result) => {
+          if (result.status === 'fulfilled') {
+            return result.value
+          }
+        })
+        callback(res)
+        return res
+      })
+    }
+
     return Promise.all(
       this.queue.plugins.map((i) => (i.ready ? i.ready() : Promise.resolve()))
     ).then((res) => {