This repository was archived by the owner on Apr 27, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #35 from john-doherty/add-utm-tracking
Add `utm`, `language`, `advert` data
- Loading branch information
Showing
10 changed files
with
461 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| var path = require('path'); | ||
| var puppeteer = require('puppeteer'); | ||
| var querystring = require('querystring'); | ||
| var utils = require('./utils'); | ||
|
|
||
| jasmine.DEFAULT_TIMEOUT_INTERVAL = 10000; | ||
|
|
||
| var url = 'file://' + path.join(__dirname, 'environment.html'); | ||
| var page = null; | ||
| var browser = null; | ||
|
|
||
| describe('mixpanel-lite UTM', function () { | ||
|
|
||
| // create a new browser instance before each test | ||
| beforeEach(async function () { | ||
|
|
||
| // Launch a new browser instance | ||
| browser = await puppeteer.launch({ | ||
| headless: true, | ||
| args: ['--no-sandbox', '--disable-setuid-sandbox'] | ||
| }); | ||
|
|
||
| // get page | ||
| page = (await browser.pages())[0]; | ||
| }); | ||
|
|
||
| afterEach(async function () { | ||
|
|
||
| return page.evaluate(function () { | ||
| return localStorage.removeItem('mixpanel-lite'); | ||
| }) | ||
| .then(function () { | ||
| return utils.sleep(500); | ||
| }) | ||
| .then(function () { | ||
| return browser.close(); | ||
| }); | ||
| }); | ||
|
|
||
| it('should send advert data to /track endpoint', async function () { | ||
| var now = (new Date()).getTime(); | ||
| var token = 'test-token-' + now; | ||
| var eventName = 'test-event-' + now; | ||
|
|
||
| // open page with UTM params | ||
| await page.goto(url + '?dclid=randomDclidValue&fbclid=randomFbclidValue&gclid=randomGclidValue&ko_click_id=randomKoClickIdValue&li_fat_id=randomLiFatIdValue&msclkid=randomMsclkidValue&ttclid=randomTtclidValue&twclid=randomTwclidValue&wbraid=randomWbraidValue'); | ||
|
|
||
| await page.setRequestInterception(true); | ||
|
|
||
| const requestPromise = new Promise((resolve, reject) => { | ||
| page.once('request', function (request) { | ||
| var requestUrl = request.url(); | ||
| var query = requestUrl.substr(requestUrl.indexOf('?') + 1); | ||
| var params = querystring.parse(query); | ||
|
|
||
| try { | ||
| // Assertions | ||
| expect(requestUrl.startsWith('https://api.mixpanel.com/track')).toBe(true); | ||
| expect(params).toBeDefined(); | ||
| expect(params._).toBeDefined(); | ||
| expect(params.data).toBeDefined(); | ||
| expect(params.data).not.toEqual(''); | ||
|
|
||
| var data = JSON.parse(Buffer.from(params.data, 'base64').toString('ascii')); | ||
|
|
||
| expect(data.event).toEqual(eventName); | ||
| expect(data.properties).toBeDefined(); | ||
| expect(data.properties.distinct_id).toBeDefined(); | ||
| expect(data.properties.$browser).toEqual('Chrome'); | ||
| expect(data.properties.token).toEqual(token); | ||
| expect(data.properties.advert.doubleClickId).toEqual('randomDclidValue'); | ||
| expect(data.properties.advert.facebookClickId).toEqual('randomFbclidValue'); | ||
| expect(data.properties.advert.genericClickId).toEqual('randomKoClickIdValue'); | ||
| expect(data.properties.advert.linkedInClickId).toEqual('randomLiFatIdValue'); | ||
| expect(data.properties.advert.microsoftClickId).toEqual('randomMsclkidValue'); | ||
| expect(data.properties.advert.tikTokClickId).toEqual('randomTtclidValue'); | ||
| expect(data.properties.advert.twitterClickId).toEqual('randomTwclidValue'); | ||
| expect(data.properties.advert.webBrowserReferrerId).toEqual('randomWbraidValue'); | ||
|
|
||
| resolve(); // Resolve the promise after assertions | ||
| } | ||
| catch (error) { | ||
| reject(error); // Reject the promise if an assertion fails | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| // Trigger the tracking | ||
| await page.evaluate(function (t, e) { | ||
| window.mixpanel.init(t); | ||
| window.mixpanel.track(e); | ||
| }, token, eventName); | ||
|
|
||
| // Wait for the requestPromise to resolve | ||
| await requestPromise; | ||
| }); | ||
|
|
||
| it('should NOT send advert data to /track endpoint', async function () { | ||
| var now = (new Date()).getTime(); | ||
| var token = 'test-token-' + now; | ||
| var eventName = 'test-event-' + now; | ||
|
|
||
| // open page without UTM params | ||
| await page.goto(url); | ||
|
|
||
| await page.setRequestInterception(true); | ||
|
|
||
| const requestPromise = new Promise((resolve, reject) => { | ||
| page.once('request', function (request) { | ||
| var requestUrl = request.url(); | ||
| var query = requestUrl.substr(requestUrl.indexOf('?') + 1); | ||
| var params = querystring.parse(query); | ||
|
|
||
| try { | ||
| // Assertions | ||
| expect(requestUrl.startsWith('https://api.mixpanel.com/track')).toBe(true); | ||
| expect(params).toBeDefined(); | ||
| expect(params._).toBeDefined(); | ||
| expect(params.data).toBeDefined(); | ||
| expect(params.data).not.toEqual(''); | ||
|
|
||
| var data = JSON.parse(Buffer.from(params.data, 'base64').toString('ascii')); | ||
|
|
||
| expect(data.event).toEqual(eventName); | ||
| expect(data.properties).toBeDefined(); | ||
| expect(data.properties.distinct_id).toBeDefined(); | ||
| expect(data.properties.$browser).toEqual('Chrome'); | ||
| expect(data.properties.token).toEqual(token); | ||
|
|
||
| expect(data.properties.advert).toBeUndefined(); | ||
|
|
||
| resolve(); // Resolve the promise after assertions | ||
| } | ||
| catch (error) { | ||
| reject(error); // Reject the promise if an assertion fails | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| // Trigger the tracking | ||
| await page.evaluate(function (t, e) { | ||
| window.mixpanel.init(t); | ||
| window.mixpanel.track(e); | ||
| }, token, eventName); | ||
|
|
||
| // Wait for the requestPromise to resolve | ||
| await requestPromise; | ||
| }); | ||
| }); |
Oops, something went wrong.