happo 6.5.1 → 6.6.0

package/dist/cypress/task.js

@@ -19,7 +19,7 @@ import asyncRetry from "async-retry";
 // package.json
 var package_default = {
   name: "happo",
-  version: "6.5.1",
+  version: "6.6.0",
   description: "Catch unexpected visual and accessibility changes and UI bugs",
   license: "MIT",
   repository: {
@@ -80,10 +80,10 @@ var package_default = {
     all: "node ./scripts/allchecks.ts",
     build: "pnpm build:types && pnpm build:dist",
     "build:custom": "esbuild src/custom/__happo__/index.ts --bundle --format=iife --global-name=happoCustom --outfile=tmp/happo-custom/bundle.js --platform=browser --target=esnext",
-    "build:dist": "./scripts/build.ts",
+    "build:dist": "node ./scripts/build.ts",
     "build:types": "pnpm tsc --pretty",
     "build:watch": "tsc --build --watch",
-    clean: "rm -rf dist tmp/tsc tmp/happo-custom",
+    clean: "node ./scripts/clean.ts",
     lint: "eslint .",
     prepublishOnly: "pnpm clean && pnpm build",
     "storybook:dev": "storybook dev --config-dir src/storybook/__tests__/storybook-app -p ${PORT:-6007}",
@@ -143,7 +143,7 @@ var package_default = {
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-unicorn": "^63.0.0",
     jiti: "^2.6.1",
-    jsdom: "^28.0.0",
+    jsdom: "^29.0.0",
     multiparty: "^4.2.3",
     prettier: "^3.6.2",
     react: "^19.2.0",
@@ -655,12 +655,42 @@ async function loadConfigFile(configFilePath, environment, logger = console) {
   return configWithDefaults;
 }
 
-// src/network/makeHappoAPIRequest.ts
+// src/network/getSignedToken.ts
 import { SignJWT } from "jose";
-async function signRequest(apiKey, apiSecret) {
-  const encodedSecret = new TextEncoder().encode(apiSecret);
-  return await new SignJWT({ key: apiKey }).setProtectedHeader({ alg: "HS256", kid: apiKey }).sign(encodedSecret);
+var TOKEN_TTL_SECONDS = 5 * 60;
+var TOKEN_REFRESH_BUFFER_SECONDS = 30;
+var cache = /* @__PURE__ */ new Map();
+function getCacheKey(apiKey, apiSecret) {
+  return `${apiKey}:${apiSecret}`;
 }
+async function getSignedToken(apiKey, apiSecret) {
+  const cacheKey = getCacheKey(apiKey, apiSecret);
+  const cachedPromise = cache.get(cacheKey);
+  if (cachedPromise) {
+    const cached = await cachedPromise;
+    const nowSeconds = Date.now() / 1e3;
+    if (cached.expiresAt - nowSeconds > TOKEN_REFRESH_BUFFER_SECONDS) {
+      return cached.token;
+    }
+  }
+  const signingPromise = (async () => {
+    const nowSeconds = Date.now() / 1e3;
+    const expiresAt = Math.floor(nowSeconds) + TOKEN_TTL_SECONDS;
+    const encodedSecret = new TextEncoder().encode(apiSecret);
+    const token = await new SignJWT({ key: apiKey }).setProtectedHeader({ alg: "HS256", kid: apiKey }).setExpirationTime(expiresAt).sign(encodedSecret);
+    return { token, expiresAt };
+  })();
+  cache.set(cacheKey, signingPromise);
+  try {
+    const { token } = await signingPromise;
+    return token;
+  } catch (error) {
+    cache.delete(cacheKey);
+    throw error;
+  }
+}
+
+// src/network/makeHappoAPIRequest.ts
 async function makeHappoAPIRequest({ url, path: path3, method = "GET", formData, body }, { apiKey, apiSecret, endpoint }, {
   retryCount = 0,
   timeout = 6e4,
@@ -673,7 +703,7 @@ async function makeHappoAPIRequest({ url, path: path3, method = "GET", formData,
       "No fetch URL provided. Either `path` (preferred) or `url` must be provided."
     );
   }
-  const signed = await signRequest(apiKey, apiSecret);
+  const signed = await getSignedToken(apiKey, apiSecret);
   const headers = {
     Authorization: `Bearer ${signed}`
   };
@@ -709,6 +739,7 @@ function createHash(data) {
 
 // src/config/RemoteBrowserTarget.ts
 var VIEWPORT_PATTERN = /^([0-9]+)x([0-9]+)$/;
+var MAX_BULK_ITEMS_PER_REQUEST = 50;
 function computeDefaultChunks(estimatedSnapCount) {
   if (!Number.isFinite(estimatedSnapCount) || estimatedSnapCount <= 0) {
     return 1;
@@ -729,6 +760,71 @@ function getPageSlices(pages, chunks) {
   }
   return result;
 }
+function buildChunkItem({
+  slice,
+  chunk,
+  pageSlice,
+  browserName,
+  viewport,
+  maxHeight,
+  otherOptions,
+  globalCSS,
+  staticPackage,
+  assetsPackage,
+  targetName
+}) {
+  const payloadString = JSON.stringify({
+    viewport,
+    maxHeight,
+    ...otherOptions,
+    globalCSS,
+    snapPayloads: slice,
+    chunk,
+    staticPackage,
+    assetsPackage,
+    pages: pageSlice,
+    extendsSha: pageSlice ? pageSlice.extendsSha : void 0
+  });
+  const payloadHash = createHash(payloadString + (pageSlice ? Math.random() : ""));
+  const type = pageSlice && pageSlice.extendsSha ? "extends-report" : `browser-${browserName}`;
+  const item = { type, targetName, payloadString, payloadHash };
+  if (pageSlice?.extendsSha) {
+    item.extendsSha = pageSlice.extendsSha;
+  }
+  return item;
+}
+async function sendIndividualSnapRequest(item, config) {
+  const formData = {
+    type: item.type,
+    targetName: item.targetName,
+    payloadHash: item.payloadHash,
+    payload: new File([item.payloadString], "payload.json", {
+      type: "application/json"
+    })
+  };
+  if (item.extendsSha) {
+    formData.extendsSha = item.extendsSha;
+  }
+  const requestResult = await makeHappoAPIRequest(
+    {
+      path: `/api/snap-requests?payloadHash=${item.payloadHash}`,
+      method: "POST",
+      formData
+    },
+    config,
+    { retryCount: 5 }
+  );
+  if (!requestResult) {
+    throw new Error("No requestResult");
+  }
+  if (!("requestId" in requestResult)) {
+    throw new Error("No requestId in requestResult");
+  }
+  if (typeof requestResult.requestId !== "number") {
+    throw new TypeError("requestId is not a number");
+  }
+  return requestResult.requestId;
+}
 var RemoteBrowserTarget = class {
   chunks;
   browserName;
@@ -767,73 +863,30 @@ var RemoteBrowserTarget = class {
     targetName,
     estimatedSnapsCount
   }, config) {
-    const boundMakeRequest = async ({
-      slice,
-      chunk,
-      pageSlice
-    }) => {
-      const payloadString = JSON.stringify({
-        viewport: this.viewport,
-        maxHeight: this.maxHeight,
-        ...this.otherOptions,
-        globalCSS,
-        snapPayloads: slice,
-        chunk,
-        staticPackage,
-        assetsPackage,
-        pages: pageSlice,
-        extendsSha: pageSlice ? pageSlice.extendsSha : void 0
-      });
-      const payloadHash = createHash(
-        payloadString + (pageSlice ? Math.random() : "")
-      );
-      const formData = {
-        type: pageSlice && pageSlice.extendsSha ? "extends-report" : `browser-${this.browserName}`,
-        targetName,
-        payloadHash,
-        payload: new File([payloadString], "payload.json", {
-          type: "application/json"
-        })
-      };
-      if (pageSlice && pageSlice.extendsSha) {
-        formData.extendsSha = pageSlice.extendsSha;
-      }
-      const requestResult = await makeHappoAPIRequest(
-        {
-          path: `/api/snap-requests?payloadHash=${payloadHash}`,
-          method: "POST",
-          json: true,
-          formData
-        },
-        config,
-        { retryCount: 5 }
-      );
-      if (!requestResult) {
-        throw new Error("No requestResult");
-      }
-      if (!("requestId" in requestResult)) {
-        throw new Error("No requestId in requestResult");
-      }
-      if (typeof requestResult.requestId !== "number") {
-        throw new TypeError("requestId is not a number");
-      }
-      return requestResult.requestId;
+    const buildItemParams = {
+      browserName: this.browserName,
+      viewport: this.viewport,
+      maxHeight: this.maxHeight,
+      otherOptions: this.otherOptions,
+      globalCSS,
+      staticPackage,
+      assetsPackage,
+      targetName
     };
-    const requestIds = [];
+    const items = [];
     if (staticPackage) {
       const effectiveChunks = this.chunks ?? Math.max(1, computeDefaultChunks(estimatedSnapsCount ?? 0));
       for (let i = 0; i < effectiveChunks; i += 1) {
-        const requestId = await boundMakeRequest({
-          chunk: effectiveChunks > 1 ? { index: i, total: effectiveChunks } : void 0
-        });
-        requestIds.push(requestId);
+        items.push(
+          buildChunkItem({
+            ...buildItemParams,
+            chunk: effectiveChunks > 1 ? { index: i, total: effectiveChunks } : void 0
+          })
+        );
       }
     } else if (pages) {
       for (const pageSlice of getPageSlices(pages, this.chunks ?? 1)) {
-        const requestId = await boundMakeRequest({
-          pageSlice
-        });
-        requestIds.push(requestId);
+        items.push(buildChunkItem({ ...buildItemParams, pageSlice }));
       }
     } else {
       const effectiveChunks = this.chunks ?? 1;
@@ -843,12 +896,63 @@ var RemoteBrowserTarget = class {
           i * snapsPerChunk,
           i * snapsPerChunk + snapsPerChunk
         );
-        const requestId = await boundMakeRequest({
-          slice
-        });
-        requestIds.push(requestId);
+        items.push(buildChunkItem({ ...buildItemParams, slice }));
       }
     }
+    if (items.length === 0) {
+      return [];
+    }
+    try {
+      const requestIds2 = Array.from({
+        length: items.length
+      });
+      for (let batchStart = 0; batchStart < items.length; batchStart += MAX_BULK_ITEMS_PER_REQUEST) {
+        const batch = items.slice(
+          batchStart,
+          batchStart + MAX_BULK_ITEMS_PER_REQUEST
+        );
+        const result = await makeHappoAPIRequest(
+          {
+            path: "/api/snap-requests/bulk",
+            method: "POST",
+            body: { items: batch }
+          },
+          config,
+          { retryCount: 5 }
+        );
+        if (result && "results" in result && Array.isArray(result.results) && result.results.length === batch.length) {
+          const bulkResults = result.results;
+          for (const [i, r] of bulkResults.entries()) {
+            requestIds2[batchStart + i] = typeof r.requestId === "number" ? r.requestId : void 0;
+          }
+        } else {
+          throw new Error(
+            "Bulk snap-requests endpoint returned an unexpected payload shape; aborting to avoid duplicate snap-requests."
+          );
+        }
+      }
+      for (const [i, item] of items.entries()) {
+        if (requestIds2[i] === void 0) {
+          requestIds2[i] = await sendIndividualSnapRequest(item, config);
+        }
+      }
+      return requestIds2.map((id, index) => {
+        if (id === void 0) {
+          throw new Error(
+            `Failed to obtain snap request ID for item at index ${index}`
+          );
+        }
+        return id;
+      });
+    } catch (error) {
+      if (!(error instanceof ErrorWithStatusCode && (error.statusCode === 404 || error.statusCode === 501))) {
+        throw error;
+      }
+    }
+    const requestIds = [];
+    for (const item of items) {
+      requestIds.push(await sendIndividualSnapRequest(item, config));
+    }
     return requestIds;
   }
 };
@@ -868,8 +972,7 @@ async function uploadAssets(buffer, options, config) {
   const signedUrlRes = await makeHappoAPIRequest(
     {
       path: `/api/snap-requests/assets/${hash}/signed-url`,
-      method: "GET",
-      json: true
+      method: "GET"
     },
     config,
     { retryCount: 3 }
@@ -921,8 +1024,7 @@ async function uploadAssets(buffer, options, config) {
   const finalizeRes = await makeHappoAPIRequest(
     {
       path: `/api/snap-requests/assets/${hash}/signed-url/finalize`,
-      method: "POST",
-      json: true
+      method: "POST"
     },
     config,
     { retryCount: 3 }
@@ -988,6 +1090,9 @@ function validateArchive(totalBytes, entries) {
 }
 
 // src/utils/deterministicArchive.ts
+function normalizeEntryName(name) {
+  return name.replaceAll("\\", "/");
+}
 var FILE_CREATION_DATE = new Date(2019, 1, 8, 13, 31, 55);
 async function resolveFilesRecursiveForDir(dirOrFile) {
   const resolvedDirOrFile = path2.resolve(dirOrFile);
@@ -1001,7 +1106,7 @@ async function resolveFilesRecursiveForDir(dirOrFile) {
       if (fileType.isFile()) {
         const fullPath = `${fileType.parentPath}/${fileType.name}`;
         fileEntries.push({
-          name: path2.relative(resolvedDirOrFile, fullPath),
+          name: normalizeEntryName(path2.relative(resolvedDirOrFile, fullPath)),
           stream: fs3.createReadStream(fullPath)
         });
       }
@@ -1010,7 +1115,7 @@ async function resolveFilesRecursiveForDir(dirOrFile) {
   }
   return [
     {
-      name: path2.relative(process.cwd(), resolvedDirOrFile),
+      name: normalizeEntryName(path2.relative(process.cwd(), resolvedDirOrFile)),
       stream: fs3.createReadStream(resolvedDirOrFile)
     }
   ];
@@ -1062,11 +1167,12 @@ async function deterministicArchive(dirsAndFiles, contentToArchive = []) {
     }
   }
   for (const file of contentToArchiveSorted) {
-    if (!seenFiles.has(file.name)) {
+    const normalizedName = normalizeEntryName(file.name);
+    if (!seenFiles.has(normalizedName)) {
       const data = await contentToUint8Array(file.content);
-      entryDataList.push({ name: file.name, data });
-      entries.push({ name: file.name, size: data.length });
-      seenFiles.add(file.name);
+      entryDataList.push({ name: normalizedName, data });
+      entries.push({ name: normalizedName, size: data.length });
+      seenFiles.add(normalizedName);
     }
   }
   entryDataList.sort((a, b) => a.name < b.name ? -1 : a.name > b.name ? 1 : 0);
@@ -1589,8 +1695,7 @@ var Controller = class {
     const uploadUrlResult = await makeHappoAPIRequest(
       {
         path: `/api/images/${hash}/upload-url`,
-        method: "GET",
-        json: true
+        method: "GET"
       },
       this.happoConfig,
       { retryCount: 2 }
@@ -1616,7 +1721,6 @@ var Controller = class {
       {
         url: uploadUrl,
         method: "POST",
-        json: true,
         formData: {
           file: new File([buffer], "image.png", { type: "image/png" })
         }