Merge pull request #1133 from chromaui/cody/cap-2599-turbosnap-exit-o…

…n-storybook-config-does-not-work-as-expected Bail on preview file changes
chromaui · Jan 3, 2025 · 43a9b94 · 43a9b94
2 parents 730a7aa + 300222f
commit 43a9b94
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 3 deletions.
diff --git a/node-src/lib/getDependentStoryFiles.test.ts b/node-src/lib/getDependentStoryFiles.test.ts
@@ -514,6 +514,33 @@ describe('getDependentStoryFiles', () => {
     );
   });
 
+  it('bails on changed preview.js file', async () => {
+    const changedFiles = ['src/foo.stories.js', 'path/to/storybook-config/preview.js'];
+    const modules = [
+      {
+        id: './path/to/storybook-config/preview.js',
+        name: './path/to/storybook-config/preview.js',
+        reasons: [{ moduleName: './path/to/storybook-config/generated-stories-entry.js' }],
+      },
+      {
+        id: CSF_GLOB,
+        name: CSF_GLOB,
+        reasons: [{ moduleName: './path/to/storybook-config/generated-stories-entry.js' }],
+      },
+    ];
+    const ctx = getContext({ configDir: 'path/to/storybook-config' });
+    const result = await getDependentStoryFiles(ctx, { modules }, statsPath, changedFiles);
+    expect(result).toBeUndefined();
+    expect(ctx.turboSnap.bailReason).toEqual({
+      changedStorybookFiles: ['path/to/storybook-config/preview.js'],
+    });
+    expect(ctx.log.warn).toHaveBeenCalledWith(
+      expect.stringContaining(
+        chalk`Found a Storybook config change in {bold path/to/storybook-config/preview.js}`
+      )
+    );
+  });
+
   it('bails on changed dependency of config file', async () => {
     const changedFiles = ['src/styles.js'];
     const modules = [

diff --git a/node-src/lib/getDependentStoryFiles.ts b/node-src/lib/getDependentStoryFiles.ts
@@ -142,8 +142,13 @@ export async function getDependentStoryFiles(
   const reasonsById = new Map<Module['id'], NormalizedName[]>();
   const csfGlobsByName = new Set<NormalizedName>();
 
+  const isStorybookFile = (name: string) =>
+    name && name.startsWith(`${storybookDirectory}/`) && !storiesEntryFiles.has(name);
+
   stats.modules
     .filter((module_) => isUserModule(module_))
+    // TODO: refactor this function
+    // eslint-disable-next-line complexity
     .map((module_) => {
       const normalizedName = normalize(module_.name);
       modulesByName.set(normalizedName, module_);
@@ -176,7 +181,10 @@ export async function getDependentStoryFiles(
         reasonsById.set(module_.id, normalizedReasons);
       }
 
-      if (reasonsById.get(module_.id)?.some((reason) => storiesEntryFiles.has(reason))) {
+      if (
+        !isStorybookFile(normalizedName) &&
+        reasonsById.get(module_.id)?.some((reason) => storiesEntryFiles.has(reason))
+      ) {
         csfGlobsByName.add(normalizedName);
       }
     });
@@ -203,8 +211,6 @@ export async function getDependentStoryFiles(
   }
 
   const isCsfGlob = (name: NormalizedName) => csfGlobsByName.has(name);
-  const isStorybookFile = (name: string) =>
-    name && name.startsWith(`${storybookDirectory}/`) && !storiesEntryFiles.has(name);
   const isStaticFile = (name: string) =>
     staticDirectories.some((directory) => name && name.startsWith(`${directory}/`));