Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
120 changes: 120 additions & 0 deletions packages/analytics-browser/integration/smoke.test.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>analytics-browser HTML smoke test</title>
</head>
<body>
<h1>Amplitude Browser HTML Smoke Test</h1>
<button id="track-button" type="button">Track</button>

<script type="module">
import { runTests } from '@web/test-runner-mocha';
import { expect } from '@esm-bundle/chai';
import { Identify, Status } from '@amplitude/analytics-core';
import { AmplitudeBrowser } from '../src/index.ts';

runTests(() => {
describe('analytics HTML smoke tests', () => {
let payloads = [];
let transportProvider;

beforeEach(() => {
payloads = [];
transportProvider = {
async send(_serverUrl, payload) {
payloads.push(payload);
return {
status: Status.Success,
statusCode: 200,
body: {
eventsIngested: payload.events.length,
payloadSizeBytes: 0,
serverUploadTime: Date.now(),
},
};
},
};
});

it('tracks an event when clicking on button', async () => {
const client = new AmplitudeBrowser();
await client.init('test-api-key', {
defaultTracking: false,
autocapture: false,
fetchRemoteConfig: false,
flushIntervalMillis: 1,
flushQueueSize: 1,
identityStorage: 'none',
}).promise;

client.config.transportProvider = transportProvider;
const trackPromise = new Promise(resolve => {
document.getElementById('track-button').addEventListener('click', async () => {
await client.track('test-event', { test_property: 'test-value' }).promise;
resolve();
});
});
// dispatch click event on button
document.getElementById('track-button').click();
await trackPromise;

expect(payloads).to.have.lengthOf(1);
expect(payloads[0].events[0].event_type).to.equal('test-event');
expect(payloads[0].events[0].event_properties).to.deep.equal({
test_property: 'test-value',
});
});
});

describe('optOut tracking', () => {
let payloads = [];
let transportProvider;

beforeEach(() => {
payloads = [];
transportProvider = {
async send(_serverUrl, payload) {
payloads.push(payload);
return {
status: Status.Success,
statusCode: 200,
body: {
eventsIngested: payload.events.length,
payloadSizeBytes: 0,
serverUploadTime: Date.now(),
},
};
},
};
});

it('only tracks events when optOut is false', async () => {
const client = new AmplitudeBrowser();
await client.init('test-api-key', {
defaultTracking: false,
autocapture: false,
fetchRemoteConfig: false,
flushIntervalMillis: 1,
flushQueueSize: 1,
identityStorage: 'none',
optOut: true,
}).promise;

client.config.transportProvider = transportProvider;
await client.track('test-event', { test_property: 'test-value' }).promise;
await client.flush().promise;

expect(payloads).to.have.lengthOf(0);
client.setOptOut(false);
await client.track('test-event-2', { test_property: 'test-value' }).promise;
await client.flush().promise;

expect(payloads).to.have.lengthOf(1);
expect(payloads[0].events[0].event_type).to.equal('test-event-2');
});
});
});
</script>
</body>
</html>
62 changes: 62 additions & 0 deletions packages/analytics-browser/integration/smoke.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import { expect } from '@esm-bundle/chai';
import { Identify, Status, type Payload, type Transport } from '@amplitude/analytics-core';
import { AmplitudeBrowser } from '../src/index';

describe('analytics smoke tests', () => {
let payloads: Payload[] = [];
let transportProvider: Transport;

beforeEach(() => {
payloads = [];
transportProvider = {
async send(_serverUrl, payload) {
payloads.push(payload);
return {
status: Status.Success,
statusCode: 200,
body: {
eventsIngested: payload.events.length,
payloadSizeBytes: 0,
serverUploadTime: Date.now(),
},
};
},
};
});

it('tracks an event and identify call', async () => {
const client = new AmplitudeBrowser();
await client.init('test-api-key', {
defaultTracking: false,
autocapture: false,
fetchRemoteConfig: false,
flushIntervalMillis: 1,
flushQueueSize: 1,
identityStorage: 'none',
}).promise;

client.config.transportProvider = transportProvider;

client.setUserId('test-user-id');
client.track('test-event', { test_property: 'test-value' });
const identity = new Identify();
identity.set('test-property', 'test-value');
identity.setOnce('test-property-once', 'test-value-once');
client.identify(identity);
await client.flush().promise;

expect(payloads).to.have.lengthOf(2);
expect(payloads[0].events[0].event_type).to.equal('test-event');
expect(payloads[0].events[0].event_properties).to.deep.equal({ test_property: 'test-value' });
expect(payloads[0].events[0].user_id).to.equal('test-user-id');
expect(payloads[1].events[0].event_type).to.equal('$identify');
expect(payloads[1].events[0].user_properties).to.deep.equal({
'$set': {
'test-property': 'test-value',
},
'$setOnce': {
'test-property-once': 'test-value-once',
},
});
});
});
7 changes: 7 additions & 0 deletions packages/analytics-browser/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"publish:s3": "node ../../scripts/publish/upload-to-s3.js",
"publish:gtm-snippet": "cd ../gtm-snippet && pnpm build && pnpm publish:s3",
"test": "jest",
"test:integration": "web-test-runner",
"test:playwright": "playwright test",
"typecheck": "tsc -p ./tsconfig.json",
"version": "pnpm version-file && GENERATE_SNIPPET=true pnpm build && cp lib/scripts/amplitude-min.js playground/html/amplitude.js && cp lib/scripts/amplitude-min.js playground/react-spa/public/amplitude.js",
Expand All @@ -60,9 +61,15 @@
"tslib": "^2.4.1"
},
"devDependencies": {
"@esm-bundle/chai": "^4.3.4",
"@rollup/plugin-commonjs": "^23.0.4",
"@rollup/plugin-node-resolve": "^15.0.1",
"@rollup/plugin-typescript": "^10.0.1",
"@web/dev-server-esbuild": "^1.0.5",
"@web/dev-server-rollup": "^1.0.0",
"@web/test-runner": "^0.20.2",
"@web/test-runner-mocha": "^1.0.0",
"@web/test-runner-playwright": "^0.11.1",
"http-server": "^14.1.1",
"isomorphic-fetch": "^3.0.0",
"rollup": "^2.79.1",
Expand Down
22 changes: 12 additions & 10 deletions packages/analytics-browser/src/types.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* eslint-disable @typescript-eslint/unbound-method */
export {
export type {
AmplitudeReturn,
BaseEvent,
EventOptions,
Expand All @@ -12,35 +12,37 @@ export {
Event,
IdentifyEvent,
GroupIdentifyEvent,
IdentifyOperation,
SpecialEventType,
IIdentify,
IRevenue,
RevenueProperty,
ILogger,
LogLevel,
Plugin,
BeforePlugin,
EnrichmentPlugin,
DestinationPlugin,
Result,
ServerZoneType,
ServerZone,
IdentityStorageType,
Storage,
TransportType,
OfflineDisabled,
Messenger,
ElementInteractionsOptions,
ActionType,
DEFAULT_CSS_SELECTOR_ALLOWLIST,
DEFAULT_DATA_ATTRIBUTE_PREFIX,
DEFAULT_ACTION_CLICK_ALLOWLIST,
Campaign,
ClickIdParameters,
ReferrerParameters,
UTMParameters,
ValidPropertyType,
ExcludeInternalReferrersOptions,
} from '@amplitude/analytics-core';
export {
IdentifyOperation,
SpecialEventType,
RevenueProperty,
LogLevel,
ServerZone,
OfflineDisabled,
DEFAULT_CSS_SELECTOR_ALLOWLIST,
DEFAULT_DATA_ATTRIBUTE_PREFIX,
DEFAULT_ACTION_CLICK_ALLOWLIST,
EXCLUDE_INTERNAL_REFERRERS_CONDITIONS,
} from '@amplitude/analytics-core';
26 changes: 26 additions & 0 deletions packages/analytics-browser/web-test-runner.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { esbuildPlugin } from '@web/dev-server-esbuild';
import { fromRollup } from '@web/dev-server-rollup';
import { playwrightLauncher } from '@web/test-runner-playwright';
import rollupCommonjs from '@rollup/plugin-commonjs';

const commonjs = fromRollup(rollupCommonjs);

/** @type {import('@web/test-runner').TestRunnerConfig} */
export default {
files: ['integration/**/*.test.ts', 'integration/**/*.test.html'],
nodeResolve: true,
// Serve from the monorepo root so workspace packages resolve under pnpm.
rootDir: '../..',
browsers: [
playwrightLauncher({ product: 'chromium' }),
playwrightLauncher({ product: 'firefox' }),
playwrightLauncher({ product: 'webkit' }),
],
plugins: [
esbuildPlugin({ ts: true }),
// Convert CJS dependencies (e.g. zen-observable, safe-json-stringify) for the browser.
commonjs({
include: ['**/node_modules/**'],
}),
],
};
Loading
Loading