Skip to content
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

Jump to bottom

Make tests faster / less flaky #713

Merged
merged 3 commits into from
Dec 7, 2022
Merged

Make tests faster / less flaky #713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2163384
make tests a bit less flake
silesky Dec 6, 2022
92d5d6c
integrations can be undefined (according to the sample we were using)…
silesky Dec 6, 2022
5b11626
add logic if plan.integration is falsy
silesky Dec 6, 2022
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/real-otters-refuse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@segment/analytics-next': patch
---

add logic if plan.integrations is falsy
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"jest": "^28.1.0",
"lint-staged": "^13.0.0",
"lodash": "^4.17.21",
"nock": "^13.2.9",
"node-gyp": "^9.0.0",
"prettier": "^2.6.2",
"ts-jest": "^28.0.4",
Expand Down
1 change: 1 addition & 0 deletions packages/browser/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
},
"devDependencies": {
"@internal/config": "0.0.0",
"@segment/analytics.js-integration": "^3.3.3",
"@segment/analytics.js-integration-amplitude": "^3.3.3",
"@segment/inspector-webext": "^2.0.3",
"@size-limit/preset-big-lib": "^7.0.8",
Expand Down
177 changes: 16 additions & 161 deletions packages/browser/src/browser/__tests__/integration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
/* eslint-disable @typescript-eslint/no-floating-promises */
import { cdnSettingsKitchenSink } from '../../test-helpers/fixtures/cdn-settings'
import { createMockFetchImplementation } from '../../test-helpers/fixtures/create-fetch-method'
import { Context } from '@/core/context'
import { Plugin } from '@/core/plugin'
import { JSDOM } from 'jsdom'
Expand All @@ -11,27 +13,19 @@ import { AnalyticsBrowser, loadLegacySettings } from '..'
import { isOffline } from '../../core/connection'
import * as SegmentPlugin from '../../plugins/segmentio'
import jar from 'js-cookie'
import {
AMPLITUDE_WRITEKEY,
TEST_WRITEKEY,
} from '../../test-helpers/test-writekeys'
import { PriorityQueue } from '../../lib/priority-queue'
import { getCDN, setGlobalCDNUrl } from '../../lib/parse-cdn'
import { clearAjsBrowserStorage } from '../../test-helpers/browser-storage'
import { ActionDestination } from '@/plugins/remote-loader'
import { ClassicIntegrationBuilder } from '../../plugins/ajs-destination/types'

// eslint-disable-next-line @typescript-eslint/no-explicit-any
let fetchCalls: Array<any>[] = []
// Mock unfetch so we can record any http requests made

jest.mock('unfetch', () => {
const originalModule = jest.requireActual('unfetch')
return {
__esModule: true,
...originalModule,
default: (...args: unknown[]) => {
fetchCalls.push(args)
return originalModule.apply(originalModule, args)
default: (url: RequestInfo, body?: RequestInit) => {
fetchCalls.push([url, body])
return createMockFetchImplementation(cdnSettingsKitchenSink)(url, body)
},
}
})
Expand Down Expand Up @@ -87,17 +81,18 @@ const enrichBilling: Plugin = {
},
}

const writeKey = TEST_WRITEKEY
const writeKey = 'foo'
const amplitudeWriteKey = 'bar'

beforeEach(() => {
setGlobalCDNUrl(undefined as any)
})

describe('Initialization', () => {
beforeEach(async () => {
fetchCalls = []
jest.resetAllMocks()
jest.resetModules()
fetchCalls = []
})

it('loads plugins', async () => {
Expand Down Expand Up @@ -204,6 +199,7 @@ describe('Initialization', () => {
},
],
})

expect(fetchCalls[0][0]).toContain(overriddenCDNUrl)
expect.assertions(3)
})
Expand Down Expand Up @@ -680,7 +676,7 @@ describe('addDestinationMiddleware', () => {
'amplitude',
'latest',
{
apiKey: AMPLITUDE_WRITEKEY,
apiKey: amplitudeWriteKey,
},
{}
)
Expand Down Expand Up @@ -823,7 +819,7 @@ describe('deregister', () => {
'amplitude',
'latest',
{
apiKey: AMPLITUDE_WRITEKEY,
apiKey: amplitudeWriteKey,
},
{}
)
Expand Down Expand Up @@ -868,7 +864,7 @@ describe('retries', () => {

it('does not retry errored events if retryQueue setting is set to false', async () => {
const [ajs] = await AnalyticsBrowser.load(
{ writeKey: TEST_WRITEKEY },
{ writeKey: writeKey },
{ retryQueue: false }
)

Expand Down Expand Up @@ -951,147 +947,6 @@ describe('Segment.io overrides', () => {
})
})

describe('.Integrations', () => {
beforeEach(async () => {
jest.restoreAllMocks()
jest.resetAllMocks()

const html = `
<!DOCTYPE html>
<head>
<script>'hi'</script>
</head>
<body>
</body>
</html>
`.trim()

const jsd = new JSDOM(html, {
runScripts: 'dangerously',
resources: 'usable',
url: 'https://localhost',
})

const windowSpy = jest.spyOn(global, 'window', 'get')
windowSpy.mockImplementation(
() => jsd.window as unknown as Window & typeof globalThis
)

const documentSpy = jest.spyOn(global, 'document', 'get')
documentSpy.mockImplementation(
() => jsd.window.document as unknown as Document
)
})

it('lists all legacy destinations', async () => {
const amplitude = new LegacyDestination(
'Amplitude',
'latest',
{
apiKey: AMPLITUDE_WRITEKEY,
},
{}
)

const ga = new LegacyDestination('Google-Analytics', 'latest', {}, {})

const [analytics] = await AnalyticsBrowser.load({
writeKey,
plugins: [amplitude, ga],
})

await analytics.ready()

expect(analytics.Integrations).toMatchInlineSnapshot(`
Object {
"Amplitude": [Function],
"Google-Analytics": [Function],
}
`)
})

it('catches destinations with dots in their names', async () => {
const amplitude = new LegacyDestination(
'Amplitude',
'latest',
{
apiKey: AMPLITUDE_WRITEKEY,
},
{}
)

const ga = new LegacyDestination('Google-Analytics', 'latest', {}, {})
const customerIO = new LegacyDestination('Customer.io', 'latest', {}, {})

const [analytics] = await AnalyticsBrowser.load({
writeKey,
plugins: [amplitude, ga, customerIO],
})

await analytics.ready()

expect(analytics.Integrations).toMatchInlineSnapshot(`
Object {
"Amplitude": [Function],
"Customer.io": [Function],
"Google-Analytics": [Function],
}
`)
})

it('uses directly provided classic integrations without fetching them from cdn', async () => {
const amplitude = // @ts-ignore
(await import('@segment/analytics.js-integration-amplitude')).default

const intializeSpy = jest.spyOn(amplitude.prototype, 'initialize')
const trackSpy = jest.spyOn(amplitude.prototype, 'track')

const [analytics] = await AnalyticsBrowser.load(
{
writeKey,
classicIntegrations: [
amplitude as unknown as ClassicIntegrationBuilder,
],
},
{
integrations: {
Amplitude: {
apiKey: 'abc',
},
},
}
)

await analytics.ready()
expect(intializeSpy).toHaveBeenCalledTimes(1)

await analytics.track('test event')

expect(trackSpy).toHaveBeenCalledTimes(1)
})

it('ignores directly provided classic integrations if settings for them are unavailable', async () => {
const amplitude = // @ts-ignore
(await import('@segment/analytics.js-integration-amplitude')).default

const intializeSpy = jest.spyOn(amplitude.prototype, 'initialize')
const trackSpy = jest.spyOn(amplitude.prototype, 'track')

const [analytics] = await AnalyticsBrowser.load({
writeKey,
classicIntegrations: [amplitude as unknown as ClassicIntegrationBuilder],
})

await analytics.ready()

expect(intializeSpy).not.toHaveBeenCalled()

await analytics.track('test event')

expect(trackSpy).not.toHaveBeenCalled()
})
})

describe('Options', () => {
beforeEach(async () => {
jest.restoreAllMocks()
Expand Down Expand Up @@ -1129,7 +984,7 @@ describe('Options', () => {
'amplitude',
'latest',
{
apiKey: AMPLITUDE_WRITEKEY,
apiKey: amplitudeWriteKey,
},
{}
)
Expand Down Expand Up @@ -1165,7 +1020,7 @@ describe('Options', () => {
'amplitude',
'latest',
{
apiKey: AMPLITUDE_WRITEKEY,
apiKey: amplitudeWriteKey,
},
initOptions
)
Expand Down Expand Up @@ -1201,7 +1056,7 @@ describe('Options', () => {
'amplitude',
'latest',
{
apiKey: AMPLITUDE_WRITEKEY,
apiKey: amplitudeWriteKey,
},
initOptions
)
Expand Down
Loading