@empiricalrun/playwright-utils 0.35.0 → 0.36.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @empiricalrun/playwright-utils
 
+## 0.36.0
+
+### Minor Changes
+
+- 2d9919d: feat: consolidate zip utils and move to streaming
+
+### Patch Changes
+
+- Updated dependencies [2d9919d]
+  - @empiricalrun/r2-uploader@0.7.0
+  - @empiricalrun/test-gen@0.78.5
+
+## 0.35.1
+
+### Patch Changes
+
+- dcd3a61: fix: blob reporter output can hit ENAMETOOLONG error
+
 ## 0.35.0
 
 ### Minor Changes

package/dist/config/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAczD,wBAAgB,gBAAgB,IAAI,MAAM,CAazC;AAkBD,eAAO,MAAM,UAAU,EAAE,oBAyBxB,CAAC;AAEF,eAAO,MAAM,OAAO,EAAE,iBAarB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAgBzD,wBAAgB,gBAAgB,IAAI,MAAM,CAazC;AA6BD,eAAO,MAAM,UAAU,EAAE,oBAyBxB,CAAC;AAEF,eAAO,MAAM,OAAO,EAAE,iBAarB,CAAC"}

package/dist/config/index.js

@@ -36,8 +36,19 @@ function chromeStablePath() {
     }
 }
 function getReporters() {
+    if (process.env.HAS_SHARDING && !process.env.SHARD_INDEX) {
+        throw new Error("Invalid env variables: HAS_SHARDING needs SHARD_INDEX");
+    }
     const middle = process.env.HAS_SHARDING
-        ? [["blob", { outputDir: "blob-report" }]]
+        ? [
+            [
+                "blob",
+                {
+                    outputDir: "blob-report",
+                    fileName: `report-${process.env.SHARD_INDEX}.zip`,
+                },
+            ],
+        ]
         : [
             ["json", { outputFile: "summary.json" }],
             ["html", { open: "never" }],

package/dist/reporter/blob-utils.d.ts

@@ -1,4 +1,4 @@
 export type AttachmentKey = string;
 export declare function makeAttachmentKey(testId: string, retryIndex: number, attachmentName: string): AttachmentKey;
-export declare function patchBlobZip(zipPath: string, attachmentUrlMap: Map<AttachmentKey, string>): Record<string, string>;
+export declare function patchBlobZip(zipPath: string, attachmentUrlMap: Map<AttachmentKey, string>): Promise<Record<string, string>>;
 //# sourceMappingURL=blob-utils.d.ts.map

package/dist/reporter/blob-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blob-utils.d.ts","sourceRoot":"","sources":["../../src/reporter/blob-utils.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,GACrB,aAAa,CAEf;AAED,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,gBAAgB,EAAE,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,GAC3C,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAoExB"}
+{"version":3,"file":"blob-utils.d.ts","sourceRoot":"","sources":["../../src/reporter/blob-utils.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,GACrB,aAAa,CAEf;AAED,wBAAsB,YAAY,CAChC,OAAO,EAAE,MAAM,EACf,gBAAgB,EAAE,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,GAC3C,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAoEjC"}

package/dist/reporter/blob-utils.js

@@ -1,27 +1,25 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeAttachmentKey = makeAttachmentKey;
 exports.patchBlobZip = patchBlobZip;
-const adm_zip_1 = __importDefault(require("adm-zip"));
+const zip_1 = require("@empiricalrun/r2-uploader/zip");
 const logger_1 = require("../logger");
 function makeAttachmentKey(testId, retryIndex, attachmentName) {
     return `${testId}|${retryIndex}|${attachmentName}`;
 }
-function patchBlobZip(zipPath, attachmentUrlMap) {
-    const zip = new adm_zip_1.default(zipPath);
-    const reportEntry = zip.getEntry("report.jsonl");
-    if (!reportEntry) {
+async function patchBlobZip(zipPath, attachmentUrlMap) {
+    const resourceToUrlMap = {};
+    const reportContent = await (0, zip_1.readZipEntry)(zipPath, "report.jsonl");
+    if (!reportContent) {
         logger_1.logger.debug(`[Blob Utils] No report.jsonl found in blob zip: ${zipPath}`);
         return {};
     }
-    const content = reportEntry.getData().toString("utf8");
-    const lines = content.split("\n").filter((line) => line.length);
+    const lines = reportContent
+        .toString("utf8")
+        .split("\n")
+        .filter((line) => line.length);
     const retryCounters = new Map();
     const testRetryMap = new Map();
-    const resourceToUrlMap = {};
     for (const line of lines) {
         const event = JSON.parse(line);
         if (event.method === "onTestEnd") {
@@ -54,13 +52,15 @@ function patchBlobZip(zipPath, attachmentUrlMap) {
             }
         }
     }
-    zip.addFile("_empirical_urls.json", Buffer.from(JSON.stringify(resourceToUrlMap, null, 2)));
-    for (const entry of zip.getEntries()) {
-        if (entry.entryName.startsWith("resources/")) {
-            zip.deleteFile(entry.entryName);
-        }
-    }
-    zip.writeZip(zipPath);
+    await (0, zip_1.patchZipFile)(zipPath, {
+        filterEntry: (filename) => !filename.startsWith("resources/"),
+        newEntries: [
+            {
+                filename: "_empirical_urls.json",
+                content: Buffer.from(JSON.stringify(resourceToUrlMap, null, 2)),
+            },
+        ],
+    });
     logger_1.logger.debug(`[Blob Utils] Patched blob zip: ${zipPath}, mapped ${Object.keys(resourceToUrlMap).length} resources`);
     return resourceToUrlMap;
 }

package/dist/reporter/empirical-reporter.d.ts

@@ -17,7 +17,6 @@ declare class EmpiricalReporter implements Reporter {
     onTestEnd(test: TestCase, result: TestResult): void;
     onEnd(result: FullResult): Promise<void>;
     private _patchBlobReport;
-    private _patchBlobZip;
     private _uploadBlobReport;
 }
 export default EmpiricalReporter;

package/dist/reporter/empirical-reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"empirical-reporter.d.ts","sourceRoot":"","sources":["../../src/reporter/empirical-reporter.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,UAAU,EACX,MAAM,2BAA2B,CAAC;AAkBnC,cAAM,iBAAkB,YAAW,QAAQ;IACzC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,aAAa,CAAyB;IAC9C,OAAO,CAAC,kBAAkB,CAAyB;IACnD,OAAO,CAAC,oBAAoB,CAAkB;IAC9C,OAAO,CAAC,oBAAoB,CAG1B;IACF,OAAO,CAAC,QAAQ,CAAmC;IACnD,OAAO,CAAC,UAAU,CACwE;IAC1F,OAAO,CAAC,sBAAsB,CAAuB;IAErD,OAAO,CAAC,YAAY,CAAgD;IACpE,OAAO,CAAC,iBAAiB,CAAyC;IAClE,OAAO,CAAC,gBAAgB,CAAkC;IAE1D,OAAO,CAAC,YAAY;;IAyBpB,OAAO,CAAC,6BAA6B,CA4BnC;IAEF,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAuFtC,KAAK,CAAC,MAAM,EAAE,UAAU;YA6HhB,gBAAgB;IAO9B,OAAO,CAAC,aAAa;YAIP,iBAAiB;CAWhC;AAED,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"empirical-reporter.d.ts","sourceRoot":"","sources":["../../src/reporter/empirical-reporter.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,UAAU,EACX,MAAM,2BAA2B,CAAC;AAkBnC,cAAM,iBAAkB,YAAW,QAAQ;IACzC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,aAAa,CAAyB;IAC9C,OAAO,CAAC,kBAAkB,CAAyB;IACnD,OAAO,CAAC,oBAAoB,CAAkB;IAC9C,OAAO,CAAC,oBAAoB,CAG1B;IACF,OAAO,CAAC,QAAQ,CAAmC;IACnD,OAAO,CAAC,UAAU,CACwE;IAC1F,OAAO,CAAC,sBAAsB,CAAuB;IAErD,OAAO,CAAC,YAAY,CAAgD;IACpE,OAAO,CAAC,iBAAiB,CAAyC;IAClE,OAAO,CAAC,gBAAgB,CAAkC;IAE1D,OAAO,CAAC,YAAY;;IAyBpB,OAAO,CAAC,6BAA6B,CA4BnC;IAEF,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAuFtC,KAAK,CAAC,MAAM,EAAE,UAAU;YA4HhB,gBAAgB;YAOhB,iBAAiB;CAWhC;AAED,eAAe,iBAAiB,CAAC"}

package/dist/reporter/empirical-reporter.js

@@ -192,8 +192,7 @@ class EmpiricalReporter {
             void (0, r2_uploader_1.sendTaskToQueue)(uploadTraceTask);
         }
         else {
-            logger_1.logger.error(`[Empirical Reporter] playwright-report/trace does not exist at: ${traceFilePath}`);
-            return;
+            logger_1.logger.debug(`[Empirical Reporter] playwright-report/trace does not exist at: ${traceFilePath}`);
         }
         await (0, r2_uploader_1.waitForTaskQueueToFinish)();
         await Promise.allSettled(this._pendingTestCaseEvents);
@@ -220,12 +219,9 @@ class EmpiricalReporter {
     async _patchBlobReport(blobDir) {
         const files = await fs_1.default.promises.readdir(blobDir);
         for (const fileName of files.filter((f) => f.endsWith(".zip"))) {
-            this._patchBlobZip(path_1.default.join(blobDir, fileName));
+            await (0, blob_utils_1.patchBlobZip)(path_1.default.join(blobDir, fileName), this._attachmentUrlMap);
         }
     }
-    _patchBlobZip(zipPath) {
-        (0, blob_utils_1.patchBlobZip)(zipPath, this._attachmentUrlMap);
-    }
     async _uploadBlobReport(blobDir) {
         const uploadTask = (0, uploader_1.createUploadTaskV2)({
             sourceDir: blobDir,

package/dist/reporter/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/reporter/util.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,qBAAqB,EACtB,MAAM,6CAA6C,CAAC;AACrD,OAAO,EACL,cAAc,EAGd,UAAU,IAAI,oBAAoB,EAElC,QAAQ,EACT,MAAM,2BAA2B,CAAC;AAoBnC,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAmB7D;AAED,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,GAAG,SAAS,UAMhC;AAED,wBAAsB,0BAA0B,CAC9C,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAO,GAC5E,OAAO,CAAC;IACT,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC,CAyCD;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,QAAQ;;;EAwBrD;AAED,wBAAsB,6BAA6B,CACjD,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,IAAI,CAAC,CAyDf;AAED,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,GAAG,EACR,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,GACnC,GAAG,CAIL;AAED,wBAAsB,gCAAgC,CACpD,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,iBAwGjB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,GAAG,EACb,iBAAiB,EAAE,GAAG,CACpB,MAAM,EACN;IAAE,WAAW,EAAE,2BAA2B,EAAE,CAAA;CAAE,EAAE,CACjD,QA+BF;AAGD,wBAAgB,wBAAwB,CACtC,WAAW,EAAE,oBAAoB,EACjC,MAAM,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,QAavC;AAED;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAC/C,mBAAmB,EAAE,MAAM,EAC3B,QAAQ,EAAE,MAAM,EAChB,cAAc,GAAE,OAAe,GAC9B,GAAG,CAAC,MAAM,EAAE;IAAE,WAAW,EAAE,2BAA2B,EAAE,CAAA;CAAE,EAAE,CAAC,CA4C/D;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAO7E;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,gCAAgC,CACpD,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,6CAoClB"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/reporter/util.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,2BAA2B,EAC3B,qBAAqB,EACtB,MAAM,6CAA6C,CAAC;AACrD,OAAO,EACL,cAAc,EAGd,UAAU,IAAI,oBAAoB,EAElC,QAAQ,EACT,MAAM,2BAA2B,CAAC;AAmBnC,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAmB7D;AAED,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,GAAG,SAAS,UAMhC;AAED,wBAAsB,0BAA0B,CAC9C,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAO,GAC5E,OAAO,CAAC;IACT,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC,CAyCD;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,QAAQ;;;EAwBrD;AAED,wBAAsB,6BAA6B,CACjD,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,IAAI,CAAC,CAyDf;AAED,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,GAAG,EACR,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,GACnC,GAAG,CAIL;AAED,wBAAsB,gCAAgC,CACpD,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,iBAuGjB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,GAAG,EACb,iBAAiB,EAAE,GAAG,CACpB,MAAM,EACN;IAAE,WAAW,EAAE,2BAA2B,EAAE,CAAA;CAAE,EAAE,CACjD,QA+BF;AAGD,wBAAgB,wBAAwB,CACtC,WAAW,EAAE,oBAAoB,EACjC,MAAM,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,QAavC;AAED;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAC/C,mBAAmB,EAAE,MAAM,EAC3B,QAAQ,EAAE,MAAM,EAChB,cAAc,GAAE,OAAe,GAC9B,GAAG,CAAC,MAAM,EAAE;IAAE,WAAW,EAAE,2BAA2B,EAAE,CAAA;CAAE,EAAE,CAAC,CA4C/D;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAO7E;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,gCAAgC,CACpD,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,6CAoClB"}

package/dist/reporter/util.js

@@ -15,7 +15,7 @@ exports.traverseJsonReportSuites = traverseJsonReportSuites;
 exports.buildTestAttachmentMapFromSummary = buildTestAttachmentMapFromSummary;
 exports.checkFileExistsAsync = checkFileExistsAsync;
 exports.updateSummaryJsonAttachmentPaths = updateSummaryJsonAttachmentPaths;
-const adm_zip_1 = __importDefault(require("adm-zip"));
+const zip_1 = require("@empiricalrun/r2-uploader/zip");
 const async_retry_1 = __importDefault(require("async-retry"));
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
@@ -181,7 +181,7 @@ async function updateHtmlZipFileAttachmentPaths(jsonFilePath, htmlFilePath, repo
     const zipPath = path_1.default.join(tempDir, "archive.zip");
     try {
         await fs_1.default.promises.writeFile(zipPath, Buffer.from(base64, "base64"));
-        new adm_zip_1.default(zipPath).extractAllTo(tempDir, true);
+        await (0, zip_1.extractZipToDirectory)(zipPath, tempDir);
         await fs_1.default.promises.unlink(zipPath);
     }
     catch (err) {
@@ -205,9 +205,8 @@ async function updateHtmlZipFileAttachmentPaths(jsonFilePath, htmlFilePath, repo
                 console.error(`❌ Error processing test file ${file}:`, err);
             }
         }
-        const newZip = new adm_zip_1.default();
-        newZip.addLocalFolder(tempDir);
-        const newBase64 = newZip.toBuffer().toString("base64");
+        const newBuffer = await (0, zip_1.createZipFromDirectory)(tempDir);
+        const newBase64 = newBuffer.toString("base64");
         let updatedHtml;
         if (oldFormatMatch) {
             // Old format (1.53.x): window.playwrightReportBase64 = "..."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.35.0",
+  "version": "0.36.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -29,7 +29,6 @@
     "@types/console-log-level": "^1.4.5",
     "@types/node": "^20.14.9",
     "@types/serve-handler": "^6.1.4",
-    "@types/adm-zip": "^0.5.7",
     "@types/pg": "^8.11.6",
     "playwright-core": "1.53.2",
     "serve-handler": "^6.1.6",
@@ -38,15 +37,14 @@
   "dependencies": {
     "@babel/code-frame": "^7.24.7",
     "pg": "^8.13.1",
-    "adm-zip": "^0.5.16",
     "async-retry": "^1.3.3",
     "authenticator": "^1.1.5",
     "console-log-level": "^1.4.1",
     "puppeteer-extra-plugin-recaptcha": "^3.6.8",
     "rimraf": "^6.0.1",
     "@empiricalrun/llm": "^0.25.1",
-    "@empiricalrun/r2-uploader": "^0.6.0",
-    "@empiricalrun/test-gen": "^0.78.4"
+    "@empiricalrun/r2-uploader": "^0.7.0",
+    "@empiricalrun/test-gen": "^0.78.5"
   },
   "scripts": {
     "dev": "tsc --build --watch",