@donggui/web 1.5.5-donggui.3
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/README.md +9 -0
- package/bin/midscene-playground +3 -0
- package/bin/midscene-web +2 -0
- package/dist/es/bin.mjs +23 -0
- package/dist/es/bin.mjs.map +1 -0
- package/dist/es/bridge-mode/agent-cli-side.mjs +137 -0
- package/dist/es/bridge-mode/agent-cli-side.mjs.map +1 -0
- package/dist/es/bridge-mode/browser.mjs +2 -0
- package/dist/es/bridge-mode/common.mjs +43 -0
- package/dist/es/bridge-mode/common.mjs.map +1 -0
- package/dist/es/bridge-mode/index.mjs +4 -0
- package/dist/es/bridge-mode/io-client.mjs +101 -0
- package/dist/es/bridge-mode/io-client.mjs.map +1 -0
- package/dist/es/bridge-mode/io-server.mjs +210 -0
- package/dist/es/bridge-mode/io-server.mjs.map +1 -0
- package/dist/es/bridge-mode/page-browser-side.mjs +118 -0
- package/dist/es/bridge-mode/page-browser-side.mjs.map +1 -0
- package/dist/es/chrome-extension/agent.mjs +9 -0
- package/dist/es/chrome-extension/agent.mjs.map +1 -0
- package/dist/es/chrome-extension/cdpInput.mjs +174 -0
- package/dist/es/chrome-extension/cdpInput.mjs.LICENSE.txt +5 -0
- package/dist/es/chrome-extension/cdpInput.mjs.map +1 -0
- package/dist/es/chrome-extension/dynamic-scripts.mjs +38 -0
- package/dist/es/chrome-extension/dynamic-scripts.mjs.map +1 -0
- package/dist/es/chrome-extension/index.mjs +5 -0
- package/dist/es/chrome-extension/page.mjs +651 -0
- package/dist/es/chrome-extension/page.mjs.map +1 -0
- package/dist/es/cli.mjs +16 -0
- package/dist/es/cli.mjs.map +1 -0
- package/dist/es/common/cache-helper.mjs +28 -0
- package/dist/es/common/cache-helper.mjs.map +1 -0
- package/dist/es/index.mjs +6 -0
- package/dist/es/mcp-server.mjs +35 -0
- package/dist/es/mcp-server.mjs.map +1 -0
- package/dist/es/mcp-tools-puppeteer.mjs +215 -0
- package/dist/es/mcp-tools-puppeteer.mjs.map +1 -0
- package/dist/es/mcp-tools.mjs +78 -0
- package/dist/es/mcp-tools.mjs.map +1 -0
- package/dist/es/playwright/ai-fixture.mjs +367 -0
- package/dist/es/playwright/ai-fixture.mjs.map +1 -0
- package/dist/es/playwright/index.mjs +40 -0
- package/dist/es/playwright/index.mjs.map +1 -0
- package/dist/es/playwright/page.mjs +44 -0
- package/dist/es/playwright/page.mjs.map +1 -0
- package/dist/es/playwright/reporter/index.mjs +216 -0
- package/dist/es/playwright/reporter/index.mjs.map +1 -0
- package/dist/es/puppeteer/agent-launcher.mjs +185 -0
- package/dist/es/puppeteer/agent-launcher.mjs.map +1 -0
- package/dist/es/puppeteer/base-page.mjs +564 -0
- package/dist/es/puppeteer/base-page.mjs.map +1 -0
- package/dist/es/puppeteer/index.mjs +34 -0
- package/dist/es/puppeteer/index.mjs.map +1 -0
- package/dist/es/puppeteer/page.mjs +9 -0
- package/dist/es/puppeteer/page.mjs.map +1 -0
- package/dist/es/static/index.mjs +3 -0
- package/dist/es/static/static-agent.mjs +12 -0
- package/dist/es/static/static-agent.mjs.map +1 -0
- package/dist/es/static/static-page.mjs +122 -0
- package/dist/es/static/static-page.mjs.map +1 -0
- package/dist/es/utils.mjs +8 -0
- package/dist/es/utils.mjs.map +1 -0
- package/dist/es/web-element.mjs +59 -0
- package/dist/es/web-element.mjs.map +1 -0
- package/dist/es/web-page.mjs +260 -0
- package/dist/es/web-page.mjs.map +1 -0
- package/dist/lib/bin.js +29 -0
- package/dist/lib/bin.js.map +1 -0
- package/dist/lib/bridge-mode/agent-cli-side.js +174 -0
- package/dist/lib/bridge-mode/agent-cli-side.js.map +1 -0
- package/dist/lib/bridge-mode/browser.js +38 -0
- package/dist/lib/bridge-mode/browser.js.map +1 -0
- package/dist/lib/bridge-mode/common.js +107 -0
- package/dist/lib/bridge-mode/common.js.map +1 -0
- package/dist/lib/bridge-mode/index.js +46 -0
- package/dist/lib/bridge-mode/index.js.map +1 -0
- package/dist/lib/bridge-mode/io-client.js +135 -0
- package/dist/lib/bridge-mode/io-client.js.map +1 -0
- package/dist/lib/bridge-mode/io-server.js +247 -0
- package/dist/lib/bridge-mode/io-server.js.map +1 -0
- package/dist/lib/bridge-mode/page-browser-side.js +162 -0
- package/dist/lib/bridge-mode/page-browser-side.js.map +1 -0
- package/dist/lib/chrome-extension/agent.js +43 -0
- package/dist/lib/chrome-extension/agent.js.map +1 -0
- package/dist/lib/chrome-extension/cdpInput.js +208 -0
- package/dist/lib/chrome-extension/cdpInput.js.LICENSE.txt +5 -0
- package/dist/lib/chrome-extension/cdpInput.js.map +1 -0
- package/dist/lib/chrome-extension/dynamic-scripts.js +88 -0
- package/dist/lib/chrome-extension/dynamic-scripts.js.map +1 -0
- package/dist/lib/chrome-extension/index.js +60 -0
- package/dist/lib/chrome-extension/index.js.map +1 -0
- package/dist/lib/chrome-extension/page.js +685 -0
- package/dist/lib/chrome-extension/page.js.map +1 -0
- package/dist/lib/cli.js +22 -0
- package/dist/lib/cli.js.map +1 -0
- package/dist/lib/common/cache-helper.js +68 -0
- package/dist/lib/common/cache-helper.js.map +1 -0
- package/dist/lib/index.js +60 -0
- package/dist/lib/index.js.map +1 -0
- package/dist/lib/mcp-server.js +75 -0
- package/dist/lib/mcp-server.js.map +1 -0
- package/dist/lib/mcp-tools-puppeteer.js +259 -0
- package/dist/lib/mcp-tools-puppeteer.js.map +1 -0
- package/dist/lib/mcp-tools.js +112 -0
- package/dist/lib/mcp-tools.js.map +1 -0
- package/dist/lib/playwright/ai-fixture.js +404 -0
- package/dist/lib/playwright/ai-fixture.js.map +1 -0
- package/dist/lib/playwright/index.js +93 -0
- package/dist/lib/playwright/index.js.map +1 -0
- package/dist/lib/playwright/page.js +78 -0
- package/dist/lib/playwright/page.js.map +1 -0
- package/dist/lib/playwright/reporter/index.js +250 -0
- package/dist/lib/playwright/reporter/index.js.map +1 -0
- package/dist/lib/puppeteer/agent-launcher.js +253 -0
- package/dist/lib/puppeteer/agent-launcher.js.map +1 -0
- package/dist/lib/puppeteer/base-page.js +607 -0
- package/dist/lib/puppeteer/base-page.js.map +1 -0
- package/dist/lib/puppeteer/index.js +84 -0
- package/dist/lib/puppeteer/index.js.map +1 -0
- package/dist/lib/puppeteer/page.js +43 -0
- package/dist/lib/puppeteer/page.js.map +1 -0
- package/dist/lib/static/index.js +52 -0
- package/dist/lib/static/index.js.map +1 -0
- package/dist/lib/static/static-agent.js +46 -0
- package/dist/lib/static/static-agent.js.map +1 -0
- package/dist/lib/static/static-page.js +156 -0
- package/dist/lib/static/static-page.js.map +1 -0
- package/dist/lib/utils.js +40 -0
- package/dist/lib/utils.js.map +1 -0
- package/dist/lib/web-element.js +96 -0
- package/dist/lib/web-element.js.map +1 -0
- package/dist/lib/web-page.js +310 -0
- package/dist/lib/web-page.js.map +1 -0
- package/dist/types/bin.d.ts +1 -0
- package/dist/types/bridge-mode/agent-cli-side.d.ts +49 -0
- package/dist/types/bridge-mode/browser.d.ts +2 -0
- package/dist/types/bridge-mode/common.d.ts +74 -0
- package/dist/types/bridge-mode/index.d.ts +4 -0
- package/dist/types/bridge-mode/io-client.d.ts +10 -0
- package/dist/types/bridge-mode/io-server.d.ts +27 -0
- package/dist/types/bridge-mode/page-browser-side.d.ts +21 -0
- package/dist/types/chrome-extension/agent.d.ts +5 -0
- package/dist/types/chrome-extension/cdpInput.d.ts +52 -0
- package/dist/types/chrome-extension/dynamic-scripts.d.ts +3 -0
- package/dist/types/chrome-extension/index.d.ts +5 -0
- package/dist/types/chrome-extension/page.d.ts +110 -0
- package/dist/types/cli.d.ts +1 -0
- package/dist/types/common/cache-helper.d.ts +20 -0
- package/dist/types/index.d.ts +7 -0
- package/dist/types/mcp-server.d.ts +26 -0
- package/dist/types/mcp-tools-puppeteer.d.ts +13 -0
- package/dist/types/mcp-tools.d.ts +12 -0
- package/dist/types/playwright/ai-fixture.d.ts +131 -0
- package/dist/types/playwright/index.d.ts +13 -0
- package/dist/types/playwright/page.d.ts +11 -0
- package/dist/types/playwright/reporter/index.d.ts +42 -0
- package/dist/types/puppeteer/agent-launcher.d.ts +61 -0
- package/dist/types/puppeteer/base-page.d.ts +106 -0
- package/dist/types/puppeteer/index.d.ts +10 -0
- package/dist/types/puppeteer/page.d.ts +6 -0
- package/dist/types/static/index.d.ts +2 -0
- package/dist/types/static/static-agent.d.ts +5 -0
- package/dist/types/static/static-page.d.ts +42 -0
- package/dist/types/utils.d.ts +6 -0
- package/dist/types/web-element.d.ts +48 -0
- package/dist/types/web-page.d.ts +62 -0
- package/package.json +166 -0
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
import * as __rspack_external_node_fs_5ea92f0c from "node:fs";
|
|
2
|
+
import { dirname, join } from "node:path";
|
|
3
|
+
import { GroupedActionDump } from "@midscene/core";
|
|
4
|
+
import { getReportFileName, printReportMsg } from "@midscene/core/agent";
|
|
5
|
+
import { getReportTpl } from "@midscene/core/utils";
|
|
6
|
+
import { getMidsceneRunSubDir } from "@midscene/shared/common";
|
|
7
|
+
import { escapeScriptTag, replaceIllegalPathCharsAndSpace } from "@midscene/shared/utils";
|
|
8
|
+
var __webpack_modules__ = {
|
|
9
|
+
"node:fs" (module) {
|
|
10
|
+
module.exports = __rspack_external_node_fs_5ea92f0c;
|
|
11
|
+
}
|
|
12
|
+
};
|
|
13
|
+
var __webpack_module_cache__ = {};
|
|
14
|
+
function __webpack_require__(moduleId) {
|
|
15
|
+
var cachedModule = __webpack_module_cache__[moduleId];
|
|
16
|
+
if (void 0 !== cachedModule) return cachedModule.exports;
|
|
17
|
+
var module = __webpack_module_cache__[moduleId] = {
|
|
18
|
+
exports: {}
|
|
19
|
+
};
|
|
20
|
+
__webpack_modules__[moduleId](module, module.exports, __webpack_require__);
|
|
21
|
+
return module.exports;
|
|
22
|
+
}
|
|
23
|
+
var external_node_fs_ = __webpack_require__("node:fs");
|
|
24
|
+
function _define_property(obj, key, value) {
|
|
25
|
+
if (key in obj) Object.defineProperty(obj, key, {
|
|
26
|
+
value: value,
|
|
27
|
+
enumerable: true,
|
|
28
|
+
configurable: true,
|
|
29
|
+
writable: true
|
|
30
|
+
});
|
|
31
|
+
else obj[key] = value;
|
|
32
|
+
return obj;
|
|
33
|
+
}
|
|
34
|
+
class MidsceneReporter {
|
|
35
|
+
static getMode(reporterType) {
|
|
36
|
+
if (!reporterType) return 'merged';
|
|
37
|
+
if ('merged' !== reporterType && 'separate' !== reporterType) throw new Error(`Unknown reporter type in playwright config: ${reporterType}, only support 'merged' or 'separate'`);
|
|
38
|
+
return reporterType;
|
|
39
|
+
}
|
|
40
|
+
getSeparatedFilename(testTitle) {
|
|
41
|
+
if (!this.testTitleToFilename.has(testTitle)) {
|
|
42
|
+
const baseTag = `playwright-${replaceIllegalPathCharsAndSpace(testTitle)}`;
|
|
43
|
+
const generatedFilename = getReportFileName(baseTag);
|
|
44
|
+
this.testTitleToFilename.set(testTitle, generatedFilename);
|
|
45
|
+
}
|
|
46
|
+
return this.testTitleToFilename.get(testTitle);
|
|
47
|
+
}
|
|
48
|
+
getReportFilename(testTitle) {
|
|
49
|
+
if ('merged' === this.mode) {
|
|
50
|
+
if (!this.mergedFilename) this.mergedFilename = getReportFileName('playwright-merged');
|
|
51
|
+
return this.mergedFilename;
|
|
52
|
+
}
|
|
53
|
+
if ('separate' === this.mode) {
|
|
54
|
+
if (!testTitle) throw new Error('testTitle is required in separate mode');
|
|
55
|
+
return this.getSeparatedFilename(testTitle);
|
|
56
|
+
}
|
|
57
|
+
throw new Error(`Unknown mode: ${this.mode}`);
|
|
58
|
+
}
|
|
59
|
+
getReportPath(testTitle) {
|
|
60
|
+
const fileName = this.getReportFilename(testTitle);
|
|
61
|
+
if ('html-and-external-assets' === this.outputFormat) return join(getMidsceneRunSubDir('report'), fileName, 'index.html');
|
|
62
|
+
return join(getMidsceneRunSubDir('report'), `${fileName}.html`);
|
|
63
|
+
}
|
|
64
|
+
copyScreenshotsToReport(tempFilePath, reportPath) {
|
|
65
|
+
const screenshotsDir = join(dirname(reportPath), 'screenshots');
|
|
66
|
+
const tempScreenshotsDir = `${tempFilePath}.screenshots`;
|
|
67
|
+
if (!(0, external_node_fs_.existsSync)(tempScreenshotsDir)) return;
|
|
68
|
+
if (!(0, external_node_fs_.existsSync)(screenshotsDir)) (0, external_node_fs_.mkdirSync)(screenshotsDir, {
|
|
69
|
+
recursive: true
|
|
70
|
+
});
|
|
71
|
+
const screenshotMapPath = `${tempFilePath}.screenshots.json`;
|
|
72
|
+
if (!(0, external_node_fs_.existsSync)(screenshotMapPath)) return;
|
|
73
|
+
try {
|
|
74
|
+
const { readFileSync } = __webpack_require__("node:fs");
|
|
75
|
+
const screenshotMap = JSON.parse(readFileSync(screenshotMapPath, 'utf-8'));
|
|
76
|
+
for (const [id, srcPath] of Object.entries(screenshotMap)){
|
|
77
|
+
if ('merged' === this.mode && this.writtenScreenshots.has(id)) continue;
|
|
78
|
+
const destPath = join(screenshotsDir, `${id}.png`);
|
|
79
|
+
if ((0, external_node_fs_.existsSync)(srcPath)) {
|
|
80
|
+
(0, external_node_fs_.copyFileSync)(srcPath, destPath);
|
|
81
|
+
if ('merged' === this.mode) this.writtenScreenshots.add(id);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
} catch (error) {
|
|
85
|
+
console.error('Error copying screenshots:', error);
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
async updateReport(testData) {
|
|
89
|
+
if (!testData || !this.mode) return;
|
|
90
|
+
this.writeQueue = this.writeQueue.then(async ()=>{
|
|
91
|
+
const reportPath = this.getReportPath(testData.attributes?.playwright_test_title);
|
|
92
|
+
if ('html-and-external-assets' === this.outputFormat) {
|
|
93
|
+
const reportDir = dirname(reportPath);
|
|
94
|
+
if (!(0, external_node_fs_.existsSync)(reportDir)) (0, external_node_fs_.mkdirSync)(reportDir, {
|
|
95
|
+
recursive: true
|
|
96
|
+
});
|
|
97
|
+
}
|
|
98
|
+
const tpl = getReportTpl();
|
|
99
|
+
if (!tpl) throw new Error('Report template not found. Ensure @midscene/core is built correctly.');
|
|
100
|
+
let dumpScript = `<script type="midscene_web_dump">\n${escapeScriptTag(testData.dumpString)}\n</script>`;
|
|
101
|
+
if ('merged' === this.mode && testData.attributes) {
|
|
102
|
+
const attributesArr = Object.keys(testData.attributes).map((key)=>`${key}="${encodeURIComponent(testData.attributes[key])}"`);
|
|
103
|
+
dumpScript = dumpScript.replace('<script type="midscene_web_dump"', `<script type="midscene_web_dump" ${attributesArr.join(' ')}`);
|
|
104
|
+
}
|
|
105
|
+
if ('merged' === this.mode) if (this.mergedReportInitialized) (0, external_node_fs_.writeFileSync)(reportPath, dumpScript, {
|
|
106
|
+
flag: 'a'
|
|
107
|
+
});
|
|
108
|
+
else {
|
|
109
|
+
(0, external_node_fs_.writeFileSync)(reportPath, tpl + dumpScript, {
|
|
110
|
+
flag: 'w'
|
|
111
|
+
});
|
|
112
|
+
this.mergedReportInitialized = true;
|
|
113
|
+
}
|
|
114
|
+
else (0, external_node_fs_.writeFileSync)(reportPath, tpl + dumpScript, {
|
|
115
|
+
flag: 'w'
|
|
116
|
+
});
|
|
117
|
+
printReportMsg(reportPath);
|
|
118
|
+
});
|
|
119
|
+
await this.writeQueue;
|
|
120
|
+
}
|
|
121
|
+
async onBegin(config, suite) {
|
|
122
|
+
this.hasMultipleProjects = (config.projects?.length || 0) > 1;
|
|
123
|
+
}
|
|
124
|
+
onTestBegin(_test, _result) {}
|
|
125
|
+
onTestEnd(test, result) {
|
|
126
|
+
const dumpAnnotation = test.annotations.find((annotation)=>'MIDSCENE_DUMP_ANNOTATION' === annotation.type);
|
|
127
|
+
if (!dumpAnnotation?.description) return;
|
|
128
|
+
const tempFilePath = dumpAnnotation.description;
|
|
129
|
+
for (const filePath of GroupedActionDump.getFilePaths(tempFilePath))this.tempFiles.add(filePath);
|
|
130
|
+
let dumpString;
|
|
131
|
+
try {
|
|
132
|
+
if ('html-and-external-assets' === this.outputFormat) {
|
|
133
|
+
const { readFileSync } = __webpack_require__("node:fs");
|
|
134
|
+
dumpString = readFileSync(tempFilePath, 'utf-8');
|
|
135
|
+
const retry = result.retry ? `(retry #${result.retry})` : '';
|
|
136
|
+
const projectName = this.hasMultipleProjects ? test.parent?.project()?.name : void 0;
|
|
137
|
+
const projectSuffix = projectName ? ` [${projectName}]` : '';
|
|
138
|
+
const testTitle = `${test.title}${projectSuffix}${retry}`;
|
|
139
|
+
const reportPath = this.getReportPath(testTitle);
|
|
140
|
+
this.copyScreenshotsToReport(tempFilePath, reportPath);
|
|
141
|
+
} else dumpString = GroupedActionDump.fromFilesAsInlineJson(tempFilePath);
|
|
142
|
+
} catch (error) {
|
|
143
|
+
console.error(`Failed to read Midscene dump file: ${tempFilePath}`, error);
|
|
144
|
+
}
|
|
145
|
+
if (dumpString) {
|
|
146
|
+
const retry = result.retry ? `(retry #${result.retry})` : '';
|
|
147
|
+
const testId = `${test.id}${retry}`;
|
|
148
|
+
const projectName = this.hasMultipleProjects ? test.parent?.project()?.name : void 0;
|
|
149
|
+
const projectSuffix = projectName ? ` [${projectName}]` : '';
|
|
150
|
+
const testData = {
|
|
151
|
+
dumpString,
|
|
152
|
+
attributes: {
|
|
153
|
+
playwright_test_id: testId,
|
|
154
|
+
playwright_test_title: `${test.title}${projectSuffix}${retry}`,
|
|
155
|
+
playwright_test_status: result.status,
|
|
156
|
+
playwright_test_duration: result.duration
|
|
157
|
+
}
|
|
158
|
+
};
|
|
159
|
+
const reportPromise = this.updateReport(testData).catch((error)=>{
|
|
160
|
+
console.error('Error updating report:', error);
|
|
161
|
+
}).finally(()=>{
|
|
162
|
+
this.pendingReports.delete(reportPromise);
|
|
163
|
+
});
|
|
164
|
+
this.pendingReports.add(reportPromise);
|
|
165
|
+
}
|
|
166
|
+
try {
|
|
167
|
+
GroupedActionDump.cleanupFiles(tempFilePath);
|
|
168
|
+
for (const filePath of GroupedActionDump.getFilePaths(tempFilePath))this.tempFiles.delete(filePath);
|
|
169
|
+
} catch {}
|
|
170
|
+
}
|
|
171
|
+
async onEnd() {
|
|
172
|
+
if (this.pendingReports.size > 0) {
|
|
173
|
+
console.log(`Midscene: Waiting for ${this.pendingReports.size} pending report(s) to complete...`);
|
|
174
|
+
await Promise.all(Array.from(this.pendingReports));
|
|
175
|
+
}
|
|
176
|
+
if ('html-and-external-assets' === this.outputFormat && 'merged' === this.mode) {
|
|
177
|
+
const reportPath = this.getReportPath();
|
|
178
|
+
const reportDir = dirname(reportPath);
|
|
179
|
+
console.log('[Midscene] Directory report generated.');
|
|
180
|
+
console.log('[Midscene] Note: This report must be served via HTTP server due to CORS restrictions.');
|
|
181
|
+
console.log(`[Midscene] Example: npx serve ${reportDir}`);
|
|
182
|
+
} else if ('html-and-external-assets' === this.outputFormat && 'separate' === this.mode) {
|
|
183
|
+
const reportBaseDir = getMidsceneRunSubDir('report');
|
|
184
|
+
console.log('[Midscene] Directory reports generated.');
|
|
185
|
+
console.log('[Midscene] Note: Reports must be served via HTTP server due to CORS restrictions.');
|
|
186
|
+
console.log(`[Midscene] Example: npx serve ${reportBaseDir}`);
|
|
187
|
+
}
|
|
188
|
+
if (this.tempFiles.size > 0) {
|
|
189
|
+
console.log(`Midscene: Cleaning up ${this.tempFiles.size} remaining temp file(s)...`);
|
|
190
|
+
for (const filePath of this.tempFiles)try {
|
|
191
|
+
(0, external_node_fs_.rmSync)(filePath, {
|
|
192
|
+
force: true
|
|
193
|
+
});
|
|
194
|
+
} catch (error) {}
|
|
195
|
+
this.tempFiles.clear();
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
constructor(options = {}){
|
|
199
|
+
_define_property(this, "mergedFilename", void 0);
|
|
200
|
+
_define_property(this, "testTitleToFilename", new Map());
|
|
201
|
+
_define_property(this, "mode", void 0);
|
|
202
|
+
_define_property(this, "outputFormat", void 0);
|
|
203
|
+
_define_property(this, "tempFiles", new Set());
|
|
204
|
+
_define_property(this, "pendingReports", new Set());
|
|
205
|
+
_define_property(this, "mergedReportInitialized", false);
|
|
206
|
+
_define_property(this, "writeQueue", Promise.resolve());
|
|
207
|
+
_define_property(this, "hasMultipleProjects", false);
|
|
208
|
+
_define_property(this, "writtenScreenshots", new Set());
|
|
209
|
+
this.mode = MidsceneReporter.getMode(options.type ?? 'merged');
|
|
210
|
+
this.outputFormat = options.outputFormat ?? 'single-html';
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
const reporter = MidsceneReporter;
|
|
214
|
+
export { reporter as default };
|
|
215
|
+
|
|
216
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"playwright/reporter/index.mjs","sources":["../../../../src/playwright/reporter/index.ts"],"sourcesContent":["import {\n copyFileSync,\n existsSync,\n mkdirSync,\n rmSync,\n writeFileSync,\n} from 'node:fs';\nimport { dirname, join } from 'node:path';\nimport {\n GroupedActionDump,\n type ReportDumpWithAttributes,\n} from '@midscene/core';\nimport { getReportFileName, printReportMsg } from '@midscene/core/agent';\nimport { getReportTpl } from '@midscene/core/utils';\nimport { getMidsceneRunSubDir } from '@midscene/shared/common';\nimport {\n escapeScriptTag,\n replaceIllegalPathCharsAndSpace,\n} from '@midscene/shared/utils';\nimport type {\n FullConfig,\n Reporter,\n Suite,\n TestCase,\n TestResult,\n} from '@playwright/test/reporter';\n\ninterface MidsceneReporterOptions {\n type?: 'merged' | 'separate';\n /**\n * Output format for the report.\n * - 'single-html': All screenshots embedded as base64 in a single HTML file (default)\n * - 'html-and-external-assets': Screenshots saved as separate PNG files in a screenshots/ subdirectory\n *\n * Note: 'html-and-external-assets' reports must be served via HTTP server due to CORS restrictions.\n */\n outputFormat?: 'single-html' | 'html-and-external-assets';\n}\n\nclass MidsceneReporter implements Reporter {\n private mergedFilename?: string;\n private testTitleToFilename = new Map<string, string>();\n mode?: 'merged' | 'separate';\n outputFormat: 'single-html' | 'html-and-external-assets';\n\n // Track all temp files created during this test run for cleanup\n private tempFiles = new Set<string>();\n\n // Track pending report updates\n private pendingReports = new Set<Promise<void>>();\n\n // Track whether the merged report file has been initialized\n private mergedReportInitialized = false;\n\n // Write queue to serialize file writes and prevent concurrent write conflicts\n private writeQueue: Promise<void> = Promise.resolve();\n\n // Track whether we have multiple projects (browsers)\n private hasMultipleProjects = false;\n\n // Track written screenshots to avoid duplicates (for directory mode)\n private writtenScreenshots = new Set<string>();\n\n constructor(options: MidsceneReporterOptions = {}) {\n // Set mode from constructor options (official Playwright way)\n this.mode = MidsceneReporter.getMode(options.type ?? 'merged');\n this.outputFormat = options.outputFormat ?? 'single-html';\n }\n\n private static getMode(reporterType: string): 'merged' | 'separate' {\n if (!reporterType) {\n return 'merged';\n }\n if (reporterType !== 'merged' && reporterType !== 'separate') {\n throw new Error(\n `Unknown reporter type in playwright config: ${reporterType}, only support 'merged' or 'separate'`,\n );\n }\n return reporterType;\n }\n\n private getSeparatedFilename(testTitle: string): string {\n if (!this.testTitleToFilename.has(testTitle)) {\n const baseTag = `playwright-${replaceIllegalPathCharsAndSpace(testTitle)}`;\n const generatedFilename = getReportFileName(baseTag);\n this.testTitleToFilename.set(testTitle, generatedFilename);\n }\n return this.testTitleToFilename.get(testTitle)!;\n }\n\n private getReportFilename(testTitle?: string): string {\n if (this.mode === 'merged') {\n if (!this.mergedFilename) {\n this.mergedFilename = getReportFileName('playwright-merged');\n }\n return this.mergedFilename;\n } else if (this.mode === 'separate') {\n if (!testTitle) throw new Error('testTitle is required in separate mode');\n return this.getSeparatedFilename(testTitle);\n }\n throw new Error(`Unknown mode: ${this.mode}`);\n }\n\n /**\n * Get the report path - for directory mode, returns a directory path with index.html\n */\n private getReportPath(testTitle?: string): string {\n const fileName = this.getReportFilename(testTitle);\n if (this.outputFormat === 'html-and-external-assets') {\n // Directory mode: report-name/index.html\n return join(getMidsceneRunSubDir('report'), fileName, 'index.html');\n }\n // Inline mode: report-name.html\n return join(getMidsceneRunSubDir('report'), `${fileName}.html`);\n }\n\n /**\n * Copy screenshots from temp location to report screenshots directory\n */\n private copyScreenshotsToReport(\n tempFilePath: string,\n reportPath: string,\n ): void {\n const screenshotsDir = join(dirname(reportPath), 'screenshots');\n const tempScreenshotsDir = `${tempFilePath}.screenshots`;\n\n if (!existsSync(tempScreenshotsDir)) {\n return;\n }\n\n // Ensure screenshots directory exists\n if (!existsSync(screenshotsDir)) {\n mkdirSync(screenshotsDir, { recursive: true });\n }\n\n // Read screenshot map to get all screenshot IDs\n const screenshotMapPath = `${tempFilePath}.screenshots.json`;\n if (!existsSync(screenshotMapPath)) {\n return;\n }\n\n try {\n const { readFileSync } = require('node:fs');\n const screenshotMap: Record<string, string> = JSON.parse(\n readFileSync(screenshotMapPath, 'utf-8'),\n );\n\n for (const [id, srcPath] of Object.entries(screenshotMap)) {\n // In merged mode, skip if already written to avoid duplicates\n // In separate mode, each test has its own screenshots directory\n if (this.mode === 'merged' && this.writtenScreenshots.has(id)) {\n continue;\n }\n\n const destPath = join(screenshotsDir, `${id}.png`);\n\n if (existsSync(srcPath)) {\n copyFileSync(srcPath, destPath);\n if (this.mode === 'merged') {\n this.writtenScreenshots.add(id);\n }\n }\n }\n } catch (error) {\n console.error('Error copying screenshots:', error);\n }\n }\n\n private async updateReport(testData: ReportDumpWithAttributes) {\n if (!testData || !this.mode) return;\n\n // Queue the write operation to prevent concurrent writes to the same file\n this.writeQueue = this.writeQueue.then(async () => {\n const reportPath = this.getReportPath(\n testData.attributes?.playwright_test_title,\n );\n\n // Ensure report directory exists for directory mode\n if (this.outputFormat === 'html-and-external-assets') {\n const reportDir = dirname(reportPath);\n if (!existsSync(reportDir)) {\n mkdirSync(reportDir, { recursive: true });\n }\n }\n\n // Get report template\n const tpl = getReportTpl();\n if (!tpl) {\n throw new Error(\n 'Report template not found. Ensure @midscene/core is built correctly.',\n );\n }\n\n // Parse the dump string and generate dump script tag\n let dumpScript = `<script type=\"midscene_web_dump\">\\n${escapeScriptTag(testData.dumpString)}\\n</script>`;\n\n // Add attributes to the dump script if this is merged report\n if (this.mode === 'merged' && testData.attributes) {\n const attributesArr = Object.keys(testData.attributes).map((key) => {\n return `${key}=\"${encodeURIComponent(testData.attributes![key])}\"`;\n });\n // Add attributes to the script tag\n dumpScript = dumpScript.replace(\n '<script type=\"midscene_web_dump\"',\n `<script type=\"midscene_web_dump\" ${attributesArr.join(' ')}`,\n );\n }\n\n // Write or append to file\n if (this.mode === 'merged') {\n // For merged report, write template + dump on first write, then only append dumps\n if (!this.mergedReportInitialized) {\n writeFileSync(reportPath, tpl + dumpScript, { flag: 'w' });\n this.mergedReportInitialized = true;\n } else {\n // Append only the dump scripts for subsequent tests\n writeFileSync(reportPath, dumpScript, { flag: 'a' });\n }\n } else {\n // For separate reports, write each test to its own file with template\n writeFileSync(reportPath, tpl + dumpScript, { flag: 'w' });\n }\n\n printReportMsg(reportPath);\n });\n\n await this.writeQueue;\n }\n\n async onBegin(config: FullConfig, suite: Suite) {\n // Check if we have multiple projects to determine if we need browser labels\n this.hasMultipleProjects = (config.projects?.length || 0) > 1;\n }\n\n onTestBegin(_test: TestCase, _result: TestResult) {\n // logger(`Starting test ${test.title}`);\n }\n\n onTestEnd(test: TestCase, result: TestResult) {\n const dumpAnnotation = test.annotations.find((annotation) => {\n return annotation.type === 'MIDSCENE_DUMP_ANNOTATION';\n });\n if (!dumpAnnotation?.description) return;\n\n const tempFilePath = dumpAnnotation.description;\n\n // Track temp files for potential cleanup in onEnd\n for (const filePath of GroupedActionDump.getFilePaths(tempFilePath)) {\n this.tempFiles.add(filePath);\n }\n\n let dumpString: string | undefined;\n\n try {\n if (this.outputFormat === 'html-and-external-assets') {\n // Directory mode: keep { $screenshot: id } format, copy screenshots to report dir\n const { readFileSync } = require('node:fs');\n dumpString = readFileSync(tempFilePath, 'utf-8');\n\n // Get report path and copy screenshots\n const retry = result.retry ? `(retry #${result.retry})` : '';\n const projectName = this.hasMultipleProjects\n ? test.parent?.project()?.name\n : undefined;\n const projectSuffix = projectName ? ` [${projectName}]` : '';\n const testTitle = `${test.title}${projectSuffix}${retry}`;\n const reportPath = this.getReportPath(testTitle);\n\n this.copyScreenshotsToReport(tempFilePath, reportPath);\n } else {\n // Inline mode: convert screenshots to base64\n dumpString = GroupedActionDump.fromFilesAsInlineJson(tempFilePath);\n }\n } catch (error) {\n console.error(\n `Failed to read Midscene dump file: ${tempFilePath}`,\n error,\n );\n // Don't return here - we still need to clean up the temp file\n }\n\n // Only update report if we successfully read the dump\n if (dumpString) {\n const retry = result.retry ? `(retry #${result.retry})` : '';\n const testId = `${test.id}${retry}`;\n\n // Get the project name (browser name) only if we have multiple projects\n const projectName = this.hasMultipleProjects\n ? test.parent?.project()?.name\n : undefined;\n const projectSuffix = projectName ? ` [${projectName}]` : '';\n\n const testData: ReportDumpWithAttributes = {\n dumpString,\n attributes: {\n playwright_test_id: testId,\n playwright_test_title: `${test.title}${projectSuffix}${retry}`,\n playwright_test_status: result.status,\n playwright_test_duration: result.duration,\n },\n };\n\n // Start async report update and track it\n const reportPromise = this.updateReport(testData)\n .catch((error) => {\n console.error('Error updating report:', error);\n })\n .finally(() => {\n this.pendingReports.delete(reportPromise);\n });\n this.pendingReports.add(reportPromise);\n }\n\n // Always try to clean up temp files\n try {\n GroupedActionDump.cleanupFiles(tempFilePath);\n for (const filePath of GroupedActionDump.getFilePaths(tempFilePath)) {\n this.tempFiles.delete(filePath);\n }\n } catch {\n // Keep in tempFiles for cleanup in onEnd\n }\n }\n\n async onEnd() {\n // Wait for all pending report updates to complete\n if (this.pendingReports.size > 0) {\n console.log(\n `Midscene: Waiting for ${this.pendingReports.size} pending report(s) to complete...`,\n );\n await Promise.all(Array.from(this.pendingReports));\n }\n\n // Print directory mode notice (only for merged mode)\n if (\n this.outputFormat === 'html-and-external-assets' &&\n this.mode === 'merged'\n ) {\n const reportPath = this.getReportPath();\n const reportDir = dirname(reportPath);\n console.log('[Midscene] Directory report generated.');\n console.log(\n '[Midscene] Note: This report must be served via HTTP server due to CORS restrictions.',\n );\n console.log(`[Midscene] Example: npx serve ${reportDir}`);\n } else if (\n this.outputFormat === 'html-and-external-assets' &&\n this.mode === 'separate'\n ) {\n const reportBaseDir = getMidsceneRunSubDir('report');\n console.log('[Midscene] Directory reports generated.');\n console.log(\n '[Midscene] Note: Reports must be served via HTTP server due to CORS restrictions.',\n );\n console.log(`[Midscene] Example: npx serve ${reportBaseDir}`);\n }\n\n // Clean up any remaining temp files that weren't deleted in onTestEnd\n if (this.tempFiles.size > 0) {\n console.log(\n `Midscene: Cleaning up ${this.tempFiles.size} remaining temp file(s)...`,\n );\n\n for (const filePath of this.tempFiles) {\n try {\n rmSync(filePath, { force: true });\n } catch (error) {\n // Silently ignore - file may have been deleted already\n }\n }\n\n this.tempFiles.clear();\n }\n }\n}\n\nexport default MidsceneReporter;\n"],"names":["MidsceneReporter","reporterType","Error","testTitle","baseTag","replaceIllegalPathCharsAndSpace","generatedFilename","getReportFileName","fileName","join","getMidsceneRunSubDir","tempFilePath","reportPath","screenshotsDir","dirname","tempScreenshotsDir","existsSync","mkdirSync","screenshotMapPath","readFileSync","require","screenshotMap","JSON","id","srcPath","Object","destPath","copyFileSync","error","console","testData","reportDir","tpl","getReportTpl","dumpScript","escapeScriptTag","attributesArr","key","encodeURIComponent","writeFileSync","printReportMsg","config","suite","_test","_result","test","result","dumpAnnotation","annotation","filePath","GroupedActionDump","dumpString","retry","projectName","undefined","projectSuffix","testId","reportPromise","Promise","Array","reportBaseDir","rmSync","options","Map","Set"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,MAAMA;IA8BJ,OAAe,QAAQC,YAAoB,EAAyB;QAClE,IAAI,CAACA,cACH,OAAO;QAET,IAAIA,AAAiB,aAAjBA,gBAA6BA,AAAiB,eAAjBA,cAC/B,MAAM,IAAIC,MACR,CAAC,4CAA4C,EAAED,aAAa,qCAAqC,CAAC;QAGtG,OAAOA;IACT;IAEQ,qBAAqBE,SAAiB,EAAU;QACtD,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAACA,YAAY;YAC5C,MAAMC,UAAU,CAAC,WAAW,EAAEC,gCAAgCF,YAAY;YAC1E,MAAMG,oBAAoBC,kBAAkBH;YAC5C,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAACD,WAAWG;QAC1C;QACA,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAACH;IACtC;IAEQ,kBAAkBA,SAAkB,EAAU;QACpD,IAAI,AAAc,aAAd,IAAI,CAAC,IAAI,EAAe;YAC1B,IAAI,CAAC,IAAI,CAAC,cAAc,EACtB,IAAI,CAAC,cAAc,GAAGI,kBAAkB;YAE1C,OAAO,IAAI,CAAC,cAAc;QAC5B;QAAO,IAAI,AAAc,eAAd,IAAI,CAAC,IAAI,EAAiB;YACnC,IAAI,CAACJ,WAAW,MAAM,IAAID,MAAM;YAChC,OAAO,IAAI,CAAC,oBAAoB,CAACC;QACnC;QACA,MAAM,IAAID,MAAM,CAAC,cAAc,EAAE,IAAI,CAAC,IAAI,EAAE;IAC9C;IAKQ,cAAcC,SAAkB,EAAU;QAChD,MAAMK,WAAW,IAAI,CAAC,iBAAiB,CAACL;QACxC,IAAI,AAAsB,+BAAtB,IAAI,CAAC,YAAY,EAEnB,OAAOM,KAAKC,qBAAqB,WAAWF,UAAU;QAGxD,OAAOC,KAAKC,qBAAqB,WAAW,GAAGF,SAAS,KAAK,CAAC;IAChE;IAKQ,wBACNG,YAAoB,EACpBC,UAAkB,EACZ;QACN,MAAMC,iBAAiBJ,KAAKK,QAAQF,aAAa;QACjD,MAAMG,qBAAqB,GAAGJ,aAAa,YAAY,CAAC;QAExD,IAAI,CAACK,AAAAA,IAAAA,kBAAAA,UAAAA,AAAAA,EAAWD,qBACd;QAIF,IAAI,CAACC,AAAAA,IAAAA,kBAAAA,UAAAA,AAAAA,EAAWH,iBACdI,AAAAA,IAAAA,kBAAAA,SAAAA,AAAAA,EAAUJ,gBAAgB;YAAE,WAAW;QAAK;QAI9C,MAAMK,oBAAoB,GAAGP,aAAa,iBAAiB,CAAC;QAC5D,IAAI,CAACK,AAAAA,IAAAA,kBAAAA,UAAAA,AAAAA,EAAWE,oBACd;QAGF,IAAI;YACF,MAAM,EAAEC,YAAY,EAAE,GAAGC,oBAAQ;YACjC,MAAMC,gBAAwCC,KAAK,KAAK,CACtDH,aAAaD,mBAAmB;YAGlC,KAAK,MAAM,CAACK,IAAIC,QAAQ,IAAIC,OAAO,OAAO,CAACJ,eAAgB;gBAGzD,IAAI,AAAc,aAAd,IAAI,CAAC,IAAI,IAAiB,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAACE,KACxD;gBAGF,MAAMG,WAAWjB,KAAKI,gBAAgB,GAAGU,GAAG,IAAI,CAAC;gBAEjD,IAAIP,AAAAA,IAAAA,kBAAAA,UAAAA,AAAAA,EAAWQ,UAAU;oBACvBG,IAAAA,kBAAAA,YAAAA,AAAAA,EAAaH,SAASE;oBACtB,IAAI,AAAc,aAAd,IAAI,CAAC,IAAI,EACX,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAACH;gBAEhC;YACF;QACF,EAAE,OAAOK,OAAO;YACdC,QAAQ,KAAK,CAAC,8BAA8BD;QAC9C;IACF;IAEA,MAAc,aAAaE,QAAkC,EAAE;QAC7D,IAAI,CAACA,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE;QAG7B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACrC,MAAMlB,aAAa,IAAI,CAAC,aAAa,CACnCkB,SAAS,UAAU,EAAE;YAIvB,IAAI,AAAsB,+BAAtB,IAAI,CAAC,YAAY,EAAiC;gBACpD,MAAMC,YAAYjB,QAAQF;gBAC1B,IAAI,CAACI,AAAAA,IAAAA,kBAAAA,UAAAA,AAAAA,EAAWe,YACdd,AAAAA,IAAAA,kBAAAA,SAAAA,AAAAA,EAAUc,WAAW;oBAAE,WAAW;gBAAK;YAE3C;YAGA,MAAMC,MAAMC;YACZ,IAAI,CAACD,KACH,MAAM,IAAI9B,MACR;YAKJ,IAAIgC,aAAa,CAAC,mCAAmC,EAAEC,gBAAgBL,SAAS,UAAU,EAAE,WAAW,CAAC;YAGxG,IAAI,AAAc,aAAd,IAAI,CAAC,IAAI,IAAiBA,SAAS,UAAU,EAAE;gBACjD,MAAMM,gBAAgBX,OAAO,IAAI,CAACK,SAAS,UAAU,EAAE,GAAG,CAAC,CAACO,MACnD,GAAGA,IAAI,EAAE,EAAEC,mBAAmBR,SAAS,UAAW,CAACO,IAAI,EAAE,CAAC,CAAC;gBAGpEH,aAAaA,WAAW,OAAO,CAC7B,oCACA,CAAC,iCAAiC,EAAEE,cAAc,IAAI,CAAC,MAAM;YAEjE;YAGA,IAAI,AAAc,aAAd,IAAI,CAAC,IAAI,EAEX,IAAK,IAAI,CAAC,uBAAuB,EAK/BG,AAAAA,IAAAA,kBAAAA,aAAAA,AAAAA,EAAc3B,YAAYsB,YAAY;gBAAE,MAAM;YAAI;iBALjB;gBACjCK,IAAAA,kBAAAA,aAAAA,AAAAA,EAAc3B,YAAYoB,MAAME,YAAY;oBAAE,MAAM;gBAAI;gBACxD,IAAI,CAAC,uBAAuB,GAAG;YACjC;iBAMAK,AAAAA,IAAAA,kBAAAA,aAAAA,AAAAA,EAAc3B,YAAYoB,MAAME,YAAY;gBAAE,MAAM;YAAI;YAG1DM,eAAe5B;QACjB;QAEA,MAAM,IAAI,CAAC,UAAU;IACvB;IAEA,MAAM,QAAQ6B,MAAkB,EAAEC,KAAY,EAAE;QAE9C,IAAI,CAAC,mBAAmB,GAAID,AAAAA,CAAAA,OAAO,QAAQ,EAAE,UAAU,KAAK;IAC9D;IAEA,YAAYE,KAAe,EAAEC,OAAmB,EAAE,CAElD;IAEA,UAAUC,IAAc,EAAEC,MAAkB,EAAE;QAC5C,MAAMC,iBAAiBF,KAAK,WAAW,CAAC,IAAI,CAAC,CAACG,aACrCA,AAAoB,+BAApBA,WAAW,IAAI;QAExB,IAAI,CAACD,gBAAgB,aAAa;QAElC,MAAMpC,eAAeoC,eAAe,WAAW;QAG/C,KAAK,MAAME,YAAYC,kBAAkB,YAAY,CAACvC,cACpD,IAAI,CAAC,SAAS,CAAC,GAAG,CAACsC;QAGrB,IAAIE;QAEJ,IAAI;YACF,IAAI,AAAsB,+BAAtB,IAAI,CAAC,YAAY,EAAiC;gBAEpD,MAAM,EAAEhC,YAAY,EAAE,GAAGC,oBAAQ;gBACjC+B,aAAahC,aAAaR,cAAc;gBAGxC,MAAMyC,QAAQN,OAAO,KAAK,GAAG,CAAC,QAAQ,EAAEA,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG;gBAC1D,MAAMO,cAAc,IAAI,CAAC,mBAAmB,GACxCR,KAAK,MAAM,EAAE,WAAW,OACxBS;gBACJ,MAAMC,gBAAgBF,cAAc,CAAC,EAAE,EAAEA,YAAY,CAAC,CAAC,GAAG;gBAC1D,MAAMlD,YAAY,GAAG0C,KAAK,KAAK,GAAGU,gBAAgBH,OAAO;gBACzD,MAAMxC,aAAa,IAAI,CAAC,aAAa,CAACT;gBAEtC,IAAI,CAAC,uBAAuB,CAACQ,cAAcC;YAC7C,OAEEuC,aAAaD,kBAAkB,qBAAqB,CAACvC;QAEzD,EAAE,OAAOiB,OAAO;YACdC,QAAQ,KAAK,CACX,CAAC,mCAAmC,EAAElB,cAAc,EACpDiB;QAGJ;QAGA,IAAIuB,YAAY;YACd,MAAMC,QAAQN,OAAO,KAAK,GAAG,CAAC,QAAQ,EAAEA,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG;YAC1D,MAAMU,SAAS,GAAGX,KAAK,EAAE,GAAGO,OAAO;YAGnC,MAAMC,cAAc,IAAI,CAAC,mBAAmB,GACxCR,KAAK,MAAM,EAAE,WAAW,OACxBS;YACJ,MAAMC,gBAAgBF,cAAc,CAAC,EAAE,EAAEA,YAAY,CAAC,CAAC,GAAG;YAE1D,MAAMvB,WAAqC;gBACzCqB;gBACA,YAAY;oBACV,oBAAoBK;oBACpB,uBAAuB,GAAGX,KAAK,KAAK,GAAGU,gBAAgBH,OAAO;oBAC9D,wBAAwBN,OAAO,MAAM;oBACrC,0BAA0BA,OAAO,QAAQ;gBAC3C;YACF;YAGA,MAAMW,gBAAgB,IAAI,CAAC,YAAY,CAAC3B,UACrC,KAAK,CAAC,CAACF;gBACNC,QAAQ,KAAK,CAAC,0BAA0BD;YAC1C,GACC,OAAO,CAAC;gBACP,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC6B;YAC7B;YACF,IAAI,CAAC,cAAc,CAAC,GAAG,CAACA;QAC1B;QAGA,IAAI;YACFP,kBAAkB,YAAY,CAACvC;YAC/B,KAAK,MAAMsC,YAAYC,kBAAkB,YAAY,CAACvC,cACpD,IAAI,CAAC,SAAS,CAAC,MAAM,CAACsC;QAE1B,EAAE,OAAM,CAER;IACF;IAEA,MAAM,QAAQ;QAEZ,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,GAAG,GAAG;YAChCpB,QAAQ,GAAG,CACT,CAAC,sBAAsB,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,iCAAiC,CAAC;YAEtF,MAAM6B,QAAQ,GAAG,CAACC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc;QAClD;QAGA,IACE,AAAsB,+BAAtB,IAAI,CAAC,YAAY,IACjB,AAAc,aAAd,IAAI,CAAC,IAAI,EACT;YACA,MAAM/C,aAAa,IAAI,CAAC,aAAa;YACrC,MAAMmB,YAAYjB,QAAQF;YAC1BiB,QAAQ,GAAG,CAAC;YACZA,QAAQ,GAAG,CACT;YAEFA,QAAQ,GAAG,CAAC,CAAC,8BAA8B,EAAEE,WAAW;QAC1D,OAAO,IACL,AAAsB,+BAAtB,IAAI,CAAC,YAAY,IACjB,AAAc,eAAd,IAAI,CAAC,IAAI,EACT;YACA,MAAM6B,gBAAgBlD,qBAAqB;YAC3CmB,QAAQ,GAAG,CAAC;YACZA,QAAQ,GAAG,CACT;YAEFA,QAAQ,GAAG,CAAC,CAAC,8BAA8B,EAAE+B,eAAe;QAC9D;QAGA,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,GAAG;YAC3B/B,QAAQ,GAAG,CACT,CAAC,sBAAsB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,0BAA0B,CAAC;YAG1E,KAAK,MAAMoB,YAAY,IAAI,CAAC,SAAS,CACnC,IAAI;gBACFY,IAAAA,kBAAAA,MAAAA,AAAAA,EAAOZ,UAAU;oBAAE,OAAO;gBAAK;YACjC,EAAE,OAAOrB,OAAO,CAEhB;YAGF,IAAI,CAAC,SAAS,CAAC,KAAK;QACtB;IACF;IAtTA,YAAYkC,UAAmC,CAAC,CAAC,CAAE;QAvBnD,uBAAQ,kBAAR;QACA,uBAAQ,uBAAsB,IAAIC;QAClC;QACA;QAGA,uBAAQ,aAAY,IAAIC;QAGxB,uBAAQ,kBAAiB,IAAIA;QAG7B,uBAAQ,2BAA0B;QAGlC,uBAAQ,cAA4BN,QAAQ,OAAO;QAGnD,uBAAQ,uBAAsB;QAG9B,uBAAQ,sBAAqB,IAAIM;QAI/B,IAAI,CAAC,IAAI,GAAGhE,iBAAiB,OAAO,CAAC8D,QAAQ,IAAI,IAAI;QACrD,IAAI,CAAC,YAAY,GAAGA,QAAQ,YAAY,IAAI;IAC9C;AAmTF;AAEA,iBAAe9D"}
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
import { readFileSync } from "node:fs";
|
|
2
|
+
import { getDebug } from "@midscene/shared/logger";
|
|
3
|
+
import { assert } from "@midscene/shared/utils";
|
|
4
|
+
import { PuppeteerAgent } from "./index.mjs";
|
|
5
|
+
import { DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT } from "@midscene/shared/constants";
|
|
6
|
+
import puppeteer from "puppeteer";
|
|
7
|
+
const defaultUA = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36';
|
|
8
|
+
const defaultViewportWidth = 1440;
|
|
9
|
+
const defaultViewportHeight = 768;
|
|
10
|
+
const defaultViewportScale = 0;
|
|
11
|
+
const defaultWaitForNetworkIdleTimeout = DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT;
|
|
12
|
+
function resolveAiActionContext(target, preference) {
|
|
13
|
+
const data = preference?.aiActContext ?? preference?.aiActionContext ?? target.aiActionContext;
|
|
14
|
+
return data;
|
|
15
|
+
}
|
|
16
|
+
const DANGEROUS_ARGS = [
|
|
17
|
+
'--no-sandbox',
|
|
18
|
+
'--disable-setuid-sandbox',
|
|
19
|
+
'--disable-web-security',
|
|
20
|
+
'--ignore-certificate-errors',
|
|
21
|
+
'--disable-features=IsolateOrigins',
|
|
22
|
+
'--disable-site-isolation-trials',
|
|
23
|
+
'--allow-running-insecure-content'
|
|
24
|
+
];
|
|
25
|
+
function validateChromeArgs(args, baseArgs) {
|
|
26
|
+
const newArgs = args.filter((arg)=>!baseArgs.some((baseArg)=>{
|
|
27
|
+
const argFlag = arg.split('=')[0];
|
|
28
|
+
const baseFlag = baseArg.split('=')[0];
|
|
29
|
+
return argFlag === baseFlag;
|
|
30
|
+
}));
|
|
31
|
+
const dangerousArgs = newArgs.filter((arg)=>DANGEROUS_ARGS.some((dangerous)=>arg.startsWith(dangerous)));
|
|
32
|
+
if (dangerousArgs.length > 0) console.warn(`Warning: Dangerous Chrome arguments detected: ${dangerousArgs.join(', ')}.\nThese arguments may reduce browser security. Use only in controlled testing environments.`);
|
|
33
|
+
}
|
|
34
|
+
const launcherDebug = getDebug('puppeteer:launcher');
|
|
35
|
+
function buildChromeArgs(options) {
|
|
36
|
+
const isWindows = 'win32' === process.platform;
|
|
37
|
+
const sandboxArgs = isWindows ? [] : [
|
|
38
|
+
'--no-sandbox',
|
|
39
|
+
'--disable-setuid-sandbox'
|
|
40
|
+
];
|
|
41
|
+
const featureArgs = [
|
|
42
|
+
'--disable-features=HttpsFirstBalancedModeAutoEnable',
|
|
43
|
+
'--disable-features=PasswordLeakDetection',
|
|
44
|
+
'--disable-save-password-bubble'
|
|
45
|
+
];
|
|
46
|
+
const userAgentArg = options?.userAgent ? [
|
|
47
|
+
`--user-agent="${options.userAgent}"`
|
|
48
|
+
] : [];
|
|
49
|
+
const windowSizeArg = options?.windowSize ? [
|
|
50
|
+
`--window-size=${options.windowSize.width},${options.windowSize.height}`
|
|
51
|
+
] : [];
|
|
52
|
+
const baseArgs = [
|
|
53
|
+
...sandboxArgs,
|
|
54
|
+
...featureArgs,
|
|
55
|
+
...userAgentArg,
|
|
56
|
+
...windowSizeArg
|
|
57
|
+
];
|
|
58
|
+
if (options?.chromeArgs?.length) {
|
|
59
|
+
validateChromeArgs(options.chromeArgs, baseArgs);
|
|
60
|
+
return [
|
|
61
|
+
...baseArgs,
|
|
62
|
+
...options.chromeArgs
|
|
63
|
+
];
|
|
64
|
+
}
|
|
65
|
+
return baseArgs;
|
|
66
|
+
}
|
|
67
|
+
async function launchPuppeteerPage(target, preference, browser, existingPage) {
|
|
68
|
+
assert(target.url, 'url is required');
|
|
69
|
+
const freeFn = [];
|
|
70
|
+
const ua = target.userAgent || defaultUA;
|
|
71
|
+
let width = defaultViewportWidth;
|
|
72
|
+
if (void 0 !== target.viewportWidth && null !== target.viewportWidth) {
|
|
73
|
+
assert('number' == typeof target.viewportWidth, 'viewportWidth must be a number');
|
|
74
|
+
width = Number.parseInt(target.viewportWidth, 10);
|
|
75
|
+
assert(width > 0, `viewportWidth must be greater than 0, but got ${width}`);
|
|
76
|
+
}
|
|
77
|
+
let height = defaultViewportHeight;
|
|
78
|
+
if (void 0 !== target.viewportHeight && null !== target.viewportHeight) {
|
|
79
|
+
assert('number' == typeof target.viewportHeight, 'viewportHeight must be a number');
|
|
80
|
+
height = Number.parseInt(target.viewportHeight, 10);
|
|
81
|
+
assert(height > 0, `viewportHeight must be greater than 0, but got ${height}`);
|
|
82
|
+
}
|
|
83
|
+
let dpr = defaultViewportScale;
|
|
84
|
+
if (void 0 !== target.deviceScaleFactor && null !== target.deviceScaleFactor) {
|
|
85
|
+
assert('number' == typeof target.deviceScaleFactor, 'deviceScaleFactor must be a number');
|
|
86
|
+
dpr = Number.parseInt(target.deviceScaleFactor, 10);
|
|
87
|
+
assert(dpr >= 0, `deviceScaleFactor must be >= 0, but got ${dpr}`);
|
|
88
|
+
}
|
|
89
|
+
const viewportConfig = {
|
|
90
|
+
width,
|
|
91
|
+
height,
|
|
92
|
+
deviceScaleFactor: dpr
|
|
93
|
+
};
|
|
94
|
+
const headed = preference?.headed || preference?.keepWindow;
|
|
95
|
+
const defaultViewportConfig = headed ? null : viewportConfig;
|
|
96
|
+
if (headed && '1' === process.env.CI) console.warn('you are probably running headed mode in CI, this will usually fail.');
|
|
97
|
+
const browserUIHeight = 100;
|
|
98
|
+
const args = buildChromeArgs({
|
|
99
|
+
userAgent: ua,
|
|
100
|
+
windowSize: headed ? {
|
|
101
|
+
width,
|
|
102
|
+
height: height + browserUIHeight
|
|
103
|
+
} : void 0,
|
|
104
|
+
chromeArgs: target.chromeArgs
|
|
105
|
+
});
|
|
106
|
+
launcherDebug('launching browser with viewport, headed', headed, 'viewport', viewportConfig, 'args', args, 'preference', preference);
|
|
107
|
+
let page;
|
|
108
|
+
let browserInstance = browser;
|
|
109
|
+
if (existingPage) {
|
|
110
|
+
page = existingPage;
|
|
111
|
+
launcherDebug('reusing existing page for shared browser context');
|
|
112
|
+
if (!browserInstance) browserInstance = page.browser();
|
|
113
|
+
} else {
|
|
114
|
+
if (!browserInstance) {
|
|
115
|
+
browserInstance = await puppeteer.launch({
|
|
116
|
+
headless: !preference?.headed,
|
|
117
|
+
defaultViewport: defaultViewportConfig,
|
|
118
|
+
args,
|
|
119
|
+
acceptInsecureCerts: target.acceptInsecureCerts,
|
|
120
|
+
ignoreDefaultArgs: preference?.ignoreDefaultArgs
|
|
121
|
+
});
|
|
122
|
+
freeFn.push({
|
|
123
|
+
name: 'puppeteer_browser',
|
|
124
|
+
fn: ()=>{
|
|
125
|
+
if (!preference?.keepWindow) if ('win32' === process.platform) setTimeout(()=>{
|
|
126
|
+
browserInstance?.close();
|
|
127
|
+
}, 800);
|
|
128
|
+
else browserInstance?.close();
|
|
129
|
+
}
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
page = await browserInstance.newPage();
|
|
133
|
+
}
|
|
134
|
+
if (target.cookie) {
|
|
135
|
+
const cookieFileContent = readFileSync(target.cookie, 'utf-8');
|
|
136
|
+
await browserInstance.setCookie(...JSON.parse(cookieFileContent));
|
|
137
|
+
}
|
|
138
|
+
if (ua) await page.setUserAgent(ua);
|
|
139
|
+
if (viewportConfig) await page.setViewport(viewportConfig);
|
|
140
|
+
const waitForNetworkIdleTimeout = 'number' == typeof target.waitForNetworkIdle?.timeout ? target.waitForNetworkIdle.timeout : defaultWaitForNetworkIdleTimeout;
|
|
141
|
+
try {
|
|
142
|
+
launcherDebug('goto', target.url);
|
|
143
|
+
await page.goto(target.url);
|
|
144
|
+
if (waitForNetworkIdleTimeout > 0) {
|
|
145
|
+
launcherDebug('waitForNetworkIdle', waitForNetworkIdleTimeout);
|
|
146
|
+
await page.waitForNetworkIdle({
|
|
147
|
+
timeout: waitForNetworkIdleTimeout
|
|
148
|
+
});
|
|
149
|
+
}
|
|
150
|
+
} catch (e) {
|
|
151
|
+
if ('boolean' == typeof target.waitForNetworkIdle?.continueOnNetworkIdleError && !target.waitForNetworkIdle?.continueOnNetworkIdleError) {
|
|
152
|
+
const newError = new Error(`failed to wait for network idle: ${e}`, {
|
|
153
|
+
cause: e
|
|
154
|
+
});
|
|
155
|
+
throw newError;
|
|
156
|
+
}
|
|
157
|
+
const newMessage = `failed to wait for network idle after ${waitForNetworkIdleTimeout}ms, but the script will continue.`;
|
|
158
|
+
console.warn(newMessage);
|
|
159
|
+
}
|
|
160
|
+
return {
|
|
161
|
+
page,
|
|
162
|
+
freeFn
|
|
163
|
+
};
|
|
164
|
+
}
|
|
165
|
+
async function puppeteerAgentForTarget(target, preference, browser, existingPage) {
|
|
166
|
+
const { page, freeFn } = await launchPuppeteerPage(target, preference, browser, existingPage);
|
|
167
|
+
const aiActContext = resolveAiActionContext(target, preference);
|
|
168
|
+
const { aiActionContext, ...preferenceToUse } = preference ?? {};
|
|
169
|
+
const agent = new PuppeteerAgent(page, {
|
|
170
|
+
...preferenceToUse,
|
|
171
|
+
aiActContext,
|
|
172
|
+
forceSameTabNavigation: void 0 !== target.forceSameTabNavigation ? target.forceSameTabNavigation : true
|
|
173
|
+
});
|
|
174
|
+
freeFn.push({
|
|
175
|
+
name: 'midscene_puppeteer_agent',
|
|
176
|
+
fn: ()=>agent.destroy()
|
|
177
|
+
});
|
|
178
|
+
return {
|
|
179
|
+
agent,
|
|
180
|
+
freeFn
|
|
181
|
+
};
|
|
182
|
+
}
|
|
183
|
+
export { buildChromeArgs, defaultUA, defaultViewportHeight, defaultViewportScale, defaultViewportWidth, defaultWaitForNetworkIdleTimeout, launchPuppeteerPage, puppeteerAgentForTarget, resolveAiActionContext };
|
|
184
|
+
|
|
185
|
+
//# sourceMappingURL=agent-launcher.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"puppeteer/agent-launcher.mjs","sources":["../../../src/puppeteer/agent-launcher.ts"],"sourcesContent":["import { readFileSync } from 'node:fs';\nimport { getDebug } from '@midscene/shared/logger';\nimport { assert } from '@midscene/shared/utils';\n\nimport { PuppeteerAgent } from '@/puppeteer/index';\nimport type { AgentOpt, Cache, MidsceneYamlScriptWebEnv } from '@midscene/core';\nimport { DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT } from '@midscene/shared/constants';\nimport puppeteer, { type Browser, type Page } from 'puppeteer';\n\nexport const defaultUA =\n 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36';\nexport const defaultViewportWidth = 1440;\nexport const defaultViewportHeight = 768;\n// Setting deviceScaleFactor value to `0` means reset this value to the system default in Puppeteer.\nexport const defaultViewportScale = 0;\nexport const defaultWaitForNetworkIdleTimeout =\n DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT;\n\nexport function resolveAiActionContext(\n target: MidsceneYamlScriptWebEnv,\n preference?: Partial<Pick<AgentOpt, 'aiActionContext' | 'aiActContext'>>,\n): AgentOpt['aiActionContext'] | undefined {\n // Prefer agent-level preference if provided; otherwise fall back to target-level context.\n // Priority: preference.aiActContext > preference.aiActionContext (deprecated) > target.aiActionContext\n const data =\n preference?.aiActContext ??\n preference?.aiActionContext ??\n target.aiActionContext;\n return data;\n}\n\n/**\n * Chrome arguments that may reduce browser security.\n * These should only be used in controlled testing environments.\n *\n * Security implications:\n * - `--no-sandbox`: Disables Chrome's sandbox security model\n * - `--disable-setuid-sandbox`: Disables setuid sandbox on Linux\n * - `--disable-web-security`: Allows cross-origin requests without CORS\n * - `--ignore-certificate-errors`: Ignores SSL/TLS certificate errors\n * - `--disable-features=IsolateOrigins`: Disables origin isolation\n * - `--disable-site-isolation-trials`: Disables site isolation\n * - `--allow-running-insecure-content`: Allows mixed HTTP/HTTPS content\n */\nconst DANGEROUS_ARGS = [\n '--no-sandbox',\n '--disable-setuid-sandbox',\n '--disable-web-security',\n '--ignore-certificate-errors',\n '--disable-features=IsolateOrigins',\n '--disable-site-isolation-trials',\n '--allow-running-insecure-content',\n] as const;\n\n/**\n * Validates Chrome launch arguments for security concerns.\n * Emits a warning if dangerous arguments are detected.\n *\n * This function filters out arguments that are already present in baseArgs\n * to avoid warning about platform-specific defaults (e.g., --no-sandbox on non-Windows).\n *\n * @param args - Chrome launch arguments to validate\n * @param baseArgs - Base Chrome arguments already configured\n *\n * @example\n * ```typescript\n * // Will show warning for --disable-web-security\n * validateChromeArgs(['--disable-web-security', '--headless'], ['--no-sandbox']);\n *\n * // Will NOT show warning for --no-sandbox (already in baseArgs)\n * validateChromeArgs(['--no-sandbox'], ['--no-sandbox', '--headless']);\n * ```\n */\nfunction validateChromeArgs(args: string[], baseArgs: string[]): void {\n // Filter out arguments that are already in baseArgs\n const newArgs = args.filter(\n (arg) =>\n !baseArgs.some((baseArg) => {\n // Check if arg starts with the same flag as baseArg (before '=' if present)\n const argFlag = arg.split('=')[0];\n const baseFlag = baseArg.split('=')[0];\n return argFlag === baseFlag;\n }),\n );\n\n const dangerousArgs = newArgs.filter((arg) =>\n DANGEROUS_ARGS.some((dangerous) => arg.startsWith(dangerous)),\n );\n\n if (dangerousArgs.length > 0) {\n console.warn(\n `Warning: Dangerous Chrome arguments detected: ${dangerousArgs.join(', ')}.\\nThese arguments may reduce browser security. Use only in controlled testing environments.`,\n );\n }\n}\n\ninterface FreeFn {\n name: string;\n fn: () => void;\n}\n\nconst launcherDebug = getDebug('puppeteer:launcher');\n\nexport interface BuildChromeArgsOptions {\n userAgent?: string;\n windowSize?: { width: number; height: number };\n chromeArgs?: string[];\n}\n\n/**\n * Builds Chrome launch arguments with sensible defaults.\n *\n * Platform-specific behavior:\n * - On non-Windows systems, automatically adds --no-sandbox and --disable-setuid-sandbox\n * for compatibility with containerized/CI environments\n *\n * @param options - Configuration options for Chrome arguments\n * @returns Array of Chrome launch arguments\n *\n * @example\n * ```typescript\n * // Basic usage\n * const args = buildChromeArgs();\n *\n * // With custom arguments\n * const args = buildChromeArgs({\n * chromeArgs: ['--disable-gpu', '--disable-dev-shm-usage'],\n * userAgent: 'CustomUA/1.0',\n * windowSize: { width: 1920, height: 1080 },\n * });\n * ```\n */\nexport function buildChromeArgs(options?: BuildChromeArgsOptions): string[] {\n const isWindows = process.platform === 'win32';\n\n const sandboxArgs = isWindows\n ? []\n : ['--no-sandbox', '--disable-setuid-sandbox'];\n const featureArgs = [\n '--disable-features=HttpsFirstBalancedModeAutoEnable',\n '--disable-features=PasswordLeakDetection',\n '--disable-save-password-bubble',\n ];\n const userAgentArg = options?.userAgent\n ? [`--user-agent=\"${options.userAgent}\"`]\n : [];\n const windowSizeArg = options?.windowSize\n ? [`--window-size=${options.windowSize.width},${options.windowSize.height}`]\n : [];\n\n const baseArgs = [\n ...sandboxArgs,\n ...featureArgs,\n ...userAgentArg,\n ...windowSizeArg,\n ];\n\n if (options?.chromeArgs?.length) {\n validateChromeArgs(options.chromeArgs, baseArgs);\n return [...baseArgs, ...options.chromeArgs];\n }\n\n return baseArgs;\n}\n\nexport async function launchPuppeteerPage(\n target: MidsceneYamlScriptWebEnv,\n preference?: {\n headed?: boolean;\n keepWindow?: boolean;\n ignoreDefaultArgs?: boolean | string[];\n },\n browser?: Browser,\n existingPage?: Page,\n) {\n assert(target.url, 'url is required');\n const freeFn: FreeFn[] = [];\n\n // prepare the environment\n const ua = target.userAgent || defaultUA;\n let width = defaultViewportWidth;\n if (target.viewportWidth !== undefined && target.viewportWidth !== null) {\n assert(\n typeof target.viewportWidth === 'number',\n 'viewportWidth must be a number',\n );\n width = Number.parseInt(target.viewportWidth as unknown as string, 10);\n assert(width > 0, `viewportWidth must be greater than 0, but got ${width}`);\n }\n let height = defaultViewportHeight;\n if (target.viewportHeight !== undefined && target.viewportHeight !== null) {\n assert(\n typeof target.viewportHeight === 'number',\n 'viewportHeight must be a number',\n );\n height = Number.parseInt(target.viewportHeight as unknown as string, 10);\n assert(\n height > 0,\n `viewportHeight must be greater than 0, but got ${height}`,\n );\n }\n let dpr = defaultViewportScale;\n if (\n target.deviceScaleFactor !== undefined &&\n target.deviceScaleFactor !== null\n ) {\n assert(\n typeof target.deviceScaleFactor === 'number',\n 'deviceScaleFactor must be a number',\n );\n dpr = Number.parseInt(target.deviceScaleFactor as unknown as string, 10);\n assert(dpr >= 0, `deviceScaleFactor must be >= 0, but got ${dpr}`);\n }\n const viewportConfig = {\n width,\n height,\n deviceScaleFactor: dpr,\n };\n\n const headed = preference?.headed || preference?.keepWindow;\n const defaultViewportConfig = headed ? null : viewportConfig;\n\n // launch the browser\n if (headed && process.env.CI === '1') {\n console.warn(\n 'you are probably running headed mode in CI, this will usually fail.',\n );\n }\n\n // Build Chrome arguments using the shared helper\n // Only pass windowSize in headed mode; in headless mode, defaultViewport takes precedence\n // Add 100px to height to account for browser UI (address bar, tabs, etc.)\n const browserUIHeight = 100;\n const args = buildChromeArgs({\n userAgent: ua,\n windowSize: headed\n ? { width, height: height + browserUIHeight }\n : undefined,\n chromeArgs: target.chromeArgs,\n });\n\n launcherDebug(\n 'launching browser with viewport, headed',\n headed,\n 'viewport',\n viewportConfig,\n 'args',\n args,\n 'preference',\n preference,\n );\n // If an existing page is provided, reuse it instead of creating a new one\n // This allows sharing localStorage and sessionStorage between YAML files\n let page: Page;\n let browserInstance = browser;\n\n if (existingPage) {\n // Reuse the existing page - this preserves localStorage and sessionStorage\n page = existingPage;\n launcherDebug('reusing existing page for shared browser context');\n\n // Get the browser instance from the existing page\n if (!browserInstance) {\n browserInstance = page.browser();\n }\n } else {\n // Create a new browser and page\n if (!browserInstance) {\n browserInstance = await puppeteer.launch({\n headless: !preference?.headed,\n defaultViewport: defaultViewportConfig,\n args,\n acceptInsecureCerts: target.acceptInsecureCerts,\n ignoreDefaultArgs: preference?.ignoreDefaultArgs,\n });\n freeFn.push({\n name: 'puppeteer_browser',\n fn: () => {\n if (!preference?.keepWindow) {\n if (process.platform === 'win32') {\n setTimeout(() => {\n browserInstance?.close();\n }, 800);\n } else {\n browserInstance?.close();\n }\n }\n },\n });\n }\n page = await browserInstance.newPage();\n }\n\n if (target.cookie) {\n const cookieFileContent = readFileSync(target.cookie, 'utf-8');\n await browserInstance.setCookie(...JSON.parse(cookieFileContent));\n }\n\n if (ua) {\n await page.setUserAgent(ua);\n }\n\n if (viewportConfig) {\n await page.setViewport(viewportConfig);\n }\n\n const waitForNetworkIdleTimeout =\n typeof target.waitForNetworkIdle?.timeout === 'number'\n ? target.waitForNetworkIdle.timeout\n : defaultWaitForNetworkIdleTimeout;\n\n try {\n launcherDebug('goto', target.url);\n await page.goto(target.url);\n if (waitForNetworkIdleTimeout > 0) {\n launcherDebug('waitForNetworkIdle', waitForNetworkIdleTimeout);\n await page.waitForNetworkIdle({\n timeout: waitForNetworkIdleTimeout,\n });\n }\n } catch (e) {\n if (\n typeof target.waitForNetworkIdle?.continueOnNetworkIdleError ===\n 'boolean' &&\n !target.waitForNetworkIdle?.continueOnNetworkIdleError\n ) {\n const newError = new Error(`failed to wait for network idle: ${e}`, {\n cause: e,\n });\n throw newError;\n }\n const newMessage = `failed to wait for network idle after ${waitForNetworkIdleTimeout}ms, but the script will continue.`;\n console.warn(newMessage);\n }\n\n return { page, freeFn };\n}\n\nexport async function puppeteerAgentForTarget(\n target: MidsceneYamlScriptWebEnv,\n preference?: {\n headed?: boolean;\n keepWindow?: boolean;\n } & Partial<\n Pick<\n AgentOpt,\n | 'testId'\n | 'groupName'\n | 'groupDescription'\n | 'generateReport'\n | 'autoPrintReportMsg'\n | 'reportFileName'\n | 'replanningCycleLimit'\n | 'cache'\n | 'aiActionContext'\n >\n >,\n browser?: Browser,\n existingPage?: Page,\n) {\n const { page, freeFn } = await launchPuppeteerPage(\n target,\n preference,\n browser,\n existingPage,\n );\n const aiActContext = resolveAiActionContext(target, preference);\n\n const { aiActionContext, ...preferenceToUse } = preference ?? {};\n\n // prepare Midscene agent\n const agent = new PuppeteerAgent(page, {\n ...preferenceToUse,\n aiActContext,\n forceSameTabNavigation:\n typeof target.forceSameTabNavigation !== 'undefined'\n ? target.forceSameTabNavigation\n : true, // true for default in yaml script\n });\n\n freeFn.push({\n name: 'midscene_puppeteer_agent',\n fn: () => agent.destroy(),\n });\n\n return { agent, freeFn };\n}\n"],"names":["defaultUA","defaultViewportWidth","defaultViewportHeight","defaultViewportScale","defaultWaitForNetworkIdleTimeout","DEFAULT_WAIT_FOR_NETWORK_IDLE_TIMEOUT","resolveAiActionContext","target","preference","data","DANGEROUS_ARGS","validateChromeArgs","args","baseArgs","newArgs","arg","baseArg","argFlag","baseFlag","dangerousArgs","dangerous","console","launcherDebug","getDebug","buildChromeArgs","options","isWindows","process","sandboxArgs","featureArgs","userAgentArg","windowSizeArg","launchPuppeteerPage","browser","existingPage","assert","freeFn","ua","width","undefined","Number","height","dpr","viewportConfig","headed","defaultViewportConfig","browserUIHeight","page","browserInstance","puppeteer","setTimeout","cookieFileContent","readFileSync","JSON","waitForNetworkIdleTimeout","e","newError","Error","newMessage","puppeteerAgentForTarget","aiActContext","aiActionContext","preferenceToUse","agent","PuppeteerAgent"],"mappings":";;;;;;AASO,MAAMA,YACX;AACK,MAAMC,uBAAuB;AAC7B,MAAMC,wBAAwB;AAE9B,MAAMC,uBAAuB;AAC7B,MAAMC,mCACXC;AAEK,SAASC,uBACdC,MAAgC,EAChCC,UAAwE;IAIxE,MAAMC,OACJD,YAAY,gBACZA,YAAY,mBACZD,OAAO,eAAe;IACxB,OAAOE;AACT;AAeA,MAAMC,iBAAiB;IACrB;IACA;IACA;IACA;IACA;IACA;IACA;CACD;AAqBD,SAASC,mBAAmBC,IAAc,EAAEC,QAAkB;IAE5D,MAAMC,UAAUF,KAAK,MAAM,CACzB,CAACG,MACC,CAACF,SAAS,IAAI,CAAC,CAACG;YAEd,MAAMC,UAAUF,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE;YACjC,MAAMG,WAAWF,QAAQ,KAAK,CAAC,IAAI,CAAC,EAAE;YACtC,OAAOC,YAAYC;QACrB;IAGJ,MAAMC,gBAAgBL,QAAQ,MAAM,CAAC,CAACC,MACpCL,eAAe,IAAI,CAAC,CAACU,YAAcL,IAAI,UAAU,CAACK;IAGpD,IAAID,cAAc,MAAM,GAAG,GACzBE,QAAQ,IAAI,CACV,CAAC,8CAA8C,EAAEF,cAAc,IAAI,CAAC,MAAM,4FAA4F,CAAC;AAG7K;AAOA,MAAMG,gBAAgBC,SAAS;AA+BxB,SAASC,gBAAgBC,OAAgC;IAC9D,MAAMC,YAAYC,AAAqB,YAArBA,QAAQ,QAAQ;IAElC,MAAMC,cAAcF,YAChB,EAAE,GACF;QAAC;QAAgB;KAA2B;IAChD,MAAMG,cAAc;QAClB;QACA;QACA;KACD;IACD,MAAMC,eAAeL,SAAS,YAC1B;QAAC,CAAC,cAAc,EAAEA,QAAQ,SAAS,CAAC,CAAC,CAAC;KAAC,GACvC,EAAE;IACN,MAAMM,gBAAgBN,SAAS,aAC3B;QAAC,CAAC,cAAc,EAAEA,QAAQ,UAAU,CAAC,KAAK,CAAC,CAAC,EAAEA,QAAQ,UAAU,CAAC,MAAM,EAAE;KAAC,GAC1E,EAAE;IAEN,MAAMZ,WAAW;WACZe;WACAC;WACAC;WACAC;KACJ;IAED,IAAIN,SAAS,YAAY,QAAQ;QAC/Bd,mBAAmBc,QAAQ,UAAU,EAAEZ;QACvC,OAAO;eAAIA;eAAaY,QAAQ,UAAU;SAAC;IAC7C;IAEA,OAAOZ;AACT;AAEO,eAAemB,oBACpBzB,MAAgC,EAChCC,UAIC,EACDyB,OAAiB,EACjBC,YAAmB;IAEnBC,OAAO5B,OAAO,GAAG,EAAE;IACnB,MAAM6B,SAAmB,EAAE;IAG3B,MAAMC,KAAK9B,OAAO,SAAS,IAAIP;IAC/B,IAAIsC,QAAQrC;IACZ,IAAIM,AAAyBgC,WAAzBhC,OAAO,aAAa,IAAkBA,AAAyB,SAAzBA,OAAO,aAAa,EAAW;QACvE4B,OACE,AAAgC,YAAhC,OAAO5B,OAAO,aAAa,EAC3B;QAEF+B,QAAQE,OAAO,QAAQ,CAACjC,OAAO,aAAa,EAAuB;QACnE4B,OAAOG,QAAQ,GAAG,CAAC,8CAA8C,EAAEA,OAAO;IAC5E;IACA,IAAIG,SAASvC;IACb,IAAIK,AAA0BgC,WAA1BhC,OAAO,cAAc,IAAkBA,AAA0B,SAA1BA,OAAO,cAAc,EAAW;QACzE4B,OACE,AAAiC,YAAjC,OAAO5B,OAAO,cAAc,EAC5B;QAEFkC,SAASD,OAAO,QAAQ,CAACjC,OAAO,cAAc,EAAuB;QACrE4B,OACEM,SAAS,GACT,CAAC,+CAA+C,EAAEA,QAAQ;IAE9D;IACA,IAAIC,MAAMvC;IACV,IACEI,AAA6BgC,WAA7BhC,OAAO,iBAAiB,IACxBA,AAA6B,SAA7BA,OAAO,iBAAiB,EACxB;QACA4B,OACE,AAAoC,YAApC,OAAO5B,OAAO,iBAAiB,EAC/B;QAEFmC,MAAMF,OAAO,QAAQ,CAACjC,OAAO,iBAAiB,EAAuB;QACrE4B,OAAOO,OAAO,GAAG,CAAC,wCAAwC,EAAEA,KAAK;IACnE;IACA,MAAMC,iBAAiB;QACrBL;QACAG;QACA,mBAAmBC;IACrB;IAEA,MAAME,SAASpC,YAAY,UAAUA,YAAY;IACjD,MAAMqC,wBAAwBD,SAAS,OAAOD;IAG9C,IAAIC,UAAUjB,AAAmB,QAAnBA,QAAQ,GAAG,CAAC,EAAE,EAC1BN,QAAQ,IAAI,CACV;IAOJ,MAAMyB,kBAAkB;IACxB,MAAMlC,OAAOY,gBAAgB;QAC3B,WAAWa;QACX,YAAYO,SACR;YAAEN;YAAO,QAAQG,SAASK;QAAgB,IAC1CP;QACJ,YAAYhC,OAAO,UAAU;IAC/B;IAEAe,cACE,2CACAsB,QACA,YACAD,gBACA,QACA/B,MACA,cACAJ;IAIF,IAAIuC;IACJ,IAAIC,kBAAkBf;IAEtB,IAAIC,cAAc;QAEhBa,OAAOb;QACPZ,cAAc;QAGd,IAAI,CAAC0B,iBACHA,kBAAkBD,KAAK,OAAO;IAElC,OAAO;QAEL,IAAI,CAACC,iBAAiB;YACpBA,kBAAkB,MAAMC,UAAU,MAAM,CAAC;gBACvC,UAAU,CAACzC,YAAY;gBACvB,iBAAiBqC;gBACjBjC;gBACA,qBAAqBL,OAAO,mBAAmB;gBAC/C,mBAAmBC,YAAY;YACjC;YACA4B,OAAO,IAAI,CAAC;gBACV,MAAM;gBACN,IAAI;oBACF,IAAI,CAAC5B,YAAY,YACf,IAAImB,AAAqB,YAArBA,QAAQ,QAAQ,EAClBuB,WAAW;wBACTF,iBAAiB;oBACnB,GAAG;yBAEHA,iBAAiB;gBAGvB;YACF;QACF;QACAD,OAAO,MAAMC,gBAAgB,OAAO;IACtC;IAEA,IAAIzC,OAAO,MAAM,EAAE;QACjB,MAAM4C,oBAAoBC,aAAa7C,OAAO,MAAM,EAAE;QACtD,MAAMyC,gBAAgB,SAAS,IAAIK,KAAK,KAAK,CAACF;IAChD;IAEA,IAAId,IACF,MAAMU,KAAK,YAAY,CAACV;IAG1B,IAAIM,gBACF,MAAMI,KAAK,WAAW,CAACJ;IAGzB,MAAMW,4BACJ,AAA8C,YAA9C,OAAO/C,OAAO,kBAAkB,EAAE,UAC9BA,OAAO,kBAAkB,CAAC,OAAO,GACjCH;IAEN,IAAI;QACFkB,cAAc,QAAQf,OAAO,GAAG;QAChC,MAAMwC,KAAK,IAAI,CAACxC,OAAO,GAAG;QAC1B,IAAI+C,4BAA4B,GAAG;YACjChC,cAAc,sBAAsBgC;YACpC,MAAMP,KAAK,kBAAkB,CAAC;gBAC5B,SAASO;YACX;QACF;IACF,EAAE,OAAOC,GAAG;QACV,IACE,AACE,aADF,OAAOhD,OAAO,kBAAkB,EAAE,8BAElC,CAACA,OAAO,kBAAkB,EAAE,4BAC5B;YACA,MAAMiD,WAAW,IAAIC,MAAM,CAAC,iCAAiC,EAAEF,GAAG,EAAE;gBAClE,OAAOA;YACT;YACA,MAAMC;QACR;QACA,MAAME,aAAa,CAAC,sCAAsC,EAAEJ,0BAA0B,iCAAiC,CAAC;QACxHjC,QAAQ,IAAI,CAACqC;IACf;IAEA,OAAO;QAAEX;QAAMX;IAAO;AACxB;AAEO,eAAeuB,wBACpBpD,MAAgC,EAChCC,UAgBC,EACDyB,OAAiB,EACjBC,YAAmB;IAEnB,MAAM,EAAEa,IAAI,EAAEX,MAAM,EAAE,GAAG,MAAMJ,oBAC7BzB,QACAC,YACAyB,SACAC;IAEF,MAAM0B,eAAetD,uBAAuBC,QAAQC;IAEpD,MAAM,EAAEqD,eAAe,EAAE,GAAGC,iBAAiB,GAAGtD,cAAc,CAAC;IAG/D,MAAMuD,QAAQ,IAAIC,eAAejB,MAAM;QACrC,GAAGe,eAAe;QAClBF;QACA,wBACE,AAAyC,WAAlCrD,OAAO,sBAAsB,GAChCA,OAAO,sBAAsB,GAC7B;IACR;IAEA6B,OAAO,IAAI,CAAC;QACV,MAAM;QACN,IAAI,IAAM2B,MAAM,OAAO;IACzB;IAEA,OAAO;QAAEA;QAAO3B;IAAO;AACzB"}
|