merge.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541
  1. "use strict";
  2. var __create = Object.create;
  3. var __defProp = Object.defineProperty;
  4. var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
  5. var __getOwnPropNames = Object.getOwnPropertyNames;
  6. var __getProtoOf = Object.getPrototypeOf;
  7. var __hasOwnProp = Object.prototype.hasOwnProperty;
  8. var __export = (target, all) => {
  9. for (var name in all)
  10. __defProp(target, name, { get: all[name], enumerable: true });
  11. };
  12. var __copyProps = (to, from, except, desc) => {
  13. if (from && typeof from === "object" || typeof from === "function") {
  14. for (let key of __getOwnPropNames(from))
  15. if (!__hasOwnProp.call(to, key) && key !== except)
  16. __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
  17. }
  18. return to;
  19. };
  20. var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
  21. // If the importer is in node compatibility mode or this is not an ESM
  22. // file that has been converted to a CommonJS file using a Babel-
  23. // compatible transform (i.e. "__esModule" has not been set), then set
  24. // "default" to the CommonJS "module.exports" for node compatibility.
  25. isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
  26. mod
  27. ));
  28. var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
  29. var merge_exports = {};
  30. __export(merge_exports, {
  31. createMergedReport: () => createMergedReport
  32. });
  33. module.exports = __toCommonJS(merge_exports);
  34. var import_fs = __toESM(require("fs"));
  35. var import_path = __toESM(require("path"));
  36. var import_utils = require("playwright-core/lib/utils");
  37. var import_blob = require("./blob");
  38. var import_multiplexer = require("./multiplexer");
  39. var import_stringInternPool = require("../isomorphic/stringInternPool");
  40. var import_teleReceiver = require("../isomorphic/teleReceiver");
  41. var import_reporters = require("../runner/reporters");
  42. var import_util = require("../util");
  43. async function createMergedReport(config, dir, reporterDescriptions, rootDirOverride) {
  44. const reporters = await (0, import_reporters.createReporters)(config, "merge", reporterDescriptions);
  45. const multiplexer = new import_multiplexer.Multiplexer(reporters);
  46. const stringPool = new import_stringInternPool.StringInternPool();
  47. let printStatus = () => {
  48. };
  49. if (!multiplexer.printsToStdio()) {
  50. printStatus = printStatusToStdout;
  51. printStatus(`merging reports from ${dir}`);
  52. }
  53. const shardFiles = await sortedShardFiles(dir);
  54. if (shardFiles.length === 0)
  55. throw new Error(`No report files found in ${dir}`);
  56. const eventData = await mergeEvents(dir, shardFiles, stringPool, printStatus, rootDirOverride);
  57. const pathSeparator = rootDirOverride ? import_path.default.sep : eventData.pathSeparatorFromMetadata ?? import_path.default.sep;
  58. const receiver = new import_teleReceiver.TeleReporterReceiver(multiplexer, {
  59. mergeProjects: false,
  60. mergeTestCases: false,
  61. resolvePath: (rootDir, relativePath) => stringPool.internString(rootDir + pathSeparator + relativePath),
  62. configOverrides: config.config
  63. });
  64. printStatus(`processing test events`);
  65. const dispatchEvents = async (events) => {
  66. for (const event of events) {
  67. if (event.method === "onEnd")
  68. printStatus(`building final report`);
  69. await receiver.dispatch(event);
  70. if (event.method === "onEnd")
  71. printStatus(`finished building report`);
  72. }
  73. };
  74. await dispatchEvents(eventData.prologue);
  75. for (const { reportFile, eventPatchers, metadata, tags } of eventData.reports) {
  76. const reportJsonl = await import_fs.default.promises.readFile(reportFile);
  77. const events = parseTestEvents(reportJsonl);
  78. new import_stringInternPool.JsonStringInternalizer(stringPool).traverse(events);
  79. eventPatchers.patchers.push(new AttachmentPathPatcher(dir));
  80. if (metadata.name)
  81. eventPatchers.patchers.push(new GlobalErrorPatcher(metadata.name));
  82. if (tags.length)
  83. eventPatchers.patchers.push(new GlobalErrorPatcher(tags.join(" ")));
  84. eventPatchers.patchEvents(events);
  85. await dispatchEvents(events);
  86. }
  87. await dispatchEvents(eventData.epilogue);
  88. }
  89. const commonEventNames = ["onBlobReportMetadata", "onConfigure", "onProject", "onBegin", "onEnd"];
  90. const commonEvents = new Set(commonEventNames);
  91. const commonEventRegex = new RegExp(`${commonEventNames.join("|")}`);
  92. function parseCommonEvents(reportJsonl) {
  93. return splitBufferLines(reportJsonl).map((line) => line.toString("utf8")).filter((line) => commonEventRegex.test(line)).map((line) => JSON.parse(line)).filter((event) => commonEvents.has(event.method));
  94. }
  95. function parseTestEvents(reportJsonl) {
  96. return splitBufferLines(reportJsonl).map((line) => line.toString("utf8")).filter((line) => line.length).map((line) => JSON.parse(line)).filter((event) => !commonEvents.has(event.method));
  97. }
  98. function splitBufferLines(buffer) {
  99. const lines = [];
  100. let start = 0;
  101. while (start < buffer.length) {
  102. const end = buffer.indexOf(10, start);
  103. if (end === -1) {
  104. lines.push(buffer.slice(start));
  105. break;
  106. }
  107. lines.push(buffer.slice(start, end));
  108. start = end + 1;
  109. }
  110. return lines;
  111. }
  112. async function extractAndParseReports(dir, shardFiles, internalizer, printStatus) {
  113. const shardEvents = [];
  114. await import_fs.default.promises.mkdir(import_path.default.join(dir, "resources"), { recursive: true });
  115. const reportNames = new UniqueFileNameGenerator();
  116. for (const file of shardFiles) {
  117. const absolutePath = import_path.default.join(dir, file);
  118. printStatus(`extracting: ${(0, import_util.relativeFilePath)(absolutePath)}`);
  119. const zipFile = new import_utils.ZipFile(absolutePath);
  120. const entryNames = await zipFile.entries();
  121. for (const entryName of entryNames.sort()) {
  122. let fileName = import_path.default.join(dir, entryName);
  123. const content = await zipFile.read(entryName);
  124. if (entryName.endsWith(".jsonl")) {
  125. fileName = reportNames.makeUnique(fileName);
  126. let parsedEvents = parseCommonEvents(content);
  127. internalizer.traverse(parsedEvents);
  128. const metadata = findMetadata(parsedEvents, file);
  129. parsedEvents = modernizer.modernize(metadata.version, parsedEvents);
  130. shardEvents.push({
  131. file,
  132. localPath: fileName,
  133. metadata,
  134. parsedEvents
  135. });
  136. }
  137. await import_fs.default.promises.writeFile(fileName, content);
  138. }
  139. zipFile.close();
  140. }
  141. return shardEvents;
  142. }
  143. function findMetadata(events, file) {
  144. if (events[0]?.method !== "onBlobReportMetadata")
  145. throw new Error(`No metadata event found in ${file}`);
  146. const metadata = events[0].params;
  147. if (metadata.version > import_blob.currentBlobReportVersion)
  148. throw new Error(`Blob report ${file} was created with a newer version of Playwright.`);
  149. return metadata;
  150. }
  151. async function mergeEvents(dir, shardReportFiles, stringPool, printStatus, rootDirOverride) {
  152. const internalizer = new import_stringInternPool.JsonStringInternalizer(stringPool);
  153. const configureEvents = [];
  154. const projectEvents = [];
  155. const endEvents = [];
  156. const blobs = await extractAndParseReports(dir, shardReportFiles, internalizer, printStatus);
  157. blobs.sort((a, b) => {
  158. const nameA = a.metadata.name ?? "";
  159. const nameB = b.metadata.name ?? "";
  160. if (nameA !== nameB)
  161. return nameA.localeCompare(nameB);
  162. const shardA = a.metadata.shard?.current ?? 0;
  163. const shardB = b.metadata.shard?.current ?? 0;
  164. if (shardA !== shardB)
  165. return shardA - shardB;
  166. return a.file.localeCompare(b.file);
  167. });
  168. printStatus(`merging events`);
  169. const reports = [];
  170. const globalTestIdSet = /* @__PURE__ */ new Set();
  171. for (let i = 0; i < blobs.length; ++i) {
  172. const { parsedEvents, metadata, localPath } = blobs[i];
  173. const eventPatchers = new JsonEventPatchers();
  174. eventPatchers.patchers.push(new IdsPatcher(
  175. stringPool,
  176. metadata.name,
  177. String(i),
  178. globalTestIdSet
  179. ));
  180. if (rootDirOverride)
  181. eventPatchers.patchers.push(new PathSeparatorPatcher(metadata.pathSeparator));
  182. eventPatchers.patchEvents(parsedEvents);
  183. let tags = [];
  184. for (const event of parsedEvents) {
  185. if (event.method === "onConfigure") {
  186. configureEvents.push(event);
  187. tags = event.params.config.tags || [];
  188. } else if (event.method === "onProject") {
  189. projectEvents.push(event);
  190. } else if (event.method === "onEnd") {
  191. endEvents.push(event);
  192. }
  193. }
  194. reports.push({
  195. eventPatchers,
  196. reportFile: localPath,
  197. metadata,
  198. tags
  199. });
  200. }
  201. return {
  202. prologue: [
  203. mergeConfigureEvents(configureEvents, rootDirOverride),
  204. ...projectEvents,
  205. { method: "onBegin", params: void 0 }
  206. ],
  207. reports,
  208. epilogue: [
  209. mergeEndEvents(endEvents),
  210. { method: "onExit", params: void 0 }
  211. ],
  212. pathSeparatorFromMetadata: blobs[0]?.metadata.pathSeparator
  213. };
  214. }
  215. function mergeConfigureEvents(configureEvents, rootDirOverride) {
  216. if (!configureEvents.length)
  217. throw new Error("No configure events found");
  218. let config = {
  219. configFile: void 0,
  220. globalTimeout: 0,
  221. maxFailures: 0,
  222. metadata: {},
  223. rootDir: "",
  224. version: "",
  225. workers: 0,
  226. globalSetup: null,
  227. globalTeardown: null
  228. };
  229. for (const event of configureEvents)
  230. config = mergeConfigs(config, event.params.config);
  231. if (rootDirOverride) {
  232. config.rootDir = rootDirOverride;
  233. } else {
  234. const rootDirs = new Set(configureEvents.map((e) => e.params.config.rootDir));
  235. if (rootDirs.size > 1) {
  236. throw new Error([
  237. `Blob reports being merged were recorded with different test directories, and`,
  238. `merging cannot proceed. This may happen if you are merging reports from`,
  239. `machines with different environments, like different operating systems or`,
  240. `if the tests ran with different playwright configs.`,
  241. ``,
  242. `You can force merge by specifying a merge config file with "-c" option. If`,
  243. `you'd like all test paths to be correct, make sure 'testDir' in the merge config`,
  244. `file points to the actual tests location.`,
  245. ``,
  246. `Found directories:`,
  247. ...rootDirs
  248. ].join("\n"));
  249. }
  250. }
  251. return {
  252. method: "onConfigure",
  253. params: {
  254. config
  255. }
  256. };
  257. }
  258. function mergeConfigs(to, from) {
  259. return {
  260. ...to,
  261. ...from,
  262. metadata: {
  263. ...to.metadata,
  264. ...from.metadata,
  265. actualWorkers: (to.metadata.actualWorkers || 0) + (from.metadata.actualWorkers || 0)
  266. },
  267. workers: to.workers + from.workers
  268. };
  269. }
  270. function mergeEndEvents(endEvents) {
  271. let startTime = endEvents.length ? 1e13 : Date.now();
  272. let status = "passed";
  273. let duration = 0;
  274. for (const event of endEvents) {
  275. const shardResult = event.params.result;
  276. if (shardResult.status === "failed")
  277. status = "failed";
  278. else if (shardResult.status === "timedout" && status !== "failed")
  279. status = "timedout";
  280. else if (shardResult.status === "interrupted" && status !== "failed" && status !== "timedout")
  281. status = "interrupted";
  282. startTime = Math.min(startTime, shardResult.startTime);
  283. duration = Math.max(duration, shardResult.duration);
  284. }
  285. const result = {
  286. status,
  287. startTime,
  288. duration
  289. };
  290. return {
  291. method: "onEnd",
  292. params: {
  293. result
  294. }
  295. };
  296. }
  297. async function sortedShardFiles(dir) {
  298. const files = await import_fs.default.promises.readdir(dir);
  299. return files.filter((file) => file.endsWith(".zip")).sort();
  300. }
  301. function printStatusToStdout(message) {
  302. process.stdout.write(`${message}
  303. `);
  304. }
  305. class UniqueFileNameGenerator {
  306. constructor() {
  307. this._usedNames = /* @__PURE__ */ new Set();
  308. }
  309. makeUnique(name) {
  310. if (!this._usedNames.has(name)) {
  311. this._usedNames.add(name);
  312. return name;
  313. }
  314. const extension = import_path.default.extname(name);
  315. name = name.substring(0, name.length - extension.length);
  316. let index = 0;
  317. while (true) {
  318. const candidate = `${name}-${++index}${extension}`;
  319. if (!this._usedNames.has(candidate)) {
  320. this._usedNames.add(candidate);
  321. return candidate;
  322. }
  323. }
  324. }
  325. }
  326. class IdsPatcher {
  327. constructor(stringPool, botName, salt, globalTestIdSet) {
  328. this._stringPool = stringPool;
  329. this._botName = botName;
  330. this._salt = salt;
  331. this._testIdsMap = /* @__PURE__ */ new Map();
  332. this._globalTestIdSet = globalTestIdSet;
  333. }
  334. patchEvent(event) {
  335. const { method, params } = event;
  336. switch (method) {
  337. case "onProject":
  338. this._onProject(params.project);
  339. return;
  340. case "onAttach":
  341. case "onTestBegin":
  342. case "onStepBegin":
  343. case "onStepEnd":
  344. case "onStdIO":
  345. params.testId = params.testId ? this._mapTestId(params.testId) : void 0;
  346. return;
  347. case "onTestEnd":
  348. params.test.testId = this._mapTestId(params.test.testId);
  349. return;
  350. }
  351. }
  352. _onProject(project) {
  353. project.metadata ??= {};
  354. project.suites.forEach((suite) => this._updateTestIds(suite));
  355. }
  356. _updateTestIds(suite) {
  357. suite.entries.forEach((entry) => {
  358. if ("testId" in entry)
  359. this._updateTestId(entry);
  360. else
  361. this._updateTestIds(entry);
  362. });
  363. }
  364. _updateTestId(test) {
  365. test.testId = this._mapTestId(test.testId);
  366. if (this._botName) {
  367. test.tags = test.tags || [];
  368. test.tags.unshift("@" + this._botName);
  369. }
  370. }
  371. _mapTestId(testId) {
  372. const t1 = this._stringPool.internString(testId);
  373. if (this._testIdsMap.has(t1))
  374. return this._testIdsMap.get(t1);
  375. if (this._globalTestIdSet.has(t1)) {
  376. const t2 = this._stringPool.internString(testId + this._salt);
  377. this._globalTestIdSet.add(t2);
  378. this._testIdsMap.set(t1, t2);
  379. return t2;
  380. }
  381. this._globalTestIdSet.add(t1);
  382. this._testIdsMap.set(t1, t1);
  383. return t1;
  384. }
  385. }
  386. class AttachmentPathPatcher {
  387. constructor(_resourceDir) {
  388. this._resourceDir = _resourceDir;
  389. }
  390. patchEvent(event) {
  391. if (event.method === "onAttach")
  392. this._patchAttachments(event.params.attachments);
  393. else if (event.method === "onTestEnd")
  394. this._patchAttachments(event.params.result.attachments ?? []);
  395. }
  396. _patchAttachments(attachments) {
  397. for (const attachment of attachments) {
  398. if (!attachment.path)
  399. continue;
  400. attachment.path = import_path.default.join(this._resourceDir, attachment.path);
  401. }
  402. }
  403. }
  404. class PathSeparatorPatcher {
  405. constructor(from) {
  406. this._from = from ?? (import_path.default.sep === "/" ? "\\" : "/");
  407. this._to = import_path.default.sep;
  408. }
  409. patchEvent(jsonEvent) {
  410. if (this._from === this._to)
  411. return;
  412. if (jsonEvent.method === "onProject") {
  413. this._updateProject(jsonEvent.params.project);
  414. return;
  415. }
  416. if (jsonEvent.method === "onTestEnd") {
  417. const test = jsonEvent.params.test;
  418. test.annotations?.forEach((annotation) => this._updateAnnotationLocation(annotation));
  419. const testResult = jsonEvent.params.result;
  420. testResult.annotations?.forEach((annotation) => this._updateAnnotationLocation(annotation));
  421. testResult.errors.forEach((error) => this._updateErrorLocations(error));
  422. (testResult.attachments ?? []).forEach((attachment) => {
  423. if (attachment.path)
  424. attachment.path = this._updatePath(attachment.path);
  425. });
  426. return;
  427. }
  428. if (jsonEvent.method === "onStepBegin") {
  429. const step = jsonEvent.params.step;
  430. this._updateLocation(step.location);
  431. return;
  432. }
  433. if (jsonEvent.method === "onStepEnd") {
  434. const step = jsonEvent.params.step;
  435. this._updateErrorLocations(step.error);
  436. step.annotations?.forEach((annotation) => this._updateAnnotationLocation(annotation));
  437. return;
  438. }
  439. if (jsonEvent.method === "onAttach") {
  440. const attach = jsonEvent.params;
  441. attach.attachments.forEach((attachment) => {
  442. if (attachment.path)
  443. attachment.path = this._updatePath(attachment.path);
  444. });
  445. return;
  446. }
  447. }
  448. _updateProject(project) {
  449. project.outputDir = this._updatePath(project.outputDir);
  450. project.testDir = this._updatePath(project.testDir);
  451. project.snapshotDir = this._updatePath(project.snapshotDir);
  452. project.suites.forEach((suite) => this._updateSuite(suite, true));
  453. }
  454. _updateSuite(suite, isFileSuite = false) {
  455. this._updateLocation(suite.location);
  456. if (isFileSuite)
  457. suite.title = this._updatePath(suite.title);
  458. for (const entry of suite.entries) {
  459. if ("testId" in entry) {
  460. this._updateLocation(entry.location);
  461. entry.annotations?.forEach((annotation) => this._updateAnnotationLocation(annotation));
  462. } else {
  463. this._updateSuite(entry);
  464. }
  465. }
  466. }
  467. _updateErrorLocations(error) {
  468. while (error) {
  469. this._updateLocation(error.location);
  470. error = error.cause;
  471. }
  472. }
  473. _updateAnnotationLocation(annotation) {
  474. this._updateLocation(annotation.location);
  475. }
  476. _updateLocation(location) {
  477. if (location)
  478. location.file = this._updatePath(location.file);
  479. }
  480. _updatePath(text) {
  481. return text.split(this._from).join(this._to);
  482. }
  483. }
  484. class GlobalErrorPatcher {
  485. constructor(botName) {
  486. this._prefix = `(${botName}) `;
  487. }
  488. patchEvent(event) {
  489. if (event.method !== "onError")
  490. return;
  491. const error = event.params.error;
  492. if (error.message !== void 0)
  493. error.message = this._prefix + error.message;
  494. if (error.stack !== void 0)
  495. error.stack = this._prefix + error.stack;
  496. }
  497. }
  498. class JsonEventPatchers {
  499. constructor() {
  500. this.patchers = [];
  501. }
  502. patchEvents(events) {
  503. for (const event of events) {
  504. for (const patcher of this.patchers)
  505. patcher.patchEvent(event);
  506. }
  507. }
  508. }
  509. class BlobModernizer {
  510. modernize(fromVersion, events) {
  511. const result = [];
  512. for (const event of events)
  513. result.push(...this._modernize(fromVersion, event));
  514. return result;
  515. }
  516. _modernize(fromVersion, event) {
  517. let events = [event];
  518. for (let version = fromVersion; version < import_blob.currentBlobReportVersion; ++version)
  519. events = this[`_modernize_${version}_to_${version + 1}`].call(this, events);
  520. return events;
  521. }
  522. _modernize_1_to_2(events) {
  523. return events.map((event) => {
  524. if (event.method === "onProject") {
  525. const modernizeSuite = (suite) => {
  526. const newSuites = suite.suites.map(modernizeSuite);
  527. const { suites, tests, ...remainder } = suite;
  528. return { entries: [...newSuites, ...tests], ...remainder };
  529. };
  530. const project = event.params.project;
  531. project.suites = project.suites.map(modernizeSuite);
  532. }
  533. return event;
  534. });
  535. }
  536. }
  537. const modernizer = new BlobModernizer();
  538. // Annotate the CommonJS export names for ESM import in node:
  539. 0 && (module.exports = {
  540. createMergedReport
  541. });