Skip to content

Fix conflict between window.analytics AND npm library in same scope. #1127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
silesky merged 2 commits into from
Aug 19, 2024
Merged

Fix conflict between window.analytics AND npm library in same scope. #1127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ca9ed0
do not hydrate from window object
silesky Aug 16, 2024
7275822
add changeset
silesky Aug 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/green-moles-provide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@segment/analytics-next': patch
---

If npm version, do not read buffered events from window.analytics
4 changes: 4 additions & 0 deletions packages/browser/src/browser/__tests__/analytics-pre-init.integration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { sleep } from '../../lib/sleep'
import { setGlobalCDNUrl } from '../../lib/parse-cdn'
import { User } from '../../core/user'
import { getBufferedPageCtxFixture } from '../../test-helpers/fixtures'
import { setVersionType } from '../../lib/version-type'

jest.mock('unfetch')

Expand Down Expand Up @@ -235,6 +236,9 @@ describe('Pre-initialization', () => {
})

describe('Snippet / standalone', () => {
beforeAll(() => {
setVersionType('web')
})
test('If a snippet user sends multiple events, all of those event gets flushed', async () => {
const onTrackCb = jest.fn()
const onTrack = ['on', 'track', onTrackCb]
Expand Down
2 changes: 2 additions & 0 deletions packages/browser/src/browser/__tests__/standalone-analytics.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import * as Factory from '../../test-helpers/factories'
import { EventQueue } from '../../core/queue/event-queue'
import { AnalyticsStandalone } from '../standalone-interface'
import { getBufferedPageCtxFixture } from '../../test-helpers/fixtures'
import { setVersionType } from '../../lib/version-type'

const track = jest.fn()
const identify = jest.fn()
Expand Down Expand Up @@ -45,6 +46,7 @@ describe('standalone bundle', () => {
const segmentDotCom = `foo`

beforeEach(async () => {
setVersionType('web')
;(window as any).analytics = undefined
const html = `
<!DOCTYPE html>
Expand Down
6 changes: 6 additions & 0 deletions packages/browser/src/core/buffer/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ import { sleep } from '../../../lib/sleep'
import { User } from '../../user'
import { getBufferedPageCtxFixture } from '../../../test-helpers/fixtures'
import * as GlobalAnalytics from '../../../lib/global-analytics-helper'
import { setVersionType } from '../../../lib/version-type'

describe(PreInitMethodCallBuffer, () => {
beforeEach(() => {
setVersionType('npm')
GlobalAnalytics.setGlobalAnalytics(undefined as any)
})

Expand All @@ -28,6 +30,7 @@ describe(PreInitMethodCallBuffer, () => {
})

it('should also read from global analytics buffer', () => {
setVersionType('web')
const call1 = new PreInitMethodCall('identify', ['foo'], jest.fn())
;(window as any).analytics = [['track', 'snippet']]

Expand Down Expand Up @@ -75,6 +78,7 @@ describe(PreInitMethodCallBuffer, () => {
expect(buffer.getCalls('group')).toEqual([call3])
})
it('should read from Snippet Buffer', () => {
setVersionType('web')
const call1 = new PreInitMethodCall('identify', ['foo'], jest.fn())
GlobalAnalytics.setGlobalAnalytics([['identify', 'snippet']] as any)

Expand All @@ -92,6 +96,7 @@ describe(PreInitMethodCallBuffer, () => {
})
describe('clear()', () => {
it('should clear calls', () => {
setVersionType('web')
const call1 = new PreInitMethodCall('identify', [], jest.fn())
const call2 = new PreInitMethodCall('identify', [], jest.fn())
const call3 = new PreInitMethodCall('group', [], jest.fn())
Expand All @@ -105,6 +110,7 @@ describe(PreInitMethodCallBuffer, () => {

describe('Snippet buffer (method calls)', () => {
it('should be read from the global analytics instance', () => {
setVersionType('web')
const getGlobalAnalyticsSpy = jest.spyOn(
GlobalAnalytics,
'getGlobalAnalytics'
Expand Down
6 changes: 6 additions & 0 deletions packages/browser/src/core/buffer/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
createPageContext,
PageContext,
} from '../page'
import { getVersionType } from '../../lib/version-type'

/**
* The names of any AnalyticsBrowser methods that also exist on Analytics
Expand Down Expand Up @@ -220,6 +221,11 @@ export class PreInitMethodCallBuffer {
* This removes existing buffered calls from the window object.
*/
private _pushSnippetWindowBuffer(): void {
// if this is the npm version, we don't want to read from the window object.
// This avoids namespace conflicts if there is a seperate analytics library on the page.
if (getVersionType() === 'npm') {
return undefined
}
const wa = getGlobalAnalytics()
if (!Array.isArray(wa)) return undefined
const buffered: SnippetBuffer = wa.splice(0, wa.length)
Expand Down
⚡