feat: add ability to disable storybook globals with null

Author: KuznetsovRoman

jest.config.js

@@ -1,8 +1,10 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
 module.exports = {
     clearMocks: true,
     globals: {
         "ts-jest": {
-            "tsconfig": "tsconfig.spec.json",
+            tsconfig: "tsconfig.spec.json",
+            isolatedModules: true,
         },
     },
     preset: "ts-jest",

src/storybook/story-test-runner/extend-stories.test.ts

@@ -39,7 +39,7 @@ describe("storybook/story-test-runner/extend-stories", () => {
         expect(extendedStories[0].browserIds).toBe(null);
     });
 
-    it("should overlay story configs / file confifs / default configs", () => {
+    it("should overlay story configs over file configs", () => {
         const customTests = {};
         const defaultExport = {
             testplane: { browserIds: ["firefox"] },
@@ -59,7 +59,7 @@ describe("storybook/story-test-runner/extend-stories", () => {
 
         const extendedStories = extendStoriesFromStoryFile(stories, { requireFn });
 
-        expect(extendedStories).toEqual([
+        expect(extendedStories).toMatchObject([
             {
                 name: "foo",
                 absolutePath: "not/existing.js",
@@ -72,12 +72,39 @@ describe("storybook/story-test-runner/extend-stories", () => {
                     ignoreDiffPixelCount: 10,
                 },
                 autoScreenshots: false,
-                autoscreenshotSelector: null,
                 autoScreenshotStorybookGlobals: { dark: { theme: "dark" } },
             },
         ]);
     });
 
+    it("should overlay story configs over default configs", () => {
+        const customTests = {};
+        const fooExport = {
+            testplane: customTests,
+            testplaneConfig: { skip: false, autoScreenshots: false, assertViewOpts: { ignoreElements: ["foobar"] } },
+        };
+        const requireFn = mkRequireStub_().mockReturnValue({ default: {}, foo: fooExport });
+        const stories = [{ name: "foo", absolutePath: "not/existing.js" }] as StorybookStory[];
+
+        const extendedStories = extendStoriesFromStoryFile(stories, { requireFn });
+
+        expect(extendedStories).toMatchObject([
+            {
+                name: "foo",
+                absolutePath: "not/existing.js",
+                extraTests: {},
+                skip: false,
+                browserIds: null,
+                assertViewOpts: {
+                    ignoreElements: ["foobar"],
+                },
+                autoScreenshots: false,
+                autoscreenshotSelector: null,
+                autoScreenshotStorybookGlobals: {},
+            },
+        ]);
+    });
+
     it("should fallback reading story configs from deprecated testplane property", () => {
         const stories = [{ name: "foo", absolutePath: "not/existing.js" }] as StorybookStory[];
         const requireFn = mkRequireStub_().mockReturnValue({ default: { testplane: { skip: true } }, foo: {} });

src/storybook/story-test-runner/index.ts

@@ -27,7 +27,10 @@ function createTestplaneTests(
             story.autoScreenshotStorybookGlobals,
             autoScreenshotStorybookGlobals,
         );
-        const screenshotGlobalSetNames = Object.keys(rawAutoScreenshotGlobalSets);
+
+        const screenshotGlobalSetNames = Object.keys(rawAutoScreenshotGlobalSets).filter(name =>
+            Boolean(rawAutoScreenshotGlobalSets[name]),
+        );
 
         const autoScreenshotGlobalSets = screenshotGlobalSetNames.length
             ? screenshotGlobalSetNames.map(name => ({ name, globals: rawAutoScreenshotGlobalSets[name] }))
@@ -41,7 +44,7 @@ function createTestplaneTests(
                     async function (ctx: TestFunctionExtendedCtx) {
                         ctx.expect = globalThis.expect;
 
-                        const result = await openStoryStep(ctx.browser, story, globals);
+                        const result = await openStoryStep(ctx.browser, story, globals as Record<string, unknown>);
                         const selector = story.autoscreenshotSelector || autoscreenshotSelector || result.rootSelector;
 
                         await autoScreenshotStep(ctx.browser, selector);

src/storybook/story-test-runner/inheritable-values.ts

@@ -1,6 +1,9 @@
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type Inheritable<T extends Record<any, any>> = T | ((baseValue: T) => T);
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const isFunc = (obj?: unknown): obj is (...args: any[]) => any => typeof obj === "function";
+
 // Acts like "Object.assign", but:
 // - Does not mutate arguments
 // - Supports functions (previousValue) => nextValue
@@ -22,13 +25,13 @@ export function inheritValue<T extends Record<any, any>>(
             resultValue = curValue;
         }
 
-        if (typeof prevValue !== "function" && typeof curValue !== "function") {
+        if (!isFunc(prevValue) && !isFunc(curValue)) {
             resultValue = Object.assign({}, prevValue, curValue);
-        } else if (typeof prevValue === "function" && typeof curValue === "function") {
+        } else if (isFunc(prevValue) && isFunc(curValue)) {
             resultValue = (baseValue: T) => curValue(prevValue(structuredClone(baseValue)));
-        } else if (typeof prevValue === "function" && typeof curValue !== "function") {
+        } else if (isFunc(prevValue) && !isFunc(curValue)) {
             resultValue = (baseValue: T) => Object.assign({}, prevValue(structuredClone(baseValue)), curValue);
-        } else if (typeof prevValue !== "function" && typeof curValue === "function") {
+        } else if (!isFunc(prevValue) && isFunc(curValue)) {
             resultValue = (baseValue: T) => curValue(structuredClone(Object.assign({}, baseValue, prevValue)));
         }
     }

src/storybook/story-test-runner/types.ts

@@ -3,7 +3,7 @@ import type { TestplaneTestFunction } from "../../types";
 import type { StorybookStoryExtended as StorybookStory } from "../get-stories";
 import type { Inheritable } from "./inheritable-values";
 
-export type AutoScreenshotStorybookGlobals = Record<string, Record<string, unknown>>;
+export type AutoScreenshotStorybookGlobals = Record<string, null | Record<string, unknown>>;
 
 export interface StorybookStoryExtraProperties {
     skip: boolean;