forked from darkreader/darkreader
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathenvironment.js
More file actions
510 lines (460 loc) · 20 KB
/
Copy pathenvironment.js
File metadata and controls
510 lines (460 loc) · 20 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
import {TestEnvironment} from 'jest-environment-node';
import {launch, connect} from 'puppeteer-core';
import {cmd} from 'web-ext';
import {WebSocketServer} from 'ws';
import {generateHTMLCoverageReports} from './coverage.js';
import {getChromePath, getFirefoxPath, chromeExtensionDebugDir, chromeMV3ExtensionDebugDir, firefoxExtensionDebugDir} from './paths.js';
import {createTestServer, generateRandomId} from './server.js';
const TEST_SERVER_PORT = 8891;
const CORS_SERVER_PORT = 8892;
const FIREFOX_DEVTOOLS_PORT = 8893;
const POPUP_TEST_PORT = 8894;
export default class CustomJestEnvironment extends TestEnvironment {
/** @type {() => void} */
extensionStartListeners = [];
pageEventListeners = new Map();
/** @type {Browser} */
browser;
/** @type {WebSocketServer} */
messageServer;
async setup() {
await super.setup();
const promises1 = [
this.createMessageServer(),
this.launchBrowser(),
];
const promises2 = [
createTestServer(TEST_SERVER_PORT),
createTestServer(CORS_SERVER_PORT),
];
const results1 = await Promise.all(promises1);
this.messageServer = results1[0];
this.browser = results1[1];
promises2.push(
this.createTestPage(),
);
const results2 = await Promise.all(promises2);
this.testServer = results2[0];
this.corsServer = results2[1];
this.page = results2[2];
// Wait for tabs to load?
this.assignTestGlobals(this.global, this.testServer, this.corsServer, this.page);
}
/**
* @returns {Promise<void>}
*/
async waitForStartup() {
if (!this.extensionOrigin) {
return new Promise((ready) => this.extensionStartListeners.push(ready));
}
}
/**
* @returns {Promise<Browser>}
*/
async launchBrowser() {
let browser;
if (this.global.product === 'chrome') {
browser = await this.launchChrome({manifestVersion: 2});
} else if (this.global.product === 'chrome-mv3') {
browser = await this.launchChrome({manifestVersion: 3});
} else if (this.global.product === 'firefox') {
browser = await this.launchFirefox();
}
// Wait for the extension to start
await this.waitForStartup();
return browser;
}
/**
* @param {{manifestVersion: number}} options
* @returns {Promise<Browser>}
*/
async launchChrome({manifestVersion}) {
const extensionDir = manifestVersion === 3 ? chromeMV3ExtensionDebugDir : chromeExtensionDebugDir;
let executablePath;
try {
executablePath = await getChromePath();
} catch (e) {
console.error(e);
}
// Explanation of these options:
// https://pptr.dev/guides/chrome-extensions
return await launch({
executablePath,
headless: false,
args: [
`--disable-extensions-except=${extensionDir}`,
`--load-extension=${extensionDir}`,
'--show-component-extension-options',
],
});
}
/**
* @returns {Promise<Browser>}
*/
async launchFirefoxPuppeteer() {
const retries = 10;
const retryIntervalInMs = 500;
for (let i = 0; i < retries; i++) {
await new Promise((resolve) => setTimeout(resolve, retryIntervalInMs));
try {
return await connect({
browserURL: `http://localhost:${FIREFOX_DEVTOOLS_PORT}`,
});
} catch (err) {
console.log(`Firefox connection attempt ${i + 1} failed:`, e);
}
}
throw new Error('Failed to connect to Puppeteer');
}
/**
* @returns {Promise<Browser>}
*/
async launchFirefox() {
// We need to manually launch Firefox via cmd.run() to install extension
// because Firefox does not support installing via CLI arguments
const firefox = await getFirefoxPath();
await cmd.run({
sourceDir: firefoxExtensionDebugDir,
firefox,
noReload: true,
args: ['--remote-debugging-port', FIREFOX_DEVTOOLS_PORT],
}, {
shouldExitProgram: false,
});
return await this.launchFirefoxPuppeteer();
}
async createTestPage() {
if (this.global.product === 'firefox') {
return;
}
const page = await this.browser.newPage();
page.on('pageerror', (err) => process.emit('uncaughtException', err));
await page.coverage.startJSCoverage();
return page;
}
async getURL(path) {
// By this point browser should be loaded and extension should be started, but
// let's wait anuway
await this.waitForStartup();
const url = new URL(path, this.extensionOrigin);
return url.href;
}
async getChromiumMV2BackgroundPage() {
const targets = this.browser.targets();
const backgroundTarget = targets.find((t) => t.type() === 'background_page');
return await backgroundTarget.page();
}
async awaitForEvent(uuid) {
return new Promise((resolve) => {
if (this.pageEventListeners.has(uuid)) {
this.pageEventListeners.get(uuid).push(resolve);
} else {
this.pageEventListeners.set(uuid, [resolve]);
}
});
}
/**
* @param {Page} page
* @param {string} url
* @param {WaitForOptions} gotoOptions
* @returns Promise which resolves when page loads
*/
async pageGoto(url, gotoOptions) {
// Normalize URL
const pathname = new URL(url).pathname;
// Depending on external circumstances, page may connect to server before page.goto() reolves
const promise = this.awaitForEvent(`ready-${pathname}`);
// Firefox does not resolve promise returned by page.goto()
// Doesn't resolve due to https://github.com/puppeteer/puppeteer/issues/6616
// TODO(anton): remove this once Firefox supports tab.eval() via WebDriver BiDi
if (this.global.product !== 'firefox') {
await this.page.goto(url, gotoOptions);
} else {
await this.global.backgroundUtils.createTab(url);
}
await promise;
}
async openTestPage(url, gotoOptions) {
if (this.global.product !== 'firefox') {
await this.page.bringToFront();
}
await this.pageGoto(url, gotoOptions);
}
onPageEventResponse(eventUUID) {
const resolves = this.pageEventListeners.get(eventUUID);
this.pageEventListeners.delete(eventUUID);
resolves && resolves.forEach((r) => r());
}
/**
* This function is evaluated within browser's page context
* after being passed to page.evaluate()
* It can use methods which will be defined in the page context,
* but can not use variables defined in this file besides those passed into it.
*/
async checkPageStylesInBrowserContext(expectations) {
const checkOne = (expectation) => {
const [selector, cssAttributeName, expectedValue] = expectation;
const selector_ = Array.isArray(selector) ? selector : [selector];
let element = document;
for (const part of selector_) {
if (element instanceof HTMLIFrameElement) {
element = element.contentDocument;
}
if (element.shadowRoot instanceof ShadowRoot) {
element = element.shadowRoot;
}
if (part === 'document') {
element = element.documentElement;
} else {
element = element.querySelector(part);
}
if (!element) {
return `Could not find element ${part}`;
}
}
const style = getComputedStyle(element);
if (style[cssAttributeName] !== expectedValue) {
return `Expected ${selector_.join(' ')} '${cssAttributeName}' to be '${expectedValue}', but got '${style[cssAttributeName]}'`;
}
};
const checkAll = () => {
/** @type{Array<[number, string]>} */
const errors = [];
for (let i = 0; i < expectations.length; i++) {
const error = checkOne(expectations[i]);
if (error) {
errors.push(error);
}
}
return errors;
};
let timeout = 10;
let errors = checkAll();
for (let i = 0; (errors.length !== 0) && (i < 10); i++) {
timeout *= 2;
await new Promise((r) => requestIdleCallback(r, {timeout}));
errors = checkAll();
}
return errors;
}
assignTestGlobals(global, testServer, corsServer, page) {
global.getColorScheme = async () => {
if (global.product === 'firefox') {
return await global.backgroundUtils.getColorScheme();
}
const isDark = await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches);
return isDark ? 'dark' : 'light';
};
global.pageUtils.evaluateScript = async (script) => {
if (global.product === 'firefox') {
if (typeof script !== 'function') {
throw new Error('Not implemented');
}
return await global.pageUtils.evaluate(`(${script.toString()})()`);
}
return await page.evaluate(script);
};
global.expectPageStyles = async (expect, expectations) => {
if (global.product === 'firefox') {
const errors = await global.pageUtils.expectPageStyles(expectations);
expect(errors.length).toBe(0);
return;
}
if (!Array.isArray(expectations[0])) {
expectations = [expectations];
}
const errors = await page.evaluate(this.checkPageStylesInBrowserContext, expectations);
expect(errors.join('\n')).toBe('');
};
global.emulateColorScheme = async (colorScheme) => {
if (global.product === 'firefox') {
await global.pageUtils.emulateColorScheme(colorScheme);
await global.backgroundUtils.emulateColorScheme(colorScheme);
const newPageColorScheme = await global.backgroundUtils.getColorScheme();
const newBGColorScheme = await global.pageUtils.getColorScheme();
if (newPageColorScheme !== colorScheme || newBGColorScheme !== colorScheme) {
throw new Error('Failed to apply new color scheme');
}
return;
}
await page.emulateMediaFeatures([{name: 'prefers-color-scheme', value: colorScheme}]);
if (global.product === 'chrome') {
const page = await this.getChromiumMV2BackgroundPage();
await page.emulateMediaFeatures([{name: 'prefers-color-scheme', value: colorScheme}]);
}
};
global.loadTestPage = async (paths, gotoOptions) => {
const {cors, ...testPaths} = paths;
testServer.setPaths(testPaths);
cors && corsServer.setPaths(cors);
await this.openTestPage(`http://localhost:${TEST_SERVER_PORT}`, gotoOptions);
};
global.corsURL = corsServer.url;
}
/**
* Creates a server and returns once extension connects to it
* @returns {Promise<WebSocketServer>} server
*/
async createMessageServer() {
const awaitForEvent = this.awaitForEvent.bind(this);
// Puppeteer cannot evaluate scripts in moz-extension:// pages
// https://github.com/puppeteer/puppeteer/issues/6616
return new Promise((resolve) => {
const wsServer = new WebSocketServer({port: POPUP_TEST_PORT});
let backgroundSocket = null;
let devToolsSocket = null;
const popupSockets = new Set();
const pageSockets = new Set();
const resolvers = new Map();
const rejectors = new Map();
let onDownloadCallback = null;
wsServer.on('connection', async (ws) => {
ws.on('message', (data) => {
const message = JSON.parse(data);
if (message.id === null && message.data && message.data.type === 'background' && message.data.extensionOrigin) {
// This is the initial message which contains extension's URL origin
// and signals that extenstion is ready
this.extensionOrigin = message.data.extensionOrigin;
this.extensionStartListeners.forEach((ready) => ready());
ws.on('close', () => backgroundSocket = null);
backgroundSocket = ws;
resolve(wsServer);
} else if (message.id === null && message.data && message.data.type === 'devtools') {
ws.on('close', () => devToolsSocket = null);
devToolsSocket = ws;
this.onPageEventResponse(message.data.uuid);
} else if (message.id === null && message.data && message.data.type === 'popup') {
ws.on('close', () => popupSockets.delete(ws));
popupSockets.add(ws);
this.onPageEventResponse(message.data.uuid);
} else if (message.id === null && message.data && message.data.type === 'page') {
if (message.data.message === 'page-ready') {
ws.on('close', () => pageSockets.delete(ws));
// Filter out non-top frames
// this is to simplify expectPageStyle implementation
if (message.data.uuid === 'ready-/') {
pageSockets.add(ws);
}
}
this.onPageEventResponse(message.data.uuid);
} else if (message.id === null && message.data && message.data.type === 'download') {
if (onDownloadCallback) {
onDownloadCallback(message.data);
}
} else if (message.error) {
const reject = rejectors.get(message.id);
reject(message.error);
} else {
const resolve = resolvers.get(message.id);
resolve(message.data);
}
resolvers.delete(message.id);
rejectors.delete(message.id);
});
});
function sendToContext(sockets, type, data) {
return new Promise((resolve, reject) => {
const id = generateRandomId();
resolvers.set(id, resolve);
rejectors.set(id, reject);
const json = JSON.stringify({type, data, id});
for (const ws of sockets) {
ws.send(json);
}
});
}
function sendToPopup(type, data) {
return sendToContext(Array.from(popupSockets), type, data);
}
function sendToDevTools(type, data) {
return sendToContext([devToolsSocket], type, data);
}
function sendToBackground(type, data) {
return sendToContext([backgroundSocket], type, data);
}
function sendToPage(type, data) {
return sendToContext(Array.from(pageSockets), type, data);
}
async function applyDevtoolsConfig(type, fixes) {
const promise = awaitForEvent('darkreader-dynamic-theme-ready');
await Promise.all([
sendToDevTools(type, fixes),
promise,
]);
}
this.global.popupUtils = {
saveFile: async (name, content) => sendToPopup('popup-saveFile', {name, content}),
click: async (selector) => await sendToPopup('popup-click', selector),
exists: async (selector) => await sendToPopup('popup-exists', selector),
};
this.global.devtoolsUtils = {
click: async (selector) => await sendToDevTools('devtools-click', selector),
exists: async (selector) => await sendToDevTools('devtools-exists', selector),
paste: async (fixes) => await applyDevtoolsConfig('devtools-paste', fixes),
reset: async () => await applyDevtoolsConfig('devtools-reset'),
};
this.global.backgroundUtils = {
changeSettings: async (settings) => await sendToBackground('changeSettings', settings),
collectData: async () => await sendToBackground('collectData'),
changeChromeStorage: async (region, data) => await sendToBackground('changeChromeStorage', {region, data}),
getChromeStorage: async (region, keys) => await sendToBackground('getChromeStorage', {region, keys}),
getManifest: async () => await sendToBackground('getManifest'),
getColorScheme: async () => {
if (this.global.product !== 'firefox') {
throw new Error('Not supported');
}
return await sendToBackground('firefox-getColorScheme');
},
createTab: async (url) => {
if (this.global.product !== 'firefox') {
throw new Error('Not supported');
}
await sendToBackground('firefox-createTab', url);
},
emulateColorScheme: async (colorScheme) => {
if (this.global.product !== 'firefox') {
throw new Error('Not supported');
}
await sendToBackground('firefox-emulateColorScheme', colorScheme);
},
setNews: async (news) => await sendToBackground('setNews', news),
onDownload: (callback) => onDownloadCallback = callback,
};
this.global.pageUtils = {
evaluate: async (script) => await sendToPage('firefox-eval', script),
expectPageStyles: async (expectations) => await sendToPage('firefox-expectPageStyles', expectations),
emulateColorScheme: async (colorScheme) => await sendToPage('firefox-emulateColorScheme', colorScheme),
getColorScheme: async () => {
if (this.global.product !== 'firefox') {
throw new Error('Not supported');
}
return await sendToPage('firefox-getColorScheme');
},
};
this.global.awaitForEvent = awaitForEvent;
});
}
/**
* @returns {Promise<void>}
*/
async teardown() {
await super.teardown();
const promises = [];
if (this.global.product !== 'firefox' && this.page?.coverage) {
const coverage = await this.page.coverage.stopJSCoverage();
const dir = './tests/browser/coverage/';
const promise = generateHTMLCoverageReports(dir, coverage);
promise.then(() => console.info('Coverage reports generated in', dir));
promises.push(promise);
}
// Note: this.browser.close() will close all tabs, so no need to close them
// explicitly
promises.push([
this.testServer?.close(),
this.corsServer?.close(),
this.messageServer?.close(),
this.browser?.close(),
]);
await Promise.all(promises);
}
}