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

fix: Page counter fix #670

Merged
merged 4 commits into from
Feb 27, 2024
Merged

fix: Page counter fix #670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fec63ad
fix: fix typo for pageCounter
Feb 23, 2024
d65e505
Merge branch 'main' of github.com:amplitude/Amplitude-TypeScript
Feb 24, 2024
64d15fb
fix: fix the pageCounter on SPR
Feb 27, 2024
ce85a24
test: fix the test
Feb 27, 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
9 changes: 4 additions & 5 deletions packages/plugin-page-view-tracking-browser/src/page-view-tracking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ export const pageViewTrackingPlugin: CreatePageViewTrackingPlugin = (options: Op
const globalScope = getGlobalScope();
let loggerProvider: Logger | undefined = undefined;
let pushState: undefined | ((data: any, unused: string, url?: string | URL | null) => void);
let pageCounter: number;
let localConfig: BrowserConfig;

const createPageViewEvent = async (): Promise<Event> => {
localConfig.pageCounter = !localConfig.pageCounter ? 1 : localConfig.pageCounter + 1;
return {
event_type: options.eventType ?? '[Amplitude] Page Viewed',
event_properties: {
Expand All @@ -33,7 +34,7 @@ export const pageViewTrackingPlugin: CreatePageViewTrackingPlugin = (options: Op
'[Amplitude] Page Title': /* istanbul ignore next */ (typeof document !== 'undefined' && document.title) || '',
'[Amplitude] Page URL':
/* istanbul ignore next */ (typeof location !== 'undefined' && location.href.split('?')[0]) || '',
'[Amplitude] Page Counter': pageCounter,
'[Amplitude] Page Counter': localConfig.pageCounter,
},
};
};
Expand Down Expand Up @@ -72,13 +73,11 @@ export const pageViewTrackingPlugin: CreatePageViewTrackingPlugin = (options: Op

setup: async (config: BrowserConfig, client: BrowserClient) => {
amplitude = client;
localConfig = config;

loggerProvider = config.loggerProvider;
loggerProvider.log('Installing @amplitude/plugin-page-view-tracking-browser');

config.pageCounter = !config.pageCounter ? 1 : config.pageCounter + 1;
pageCounter = config.pageCounter;

if (globalScope) {
globalScope.addEventListener('popstate', trackHistoryPageViewWrapper);

Expand Down
97 changes: 50 additions & 47 deletions packages/plugin-page-view-tracking-browser/test/page-view-tracking.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ describe('pageViewTrackingPlugin', () => {
language: true,
platform: true,
},
pageCounter: 0,
};

beforeAll(() => {
Expand All @@ -56,7 +57,51 @@ describe('pageViewTrackingPlugin', () => {
});

describe('setup', () => {
let currentTestIndex = 0;
test.each([
{ trackHistoryChanges: undefined },
{ trackHistoryChanges: 'pathOnly' as const },
{ trackHistoryChanges: 'all' as const },
])('should track dynamic page view', async (options) => {
mockConfig.pageCounter = 0;

const amplitude = createInstance();
const track = jest.spyOn(amplitude, 'track').mockReturnValue({
promise: Promise.resolve({
code: 200,
message: '',
event: {
event_type: '[Amplitude] Page Viewed',
},
}),
});

const oldURL = new URL('https://www.example.com/home');
mockWindowLocationFromURL(oldURL);
const plugin = pageViewTrackingPlugin(options);
await plugin.setup?.(mockConfig, amplitude);

const newURL = new URL('https://www.example.com/about');
mockWindowLocationFromURL(newURL);
window.history.pushState(undefined, newURL.href);

// Page view tracking on push state executes async
// Block event loop for 1s before asserting
await new Promise((resolve) => setTimeout(resolve, 1000));

expect(track).toHaveBeenNthCalledWith(2, {
event_properties: {
'[Amplitude] Page Domain': newURL.hostname,
'[Amplitude] Page Location': newURL.toString(),
'[Amplitude] Page Path': newURL.pathname,
'[Amplitude] Page Title': '',
'[Amplitude] Page URL': newURL.toString(),
'[Amplitude] Page Counter': 2,
},
event_type: '[Amplitude] Page Viewed',
});
expect(track).toHaveBeenCalledTimes(2);
});

test.each([
undefined,
{},
Expand All @@ -68,6 +113,7 @@ describe('pageViewTrackingPlugin', () => {
eventType: 'Page Viewed',
},
])('should track initial page view', async (options) => {
mockConfig.pageCounter = 0;
const amplitude = createInstance();
const search = 'utm_source=google&utm_medium=cpc&utm_campaign=brand&utm_term=keyword&utm_content=adcopy';
const hostname = 'www.example.com';
Expand All @@ -92,7 +138,7 @@ describe('pageViewTrackingPlugin', () => {
'[Amplitude] Page Path': pathname,
'[Amplitude] Page Title': '',
'[Amplitude] Page URL': `https://${hostname}${pathname}`,
'[Amplitude] Page Counter': ++currentTestIndex,
'[Amplitude] Page Counter': 1,
utm_source: 'google',
utm_medium: 'cpc',
utm_campaign: 'brand',
Expand All @@ -112,58 +158,13 @@ describe('pageViewTrackingPlugin', () => {
trackOn: () => false,
},
])('should not track initial page view', async (options) => {
++currentTestIndex;
const amplitude = createInstance();
const track = jest.spyOn(amplitude, 'track');
const plugin = pageViewTrackingPlugin(options);
await plugin.setup?.(mockConfig, amplitude);
expect(track).toHaveBeenCalledTimes(0);
});

test.each([
{ trackHistoryChanges: undefined },
{ trackHistoryChanges: 'pathOnly' as const },
{ trackHistoryChanges: 'all' as const },
])('should track dynamic page view', async (options) => {
const amplitude = createInstance();
const track = jest.spyOn(amplitude, 'track').mockReturnValue({
promise: Promise.resolve({
code: 200,
message: '',
event: {
event_type: '[Amplitude] Page Viewed',
},
}),
});

const oldURL = new URL('https://www.example.com/home');
mockWindowLocationFromURL(oldURL);

const plugin = pageViewTrackingPlugin(options);
await plugin.setup?.(mockConfig, amplitude);

const newURL = new URL('https://www.example.com/about');
mockWindowLocationFromURL(newURL);
window.history.pushState(undefined, newURL.href);

// Page view tracking on push state executes async
// Block event loop for 1s before asserting
await new Promise((resolve) => setTimeout(resolve, 1000));

expect(track).toHaveBeenNthCalledWith(2, {
event_properties: {
'[Amplitude] Page Domain': newURL.hostname,
'[Amplitude] Page Location': newURL.toString(),
'[Amplitude] Page Path': newURL.pathname,
'[Amplitude] Page Title': '',
'[Amplitude] Page URL': newURL.toString(),
'[Amplitude] Page Counter': ++currentTestIndex,
},
event_type: '[Amplitude] Page Viewed',
});
expect(track).toHaveBeenCalledTimes(2);
});

test.each([
{ trackHistoryChanges: 'pathOnly' as const },
{
Expand Down Expand Up @@ -203,9 +204,11 @@ describe('pageViewTrackingPlugin', () => {

describe('execute', () => {
test('should track page view on attribution', async () => {
const amplitude = createInstance();
const plugin = pageViewTrackingPlugin({
trackOn: 'attribution',
});
await plugin.setup?.(mockConfig, amplitude);
const event = await plugin.execute?.({
event_type: '$identify',
user_properties: {
Expand Down
Loading