@chromatic-com/cypress 0.12.5 → 0.12.7

package/dist/index.js

@@ -5,6 +5,7 @@ var path2 = require('path');
 var fs = require('fs');
 var promises = require('fs/promises');
 var crypto = require('crypto');
+var csf = require('storybook/internal/csf');
 var analyticsNode = require('@segment/analytics-node');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
@@ -3393,7 +3394,7 @@ var logger = process.env.LOG ? console : {
 
 // ../shared/src/resource-archiver/index.ts
 var _ResourceArchiver = class _ResourceArchiver {
-  constructor(cdpClient, allowedDomains, httpCredentials) {
+  constructor(cdpClient, allowedDomains, httpCredentials, firstUrl) {
     __publicField(this, "archive", {});
     __publicField(this, "client");
     /**
@@ -3467,6 +3468,7 @@ var _ResourceArchiver = class _ResourceArchiver {
     }, "requestPaused"));
     this.client = cdpClient;
     this.httpCredentials = httpCredentials;
+    this.firstUrl = firstUrl;
     this.assetDomains = (allowedDomains || []).map((domain) => {
       if (domain.startsWith("http")) {
         return domain;
@@ -3526,12 +3528,25 @@ var _ResourceArchiver = class _ResourceArchiver {
     const contentTypeHeader = responseHeaders.find(({ name }) => name.toLowerCase() === "content-type");
     const isFirstRequest = requestUrl.toString() === this.firstUrl.toString();
     if (isRequestFromAllowedDomain && !isFirstRequest) {
+      logger.log("Archiving request", {
+        url: request.url,
+        statusCode: responseStatusCode,
+        statusText: responseStatusText,
+        contentType: contentTypeHeader?.value
+      });
       this.archive[request.url] = {
         statusCode: responseStatusCode,
         statusText: responseStatusText,
         body: Buffer.from(body, base64Encoded ? "base64" : "utf8"),
         contentType: contentTypeHeader?.value
       };
+    } else {
+      logger.log("Skipping archiving of request", {
+        url: request.url,
+        firstUrl: this.firstUrl.toString(),
+        isFirstRequest,
+        isRequestFromAllowedDomain
+      });
     }
     await this.clientSend(request, "Fetch.continueRequest", {
       requestId
@@ -3794,8 +3809,7 @@ var _DOMSnapshot = class _DOMSnapshot {
         const currentSrc = this.mapSrcsetUrls(srcsetValue, sourceMap);
         if (currentSrc) {
           node.attributes.src = currentSrc;
-          delete node.attributes.srcset;
-          delete node.attributes.sizes;
+          this.removeResponsiveImageAttributes(node.attributes);
         }
       }
       if (node.tagName === "picture") {
@@ -3820,6 +3834,7 @@ var _DOMSnapshot = class _DOMSnapshot {
       const imageElement = node.childNodes.find((childNode) => childNode.type === NodeType.Element && childNode.tagName === "img");
       if (imageElement && imageElement.attributes) {
         imageElement.attributes.src = sourceMap.get(matchingUrl);
+        this.removeResponsiveImageAttributes(imageElement.attributes);
       }
     }
   }
@@ -3854,6 +3869,10 @@ var _DOMSnapshot = class _DOMSnapshot {
     });
     return currentSrc;
   }
+  removeResponsiveImageAttributes(attributes) {
+    delete attributes.srcset;
+    delete attributes.sizes;
+  }
 };
 __name(_DOMSnapshot, "DOMSnapshot");
 var DOMSnapshot = _DOMSnapshot;
@@ -3868,6 +3887,7 @@ __name(viewportToString, "viewportToString");
 var sanitize = /* @__PURE__ */ __name((string) => {
   return string.toLowerCase().replace(/[ ’–—―′¿'`~!@#$%^&*()_|+\-=?;:'",.<>\{\}\[\]\\\/]/gi, "-").replace(/[\r\n]/g, "-").replace(/-+/g, "-").replace(/^-+/, "").replace(/-+$/, "");
 }, "sanitize");
+var collapseNewlines = /* @__PURE__ */ __name((title) => title.replace(/[\r\n]+/g, " ").trim(), "collapseNewlines");
 
 // ../shared/src/write-archive/snapshot-files.ts
 var SNAPSHOT_FILE_EXT = "snapshot.json";
@@ -3886,49 +3906,60 @@ function snapshotFileName(snapshotId2, viewport) {
   return fileNameParts.join(".");
 }
 __name(snapshotFileName, "snapshotFileName");
-
-// ../shared/src/write-archive/stories-files.ts
 var STORIES_FILE_EXT = "stories.json";
+var uniqueId = {
+  value: 1
+};
 function storiesFileName(testTitle) {
   const fileName = [
-    sanitize(testTitle),
+    sanitize(testTitle) + "-" + uniqueId.value++,
     STORIES_FILE_EXT
   ].join(".");
   const maxByteLength = MAX_FILE_NAME_BYTE_LENGTH - 25;
   return truncateFileName(fileName, maxByteLength);
 }
 __name(storiesFileName, "storiesFileName");
-function createStories(title, domSnapshots, chromaticStorybookParams) {
+function createStories(storyTitle, domSnapshots, chromaticStorybookParams) {
+  const title = collapseNewlines(storyTitle);
   return {
     title,
-    stories: Object.entries(domSnapshots).map(([name, { viewport }]) => ({
-      name,
-      // Viewport addon (Storybook 10+): `parameters.viewport.options` registers sizes; `globals.viewport`
-      // selects the active one. See https://storybook.js.org/docs/essentials/viewport#defining-the-viewport-for-a-story
-      // `defaultViewport` is not read by SB 10's types but our archive preview uses it as a fetch fallback.
-      globals: {
-        viewport: viewportToString(viewport)
-      },
-      parameters: {
-        server: {
-          id: snapshotId(title, name)
-        },
-        chromatic: {
-          ...chromaticStorybookParams,
-          modes: buildStoryModesConfig([
-            viewport
-          ])
+    stories: Object.entries(domSnapshots).map(([snapshotName, { viewport, parameters }]) => {
+      const name = collapseNewlines(snapshotName);
+      const { chromatic: chromaticParams, ...restParameters } = parameters || {};
+      return {
+        name,
+        // Viewport addon (Storybook 10+): `parameters.viewport.options` registers sizes; `globals.viewport`
+        // selects the active one. See https://storybook.js.org/docs/essentials/viewport#defining-the-viewport-for-a-story
+        // `defaultViewport` is not read by SB 10's types but our archive preview uses it as a fetch fallback.
+        globals: {
+          viewport: viewportToString(viewport)
         },
-        viewport: {
-          options: buildStoryViewportsConfig([
-            viewport
-          ]),
-          defaultViewport: viewportToString(findDefaultViewport([
-            viewport
-          ]))
+        parameters: {
+          // Work-around for cases where "あ" in story name would cause Storybook to fail to load the story due to an invalid story ID.
+          // See https://github.com/chromaui/chromatic-e2e/issues/365
+          __id: csf.toId(title, csf.storyNameFromExport(name)),
+          server: {
+            id: snapshotId(title, name)
+          },
+          chromatic: {
+            ...chromaticStorybookParams,
+            ...chromaticParams,
+            modes: buildStoryModesConfig([
+              viewport
+            ])
+          },
+          viewport: {
+            options: buildStoryViewportsConfig([
+              viewport
+            ]),
+            defaultViewport: viewportToString(findDefaultViewport([
+              viewport
+            ]))
+          },
+          ...restParameters
         }
-      }
-    }))
+      };
+    })
   };
 }
 __name(createStories, "createStories");
@@ -4003,10 +4034,13 @@ async function writeTestResult(e2eTestInfo, domSnapshots, archive, chromaticStor
     const archiveFile = new ArchiveFile(url, response, pageUrl);
     const origSrcPath = archiveFile.originalSrc();
     const fileSystemPath = archiveFile.toFileSystemPath();
+    const responsePath = path2.join(archiveDir, fileSystemPath);
     if (origSrcPath !== fileSystemPath) {
       sourceMap.set(origSrcPath, fileSystemPath);
     }
-    await outputFile(path2.join(archiveDir, fileSystemPath), response.body);
+    if (!fs.existsSync(responsePath)) {
+      await outputFile(responsePath, response.body);
+    }
   }));
   await Promise.all(Object.entries(domSnapshots).map(async ([name, domSnapshot]) => {
     const snapshot = new DOMSnapshot(domSnapshot);

package/dist/index.mjs

@@ -3,6 +3,7 @@ import path2, { join } from 'path';
 import { existsSync, mkdirSync } from 'fs';
 import { writeFile } from 'fs/promises';
 import { createHash } from 'crypto';
+import { toId, storyNameFromExport } from 'storybook/internal/csf';
 import { Analytics } from '@segment/analytics-node';
 
 var __create = Object.create;
@@ -3386,7 +3387,7 @@ var logger = process.env.LOG ? console : {
 
 // ../shared/src/resource-archiver/index.ts
 var _ResourceArchiver = class _ResourceArchiver {
-  constructor(cdpClient, allowedDomains, httpCredentials) {
+  constructor(cdpClient, allowedDomains, httpCredentials, firstUrl) {
     __publicField(this, "archive", {});
     __publicField(this, "client");
     /**
@@ -3460,6 +3461,7 @@ var _ResourceArchiver = class _ResourceArchiver {
     }, "requestPaused"));
     this.client = cdpClient;
     this.httpCredentials = httpCredentials;
+    this.firstUrl = firstUrl;
     this.assetDomains = (allowedDomains || []).map((domain) => {
       if (domain.startsWith("http")) {
         return domain;
@@ -3519,12 +3521,25 @@ var _ResourceArchiver = class _ResourceArchiver {
     const contentTypeHeader = responseHeaders.find(({ name }) => name.toLowerCase() === "content-type");
     const isFirstRequest = requestUrl.toString() === this.firstUrl.toString();
     if (isRequestFromAllowedDomain && !isFirstRequest) {
+      logger.log("Archiving request", {
+        url: request.url,
+        statusCode: responseStatusCode,
+        statusText: responseStatusText,
+        contentType: contentTypeHeader?.value
+      });
       this.archive[request.url] = {
         statusCode: responseStatusCode,
         statusText: responseStatusText,
         body: Buffer.from(body, base64Encoded ? "base64" : "utf8"),
         contentType: contentTypeHeader?.value
       };
+    } else {
+      logger.log("Skipping archiving of request", {
+        url: request.url,
+        firstUrl: this.firstUrl.toString(),
+        isFirstRequest,
+        isRequestFromAllowedDomain
+      });
     }
     await this.clientSend(request, "Fetch.continueRequest", {
       requestId
@@ -3787,8 +3802,7 @@ var _DOMSnapshot = class _DOMSnapshot {
         const currentSrc = this.mapSrcsetUrls(srcsetValue, sourceMap);
         if (currentSrc) {
           node.attributes.src = currentSrc;
-          delete node.attributes.srcset;
-          delete node.attributes.sizes;
+          this.removeResponsiveImageAttributes(node.attributes);
         }
       }
       if (node.tagName === "picture") {
@@ -3813,6 +3827,7 @@ var _DOMSnapshot = class _DOMSnapshot {
       const imageElement = node.childNodes.find((childNode) => childNode.type === NodeType.Element && childNode.tagName === "img");
       if (imageElement && imageElement.attributes) {
         imageElement.attributes.src = sourceMap.get(matchingUrl);
+        this.removeResponsiveImageAttributes(imageElement.attributes);
       }
     }
   }
@@ -3847,6 +3862,10 @@ var _DOMSnapshot = class _DOMSnapshot {
     });
     return currentSrc;
   }
+  removeResponsiveImageAttributes(attributes) {
+    delete attributes.srcset;
+    delete attributes.sizes;
+  }
 };
 __name(_DOMSnapshot, "DOMSnapshot");
 var DOMSnapshot = _DOMSnapshot;
@@ -3861,6 +3880,7 @@ __name(viewportToString, "viewportToString");
 var sanitize = /* @__PURE__ */ __name((string) => {
   return string.toLowerCase().replace(/[ ’–—―′¿'`~!@#$%^&*()_|+\-=?;:'",.<>\{\}\[\]\\\/]/gi, "-").replace(/[\r\n]/g, "-").replace(/-+/g, "-").replace(/^-+/, "").replace(/-+$/, "");
 }, "sanitize");
+var collapseNewlines = /* @__PURE__ */ __name((title) => title.replace(/[\r\n]+/g, " ").trim(), "collapseNewlines");
 
 // ../shared/src/write-archive/snapshot-files.ts
 var SNAPSHOT_FILE_EXT = "snapshot.json";
@@ -3879,49 +3899,60 @@ function snapshotFileName(snapshotId2, viewport) {
   return fileNameParts.join(".");
 }
 __name(snapshotFileName, "snapshotFileName");
-
-// ../shared/src/write-archive/stories-files.ts
 var STORIES_FILE_EXT = "stories.json";
+var uniqueId = {
+  value: 1
+};
 function storiesFileName(testTitle) {
   const fileName = [
-    sanitize(testTitle),
+    sanitize(testTitle) + "-" + uniqueId.value++,
     STORIES_FILE_EXT
   ].join(".");
   const maxByteLength = MAX_FILE_NAME_BYTE_LENGTH - 25;
   return truncateFileName(fileName, maxByteLength);
 }
 __name(storiesFileName, "storiesFileName");
-function createStories(title, domSnapshots, chromaticStorybookParams) {
+function createStories(storyTitle, domSnapshots, chromaticStorybookParams) {
+  const title = collapseNewlines(storyTitle);
   return {
     title,
-    stories: Object.entries(domSnapshots).map(([name, { viewport }]) => ({
-      name,
-      // Viewport addon (Storybook 10+): `parameters.viewport.options` registers sizes; `globals.viewport`
-      // selects the active one. See https://storybook.js.org/docs/essentials/viewport#defining-the-viewport-for-a-story
-      // `defaultViewport` is not read by SB 10's types but our archive preview uses it as a fetch fallback.
-      globals: {
-        viewport: viewportToString(viewport)
-      },
-      parameters: {
-        server: {
-          id: snapshotId(title, name)
-        },
-        chromatic: {
-          ...chromaticStorybookParams,
-          modes: buildStoryModesConfig([
-            viewport
-          ])
+    stories: Object.entries(domSnapshots).map(([snapshotName, { viewport, parameters }]) => {
+      const name = collapseNewlines(snapshotName);
+      const { chromatic: chromaticParams, ...restParameters } = parameters || {};
+      return {
+        name,
+        // Viewport addon (Storybook 10+): `parameters.viewport.options` registers sizes; `globals.viewport`
+        // selects the active one. See https://storybook.js.org/docs/essentials/viewport#defining-the-viewport-for-a-story
+        // `defaultViewport` is not read by SB 10's types but our archive preview uses it as a fetch fallback.
+        globals: {
+          viewport: viewportToString(viewport)
         },
-        viewport: {
-          options: buildStoryViewportsConfig([
-            viewport
-          ]),
-          defaultViewport: viewportToString(findDefaultViewport([
-            viewport
-          ]))
+        parameters: {
+          // Work-around for cases where "あ" in story name would cause Storybook to fail to load the story due to an invalid story ID.
+          // See https://github.com/chromaui/chromatic-e2e/issues/365
+          __id: toId(title, storyNameFromExport(name)),
+          server: {
+            id: snapshotId(title, name)
+          },
+          chromatic: {
+            ...chromaticStorybookParams,
+            ...chromaticParams,
+            modes: buildStoryModesConfig([
+              viewport
+            ])
+          },
+          viewport: {
+            options: buildStoryViewportsConfig([
+              viewport
+            ]),
+            defaultViewport: viewportToString(findDefaultViewport([
+              viewport
+            ]))
+          },
+          ...restParameters
         }
-      }
-    }))
+      };
+    })
   };
 }
 __name(createStories, "createStories");
@@ -3996,10 +4027,13 @@ async function writeTestResult(e2eTestInfo, domSnapshots, archive, chromaticStor
     const archiveFile = new ArchiveFile(url, response, pageUrl);
     const origSrcPath = archiveFile.originalSrc();
     const fileSystemPath = archiveFile.toFileSystemPath();
+    const responsePath = join(archiveDir, fileSystemPath);
     if (origSrcPath !== fileSystemPath) {
       sourceMap.set(origSrcPath, fileSystemPath);
     }
-    await outputFile(join(archiveDir, fileSystemPath), response.body);
+    if (!existsSync(responsePath)) {
+      await outputFile(responsePath, response.body);
+    }
   }));
   await Promise.all(Object.entries(domSnapshots).map(async ([name, domSnapshot]) => {
     const snapshot = new DOMSnapshot(domSnapshot);

package/dist/storybook-config/main.d.mts

@@ -12,6 +12,9 @@ declare const _default: {
         renderer: string;
     };
     staticDirs: string[];
+    features: {
+        sidebarOnboardingChecklist: boolean;
+    };
 };
 
 export { _default as default };

package/dist/storybook-config/main.mjs

@@ -47,7 +47,10 @@ var main_default = {
   },
   staticDirs: [
     path2.resolve(archivesDir(DEFAULT_OUTPUT_DIR), "archive")
-  ]
+  ],
+  features: {
+    sidebarOnboardingChecklist: false
+  }
 };
 
 export { main_default as default };

package/dist/storybook-config/manager.mjs

@@ -3,7 +3,13 @@ import { addons } from 'storybook/manager-api';
 // ../shared/storybook-config/manager.ts
 addons.setConfig({
   sidebar: {
-    // this ensures we use folders at the root-level instead of categories
+    // Ensures we use folders at the root-level instead of categories
     showRoots: false
+  },
+  layoutCustomisations: {
+    // Hide toolbar options that don't make sense in e2e setup
+    showToolbar: () => false,
+    // Hide bottom panel that's empty in e2e setup
+    showPanel: () => false
   }
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chromatic-com/cypress",
-  "version": "0.12.5",
+  "version": "0.12.7",
   "description": "Chromatic Visual Regression Testing for Cypress",
   "repository": {
     "type": "git",