import * as Fs from 'fs';
import { Helpers } from '@secret-agent/testing';
import { GlobalPool } from '@secret-agent/core';
import { ITestKoaServer } from '@secret-agent/testing/helpers';
import Resolvable from '@secret-agent/commons/Resolvable';
import Viewports from '@secret-agent/default-browser-emulator/lib/Viewports';
import { Handler } from '../index';
let koaServer: ITestKoaServer;
let handler: Handler;
beforeAll(async () => {
handler = new Handler();
Helpers.onClose(() => handler.close(), true);
koaServer = await Helpers.runKoaServer(true);
GlobalPool.maxConcurrentAgentsCount = 3;
});
afterAll(Helpers.afterAll);
afterEach(Helpers.afterEach);
describe('basic Emulator tests', () => {
it('should be able to set a timezoneId', async () => {
const agent = await handler.createAgent({
timezoneId: 'America/Los_Angeles',
});
Helpers.needsClosing.push(agent);
await new Promise(resolve => setTimeout(resolve, 1e3));
await agent.goto(`${koaServer.baseUrl}`);
const formatted = 'Sat Nov 19 2016 10:12:34 GMT-0800 (Pacific Standard Time)';
const timezoneOffset = await agent.getJsValue('new Date(1479579154987).toString()');
expect(timezoneOffset).toBe(formatted);
});
it('should affect accept-language header', async () => {
const agent = await handler.createAgent({ locale: 'en-GB,en' });
Helpers.needsClosing.push(agent);
let acceptLanguage = '';
koaServer.get('/headers', ctx => {
acceptLanguage = ctx.get('accept-language');
ctx.body = '<html></html>';
});
await agent.goto(`${koaServer.baseUrl}/headers`);
expect(acceptLanguage).toBe('en-GB,en;q=0.9');
});
it('should affect navigator.language', async () => {
const agent = await handler.createAgent({ locale: 'fr-CH,fr-CA' });
Helpers.needsClosing.push(agent);
await agent.goto(`${koaServer.baseUrl}`);
const result = await agent.getJsValue(`navigator.language`);
expect(result).toBe('fr-CH');
const result2 = await agent.getJsValue(`navigator.languages`);
expect(result2).toStrictEqual(['fr-CH', 'fr-CA']);
});
it('should format number', async () => {
{
const agent = await handler.createAgent({ locale: 'en-US,en;q=0.9' });
Helpers.needsClosing.push(agent);
await agent.goto(`${koaServer.baseUrl}`);
const result = await agent.getJsValue(`(1000000.5).toLocaleString()`);
expect(result).toBe('1,000,000.5');
}
{
const agent = await handler.createAgent({ locale: 'fr-CH' });
Helpers.needsClosing.push(agent);
await agent.goto(`${koaServer.baseUrl}`);
const result = await agent.getJsValue(`(1000000.5).toLocaleString()`);
expect(result).toBe('1 000 000,5');
}
});
it('should format date', async () => {
{
const agent = await handler.createAgent({
locale: 'en-US',
timezoneId: 'America/Los_Angeles',
});
Helpers.needsClosing.push(agent);
await agent.goto(`${koaServer.baseUrl}`);
const formatted = 'Sat Nov 19 2016 10:12:34 GMT-0800 (Pacific Standard Time)';
const result = await agent.getJsValue(`new Date(1479579154987).toString()`);
expect(result).toBe(formatted);
}
{
const agent = await handler.createAgent({
locale: 'de-DE',
timezoneId: 'Europe/Berlin',
});
Helpers.needsClosing.push(agent);
await agent.goto(`${koaServer.baseUrl}`);
const formatted = 'Sat Nov 19 2016 19:12:34 GMT+0100 (Mitteleuropäische Normalzeit)';
const result = await agent.getJsValue(`new Date(1479579154987).toString()`);
expect(result).toBe(formatted);
}
});
});
describe('setScreensize', () => {
it('should set the proper viewport size', async () => {
const windowFraming = {
screenGapLeft: 0,
screenGapTop: 0,
screenGapRight: 0,
screenGapBottom: 0,
frameBorderWidth: 0,
frameBorderHeight: 0,
};
const viewport = Viewports.getDefault(windowFraming, windowFraming);
const agent = await handler.createAgent({
viewport,
});
Helpers.needsClosing.push(agent);
await agent.goto(`${koaServer.baseUrl}`);
const screenWidth = await agent.getJsValue('screen.width');
expect(screenWidth).toBe(viewport.screenWidth);
const screenHeight = await agent.getJsValue('screen.height');
expect(screenHeight).toBe(viewport.screenHeight);
const screenX = await agent.getJsValue('screenX');
expect(screenX).toBe(viewport.positionX);
const screenY = await agent.getJsValue('screenY');
expect(screenY).toBe(viewport.positionY);
const innerWidth = await agent.getJsValue('innerWidth');
expect(innerWidth).toBe(viewport.width);
const innerHeight = await agent.getJsValue('innerHeight');
expect(innerHeight).toBe(viewport.height);
});
it('should support Media Queries', async () => {
const agent = await handler.createAgent({
viewport: {
width: 200,
height: 200,
screenWidth: 200,
screenHeight: 200,
positionY: 0,
positionX: 0,
},
});
Helpers.needsClosing.push(agent);
expect(await agent.getJsValue(`matchMedia('(min-device-width: 100px)').matches`)).toBe(true);
expect(await agent.getJsValue(`matchMedia('(min-device-width: 300px)').matches`)).toBe(false);
expect(await agent.getJsValue(`matchMedia('(max-device-width: 100px)').matches`)).toBe(false);
expect(await agent.getJsValue(`matchMedia('(max-device-width: 300px)').matches`)).toBe(true);
expect(await agent.getJsValue(`matchMedia('(device-width: 500px)').matches`)).toBe(false);
expect(await agent.getJsValue(`matchMedia('(device-width: 200px)').matches`)).toBe(true);
expect(await agent.getJsValue(`matchMedia('(min-device-height: 100px)').matches`)).toBe(true);
expect(await agent.getJsValue(`matchMedia('(min-device-height: 300px)').matches`)).toBe(false);
expect(await agent.getJsValue(`matchMedia('(max-device-height: 100px)').matches`)).toBe(false);
expect(await agent.getJsValue(`matchMedia('(max-device-height: 300px)').matches`)).toBe(true);
expect(await agent.getJsValue(`matchMedia('(device-height: 500px)').matches`)).toBe(false);
expect(await agent.getJsValue(`matchMedia('(device-height: 200px)').matches`)).toBe(true);
});
});
describe('mouse', () => {
it('should emulate the hover media feature', async () => {
const agent = await handler.createAgent();
Helpers.needsClosing.push(agent);
expect(await agent.getJsValue(`matchMedia('(hover: none)').matches`)).toBe(false);
expect(await agent.getJsValue(`matchMedia('(hover: hover)').matches`)).toBe(true);
expect(await agent.getJsValue(`matchMedia('(any-hover: none)').matches`)).toBe(false);
expect(await agent.getJsValue(`matchMedia('(any-hover: hover)').matches`)).toBe(true);
expect(await agent.getJsValue(`matchMedia('(pointer: coarse)').matches`)).toBe(false);
expect(await agent.getJsValue(`matchMedia('(pointer: fine)').matches`)).toBe(true);
expect(await agent.getJsValue(`matchMedia('(any-pointer: coarse)').matches`)).toBe(false);
expect(await agent.getJsValue(`matchMedia('(any-pointer: fine)').matches`)).toBe(true);
});
});
describe('geolocation', () => {
it('should be able to set a geolocation', async () => {
const agent = await handler.createAgent({ geolocation: { longitude: 10, latitude: 10 } });
Helpers.needsClosing.push(agent);
await agent.goto(koaServer.baseUrl);
const geolocation = await agent.getJsValue(`new Promise(resolve => navigator.geolocation.getCurrentPosition(position => {
resolve({ latitude: position.coords.latitude, longitude: position.coords.longitude });
}))`);
expect(geolocation).toEqual({
latitude: 10,
longitude: 10,
});
});
});
describe('user agent and platform', () => {
const propsToGet = `appVersion, platform, userAgent, deviceMemory`.split(',').map(x => x.trim());
it('should be able to configure a userAgent', async () => {
const userAgent =
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4472.124 Safari/537.36';
const agent = await handler.createAgent({
userAgent,
});
Helpers.needsClosing.push(agent);
const agentMeta = await agent.meta;
expect(agentMeta.userAgentString).toBe(userAgent);
});
it('should be able to configure a userAgent with a range', async () => {
const agent = await handler.createAgent({
userAgent: '~ chrome >= 88 && chrome < 89',
});
Helpers.needsClosing.push(agent);
const agentMeta = await agent.meta;
const chromeMatch = agentMeta.userAgentString.match(/Chrome\/(\d+)/);
expect(chromeMatch).toBeTruthy();
const version = Number(chromeMatch[1]);
expect(version).toBe(88);
});
it('should be able to configure a userAgent with a wildcard', async () => {
const agent = await handler.createAgent({
userAgent: '~ chrome = 88.x',
});
Helpers.needsClosing.push(agent);
const agentMeta = await agent.meta;
const chromeMatch = agentMeta.userAgentString.match(/Chrome\/(\d+)/);
expect(chromeMatch).toBeTruthy();
const version = Number(chromeMatch[1]);
expect(version).toBe(88);
});
it('should add user agent and platform to window & frames', async () => {
const agent = await handler.createAgent();
Helpers.needsClosing.push(agent);
const agentMeta = await agent.meta;
const requestUserAgentStrings: string[] = [];
koaServer.get('/agent-test', ctx => {
requestUserAgentStrings.push(ctx.get('user-agent'));
ctx.body = `<html lang="en">
<h1>Agent Test</h1>
<iframe src="/frame"></iframe>
</html>`;
});
koaServer.get('/frame', ctx => {
requestUserAgentStrings.push(ctx.get('user-agent'));
ctx.body = `<html><body>
<script>
const { ${propsToGet.join(',')} } = navigator;
fetch('${koaServer.baseUrl}/frame-xhr', {
method: 'POST',
body: JSON.stringify({ ${propsToGet.join(',')} })
});
</script>
</body></html>`;
});
const frameXhr = new Promise<object>(resolve => {
koaServer.post('/frame-xhr', async ctx => {
requestUserAgentStrings.push(ctx.get('user-agent'));
const body = JSON.parse((await Helpers.readableToBuffer(ctx.req)).toString());
resolve(body);
ctx.body = 'Ok';
});
});
await agent.goto(`${koaServer.baseUrl}/agent-test`);
const frameParams = await frameXhr;
for (const useragent of requestUserAgentStrings) {
expect(useragent).toBe(agentMeta.userAgentString);
}
async function getJsValue(jsValue: string) {
const result = await agent.getJsValue(jsValue);
return result;
}
const windowParams: any = {};
for (const prop of propsToGet) {
windowParams[prop] = await getJsValue(`navigator.${prop}`);
}
expect(agentMeta.userAgentString).toBe(windowParams.userAgent);
expect(agentMeta.operatingSystemPlatform).toBe(windowParams.platform);
for (const prop of propsToGet) {
expect(`${prop}=${frameParams[prop]}`).toStrictEqual(`${prop}=${windowParams[prop]}`);
}
});
it('should maintain user agent and platform across navigations', async () => {
const agent = await handler.createAgent();
Helpers.needsClosing.push(agent);
const agentMeta = await agent.meta;
const requestUserAgentStrings: string[] = [];
const httpsServer = await Helpers.runHttpsServer(async (req, res) => {
requestUserAgentStrings.push(req.headers['user-agent']);
if (req.url === '/s2-page1') {
res.end(
`<html lang="en">
<script>
const { ${propsToGet.join(',')} } = navigator;
var startPageVars = { ${propsToGet.join(',')} };
</script>
<body><a href="${koaServer.baseUrl}/page2">link</a></body></html>`,
);
} else {
res.writeHead(404).end();
}
});
koaServer.get('/page1', ctx => {
requestUserAgentStrings.push(ctx.get('user-agent'));
ctx.body = `<html lang="en"><body><a href="${httpsServer.baseUrl}/s2-page1">link</a></body></html>`;
});
koaServer.get('/page2', ctx => {
requestUserAgentStrings.push(ctx.get('user-agent'));
ctx.body = `<html lang="en"><body><h1>Last Page</h1></body></html>`;
});
async function getParams() {
const windowParams: any = {};
for (const prop of propsToGet) {
windowParams[prop] = await agent.getJsValue(`navigator.${prop}`);
}
return windowParams;
}
await agent.goto(`${koaServer.baseUrl}/page1`);
const page1WindowParams = await getParams();
expect(agentMeta.userAgentString).toBe(page1WindowParams.userAgent);
expect(agentMeta.operatingSystemPlatform).toBe(page1WindowParams.platform);
await agent.click(agent.document.querySelector('a'));
const page2WindowParams = await getParams();
for (const prop of propsToGet) {
expect(`${prop}=${page2WindowParams[prop]}`).toStrictEqual(
`${prop}=${page1WindowParams[prop]}`,
);
}
const page2StartParams = await agent.getJsValue('startPageVars');
for (const prop of propsToGet) {
expect(`${prop}=${page2StartParams[prop]}`).toStrictEqual(
`${prop}=${page1WindowParams[prop]}`,
);
}
await agent.click(agent.document.querySelector('a'));
const page3WindowParams = await getParams();
for (const key of propsToGet) {
expect(page3WindowParams[key]).toBe(page1WindowParams[key]);
}
await agent.goBack();
const backParams = await getParams();
for (const key of propsToGet) {
expect(backParams[key]).toBe(page1WindowParams[key]);
}
for (const useragent of requestUserAgentStrings) {
expect(useragent).toBe(agentMeta.userAgentString);
}
});
it('should add user agent and platform to dedicated workers', async () => {
const agent = await handler.createAgent();
Helpers.needsClosing.push(agent);
const agentMeta = await agent.meta;
const requestUserAgentStrings: string[] = [];
koaServer.get('/workers-test', ctx => {
requestUserAgentStrings.push(ctx.get('user-agent'));
ctx.body = `<html lang="en">
<script>new Worker("worker.js").postMessage('');</script>
</html>`;
});
koaServer.get('/worker.js', ctx => {
requestUserAgentStrings.push(ctx.get('user-agent'));
ctx.set('content-type', 'application/javascript');
ctx.body = `onmessage = () => {
const { ${propsToGet.join(',')} } = navigator;
fetch('/worker-xhr', {
method: 'POST',
body: JSON.stringify({ ${propsToGet.join(',')} })
});
}`;
});
const xhr = new Promise<object>(resolve => {
koaServer.post('/worker-xhr', async ctx => {
requestUserAgentStrings.push(ctx.get('user-agent'));
const body = JSON.parse((await Helpers.readableToBuffer(ctx.req)).toString());
resolve(body);
ctx.body = 'Ok';
});
});
await agent.goto(`${koaServer.baseUrl}/workers-test`);
const params = await xhr;
for (const useragent of requestUserAgentStrings) {
expect(useragent).toBe(agentMeta.userAgentString);
}
for (const prop of propsToGet) {
const windowValue = await agent.getJsValue(`navigator.${prop}`);
expect(params[prop]).toStrictEqual(windowValue);
expect(`${prop}=${params[prop]}`).toStrictEqual(`${prop}=${windowValue}`);
}
});
it('should add user agent and platform to service workers', async () => {
const agent = await handler.createAgent();
Helpers.needsClosing.push(agent);
const agentMeta = await agent.meta;
const requestUserAgentStrings: string[] = [];
koaServer.get('/sw-test', ctx => {
requestUserAgentStrings.push(ctx.get('user-agent'));
ctx.body = `<html lang="en">
<h1>Service Worker Test</h1>
<script>
navigator.serviceWorker.register('./service-worker.js');
navigator.serviceWorker.ready.then((reg) => {
if (reg.active) {
reg.active.postMessage("send");
}
});
navigator.serviceWorker.addEventListener("message", (event) => {
fetch('/service-xhr', {
method: 'POST',
body: event.data
});
});
</script>
</html>`;
});
koaServer.get('/service-worker.js', ctx => {
requestUserAgentStrings.push(ctx.get('user-agent'));
ctx.set('content-type', 'application/javascript');
ctx.body = `
self.addEventListener("install", (event) => {
event.waitUntil(self.skipWaiting());
});
self.addEventListener('activate', event => {
event.waitUntil(self.clients.claim());
});
self.addEventListener('message', async event => {
if (event.data !== 'send') return;
self.skipWaiting();
self.clients.claim();
const clients = await self.clients.matchAll();
const { ${propsToGet.join(',')} } = navigator;
const data = JSON.stringify({ ${propsToGet.join(',')} });
clients.forEach(client => client.postMessage(data));
});`;
});
const xhr = new Promise<object>(resolve => {
koaServer.post('/service-xhr', async ctx => {
requestUserAgentStrings.push(ctx.get('user-agent'));
const body = JSON.parse((await Helpers.readableToBuffer(ctx.req)).toString());
resolve(body);
ctx.body = 'Ok';
});
});
await agent.goto(`${koaServer.baseUrl}/sw-test`);
const params = await xhr;
for (const useragent of requestUserAgentStrings) {
expect(useragent).toBe(agentMeta.userAgentString);
}
for (const prop of propsToGet) {
const windowValue = await agent.getJsValue(`navigator.${prop}`);
expect(params[prop]).toStrictEqual(windowValue);
}
});
it('should be able to load the creep-js phantom worker tests', async () => {
let jsonResult = new Resolvable<string>();
const httpsServer = await Helpers.runHttpsServer(async (req, res) => {
res.setHeader('access-control-allow-origin', '*');
if (req.url.match('/creepjs/tests/workers.html')) {
res.end(`<!DOCTYPE html>
<html lang="en">
<body>
<div id="fingerprint-data"></div>
<script src="workers.js"></script>
</body>
</html>`);
} else if (req.url.includes('worker-result')) {
const result = await Helpers.readableToBuffer(req);
jsonResult.resolve(result.toString());
res.end('');
} else {
await new Promise(resolve => setTimeout(resolve, 50));
const body = Fs.readFileSync(`${__dirname}/html/worker.js`);
res.setHeader('etag', 'W/"602f25aa-573c"');
res.setHeader('content-type', 'application/javascript; charset=utf-8');
res.end(body);
}
});
jsonResult = new Resolvable<string>();
const agent = await handler.createAgent();
Helpers.needsClosing.push(agent);
await agent.goto(`${httpsServer.baseUrl}/creepjs/tests/workers.html`);
const result = JSON.parse(await jsonResult.promise);
expect(result).toBeTruthy();
const { windowScope, dedicatedWorker, sharedWorker, serviceWorker } = result;
expect(windowScope.userAgent).toBe(dedicatedWorker.userAgent);
expect(windowScope.userAgent).toBe(serviceWorker.userAgent);
expect(windowScope.userAgent).toBe(sharedWorker.userAgent);
expect(windowScope.memory).toBe(dedicatedWorker.memory);
expect(windowScope.memory).toBe(serviceWorker.memory);
expect(windowScope.memory).toBe(sharedWorker.memory);
await agent.close();
});
it.skip('should load creepjs', async () => {
const agent = await handler.createAgent();
Helpers.needsClosing.push(agent);
await agent.goto('https://abrahamjuliot.github.io/creepjs/tests/workers.html');
await agent.waitForPaintingStable();
const cols = await agent.document.querySelectorAll('.col-six');
for (const col of cols) {
const background = await col.getAttribute('style');
expect(background.trim()).toBe('background: none');
}
});
});
