browser: refactor/remove asPromise (#686)

segmentio · Dec 2, 2022 · c5d2a99 · c5d2a99
1 parent db38bb3
commit c5d2a99
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 77 deletions.
diff --git a/packages/browser/src/core/callback/index.ts b/packages/browser/src/core/callback/index.ts
@@ -1,5 +1,4 @@
 import { Context } from '../context'
-import { asPromise } from '../../lib/as-promise'
 import { Callback } from '../events/interfaces'
 
 export function pTimeout(
@@ -34,7 +33,7 @@ export function invokeCallback(
 ): Promise<Context> {
   const cb = () => {
     try {
-      return asPromise(callback(ctx))
+      return Promise.resolve(callback(ctx))
     } catch (err) {
       return Promise.reject(err)
     }

diff --git a/packages/browser/src/lib/__tests__/as-promise.test.ts b/packages/browser/src/lib/__tests__/as-promise.test.ts
diff --git a/packages/browser/src/lib/as-promise.ts b/packages/browser/src/lib/as-promise.ts
diff --git a/packages/browser/src/plugins/ajs-destination/index.ts b/packages/browser/src/plugins/ajs-destination/index.ts
@@ -7,7 +7,6 @@ import { Context, ContextCancelation } from '../../core/context'
 import { isServer } from '../../core/environment'
 import { Plugin } from '../../core/plugin'
 import { attempt } from '../../core/queue/delivery'
-import { asPromise } from '../../lib/as-promise'
 import { isPlanEventEnabled } from '../../lib/is-plan-event-enabled'
 import { mergedOptions } from '../../lib/merged-options'
 import { pWhile } from '../../lib/p-while'
@@ -261,9 +260,7 @@ export class LegacyDestination implements Plugin {
 
     try {
       if (this.integration) {
-        await asPromise(
-          this.integration.invoke.call(this.integration, eventType, event)
-        )
+        await this.integration.invoke.call(this.integration, eventType, event)
       }
     } catch (err) {
       ctx.stats.increment('analytics_js.integration.invoke.error', 1, [

diff --git a/packages/browser/src/plugins/middleware/__tests__/index.test.ts b/packages/browser/src/plugins/middleware/__tests__/index.test.ts
@@ -6,7 +6,6 @@ import {
 import { Analytics } from '../../../core/analytics'
 import { Context } from '../../../core/context'
 import { Plugin } from '../../../core/plugin'
-import { asPromise } from '../../../lib/as-promise'
 import { LegacyDestination } from '../../ajs-destination'
 
 describe(sourceMiddlewarePlugin, () => {
@@ -91,15 +90,18 @@ describe(sourceMiddlewarePlugin, () => {
       expect(returnedCtx).toBe(toReturn)
 
       const toCancel = new Context({ type: 'track' })
-      await asPromise(hangsXT.track!(toCancel)).catch((err) => {
+      try {
+        await hangsXT.track!(toCancel)
+        throw new Error('should not reach here.')
+      } catch (err) {
         expect(err).toMatchInlineSnapshot(`
           ContextCancelation {
             "reason": "Middleware \`next\` function skipped",
             "retry": false,
             "type": "middleware_cancellation",
           }
         `)
-      })
+      }
     })
   })
 

diff --git a/packages/browser/src/plugins/middleware/index.ts b/packages/browser/src/plugins/middleware/index.ts
@@ -1,7 +1,6 @@
 import { Context, ContextCancelation } from '../../core/context'
 import { SegmentEvent } from '../../core/events'
 import { Plugin } from '../../core/plugin'
-import { asPromise } from '../../lib/as-promise'
 import { SegmentFacade, toFacade } from '../../lib/to-facade'
 
 export interface MiddlewareParams {
@@ -17,10 +16,13 @@ export interface DestinationMiddlewareParams {
   next: (payload: MiddlewareParams['payload'] | null) => void
 }
 
-export type MiddlewareFunction = (middleware: MiddlewareParams) => void
+export type MiddlewareFunction = (
+  middleware: MiddlewareParams
+) => void | Promise<void>
+
 export type DestinationMiddlewareFunction = (
   middleware: DestinationMiddlewareParams
-) => void
+) => void | Promise<void>
 
 export async function applyDestinationMiddleware(
   destination: string,
@@ -39,26 +41,24 @@ export async function applyDestinationMiddleware(
     let nextCalled = false
     let returnedEvent: SegmentEvent | null = null
 
-    await asPromise(
-      fn({
-        payload: toFacade(event, {
-          clone: true,
-          traverse: false,
-        }),
-        integration: destination,
-        next(evt) {
-          nextCalled = true
-
-          if (evt === null) {
-            returnedEvent = null
-          }
-
-          if (evt) {
-            returnedEvent = evt.obj
-          }
-        },
-      })
-    )
+    await fn({
+      payload: toFacade(event, {
+        clone: true,
+        traverse: false,
+      }),
+      integration: destination,
+      next(evt) {
+        nextCalled = true
+
+        if (evt === null) {
+          returnedEvent = null
+        }
+
+        if (evt) {
+          returnedEvent = evt.obj
+        }
+      },
+    })
 
     if (!nextCalled && returnedEvent !== null) {
       returnedEvent = returnedEvent as SegmentEvent
@@ -89,21 +89,19 @@ export function sourceMiddlewarePlugin(
   async function apply(ctx: Context): Promise<Context> {
     let nextCalled = false
 
-    await asPromise(
-      fn({
-        payload: toFacade(ctx.event, {
-          clone: true,
-          traverse: false,
-        }),
-        integrations: integrations ?? {},
-        next(evt) {
-          nextCalled = true
-          if (evt) {
-            ctx.event = evt.obj
-          }
-        },
-      })
-    )
+    await fn({
+      payload: toFacade(ctx.event, {
+        clone: true,
+        traverse: false,
+      }),
+      integrations: integrations ?? {},
+      next(evt) {
+        nextCalled = true
+        if (evt) {
+          ctx.event = evt.obj
+        }
+      },
+    })
 
     if (!nextCalled) {
       throw new ContextCancelation({

diff --git a/packages/browser/src/plugins/remote-loader/index.ts b/packages/browser/src/plugins/remote-loader/index.ts
@@ -2,7 +2,6 @@ import type { Integrations } from '../../core/events/interfaces'
 import { LegacySettings } from '../../browser'
 import { JSONObject, JSONValue } from '../../core/events'
 import { Plugin } from '../../core/plugin'
-import { asPromise } from '../../lib/as-promise'
 import { loadScript } from '../../lib/load-script'
 import { getCDN } from '../../lib/parse-cdn'
 import {
@@ -187,12 +186,10 @@ export async function remoteLoader(
         if (typeof window[libraryName] === 'function') {
           // @ts-expect-error
           const pluginFactory = window[libraryName] as PluginFactory
-          const plugin = await asPromise(
-            pluginFactory({
-              ...remotePlugin.settings,
-              ...mergedIntegrations[remotePlugin.name],
-            })
-          )
+          const plugin = await pluginFactory({
+            ...remotePlugin.settings,
+            ...mergedIntegrations[remotePlugin.name],
+          })
           const plugins = Array.isArray(plugin) ? plugin : [plugin]
 
           validate(plugins)

diff --git a/packages/browser/src/plugins/routing-middleware/__tests__/index.test.ts b/packages/browser/src/plugins/routing-middleware/__tests__/index.test.ts
@@ -25,7 +25,7 @@ describe('tsub middleware', () => {
       payload = transformed?.obj
     })
 
-    middleware({
+    void middleware({
       integration: 'Google Tag Manager',
       next,
       payload: toFacade({
@@ -44,7 +44,7 @@ describe('tsub middleware', () => {
       payload = transformed?.obj
     })
 
-    middleware({
+    void middleware({
       integration: 'Google Analytics',
       next,
       payload: toFacade({