add tests too

Author: silesky

packages/browser/src/browser/__tests__/query-string.integration.test.ts

@@ -37,33 +37,36 @@ describe('queryString', () => {
     setGlobalCDNUrl(undefined as any)
   })
 
-  it('applies query string logic before analytics is finished initializing', async () => {
-    let analyticsInitializedBeforeQs: boolean | undefined
-    const originalQueryString = Analytics.prototype.queryString
-    const mockQueryString = jest
-      .fn()
-      .mockImplementation(async function (this: Analytics, ...args) {
-        // simulate network latency when retrieving the bundle
-        await new Promise((r) => setTimeout(r, 500))
-        return originalQueryString.apply(this, args).then((result) => {
-          // ensure analytics has not finished initializing before querystring completes
-          analyticsInitializedBeforeQs = this.initialized
-          return result
-        })
-      })
-    Analytics.prototype.queryString = mockQueryString
+  it('querystring events that update anonymousId have priority over other buffered events', async () => {
+    const queryStringSpy = jest.spyOn(Analytics.prototype, 'queryString')
 
     jsd.reconfigure({
       url: 'https://localhost/?ajs_aid=123',
     })
 
-    const [analytics] = await AnalyticsBrowser.load({ writeKey })
-    expect(mockQueryString).toHaveBeenCalledWith('?ajs_aid=123')
-    expect(analyticsInitializedBeforeQs).toBe(false)
-    // check that calls made immediately after analytics is loaded use correct anonymousId
-    const pageContext = await analytics.page()
+    const analytics = new AnalyticsBrowser()
+    const pagePromise = analytics.page()
+    await analytics.load({ writeKey })
+    expect(queryStringSpy).toHaveBeenCalledWith('?ajs_aid=123')
+    const pageContext = await pagePromise
     expect(pageContext.event.anonymousId).toBe('123')
-    expect(analytics.user().anonymousId()).toBe('123')
+    const user = await analytics.user()
+    expect(user.anonymousId()).toBe('123')
+  })
+
+  it('querystring events have middleware applied like any other event', async () => {
+    jsd.reconfigure({
+      url: 'https://localhost/?ajs_aid=123',
+    })
+
+    const analytics = new AnalyticsBrowser()
+    void analytics.addSourceMiddleware(({ next, payload }) => {
+      payload.obj.context!.page!.url = 'http://foo.com'
+      return next(payload)
+    })
+    await analytics.load({ writeKey })
+    const pageContext = await analytics.page()
+    expect(pageContext.event.context!.page!.url).toBe('http://foo.com')
   })
 
   it('applies query string logic if window.location.search is present', async () => {

packages/browser/src/browser/index.ts

@@ -208,11 +208,10 @@ function flushPreBuffer(
  */
 async function flushFinalBuffer(
   analytics: Analytics,
+  queryString: string,
   buffer: PreInitMethodCallBuffer
 ): Promise<void> {
-  // Call popSnippetWindowBuffer before each flush task since there may be
-  // analytics calls during async function calls.
-  await flushAddSourceMiddleware(analytics, buffer)
+  await flushQueryString(analytics, queryString)
   flushAnalyticsCallsInNewTask(analytics, buffer)
 }
 
@@ -355,6 +354,9 @@ async function registerPlugins(
     })
   }
 
+  // register any source middleware that was added before initialization. Could probably be added to the buffer, but it's a bit of a special case.
+  await flushAddSourceMiddleware(analytics, preInitBuffer)
+
   return ctx
 }
 
@@ -435,11 +437,7 @@ async function loadAnalytics(
 
   analytics.initialized = true
   analytics.emit('initialize', settings, options)
-
-  await flushFinalBuffer(analytics, preInitBuffer)
-
-  // not sure why we need to await this, but it was legacy -- can probably be removed
-  await flushQueryString(analytics, queryString)
+  await flushFinalBuffer(analytics, queryString, preInitBuffer)
 
   return [analytics, ctx]
 }