@axe-core/watcher 3.11.0-rc.e230efa3 → 3.11.1-next.06e682d4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Controller.d.ts +9 -1
- package/dist/Controller.js +24 -10
- package/dist/Controller.js.map +1 -1
- package/dist/EventForwarder.js +4 -6
- package/dist/EventForwarder.js.map +1 -1
- package/dist/createDebugger.d.ts +9 -0
- package/dist/createDebugger.js +27 -0
- package/dist/createDebugger.js.map +1 -0
- package/dist/cypress.d.ts +1 -1
- package/dist/cypress.js +45 -45
- package/dist/cypress.js.map +1 -1
- package/dist/cypressCommands.d.ts +3 -1
- package/dist/cypressCommands.js +88 -86
- package/dist/cypressCommands.js.map +1 -1
- package/dist/git.d.ts +2 -1
- package/dist/git.js +5 -4
- package/dist/git.js.map +1 -1
- package/dist/playwright.d.ts +1 -1
- package/dist/playwright.js +10 -7
- package/dist/playwright.js.map +1 -1
- package/dist/playwrightTest.js +10 -3
- package/dist/playwrightTest.js.map +1 -1
- package/dist/playwrightWrapping.d.ts +1 -1
- package/dist/playwrightWrapping.js +41 -41
- package/dist/playwrightWrapping.js.map +1 -1
- package/dist/puppeteer.d.ts +1 -1
- package/dist/puppeteer.js +11 -8
- package/dist/puppeteer.js.map +1 -1
- package/dist/puppeteerWrapping.d.ts +3 -2
- package/dist/puppeteerWrapping.js +100 -42
- package/dist/puppeteerWrapping.js.map +1 -1
- package/dist/sendResultsToServer.d.ts +9 -2
- package/dist/sendResultsToServer.js +26 -44
- package/dist/sendResultsToServer.js.map +1 -1
- package/dist/utils/constants.d.ts +4 -0
- package/dist/utils/constants.js +16 -0
- package/dist/utils/constants.js.map +1 -0
- package/dist/utils/headlessNotSupportedError.d.ts +5 -0
- package/dist/utils/headlessNotSupportedError.js +17 -0
- package/dist/utils/headlessNotSupportedError.js.map +1 -0
- package/dist/utils/headlessNotSupportedError.test.d.ts +1 -0
- package/dist/utils/headlessNotSupportedError.test.js +21 -0
- package/dist/utils/headlessNotSupportedError.test.js.map +1 -0
- package/dist/utils/mergeChromeArgs.d.ts +12 -0
- package/dist/utils/mergeChromeArgs.js +73 -0
- package/dist/utils/mergeChromeArgs.js.map +1 -0
- package/dist/utils/mergeChromeArgs.test.d.ts +1 -0
- package/dist/utils/mergeChromeArgs.test.js +260 -0
- package/dist/utils/mergeChromeArgs.test.js.map +1 -0
- package/dist/utils/proxyHandlers.d.ts +12 -0
- package/dist/utils/proxyHandlers.js +62 -0
- package/dist/utils/proxyHandlers.js.map +1 -0
- package/dist/utils/proxyHandlers.test.d.ts +1 -0
- package/dist/utils/proxyHandlers.test.js +28 -0
- package/dist/utils/proxyHandlers.test.js.map +1 -0
- package/dist/utils/readVariables.d.ts +7 -0
- package/dist/utils/readVariables.js +17 -0
- package/dist/utils/readVariables.js.map +1 -0
- package/dist/utils/updateAutoAnalyze.d.ts +7 -0
- package/dist/utils/updateAutoAnalyze.js +20 -0
- package/dist/utils/updateAutoAnalyze.js.map +1 -0
- package/dist/utils/validateApiKey.d.ts +7 -0
- package/dist/utils/validateApiKey.js +34 -0
- package/dist/utils/validateApiKey.js.map +1 -0
- package/dist/utils/validateApiKey.test.d.ts +1 -0
- package/dist/utils/validateApiKey.test.js +66 -0
- package/dist/utils/validateApiKey.test.js.map +1 -0
- package/dist/utils/validateAxeRunContext.d.ts +2 -0
- package/dist/utils/validateAxeRunContext.js +59 -0
- package/dist/utils/validateAxeRunContext.js.map +1 -0
- package/dist/utils/validateAxeRunContext.test.d.ts +1 -0
- package/dist/utils/validateAxeRunContext.test.js +100 -0
- package/dist/utils/validateAxeRunContext.test.js.map +1 -0
- package/dist/utils/validateAxeRunOptions.d.ts +13 -0
- package/dist/utils/validateAxeRunOptions.js +161 -0
- package/dist/utils/validateAxeRunOptions.js.map +1 -0
- package/dist/utils/validateAxeRunOptions.test.d.ts +1 -0
- package/dist/utils/validateAxeRunOptions.test.js +230 -0
- package/dist/utils/validateAxeRunOptions.test.js.map +1 -0
- package/dist/utils/writeExtensionManifest.d.ts +7 -0
- package/dist/utils/writeExtensionManifest.js +18 -0
- package/dist/utils/writeExtensionManifest.js.map +1 -0
- package/dist/utils/writeVariables.d.ts +64 -0
- package/dist/utils/writeVariables.js +119 -0
- package/dist/utils/writeVariables.js.map +1 -0
- package/dist/utils/writeVariables.test.d.ts +1 -0
- package/dist/utils/writeVariables.test.js +184 -0
- package/dist/utils/writeVariables.test.js.map +1 -0
- package/dist/wdio.d.ts +1 -1
- package/dist/wdio.js +18 -13
- package/dist/wdio.js.map +1 -1
- package/dist/webdriver.d.ts +1 -1
- package/dist/webdriver.js +15 -8
- package/dist/webdriver.js.map +1 -1
- package/dist/webdriverWrapping.d.ts +1 -1
- package/dist/webdriverWrapping.js +16 -16
- package/dist/webdriverWrapping.js.map +1 -1
- package/extension/background.js +1 -1
- package/extension/content.js +1 -1
- package/package.json +11 -8
- package/dist/util.d.ts +0 -66
- package/dist/util.js +0 -167
- package/dist/util.js.map +0 -1
package/dist/Controller.d.ts
CHANGED
|
@@ -1,9 +1,17 @@
|
|
|
1
|
+
import type { Debugger } from 'debug';
|
|
2
|
+
interface ControllerParams {
|
|
3
|
+
/** The namespace for the debug logger. */
|
|
4
|
+
debugLoggerName: string;
|
|
5
|
+
}
|
|
1
6
|
declare abstract class Controller {
|
|
2
7
|
protected abstract executeScript<A = unknown, T = void>(fn: string | ((...args: A[]) => Promise<T>), ...args: unknown[]): Promise<T>;
|
|
3
8
|
protected isStopped: boolean;
|
|
9
|
+
protected debugLogger: Debugger;
|
|
10
|
+
constructor({ debugLoggerName }: ControllerParams);
|
|
4
11
|
start(): Promise<void>;
|
|
5
12
|
stop(): Promise<void>;
|
|
6
|
-
analyze({ __UserRequestedAnalyze }?: {
|
|
13
|
+
analyze({ __Method, __UserRequestedAnalyze }?: {
|
|
14
|
+
__Method?: string;
|
|
7
15
|
__UserRequestedAnalyze?: boolean;
|
|
8
16
|
}): Promise<void>;
|
|
9
17
|
flush(): Promise<void>;
|
package/dist/Controller.js
CHANGED
|
@@ -3,14 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
const
|
|
6
|
+
const updateAutoAnalyze_1 = __importDefault(require("./utils/updateAutoAnalyze"));
|
|
7
7
|
const sendResultsToServer_1 = __importDefault(require("./sendResultsToServer"));
|
|
8
|
+
const createDebugger_1 = __importDefault(require("./createDebugger"));
|
|
8
9
|
class Controller {
|
|
9
|
-
constructor() {
|
|
10
|
+
constructor({ debugLoggerName }) {
|
|
10
11
|
this.isStopped = false;
|
|
12
|
+
this.debugLogger = (0, createDebugger_1.default)(debugLoggerName);
|
|
11
13
|
}
|
|
12
14
|
async start() {
|
|
13
|
-
(0,
|
|
15
|
+
(0, updateAutoAnalyze_1.default)(true);
|
|
14
16
|
this.isStopped = false;
|
|
15
17
|
await this.executeScript(() => {
|
|
16
18
|
if (!['http:', 'https:', 'file:'].includes(window.location.protocol)) {
|
|
@@ -28,7 +30,7 @@ class Controller {
|
|
|
28
30
|
});
|
|
29
31
|
}
|
|
30
32
|
async stop() {
|
|
31
|
-
(0,
|
|
33
|
+
(0, updateAutoAnalyze_1.default)(false);
|
|
32
34
|
this.isStopped = true;
|
|
33
35
|
await this.executeScript(() => {
|
|
34
36
|
if (!['http:', 'https:', 'file:'].includes(window.location.protocol)) {
|
|
@@ -45,19 +47,24 @@ class Controller {
|
|
|
45
47
|
});
|
|
46
48
|
});
|
|
47
49
|
}
|
|
48
|
-
async analyze({ __UserRequestedAnalyze = true } = {}) {
|
|
50
|
+
async analyze({ __Method, __UserRequestedAnalyze = true } = {}) {
|
|
51
|
+
this.debugLogger(`Analyze: Invoked${__Method ? ` - ${__Method}` : ''}`);
|
|
49
52
|
// If the user didn't request an analyze, and we're in manual mode, don't do anything.
|
|
50
53
|
if (this.isStopped && !__UserRequestedAnalyze) {
|
|
54
|
+
this.debugLogger('Analyze: Skipped', {
|
|
55
|
+
isStopped: this.isStopped,
|
|
56
|
+
__UserRequestedAnalyze
|
|
57
|
+
});
|
|
51
58
|
return;
|
|
52
59
|
}
|
|
53
|
-
await this.executeScript((userRequestedAnalyze) => {
|
|
60
|
+
const result = await this.executeScript((userRequestedAnalyze) => {
|
|
54
61
|
if (!['http:', 'https:', 'file:'].includes(window.location.protocol)) {
|
|
55
|
-
return Promise.resolve();
|
|
62
|
+
return Promise.resolve({ message: 'Skipped - Invalid protocol' });
|
|
56
63
|
}
|
|
57
64
|
return new Promise(resolve => {
|
|
58
|
-
const fn = () => {
|
|
65
|
+
const fn = (event) => {
|
|
59
66
|
window.removeEventListener('axe:manual-mode-analyze-done', fn);
|
|
60
|
-
resolve();
|
|
67
|
+
resolve(event.detail);
|
|
61
68
|
};
|
|
62
69
|
window.addEventListener('axe:manual-mode-analyze-done', fn);
|
|
63
70
|
const event = new CustomEvent('axe:manual-mode-analyze', {
|
|
@@ -66,8 +73,10 @@ class Controller {
|
|
|
66
73
|
window.dispatchEvent(event);
|
|
67
74
|
});
|
|
68
75
|
}, __UserRequestedAnalyze);
|
|
76
|
+
this.debugLogger(`Analyze: ${result.message}`);
|
|
69
77
|
}
|
|
70
78
|
async flush() {
|
|
79
|
+
this.debugLogger('Flush: Invoked (may analyze implicitly)');
|
|
71
80
|
const results = await this.executeScript(() => {
|
|
72
81
|
if (!['http:', 'https:', 'file:'].includes(window.location.protocol)) {
|
|
73
82
|
return Promise.resolve([]);
|
|
@@ -88,7 +97,12 @@ class Controller {
|
|
|
88
97
|
window.dispatchEvent(event);
|
|
89
98
|
});
|
|
90
99
|
});
|
|
91
|
-
|
|
100
|
+
this.debugLogger(`Flush: Received ${results.length} results`);
|
|
101
|
+
await (0, sendResultsToServer_1.default)({
|
|
102
|
+
results,
|
|
103
|
+
debugLogger: this.debugLogger
|
|
104
|
+
});
|
|
105
|
+
this.debugLogger('Flush: Complete');
|
|
92
106
|
}
|
|
93
107
|
}
|
|
94
108
|
exports.default = Controller;
|
package/dist/Controller.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Controller.js","sourceRoot":"","sources":["../src/Controller.ts"],"names":[],"mappings":";;;;;AAAA,
|
|
1
|
+
{"version":3,"file":"Controller.js","sourceRoot":"","sources":["../src/Controller.ts"],"names":[],"mappings":";;;;;AAAA,kFAAyD;AACzD,gFAAwE;AACxE,sEAA6C;AAQ7C,MAAe,UAAU;IASvB,YAAY,EAAE,eAAe,EAAoB;QAHvC,cAAS,GAAG,KAAK,CAAA;QAIzB,IAAI,CAAC,WAAW,GAAG,IAAA,wBAAc,EAAC,eAAe,CAAC,CAAA;IACpD,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,IAAA,2BAAiB,EAAC,IAAI,CAAC,CAAA;QACvB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QAEtB,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE;YAC5B,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;YAC1B,CAAC;YAED,OAAO,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;gBACjC,MAAM,EAAE,GAAG,GAAS,EAAE;oBACpB,MAAM,CAAC,mBAAmB,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAA;oBAC1D,OAAO,EAAE,CAAA;gBACX,CAAC,CAAA;gBACD,MAAM,CAAC,gBAAgB,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAA;gBACvD,MAAM,KAAK,GAAG,IAAI,WAAW,CAAC,qBAAqB,CAAC,CAAA;gBACpD,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAC7B,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,IAAA,2BAAiB,EAAC,KAAK,CAAC,CAAA;QACxB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QAErB,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE;YAC5B,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;YAC1B,CAAC;YAED,OAAO,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;gBACjC,MAAM,EAAE,GAAG,GAAS,EAAE;oBACpB,MAAM,CAAC,mBAAmB,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAA;oBACzD,OAAO,EAAE,CAAA;gBACX,CAAC,CAAA;gBACD,MAAM,CAAC,gBAAgB,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAA;gBACtD,MAAM,KAAK,GAAG,IAAI,WAAW,CAAC,oBAAoB,CAAC,CAAA;gBACnD,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAC7B,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,EACnB,QAAQ,EACR,sBAAsB,GAAG,IAAI,KAI3B,EAAE;QACJ,IAAI,CAAC,WAAW,CAAC,mBAAmB,QAAQ,CAAC,CAAC,CAAC,MAAM,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QACvE,sFAAsF;QACtF,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC9C,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE;gBACnC,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,sBAAsB;aACvB,CAAC,CAAA;YACF,OAAM;QACR,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC,oBAA6B,EAAE,EAAE;YACxE,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrE,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,4BAA4B,EAAE,CAAC,CAAA;YACnE,CAAC;YAED,OAAO,IAAI,OAAO,CAAsB,OAAO,CAAC,EAAE;gBAChD,MAAM,EAAE,GAAG,CAAC,KAAkB,EAAQ,EAAE;oBACtC,MAAM,CAAC,mBAAmB,CACxB,8BAA8B,EAC9B,EAAgB,CACjB,CAAA;oBACD,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;gBACvB,CAAC,CAAA;gBACD,MAAM,CAAC,gBAAgB,CACrB,8BAA8B,EAC9B,EAAgB,CACjB,CAAA;gBACD,MAAM,KAAK,GAAG,IAAI,WAAW,CAAC,yBAAyB,EAAE;oBACvD,MAAM,EAAE,EAAE,oBAAoB,EAAE;iBACjC,CAAC,CAAA;gBACF,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAC7B,CAAC,CAAC,CAAA;QACJ,CAAC,EAAE,sBAAsB,CAAC,CAAA;QAE1B,IAAI,CAAC,WAAW,CAAC,YAAY,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;IAChD,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,WAAW,CAAC,yCAAyC,CAAC,CAAA;QAC3D,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE;YAC5C,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrE,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC5B,CAAC;YAED,OAAO,IAAI,OAAO,CAAW,OAAO,CAAC,EAAE;gBACrC,MAAM,eAAe,GAAa,EAAE,CAAA;gBAEpC,MAAM,UAAU,GAAG,GAAS,EAAE;oBAC5B,MAAM,CAAC,mBAAmB,CAAC,eAAe,EAAE,UAAU,CAAC,CAAA;oBACvD,MAAM,CAAC,mBAAmB,CAAC,YAAY,EAAE,WAAyB,CAAC,CAAA;oBACnE,OAAO,CAAC,eAAe,CAAC,CAAA;gBAC1B,CAAC,CAAA;gBAED,MAAM,WAAW,GAAG,CAAC,CAAwB,EAAQ,EAAE;oBACrD,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAA;gBACnC,CAAC,CAAA;gBAED,MAAM,CAAC,gBAAgB,CAAC,YAAY,EAAE,WAAyB,CAAC,CAAA;gBAChE,MAAM,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,CAAA;gBACpD,MAAM,KAAK,GAAG,IAAI,WAAW,CAAC,iBAAiB,CAAC,CAAA;gBAChD,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAC7B,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,WAAW,CAAC,mBAAmB,OAAO,CAAC,MAAM,UAAU,CAAC,CAAA;QAC7D,MAAM,IAAA,6BAAmB,EAAC;YACxB,OAAO;YACP,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC,CAAA;QACF,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAA;IACrC,CAAC;CACF;AAED,kBAAe,UAAU,CAAA"}
|
package/dist/EventForwarder.js
CHANGED
|
@@ -34,12 +34,10 @@ class EventForwarder {
|
|
|
34
34
|
.reduce((prevLaunchOptions, listener) => listener(browser, prevLaunchOptions), launchOptions));
|
|
35
35
|
}
|
|
36
36
|
else {
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
}
|
|
42
|
-
});
|
|
37
|
+
for (const listener of this.emitter.listeners(event)) {
|
|
38
|
+
/* eslint-disable-next-line @typescript-eslint/no-explicit-any */
|
|
39
|
+
on(event, listener);
|
|
40
|
+
}
|
|
43
41
|
}
|
|
44
42
|
}
|
|
45
43
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EventForwarder.js","sourceRoot":"","sources":["../src/EventForwarder.ts"],"names":[],"mappings":";;;;;AAYA,kEAAwC;AAExC,MAAM,cAAc;IAKlB;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,uBAAY,EAAE,CAAA;QACjC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,EAAQ,EAAE;YAC7B,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;gBACtB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;YAC/B,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,EAAqC,CAAC,CAAA;YAChE,CAAC;QACH,CAAC,CAAA;IACH,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,EAAwB;QACrC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QACxB,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;YAC9C,0EAA0E;YAC1E,wEAAwE;YACxE,uBAAuB;YACvB,IAAI,KAAK,KAAK,uBAAuB,EAAE,CAAC;gBACtC,EAAE,CACA,uBAAuB,EACvB,CACE,OAAwB,EACxB,aAAiD,EACjD,EAAE,CACF,IAAI,CAAC,OAAO;qBACT,SAAS,CAAC,KAAK,CAAC;qBAChB,MAAM,CACL,CAAC,iBAAiB,EAAE,QAAQ,EAAE,EAAE,CAC9B,QAAQ,CACN,OAAO,EACP,iBAAiB,CAC+B,EACpD,aAAa,CACd,CACN,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,
|
|
1
|
+
{"version":3,"file":"EventForwarder.js","sourceRoot":"","sources":["../src/EventForwarder.ts"],"names":[],"mappings":";;;;;AAYA,kEAAwC;AAExC,MAAM,cAAc;IAKlB;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,uBAAY,EAAE,CAAA;QACjC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,EAAQ,EAAE;YAC7B,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;gBACtB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;YAC/B,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,EAAqC,CAAC,CAAA;YAChE,CAAC;QACH,CAAC,CAAA;IACH,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,EAAwB;QACrC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QACxB,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;YAC9C,0EAA0E;YAC1E,wEAAwE;YACxE,uBAAuB;YACvB,IAAI,KAAK,KAAK,uBAAuB,EAAE,CAAC;gBACtC,EAAE,CACA,uBAAuB,EACvB,CACE,OAAwB,EACxB,aAAiD,EACjD,EAAE,CACF,IAAI,CAAC,OAAO;qBACT,SAAS,CAAC,KAAK,CAAC;qBAChB,MAAM,CACL,CAAC,iBAAiB,EAAE,QAAQ,EAAE,EAAE,CAC9B,QAAQ,CACN,OAAO,EACP,iBAAiB,CAC+B,EACpD,aAAa,CACd,CACN,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrD,iEAAiE;oBACjE,EAAE,CAAC,KAAY,EAAE,QAAQ,CAAC,CAAA;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAED,kBAAe,cAAc,CAAA"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import debug from 'debug';
|
|
2
|
+
/**
|
|
3
|
+
* Creates a debug logger with the given namespace
|
|
4
|
+
*
|
|
5
|
+
* @param namespace The namespace for the debug logger for example: `PlaywrightController` or `PlaywrightWrapping`.
|
|
6
|
+
* @returns debug instance
|
|
7
|
+
*/
|
|
8
|
+
declare function createDebugger(namespace: string): debug.Debugger;
|
|
9
|
+
export default createDebugger;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
const debug_1 = __importDefault(require("debug"));
|
|
7
|
+
/**
|
|
8
|
+
* The prefix for the debug logger allows users to filter logs by the prefix
|
|
9
|
+
* using the debug package.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```bash
|
|
13
|
+
* DEBUG=axe-watcher:* yarn test
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
const NAMESPACE_PREFIX = 'axe-watcher';
|
|
17
|
+
/**
|
|
18
|
+
* Creates a debug logger with the given namespace
|
|
19
|
+
*
|
|
20
|
+
* @param namespace The namespace for the debug logger for example: `PlaywrightController` or `PlaywrightWrapping`.
|
|
21
|
+
* @returns debug instance
|
|
22
|
+
*/
|
|
23
|
+
function createDebugger(namespace) {
|
|
24
|
+
return (0, debug_1.default)(`${NAMESPACE_PREFIX}:${namespace}`);
|
|
25
|
+
}
|
|
26
|
+
exports.default = createDebugger;
|
|
27
|
+
//# sourceMappingURL=createDebugger.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createDebugger.js","sourceRoot":"","sources":["../src/createDebugger.ts"],"names":[],"mappings":";;;;;AAAA,kDAAyB;AAEzB;;;;;;;;GAQG;AACH,MAAM,gBAAgB,GAAG,aAAa,CAAA;AAEtC;;;;;GAKG;AAEH,SAAS,cAAc,CAAC,SAAiB;IACvC,OAAO,IAAA,eAAK,EAAC,GAAG,gBAAgB,IAAI,SAAS,EAAE,CAAC,CAAA;AAClD,CAAC;AAED,kBAAe,cAAc,CAAA"}
|
package/dist/cypress.d.ts
CHANGED
package/dist/cypress.js
CHANGED
|
@@ -4,10 +4,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.cypressConfig = void 0;
|
|
7
|
-
const fs_1 = __importDefault(require("fs"));
|
|
8
|
-
const util_1 = require("./util");
|
|
9
7
|
const sendResultsToServer_1 = __importDefault(require("./sendResultsToServer"));
|
|
10
8
|
const EventForwarder_1 = __importDefault(require("./EventForwarder"));
|
|
9
|
+
const writeVariables_1 = __importDefault(require("./utils/writeVariables"));
|
|
10
|
+
const writeExtensionManifest_1 = __importDefault(require("./utils/writeExtensionManifest"));
|
|
11
|
+
const headlessNotSupportedError_1 = require("./utils/headlessNotSupportedError");
|
|
12
|
+
const mergeChromeArgs_1 = __importDefault(require("./utils/mergeChromeArgs"));
|
|
13
|
+
const createDebugger_1 = __importDefault(require("./createDebugger"));
|
|
14
|
+
const debugLogger = (0, createDebugger_1.default)('CypressController');
|
|
11
15
|
/**
|
|
12
16
|
* Create a Cypress config that uses the axe Watcher extension.
|
|
13
17
|
*
|
|
@@ -15,12 +19,14 @@ const EventForwarder_1 = __importDefault(require("./EventForwarder"));
|
|
|
15
19
|
*/
|
|
16
20
|
const cypressConfig = (config) => {
|
|
17
21
|
const { axe, ...userConfig } = config;
|
|
18
|
-
|
|
22
|
+
const { DEBUG } = process.env;
|
|
23
|
+
const hasWatcherDebug = DEBUG && DEBUG.includes('axe-watcher');
|
|
24
|
+
(0, writeVariables_1.default)({
|
|
19
25
|
...axe,
|
|
20
26
|
// Let the extension know to check for Cypress frames.
|
|
21
27
|
cypress: true
|
|
22
28
|
});
|
|
23
|
-
(0,
|
|
29
|
+
(0, writeExtensionManifest_1.default)({
|
|
24
30
|
all_frames: true,
|
|
25
31
|
exclude_globs: [
|
|
26
32
|
// Top-level Cypress page.
|
|
@@ -30,6 +36,12 @@ const cypressConfig = (config) => {
|
|
|
30
36
|
]
|
|
31
37
|
});
|
|
32
38
|
return {
|
|
39
|
+
...(hasWatcherDebug && {
|
|
40
|
+
env: {
|
|
41
|
+
...config.env,
|
|
42
|
+
__AXE_WATCHER_DEBUG: hasWatcherDebug
|
|
43
|
+
}
|
|
44
|
+
}),
|
|
33
45
|
...userConfig,
|
|
34
46
|
e2e: {
|
|
35
47
|
...userConfig.e2e,
|
|
@@ -61,53 +73,41 @@ const cypressConfig = (config) => {
|
|
|
61
73
|
* ensure we wait for the user's `setupNodeEvents` to resolve.
|
|
62
74
|
*/
|
|
63
75
|
const userNodeEventConfig = await ((_b = (_a = userConfig.e2e) === null || _a === void 0 ? void 0 : _a.setupNodeEvents) === null || _b === void 0 ? void 0 : _b.call(_a, on, ...args));
|
|
76
|
+
on('task', {
|
|
77
|
+
__uploadAxeWatcherResults: async (results) => {
|
|
78
|
+
if (!results.length) {
|
|
79
|
+
// Indicates to Cypress that the event has been handled.
|
|
80
|
+
// @see https://docs.cypress.io/api/commands/task#Usage
|
|
81
|
+
return null;
|
|
82
|
+
}
|
|
83
|
+
await (0, sendResultsToServer_1.default)({
|
|
84
|
+
results,
|
|
85
|
+
debugLogger
|
|
86
|
+
});
|
|
87
|
+
return null;
|
|
88
|
+
},
|
|
89
|
+
__debugAxeWatcher: (message) => {
|
|
90
|
+
debugLogger(message);
|
|
91
|
+
return null;
|
|
92
|
+
}
|
|
93
|
+
});
|
|
64
94
|
on('before:browser:launch', (browser, launchOptions) => {
|
|
65
|
-
|
|
66
|
-
|
|
95
|
+
// We only officially support Chrome, but for backcompat we are permissive and accept other
|
|
96
|
+
// Chromium-based browsers (eg, "chromium", "chrome:beta", "edge").
|
|
97
|
+
if (browser.name.startsWith('firefox') ||
|
|
98
|
+
browser.name.startsWith('electron')) {
|
|
99
|
+
throw new Error(`The @axe-core/watcher package only supports running in Chrome, but Cypress is configured with browser "${browser.name}". Please refer to our System Requirements for more information: https://docs.deque.com/developer-hub/2/en/dh-system-requirements`);
|
|
67
100
|
}
|
|
68
101
|
if (browser.isHeadless && launchOptions.args.includes('--headless')) {
|
|
69
|
-
throw new
|
|
102
|
+
throw new headlessNotSupportedError_1.HeadlessNotSupportedError('In Cypress, "--headless=new" became the default headless mode in Cypress version 12.15.0. Ensure your Cypress version is up to date and that you are not using a "before:browser:launch" configuration that adds "--headless" to launchOptions.args.');
|
|
70
103
|
}
|
|
71
|
-
// Load the extension. Merge
|
|
72
|
-
const
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
const [key, value] = arg.split('=');
|
|
77
|
-
if (!prev[key]) {
|
|
78
|
-
prev[key] = [];
|
|
79
|
-
}
|
|
80
|
-
if (value) {
|
|
81
|
-
prev[key].push(value);
|
|
82
|
-
}
|
|
83
|
-
return prev;
|
|
84
|
-
}, {});
|
|
85
|
-
launchOptions.args = Object.entries(launchOptionsArgs).map(([key, value]) => value.length > 0 ? [key, value.join(',')].join('=') : key);
|
|
104
|
+
// Load the extension. Merge extension args if provided by the user
|
|
105
|
+
const existingArgs = launchOptions.args;
|
|
106
|
+
launchOptions.args = (0, mergeChromeArgs_1.default)(existingArgs, {
|
|
107
|
+
disableOtherExtensions: false
|
|
108
|
+
});
|
|
86
109
|
return launchOptions;
|
|
87
110
|
});
|
|
88
|
-
// Read the results sent from the extension, then forward to the server.
|
|
89
|
-
on('after:run', async () => {
|
|
90
|
-
let results;
|
|
91
|
-
try {
|
|
92
|
-
results = fs_1.default
|
|
93
|
-
.readdirSync('cypress/axe-watcher')
|
|
94
|
-
.filter(f => f.endsWith('.json'));
|
|
95
|
-
}
|
|
96
|
-
catch (error) {
|
|
97
|
-
// this is a non-error; the test suite likely just failed early
|
|
98
|
-
// without running any scans
|
|
99
|
-
if (error.code === 'ENOENT') {
|
|
100
|
-
return;
|
|
101
|
-
}
|
|
102
|
-
throw error;
|
|
103
|
-
}
|
|
104
|
-
for (const result of results) {
|
|
105
|
-
const data = fs_1.default.readFileSync(`cypress/axe-watcher/${result}`, 'utf8');
|
|
106
|
-
const parsed = JSON.parse(data);
|
|
107
|
-
await (0, sendResultsToServer_1.default)(parsed);
|
|
108
|
-
fs_1.default.unlinkSync(`cypress/axe-watcher/${result}`);
|
|
109
|
-
}
|
|
110
|
-
});
|
|
111
111
|
/**
|
|
112
112
|
* Forward the accumulated events to cypress.
|
|
113
113
|
* For more information, see comment on #44
|
package/dist/cypress.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cypress.js","sourceRoot":"","sources":["../src/cypress.ts"],"names":[],"mappings":";;;;;;AACA,
|
|
1
|
+
{"version":3,"file":"cypress.js","sourceRoot":"","sources":["../src/cypress.ts"],"names":[],"mappings":";;;;;;AACA,gFAAwE;AACxE,sEAA6C;AAC7C,4EAA2E;AAC3E,4FAA0D;AAC1D,iFAA6E;AAC7E,8EAAqD;AACrD,sEAA6C;AAE7C,MAAM,WAAW,GAAG,IAAA,wBAAc,EAAC,mBAAmB,CAAC,CAAA;AAEvD;;;;GAIG;AAEI,MAAM,aAAa,GAAG,CAC3B,MAA6C,EACtB,EAAE;IACzB,MAAM,EAAE,GAAG,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAA;IACrC,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,GAAG,CAAA;IAC7B,MAAM,eAAe,GAAG,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAA;IAE9D,IAAA,wBAAc,EAAC;QACb,GAAG,GAAG;QACN,sDAAsD;QACtD,OAAO,EAAE,IAAI;KACd,CAAC,CAAA;IACF,IAAA,gCAAa,EAAC;QACZ,UAAU,EAAE,IAAI;QAChB,aAAa,EAAE;YACb,0BAA0B;YAC1B,4BAA4B;YAC5B,4BAA4B;YAC5B,uBAAuB;SACxB;KACF,CAAC,CAAA;IAEF,OAAO;QACL,GAAG,CAAC,eAAe,IAAI;YACrB,GAAG,EAAE;gBACH,GAAG,MAAM,CAAC,GAAG;gBACb,mBAAmB,EAAE,eAAe;aACrC;SACF,CAAC;QACF,GAAG,UAAU;QACb,GAAG,EAAE;YACH,GAAG,UAAU,CAAC,GAAG;YACjB,KAAK,CAAC,eAAe,CACnB,SAAS,EACT,GAAG,IAAI;;gBAEP;;;;;;;;;;mBAUG;gBACH,MAAM,cAAc,GAAG,IAAI,wBAAc,EAAE,CAAA;gBAC3C,MAAM,EAAE,GAAG,cAAc,CAAC,EAAE,CAAA;gBAE5B;;;;;;;;;;;mBAWG;gBACH,MAAM,mBAAmB,GAAG,MAAM,CAAA,MAAA,MAAA,UAAU,CAAC,GAAG,0CAAE,eAAe,mDAC/D,EAAE,EACF,GAAG,IAAI,CACR,CAAA,CAAA;gBAED,EAAE,CAAC,MAAM,EAAE;oBACT,yBAAyB,EAAE,KAAK,EAAE,OAAiB,EAAE,EAAE;wBACrD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;4BACpB,wDAAwD;4BACxD,uDAAuD;4BACvD,OAAO,IAAI,CAAA;wBACb,CAAC;wBACD,MAAM,IAAA,6BAAmB,EAAC;4BACxB,OAAO;4BACP,WAAW;yBACZ,CAAC,CAAA;wBACF,OAAO,IAAI,CAAA;oBACb,CAAC;oBACD,iBAAiB,EAAE,CAAC,OAAe,EAAE,EAAE;wBACrC,WAAW,CAAC,OAAO,CAAC,CAAA;wBACpB,OAAO,IAAI,CAAA;oBACb,CAAC;iBACF,CAAC,CAAA;gBAEF,EAAE,CAAC,uBAAuB,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,EAAE;oBACrD,2FAA2F;oBAC3F,mEAAmE;oBACnE,IACE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;wBAClC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EACnC,CAAC;wBACD,MAAM,IAAI,KAAK,CACb,0GAA0G,OAAO,CAAC,IAAI,mIAAmI,CAC1P,CAAA;oBACH,CAAC;oBAED,IAAI,OAAO,CAAC,UAAU,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;wBACpE,MAAM,IAAI,qDAAyB,CACjC,sPAAsP,CACvP,CAAA;oBACH,CAAC;oBAED,mEAAmE;oBACnE,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,CAAA;oBACvC,aAAa,CAAC,IAAI,GAAG,IAAA,yBAAe,EAAC,YAAY,EAAE;wBACjD,sBAAsB,EAAE,KAAK;qBAC9B,CAAC,CAAA;oBAEF,OAAO,aAAa,CAAA;gBACtB,CAAC,CAAC,CAAA;gBAEF;;;mBAGG;gBACH,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;gBAEjC,OAAO,mBAAmB,CAAA;YAC5B,CAAC;SACF;KACF,CAAA;AACH,CAAC,CAAA;AA3HY,QAAA,aAAa,iBA2HzB"}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
export {};
|
|
2
1
|
declare global {
|
|
3
2
|
namespace Cypress {
|
|
4
3
|
interface Chainable {
|
|
@@ -12,6 +11,7 @@ declare global {
|
|
|
12
11
|
axeFlush(): Chainable<void>;
|
|
13
12
|
/** Perform an axe-core analysis. */
|
|
14
13
|
axeWatcherAnalyze(params?: {
|
|
14
|
+
__Method?: string;
|
|
15
15
|
__UserRequestedAnalyze?: boolean;
|
|
16
16
|
}): Chainable<void>;
|
|
17
17
|
/**
|
|
@@ -20,6 +20,7 @@ declare global {
|
|
|
20
20
|
* @Deprecated Use cy.axeWatcherAnalyze() instead
|
|
21
21
|
*/
|
|
22
22
|
axeAnalyze(params?: {
|
|
23
|
+
__Method?: string;
|
|
23
24
|
__UserRequestedAnalyze?: boolean;
|
|
24
25
|
}): Chainable<void>;
|
|
25
26
|
/**
|
|
@@ -48,3 +49,4 @@ declare global {
|
|
|
48
49
|
type CypressMethod = keyof Cypress.Chainable;
|
|
49
50
|
/** Commands we wrap to help us identify new page states. */
|
|
50
51
|
export declare const WRAPPED_COMMANDS: ReadonlyArray<CypressMethod>;
|
|
52
|
+
export {};
|
package/dist/cypressCommands.js
CHANGED
|
@@ -27,8 +27,17 @@ exports.WRAPPED_COMMANDS = [
|
|
|
27
27
|
'trigger',
|
|
28
28
|
'type',
|
|
29
29
|
'uncheck',
|
|
30
|
+
'visit',
|
|
30
31
|
'wait'
|
|
31
32
|
];
|
|
33
|
+
/** Helper function to log debug messages */
|
|
34
|
+
const logDebugAxeWatcher = ({ message }) => {
|
|
35
|
+
// perf: we only want to log debug messages if the env has been set
|
|
36
|
+
// so it doesn't enqueue a Cypress command
|
|
37
|
+
if (Cypress.env('__AXE_WATCHER_DEBUG')) {
|
|
38
|
+
cy.task('__debugAxeWatcher', message, { log: false });
|
|
39
|
+
}
|
|
40
|
+
};
|
|
32
41
|
const shouldAnalyzeLocation = (location) => ['http:', 'https:', 'file:'].includes(location.protocol);
|
|
33
42
|
/**
|
|
34
43
|
* Wrapped commands queue an axe run before calling the original method. This can seem
|
|
@@ -39,99 +48,91 @@ const shouldAnalyzeLocation = (location) => ['http:', 'https:', 'file:'].include
|
|
|
39
48
|
* The last command that runs relies on the flush to catch the last page state.
|
|
40
49
|
*/
|
|
41
50
|
exports.WRAPPED_COMMANDS.forEach(method => Cypress.Commands.overwrite(method, (originalFn, ...args) => {
|
|
42
|
-
var _a, _b, _c, _d, _e
|
|
43
|
-
const currentCommand =
|
|
51
|
+
var _a, _b, _c, _d, _e;
|
|
52
|
+
const currentCommand = cy.state('current');
|
|
53
|
+
const currentCommandName = currentCommand === null || currentCommand === void 0 ? void 0 : currentCommand.get('name');
|
|
54
|
+
const currentCommandType = currentCommand === null || currentCommand === void 0 ? void 0 : currentCommand.get('type');
|
|
55
|
+
// TODO: Remove the feature flag once #1109 is fully resolved.
|
|
56
|
+
const tryRequerySubject = !!Cypress.env('__AXE_WATCHER_CYPRESS_REQUERY_SUBJECT_AFTER_ANALYZE') &&
|
|
57
|
+
'getSubjectFromChain' in cy;
|
|
44
58
|
// Some commands, like "type" call other commands internally, like "click".
|
|
45
59
|
// We don't want to enqueue a run in these scenarios because it can cause
|
|
46
60
|
// promises to be returned from commands, which Cypress does not allow.
|
|
47
61
|
// See: https://github.com/cypress-io/cypress/issues/19086
|
|
48
|
-
if (
|
|
62
|
+
if (currentCommandName && currentCommandName !== method) {
|
|
49
63
|
return originalFn(...args);
|
|
50
64
|
}
|
|
51
|
-
//
|
|
52
|
-
|
|
65
|
+
// axeWatcherAnalyze is slow; it's possible for the Cypress subject to become invalidated
|
|
66
|
+
// while it's running (eg, if the subject is in some sort of remount-loop). To account for
|
|
67
|
+
// this, we ask Cypress to requery the subject object from the subjectChain before returning
|
|
68
|
+
// control to the original function.
|
|
69
|
+
// Note that we don't always have access to an original subjectChain to restore; the API is
|
|
70
|
+
// only available in Cypress 12+, and even then we might be wrapping a command that doesn't
|
|
71
|
+
// necessarily operate on a subject.
|
|
53
72
|
// The "Subject Chain" represents the chain of Cypress selection operations that lead up
|
|
54
73
|
// to finding the "Subject". cy.getSubjectFromChain() requeries those operations to retrieve
|
|
55
74
|
// a fresh "Subject" handle.
|
|
56
|
-
const
|
|
57
|
-
cy.
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
* Set a flag on the Window to indicate that a wrapped method has been called.
|
|
63
|
-
* This is used to determine whether we should call `axeFlush` after the test.
|
|
64
|
-
*/
|
|
65
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
66
|
-
;
|
|
67
|
-
win.__AXE_WATCHER_HAS_VISITED = true;
|
|
68
|
-
}
|
|
69
|
-
})
|
|
70
|
-
.axeWatcherAnalyze({ __UserRequestedAnalyze: false })
|
|
71
|
-
// axeWatcherAnalyze is slow; it's possible for the Cypress subject to become invalidated
|
|
72
|
-
// while it's running (eg, if the subject is in some sort of remount-loop). To account for
|
|
73
|
-
// this, we ask Cypress to requery the subject object from the subjectChain before returning
|
|
74
|
-
// control to the original function.
|
|
75
|
-
//
|
|
76
|
-
// Note that we don't always have access to an original subjectChain to restore; the API is
|
|
77
|
-
// only available in Cypress 12+, and even then we might be wrapping a command that doesn't
|
|
78
|
-
// necessarily operate on a subject.
|
|
79
|
-
.then(() => {
|
|
80
|
-
var _a, _b;
|
|
81
|
-
// Some Cypress commands pick up the subject from cy.subject(), and some pick it up from a
|
|
82
|
-
// subject parameter that's passed to the command. Returning the updated subject from this
|
|
83
|
-
// .then() sets cy.subject() to handle the former...
|
|
84
|
-
return originalSubjectChain &&
|
|
85
|
-
((_b = (_a = cy).getSubjectFromChain) === null || _b === void 0 ? void 0 : _b.call(_a, originalSubjectChain));
|
|
86
|
-
})
|
|
87
|
-
.then(updatedSubject => {
|
|
88
|
-
// ...and this map handles the latter.
|
|
89
|
-
const argsWithRefreshedSubject = args.map(arg => originalSubject && arg === originalSubject ? updatedSubject : arg);
|
|
90
|
-
// originalFn might return a Promise that Cypress needs to be able to track, so it's important
|
|
91
|
-
// to propagate its return value even though we're not chaining any further cypress commands
|
|
92
|
-
// ourselves.
|
|
93
|
-
return originalFn(...argsWithRefreshedSubject);
|
|
75
|
+
const originalSubject = (_b = (_a = cy).subject) === null || _b === void 0 ? void 0 : _b.call(_a);
|
|
76
|
+
const originalSubjectChain = (_d = (_c = cy).subjectChain) === null || _d === void 0 ? void 0 : _d.call(_c);
|
|
77
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
78
|
+
let commandChain = cy.window().axeWatcherAnalyze({
|
|
79
|
+
__Method: method,
|
|
80
|
+
__UserRequestedAnalyze: false
|
|
94
81
|
});
|
|
82
|
+
// This version has issues if the subject is remounting continuously because Cypress
|
|
83
|
+
// considers the ".then" to be an action (not a query) and so isn't willing to re-run
|
|
84
|
+
// it if necessary for actionability checks
|
|
85
|
+
//
|
|
86
|
+
// commandChain = commandChain.then(() => (cy as CyInternal).getSubjectFromChain!(originalSubjectChain))
|
|
87
|
+
//
|
|
88
|
+
if (tryRequerySubject) {
|
|
89
|
+
const timeout = (_e = args.find(arg => arg.timeout)) === null || _e === void 0 ? void 0 : _e.timeout;
|
|
90
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
91
|
+
commandChain = commandChain.__axeRestoreSubject(originalSubjectChain, timeout);
|
|
92
|
+
// In all hooked cases, originalFn can have its own timeout.
|
|
93
|
+
// Setting our own very long timeout here both maintains the original timeout
|
|
94
|
+
// and correctly attributes an error thrown because of it to the originalFn timing out,
|
|
95
|
+
// rather than to our wrapper.
|
|
96
|
+
commandChain.then({ timeout: 999999 }, refreshedSubject => originalFn(
|
|
97
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
98
|
+
...updateSubject(args, currentCommandType, refreshedSubject)));
|
|
99
|
+
}
|
|
100
|
+
else {
|
|
101
|
+
commandChain
|
|
102
|
+
// Set the subject back to the previous subject
|
|
103
|
+
.then(() => originalSubject)
|
|
104
|
+
.then(() => originalFn(...args));
|
|
105
|
+
}
|
|
95
106
|
}));
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
*/
|
|
117
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
118
|
-
;
|
|
119
|
-
win.__AXE_WATCHER_HAS_VISITED = true;
|
|
120
|
-
}
|
|
121
|
-
})
|
|
122
|
-
.then(() => visitResult);
|
|
107
|
+
function updateSubject(args, commandType, refreshedSubject) {
|
|
108
|
+
if (commandType === 'parent') {
|
|
109
|
+
return args;
|
|
110
|
+
}
|
|
111
|
+
else {
|
|
112
|
+
return [refreshedSubject, ...args.slice(1)];
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
Cypress.Commands.addQuery(
|
|
116
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
117
|
+
'__axeRestoreSubject',
|
|
118
|
+
// This must be a regular function because timeouts rely on `this`
|
|
119
|
+
// https://docs.cypress.io/api/cypress-api/custom-queries#Arguments
|
|
120
|
+
function (subjectChain, timeout) {
|
|
121
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
122
|
+
this.set('timeout', timeout);
|
|
123
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
124
|
+
this.set('onFail', (err) => {
|
|
125
|
+
const runner = cy.state('runnable');
|
|
126
|
+
err.codeFrame = runner.invocationDetails;
|
|
123
127
|
});
|
|
128
|
+
return () => cy.getSubjectFromChain(subjectChain);
|
|
124
129
|
});
|
|
125
130
|
function axeWatcherFlushCommand() {
|
|
131
|
+
logDebugAxeWatcher({ message: 'Flush: Invoked (may analyze implicitly)' });
|
|
126
132
|
cy.window().then(win => {
|
|
127
133
|
if (!shouldAnalyzeLocation(win.location)) {
|
|
128
134
|
return Promise.resolve();
|
|
129
135
|
}
|
|
130
|
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
131
|
-
const hasVisited = win.__AXE_WATCHER_HAS_VISITED;
|
|
132
|
-
if (!hasVisited) {
|
|
133
|
-
return Promise.resolve();
|
|
134
|
-
}
|
|
135
136
|
return new Promise(resolve => {
|
|
136
137
|
const results = [];
|
|
137
138
|
const onAxeResult = (event) => {
|
|
@@ -140,7 +141,6 @@ function axeWatcherFlushCommand() {
|
|
|
140
141
|
const onFlushEnd = () => {
|
|
141
142
|
win.removeEventListener('axe:flush-end', onFlushEnd);
|
|
142
143
|
win.removeEventListener('axe:result', onAxeResult);
|
|
143
|
-
win.__AXE_WATCHER_HAS_VISITED = false;
|
|
144
144
|
resolve(results);
|
|
145
145
|
};
|
|
146
146
|
win.addEventListener('axe:flush-end', onFlushEnd);
|
|
@@ -148,11 +148,8 @@ function axeWatcherFlushCommand() {
|
|
|
148
148
|
const event = new CustomEvent('axe:flush-start');
|
|
149
149
|
win.dispatchEvent(event);
|
|
150
150
|
}).then(results => {
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
const rnd = Math.random().toString(36).slice(2);
|
|
154
|
-
const filename = `cypress/axe-watcher/${time}-${rnd}.json`;
|
|
155
|
-
cy.writeFile(filename, JSON.stringify(results, null, 2));
|
|
151
|
+
cy.task('__uploadAxeWatcherResults', results, { log: false });
|
|
152
|
+
logDebugAxeWatcher({ message: 'Flush: complete' });
|
|
156
153
|
});
|
|
157
154
|
});
|
|
158
155
|
}
|
|
@@ -160,26 +157,31 @@ const doesCypressCommandExist = (commandName) => {
|
|
|
160
157
|
//@ts-expect-error - Property 'cy' does not exist on type 'Cypress & CyEventEmitter'.ts(2339)
|
|
161
158
|
return !!Cypress.cy[commandName];
|
|
162
159
|
};
|
|
163
|
-
function axeWatcherAnalyzeCommand({ __UserRequestedAnalyze = true } = {}) {
|
|
160
|
+
function axeWatcherAnalyzeCommand({ __Method, __UserRequestedAnalyze = true } = {}) {
|
|
161
|
+
logDebugAxeWatcher({
|
|
162
|
+
message: `Analyze: Invoked${__Method ? ` - ${__Method}` : ''}`
|
|
163
|
+
});
|
|
164
164
|
const userRequestedAnalyze = __UserRequestedAnalyze;
|
|
165
165
|
cy.window().then(win => {
|
|
166
166
|
if (!shouldAnalyzeLocation(win.location)) {
|
|
167
|
-
return Promise.resolve();
|
|
167
|
+
return Promise.resolve({ message: `Skipped - Invalid protocol` });
|
|
168
168
|
}
|
|
169
169
|
// If the user didn't request an analyze, and we're in manual mode, don't do anything.
|
|
170
170
|
if (isStopped && !userRequestedAnalyze) {
|
|
171
|
-
return Promise.resolve();
|
|
171
|
+
return Promise.resolve({ message: `Skipped (Manual mode)` });
|
|
172
172
|
}
|
|
173
173
|
return new Promise(resolve => {
|
|
174
|
-
const fn = () => {
|
|
174
|
+
const fn = (event) => {
|
|
175
175
|
win.removeEventListener('axe:manual-mode-analyze-done', fn);
|
|
176
|
-
resolve();
|
|
176
|
+
resolve(event.detail);
|
|
177
177
|
};
|
|
178
178
|
win.addEventListener('axe:manual-mode-analyze-done', fn);
|
|
179
179
|
const event = new CustomEvent('axe:manual-mode-analyze', {
|
|
180
180
|
detail: { userRequestedAnalyze }
|
|
181
181
|
});
|
|
182
182
|
win.dispatchEvent(event);
|
|
183
|
+
}).then(result => {
|
|
184
|
+
logDebugAxeWatcher({ message: `Analyze: ${result === null || result === void 0 ? void 0 : result.message}` });
|
|
183
185
|
});
|
|
184
186
|
});
|
|
185
187
|
}
|