@scoutqa/playwright 1.58.0-fork.1

package/lib/reporters/blob.js

@@ -0,0 +1,139 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var blob_exports = {};
+__export(blob_exports, {
+  BlobReporter: () => BlobReporter,
+  currentBlobReportVersion: () => currentBlobReportVersion
+});
+module.exports = __toCommonJS(blob_exports);
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_stream = require("stream");
+var import_utils = require("playwright-core/lib/utils");
+var import_utils2 = require("playwright-core/lib/utils");
+var import_utilsBundle = require("playwright-core/lib/utilsBundle");
+var import_zipBundle = require("playwright-core/lib/zipBundle");
+var import_base = require("./base");
+var import_teleEmitter = require("./teleEmitter");
+const currentBlobReportVersion = 2;
+class BlobReporter extends import_teleEmitter.TeleReporterEmitter {
+  constructor(options) {
+    super((message) => this._messages.push(message));
+    this._messages = [];
+    this._attachments = [];
+    this._options = options;
+    if (this._options.fileName && !this._options.fileName.endsWith(".zip"))
+      throw new Error(`Blob report file name must end with .zip extension: ${this._options.fileName}`);
+    this._salt = (0, import_utils2.createGuid)();
+  }
+  onConfigure(config) {
+    const metadata = {
+      version: currentBlobReportVersion,
+      userAgent: (0, import_utils2.getUserAgent)(),
+      // TODO: remove after some time, recommend config.tag instead.
+      name: process.env.PWTEST_BOT_NAME,
+      shard: config.shard ?? void 0,
+      pathSeparator: import_path.default.sep
+    };
+    this._messages.push({
+      method: "onBlobReportMetadata",
+      params: metadata
+    });
+    this._config = config;
+    super.onConfigure(config);
+  }
+  async onTestPaused(test, result, step) {
+    return { action: void 0 };
+  }
+  async onEnd(result) {
+    await super.onEnd(result);
+    const zipFileName = await this._prepareOutputFile();
+    const zipFile = new import_zipBundle.yazl.ZipFile();
+    const zipFinishPromise = new import_utils2.ManualPromise();
+    const finishPromise = zipFinishPromise.catch((e) => {
+      throw new Error(`Failed to write report ${zipFileName}: ` + e.message);
+    });
+    zipFile.on("error", (error) => zipFinishPromise.reject(error));
+    zipFile.outputStream.pipe(import_fs.default.createWriteStream(zipFileName)).on("close", () => {
+      zipFinishPromise.resolve(void 0);
+    }).on("error", (error) => zipFinishPromise.reject(error));
+    for (const { originalPath, zipEntryPath } of this._attachments) {
+      if (!import_fs.default.statSync(originalPath, { throwIfNoEntry: false })?.isFile())
+        continue;
+      zipFile.addFile(originalPath, zipEntryPath);
+    }
+    const lines = this._messages.map((m) => JSON.stringify(m) + "\n");
+    const content = import_stream.Readable.from(lines);
+    zipFile.addReadStream(content, "report.jsonl");
+    zipFile.end();
+    await finishPromise;
+  }
+  async _prepareOutputFile() {
+    const { outputFile, outputDir } = (0, import_base.resolveOutputFile)("BLOB", {
+      ...this._options,
+      default: {
+        fileName: this._defaultReportName(this._config),
+        outputDir: "blob-report"
+      }
+    });
+    if (!process.env.PWTEST_BLOB_DO_NOT_REMOVE)
+      await (0, import_utils.removeFolders)([outputDir]);
+    await import_fs.default.promises.mkdir(import_path.default.dirname(outputFile), { recursive: true });
+    return outputFile;
+  }
+  _defaultReportName(config) {
+    let reportName = "report";
+    if (this._options._commandHash)
+      reportName += "-" + (0, import_utils.sanitizeForFilePath)(this._options._commandHash);
+    if (config.shard) {
+      const paddedNumber = `${config.shard.current}`.padStart(`${config.shard.total}`.length, "0");
+      reportName = `${reportName}-${paddedNumber}`;
+    }
+    return `${reportName}.zip`;
+  }
+  _serializeAttachments(attachments) {
+    return super._serializeAttachments(attachments).map((attachment) => {
+      if (!attachment.path)
+        return attachment;
+      const sha1 = (0, import_utils2.calculateSha1)(attachment.path + this._salt);
+      const extension = import_utilsBundle.mime.getExtension(attachment.contentType) || "dat";
+      const newPath = `resources/${sha1}.${extension}`;
+      this._attachments.push({ originalPath: attachment.path, zipEntryPath: newPath });
+      return {
+        ...attachment,
+        path: newPath
+      };
+    });
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BlobReporter,
+  currentBlobReportVersion
+});

package/lib/reporters/dot.js

@@ -0,0 +1,82 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var dot_exports = {};
+__export(dot_exports, {
+  default: () => dot_default
+});
+module.exports = __toCommonJS(dot_exports);
+var import_base = require("./base");
+class DotReporter extends import_base.TerminalReporter {
+  constructor() {
+    super(...arguments);
+    this._counter = 0;
+  }
+  onBegin(suite) {
+    super.onBegin(suite);
+    this.writeLine(this.generateStartingMessage());
+  }
+  onStdOut(chunk, test, result) {
+    super.onStdOut(chunk, test, result);
+    if (!this.config.quiet)
+      this.screen.stdout.write(chunk);
+  }
+  onStdErr(chunk, test, result) {
+    super.onStdErr(chunk, test, result);
+    if (!this.config.quiet)
+      this.screen.stderr.write(chunk);
+  }
+  onTestEnd(test, result) {
+    super.onTestEnd(test, result);
+    if (this._counter === 80) {
+      this.screen.stdout.write("\n");
+      this._counter = 0;
+    }
+    ++this._counter;
+    if (result.status === "skipped") {
+      this.screen.stdout.write(this.screen.colors.yellow("\xB0"));
+      return;
+    }
+    if (this.willRetry(test)) {
+      this.screen.stdout.write(this.screen.colors.gray("\xD7"));
+      return;
+    }
+    switch (test.outcome()) {
+      case "expected":
+        this.screen.stdout.write(this.screen.colors.green("\xB7"));
+        break;
+      case "unexpected":
+        this.screen.stdout.write(this.screen.colors.red(result.status === "timedOut" ? "T" : "F"));
+        break;
+      case "flaky":
+        this.screen.stdout.write(this.screen.colors.yellow("\xB1"));
+        break;
+    }
+  }
+  onError(error) {
+    super.onError(error);
+    this.writeLine("\n" + this.formatError(error).message);
+    this._counter = 0;
+  }
+  async onEnd(result) {
+    await super.onEnd(result);
+    this.screen.stdout.write("\n");
+    this.epilogue(true);
+  }
+}
+var dot_default = DotReporter;

package/lib/reporters/empty.js

@@ -0,0 +1,32 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var empty_exports = {};
+__export(empty_exports, {
+  default: () => empty_default
+});
+module.exports = __toCommonJS(empty_exports);
+class EmptyReporter {
+  version() {
+    return "v2";
+  }
+  printsToStdio() {
+    return false;
+  }
+}
+var empty_default = EmptyReporter;

package/lib/reporters/github.js

@@ -0,0 +1,128 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var github_exports = {};
+__export(github_exports, {
+  GitHubReporter: () => GitHubReporter,
+  default: () => github_default
+});
+module.exports = __toCommonJS(github_exports);
+var import_path = __toESM(require("path"));
+var import_utils = require("playwright-core/lib/utils");
+var import_utilsBundle = require("playwright-core/lib/utilsBundle");
+var import_base = require("./base");
+var import_util = require("../util");
+class GitHubLogger {
+  _log(message, type = "notice", options = {}) {
+    message = message.replace(/\n/g, "%0A");
+    const configs = Object.entries(options).map(([key, option]) => `${key}=${option}`).join(",");
+    process.stdout.write((0, import_util.stripAnsiEscapes)(`::${type} ${configs}::${message}
+`));
+  }
+  debug(message, options) {
+    this._log(message, "debug", options);
+  }
+  error(message, options) {
+    this._log(message, "error", options);
+  }
+  notice(message, options) {
+    this._log(message, "notice", options);
+  }
+  warning(message, options) {
+    this._log(message, "warning", options);
+  }
+}
+class GitHubReporter extends import_base.TerminalReporter {
+  constructor(options = {}) {
+    super(options);
+    this.githubLogger = new GitHubLogger();
+    this.screen = { ...this.screen, colors: import_utils.noColors };
+  }
+  printsToStdio() {
+    return false;
+  }
+  async onEnd(result) {
+    await super.onEnd(result);
+    this._printAnnotations();
+  }
+  onError(error) {
+    const errorMessage = this.formatError(error).message;
+    this.githubLogger.error(errorMessage);
+  }
+  _printAnnotations() {
+    const summary = this.generateSummary();
+    const summaryMessage = this.generateSummaryMessage(summary);
+    if (summary.failuresToPrint.length)
+      this._printFailureAnnotations(summary.failuresToPrint);
+    this._printSlowTestAnnotations();
+    this._printSummaryAnnotation(summaryMessage);
+  }
+  _printSlowTestAnnotations() {
+    this.getSlowTests().forEach(([file, duration]) => {
+      const filePath = workspaceRelativePath(import_path.default.join(process.cwd(), file));
+      this.githubLogger.warning(`${filePath} took ${(0, import_utilsBundle.ms)(duration)}`, {
+        title: "Slow Test",
+        file: filePath
+      });
+    });
+  }
+  _printSummaryAnnotation(summary) {
+    this.githubLogger.notice(summary, {
+      title: "\u{1F3AD} Playwright Run Summary"
+    });
+  }
+  _printFailureAnnotations(failures) {
+    failures.forEach((test, index) => {
+      const title = this.formatTestTitle(test);
+      const header = this.formatTestHeader(test, { indent: "  ", index: index + 1, mode: "error" });
+      for (const result of test.results) {
+        const errors = (0, import_base.formatResultFailure)(this.screen, test, result, "    ");
+        for (const error of errors) {
+          const options = {
+            file: workspaceRelativePath(error.location?.file || test.location.file),
+            title
+          };
+          if (error.location) {
+            options.line = error.location.line;
+            options.col = error.location.column;
+          }
+          const message = [header, ...(0, import_base.formatRetry)(this.screen, result), error.message].join("\n");
+          this.githubLogger.error(message, options);
+        }
+      }
+    });
+  }
+}
+function workspaceRelativePath(filePath) {
+  return import_path.default.relative(process.env["GITHUB_WORKSPACE"] ?? "", filePath);
+}
+var github_default = GitHubReporter;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  GitHubReporter
+});