mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
* Update test environments and lint configuration Update Jest (unit + integration) and Playwright (e2e) test environments. Includes stability improvements for e2e tests using newer, more stable methods per the Playwright docs. - Update Jest 26 => 27 - Update Jest-related libs (babel parser) - Update Playwright 1.8 => Playwright Test 1.18 - Update GitHub CI (action versions, job parallelization, and matrices) - Update ESLint 5 => 8 - Update ESLint-related libs (parser, prettier, Jest, Playwright) - Fix test failures on M1-based Macs - Fix e2e stability issues by replacing PW $ method calls - Fix ESLint errors - Fix incorrect CI flag on Jest runs (-ci => --ci) - Refactor e2e test runner from Jest to Playwright Test - Refactor e2e test files for Playwright Test - Refactor fix-lint script name to lint:fix for consistency - Refactor npm scripts order for readability - Remove unnecessary configs and libs - Remove example image snapshots
86 lines
2.4 KiB
JavaScript
86 lines
2.4 KiB
JavaScript
/* global afterEach, beforeAll, beforeEach */
|
|
|
|
import mock from 'xhr-mock';
|
|
|
|
const sideEffects = {
|
|
document: {
|
|
addEventListener: {
|
|
fn: document.addEventListener,
|
|
refs: [],
|
|
},
|
|
keys: Object.keys(document),
|
|
},
|
|
window: {
|
|
addEventListener: {
|
|
fn: window.addEventListener,
|
|
refs: [],
|
|
},
|
|
keys: Object.keys(window),
|
|
},
|
|
};
|
|
|
|
// Lifecycle Hooks
|
|
// -----------------------------------------------------------------------------
|
|
beforeAll(async () => {
|
|
// Spy addEventListener
|
|
['document', 'window'].forEach(obj => {
|
|
const fn = sideEffects[obj].addEventListener.fn;
|
|
const refs = sideEffects[obj].addEventListener.refs;
|
|
|
|
function addEventListenerSpy(type, listener, options) {
|
|
// Store listener reference so it can be removed during reset
|
|
refs.push({ type, listener, options });
|
|
// Call original window.addEventListener
|
|
fn(type, listener, options);
|
|
}
|
|
|
|
// Add to default key array to prevent removal during reset
|
|
sideEffects[obj].keys.push('addEventListener');
|
|
|
|
// Replace addEventListener with mock
|
|
global[obj].addEventListener = addEventListenerSpy;
|
|
});
|
|
});
|
|
|
|
// Reset JSDOM. This attempts to remove side effects from tests, however it does
|
|
// not reset all changes made to globals like the window and document
|
|
// objects. Tests requiring a full JSDOM reset should be stored in separate
|
|
// files, which is only way to do a complete JSDOM reset with Jest.
|
|
beforeEach(async () => {
|
|
const rootElm = document.documentElement;
|
|
|
|
// Remove attributes on root element
|
|
[...rootElm.attributes].forEach(attr => rootElm.removeAttribute(attr.name));
|
|
|
|
// Remove elements (faster than setting innerHTML)
|
|
while (rootElm.firstChild) {
|
|
rootElm.removeChild(rootElm.firstChild);
|
|
}
|
|
|
|
// Remove global listeners and keys
|
|
['document', 'window'].forEach(obj => {
|
|
const refs = sideEffects[obj].addEventListener.refs;
|
|
|
|
// Listeners
|
|
while (refs.length) {
|
|
const { type, listener, options } = refs.pop();
|
|
global[obj].removeEventListener(type, listener, options);
|
|
}
|
|
|
|
// Keys
|
|
Object.keys(global[obj])
|
|
.filter(key => !sideEffects[obj].keys.includes(key))
|
|
.forEach(key => {
|
|
delete global[obj][key];
|
|
});
|
|
});
|
|
|
|
// Restore base elements
|
|
rootElm.innerHTML = '<head></head><body></body>';
|
|
});
|
|
|
|
afterEach(async () => {
|
|
// Restore the global XMLHttpRequest object to its original state
|
|
mock.teardown();
|
|
});
|