@servicetitan/startup 36.4.0 → 37.0.1

package/src/jest/__tests__/resolver.test.ts

@@ -1,7 +1,14 @@
+import { checkResource } from '../../core/check-resource';
 import resolver from '../resolver';
 
+jest.mock('../../core/check-resource');
+
 describe('[startup] Jest resolver', () => {
-    const options: Partial<Parameters<typeof resolver>[1]> = { defaultResolver: jest.fn() };
+    const checker = jest.fn();
+    const options: Partial<Parameters<typeof resolver>[1]> = {
+        defaultResolver: jest.fn(),
+        basedir: '/node_modules/some-package/dist',
+    };
     let path: string;
     let queryParam: string | undefined;
 
@@ -9,6 +16,8 @@ describe('[startup] Jest resolver', () => {
         path = 'foo.svg';
         queryParam = undefined;
         jest.clearAllMocks();
+        jest.mocked(checkResource).mockReturnValue(checker as any);
+        checker.mockReturnValue(false);
     });
 
     const subject = () => resolver(`${path}${queryParam ?? ''}`, options as any);
@@ -38,4 +47,36 @@ describe('[startup] Jest resolver', () => {
 
         itCallsDefaultResolver();
     });
+
+    describe('when defaultResolver throws', () => {
+        const error = new Error("Cannot find module 'foo'");
+
+        beforeEach(() =>
+            jest.mocked(options.defaultResolver!).mockImplementation(() => {
+                throw error;
+            })
+        );
+
+        test('rethrows the error', () => {
+            expect(subject).toThrow(error);
+        });
+
+        describe('when checkResource returns "empty"', () => {
+            beforeEach(() => checker.mockReturnValue('empty'));
+
+            test('returns the empty module path', () => {
+                expect(subject()).toBe(
+                    require.resolve('../../webpack/configs/plugins/ignore-plugin/empty-module')
+                );
+            });
+        });
+
+        describe('when checkResource returns "throw"', () => {
+            beforeEach(() => checker.mockReturnValue('throw'));
+
+            test('rethrows the error', () => {
+                expect(subject).toThrow(error);
+            });
+        });
+    });
 });

package/src/jest/resolver.ts

@@ -1,9 +1,25 @@
 import type { SyncResolver } from 'jest-resolve';
+import { checkResource } from '../core/check-resource';
 import { SVG_PATH_REGEX } from '../utils/transform-svg';
 
+const EMPTY_MODULE_PATH = require.resolve('../webpack/configs/plugins/ignore-plugin/empty-module');
+
 const resolver: SyncResolver = (path, options) => {
     const { type, path: pathSansType } = SVG_PATH_REGEX.exec(path)?.groups ?? {};
-    return options.defaultResolver(type ? pathSansType : path, options);
+    const resolvedPath = type ? pathSansType : path;
+
+    try {
+        return options.defaultResolver(resolvedPath, options);
+    } catch (error) {
+        const mode = checkResource({ package: { dependencies: {} } })({
+            resource: resolvedPath,
+            importer: options.basedir ?? '',
+        });
+        if (mode === 'empty') {
+            return EMPTY_MODULE_PATH;
+        }
+        throw error;
+    }
 };
 
 export = resolver;

package/src/storybook-config/__tests__/vite-final.test.ts

@@ -0,0 +1,122 @@
+import type { InlineConfig } from 'vite';
+import { createCssConfig } from '../../vite/config/create-css-config';
+import { svgrPlugin } from '../../vite/plugins/svgr-plugin';
+import { viteFinal } from '../vite-final';
+
+jest.mock('../../vite/plugins/svgr-plugin', () => ({ svgrPlugin: jest.fn() }));
+
+describe(`[startup/storybook-config] ${viteFinal.name}`, () => {
+    const mockSvgrPlugin = { name: 'vite-plugin-svgr' } as any;
+    let config: InlineConfig;
+    let configType: 'DEVELOPMENT' | 'PRODUCTION' | undefined;
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        jest.mocked(svgrPlugin).mockReturnValue(mockSvgrPlugin);
+        config = {};
+        configType = undefined;
+    });
+
+    const subject = () => viteFinal(config, { configType });
+
+    test('adds svgr plugin', () => {
+        expect(subject()).toEqual(expect.objectContaining({ plugins: [mockSvgrPlugin] }));
+    });
+
+    test('dedupes react', () => {
+        expect(subject()).toEqual(
+            expect.objectContaining({ resolve: { dedupe: ['react', 'react-dom'] } })
+        );
+    });
+
+    test('pre-bundles react', () => {
+        expect(subject()).toEqual(
+            expect.objectContaining({
+                optimizeDeps: { include: ['react', 'react-dom', 'react/jsx-runtime'] },
+            })
+        );
+    });
+
+    describe.each([
+        ['DEVELOPMENT', false],
+        ['PRODUCTION', true],
+    ] as const)('when configType is %s', (type, isProduction) => {
+        const cssConfig = createCssConfig(isProduction);
+
+        beforeEach(() => (configType = type));
+
+        test('adds the css modules', () => {
+            const { modules } = cssConfig;
+
+            expect(subject()).toEqual(
+                expect.objectContaining({ css: expect.objectContaining({ modules }) })
+            );
+        });
+
+        test('adds the preprocessor options', () => {
+            const { preprocessorOptions } = cssConfig;
+
+            expect(subject()).toEqual(
+                expect.objectContaining({ css: expect.objectContaining({ preprocessorOptions }) })
+            );
+        });
+    });
+
+    describe('when config already contains css preprocessor options', () => {
+        const scssOptions = { quietDeps: true };
+
+        beforeEach(() => (config = { css: { preprocessorOptions: { scss: scssOptions } } }));
+
+        test('preserves existing preprocessor options', () => {
+            const { preprocessorOptions } = createCssConfig(false);
+
+            expect(subject()).toEqual(
+                expect.objectContaining({
+                    css: expect.objectContaining({
+                        preprocessorOptions: {
+                            ...config.css?.preprocessorOptions,
+                            ...preprocessorOptions,
+                        },
+                    }),
+                })
+            );
+        });
+    });
+
+    describe('when config already contains plugins', () => {
+        const existingPlugin = { name: 'existing' };
+
+        beforeEach(() => (config = { plugins: [existingPlugin] }));
+
+        test('preserves existing plugins', () => {
+            expect(subject()).toEqual(
+                expect.objectContaining({ plugins: [existingPlugin, mockSvgrPlugin] })
+            );
+        });
+    });
+
+    describe('when config already contains resolve.dedupe', () => {
+        beforeEach(() => (config = { resolve: { dedupe: ['lodash', 'react'] } }));
+
+        test('merges react without duplicating existing entries', () => {
+            expect((subject().resolve as { dedupe: string[] }).dedupe).toEqual([
+                'lodash',
+                'react',
+                'react-dom',
+            ]);
+        });
+    });
+
+    describe('when config already contains optimizeDeps.include', () => {
+        beforeEach(() => (config = { optimizeDeps: { include: ['lodash', 'react'] } }));
+
+        test('merges react without duplicating existing entries', () => {
+            expect((subject().optimizeDeps as { include: string[] }).include).toEqual([
+                'lodash',
+                'react',
+                'react-dom',
+                'react/jsx-runtime',
+            ]);
+        });
+    });
+});

package/src/storybook-config/index.ts

@@ -1,2 +1,3 @@
 export * from './swc';
+export * from './vite-final';
 export * from './webpack-final';

package/src/storybook-config/vite-final.ts

@@ -0,0 +1,65 @@
+import { inspect } from 'node:util';
+import type { InlineConfig } from 'vite';
+import { log } from '../utils';
+import { createCssConfig } from '../vite/config/create-css-config';
+import { svgrPlugin } from '../vite/plugins/svgr-plugin';
+import type { ViteBuildContext } from '../vite/types';
+
+interface ViteFinalOptions {
+    /*
+     * Storybook signals the build type through `configType`, not Vite's
+     * `config.mode` (which Storybook's Vite builder leaves unset).
+     */
+    configType?: 'DEVELOPMENT' | 'PRODUCTION';
+}
+
+/*
+ * Pre-bundle and dedupe React so the Storybook preview loads a single React
+ * instance. Storybook leaves this to Vite's automatic discovery, which can miss
+ * React in monorepos.
+ */
+const REACT_DEDUPE = ['react', 'react-dom'];
+const REACT_OPTIMIZE = [...REACT_DEDUPE, 'react/jsx-runtime'];
+
+export function viteFinal(
+    config: InlineConfig,
+    { configType }: ViteFinalOptions = {}
+): InlineConfig {
+    const isProduction = configType === 'PRODUCTION';
+    const css = createCssConfig(isProduction);
+    const plugins = [svgrPlugin(getContext())];
+
+    const merged: InlineConfig = {
+        ...config,
+        css: {
+            ...config.css,
+            modules: css.modules,
+            preprocessorOptions: {
+                ...config.css?.preprocessorOptions,
+                ...css.preprocessorOptions,
+            },
+        },
+        resolve: {
+            ...config.resolve,
+            dedupe: [...new Set([...(config.resolve?.dedupe ?? []), ...REACT_DEDUPE])],
+        },
+        optimizeDeps: {
+            ...config.optimizeDeps,
+            include: [...new Set([...(config.optimizeDeps?.include ?? []), ...REACT_OPTIMIZE])],
+        },
+        plugins: [...(config.plugins ?? []), ...plugins],
+    };
+
+    /* istanbul ignore next: debug only */
+    log.debug('storybook-config:vite-final', () => inspect({ merged }, { depth: null }));
+
+    return merged;
+}
+
+function getContext(): ViteBuildContext {
+    /*
+     * svgrPlugin only reads bundlerConfig.pluginOverrides, so a minimal context
+     * is enough to reuse it with startup's default SVG include patterns.
+     */
+    return { bundlerConfig: { pluginOverrides: {} } } as ViteBuildContext;
+}

package/src/utils/__tests__/get-configuration.test.ts

@@ -4,6 +4,7 @@ import {
     getConfiguration,
     getConfigurationSafe,
     getESLintConfiguration,
+    getExposeProcessEnv,
     getJestConfiguration,
     getReviewConfiguration,
     getStylelintConfiguration,
@@ -18,6 +19,7 @@ import {
     isLegacy,
     isLegacyRoot,
     isStyleCheckDisabled,
+    isViteDevServerDisabled,
     isWebComponent,
 } from '../get-configuration';
 import { log } from '../log';
@@ -225,6 +227,22 @@ describe('[startup] Utils', () => {
         });
     });
 
+    describe(getExposeProcessEnv.name, () => {
+        const subject = () => getExposeProcessEnv();
+
+        itReturns(subject, []);
+
+        describe('with "cli.expose-process-env"', () => {
+            const content = { cli: { 'expose-process-env': ['API_URL', 'FEATURE_FLAG'] } };
+
+            beforeEach(() => mockPackageJson(content));
+
+            test('returns "cli.expose-process-env"', () => {
+                expect(subject()).toEqual(content.cli['expose-process-env']);
+            });
+        });
+    });
+
     describe(getViteConfiguration.name, () => {
         const subject = () => getViteConfiguration();
 
@@ -412,16 +430,16 @@ describe('[startup] Utils', () => {
     });
 
     describe.each([
-        {
-            fn: isBundle,
-            defaultValue: true,
-            trigger: { cli: { webpack: false } },
-        },
         {
             fn: isDevServerDisabled,
             defaultValue: false,
             trigger: { cli: { webpack: { devServer: false } } },
         },
+        {
+            fn: isViteDevServerDisabled,
+            defaultValue: false,
+            trigger: { cli: { vite: { devServer: false } } },
+        },
         {
             fn: isExposeSharedDependencies,
             defaultValue: false,
@@ -486,4 +504,63 @@ describe('[startup] Utils', () => {
             });
         });
     });
+
+    describe(isBundle.name, () => {
+        let json: Record<string, any>;
+
+        beforeEach(() => {
+            json = { name: '{packageName}', cli: {} };
+            mockPackageJson(json);
+        });
+
+        const subject = () => isBundle();
+
+        itReturns(subject, true);
+
+        describe('when cli.webpack is false', () => {
+            beforeEach(() => {
+                json.cli.webpack = false;
+                mockPackageJson(json);
+            });
+
+            itReturns(subject, false);
+
+            describe('when cli.vite is truthy', () => {
+                beforeEach(() => {
+                    json.cli.vite = {};
+                    mockPackageJson(json);
+                });
+
+                test('throws error', () => {
+                    expect(subject).toThrow(
+                        `package ${json.name} has conflicting webpack and vite configurations: ` +
+                            `cli.webpack is false but cli.vite is not`
+                    );
+                });
+            });
+        });
+
+        describe('when cli.vite is false', () => {
+            beforeEach(() => {
+                json.cli.vite = false;
+                mockPackageJson(json);
+            });
+
+            itReturns(subject, false);
+
+            describe('when cli.webpack is truthy', () => {
+                beforeEach(() => {
+                    json.cli.webpack = {};
+                    mockPackageJson(json);
+                });
+
+                test('throws error', () => {
+                    expect(subject).toThrow(
+                        `package ${json.name} has conflicting webpack and vite configurations: ` +
+                            `cli.vite is false but cli.webpack is not`
+                    );
+                });
+            });
+        });
+    });
 });

package/src/utils/__tests__/get-package-name.test.ts

@@ -0,0 +1,57 @@
+import { fs, vol } from 'memfs';
+import { getPackageName } from '../get-package-name';
+import { LocationOrJson } from '../types';
+
+jest.mock('fs', () => fs);
+
+describe(getPackageName.name, () => {
+    let locationOrJson: LocationOrJson | undefined;
+
+    beforeEach(() => {
+        vol.reset();
+        locationOrJson = undefined;
+    });
+
+    const subject = () => getPackageName(locationOrJson);
+
+    describe('with a JSON object', () => {
+        beforeEach(() => (locationOrJson = { name: 'foo' }));
+
+        test('returns "name" property', () => {
+            expect(subject()).toBe((locationOrJson as Record<string, any>).name);
+        });
+    });
+
+    describe('when name is not present', () => {
+        beforeEach(() => (locationOrJson = {}));
+
+        test('returns empty string', () => {
+            expect(subject()).toBe('');
+        });
+    });
+
+    describe('with a location', () => {
+        const packageJson = { name: 'bar' };
+
+        beforeEach(() => {
+            locationOrJson = 'packages/foo';
+            vol.fromJSON({
+                [`${locationOrJson as string}/package.json`]: JSON.stringify(packageJson),
+            });
+        });
+
+        test('returns "name" from location\'s package.json', () => {
+            expect(subject()).toBe(packageJson.name);
+        });
+    });
+
+    describe('with no argument', () => {
+        const packageJson = { name: 'baz' };
+
+        beforeEach(() => vol.fromJSON({ 'package.json': JSON.stringify(packageJson) }));
+
+        test('returns "name" from current package.json', () => {
+            expect(subject()).toBe(packageJson.name);
+        });
+    });
+});

package/src/utils/__tests__/validate-shared-dependencies.test.ts

@@ -3,53 +3,68 @@ import { validateSharedDependencies } from '../validate-shared-dependencies';
 
 jest.mock('fs', () => fs);
 
-describe('validateSharedDependencies', () => {
-    function mockPackageJson(content: Record<string, any> = {}) {
-        vol.fromJSON({ 'package.json': JSON.stringify(content) });
-    }
+describe(`[startup] ${validateSharedDependencies.name}`, () => {
+    let cli: Record<string, any>;
 
+    beforeEach(() => (cli = {}));
     afterEach(() => vol.reset());
 
-    test('passes when neither is set', () => {
-        mockPackageJson();
-        expect(() => validateSharedDependencies()).not.toThrow();
-    });
+    const subject = () => {
+        vol.fromJSON({ 'package.json': JSON.stringify({ cli }) });
+        return validateSharedDependencies();
+    };
 
-    test('passes when only cli top level is set', () => {
-        mockPackageJson({ cli: { 'shared-dependencies': { defaults: '' } } });
-        expect(() => validateSharedDependencies()).not.toThrow();
-    });
+    function itDoesNotThrow() {
+        test('does not throw', () => {
+            expect(subject).not.toThrow();
+        });
+    }
 
-    test('passes when only cli.webpack is set', () => {
-        mockPackageJson({ cli: { webpack: { 'shared-dependencies': { defaults: '' } } } });
-        expect(() => validateSharedDependencies()).not.toThrow();
-    });
+    function itThrows(message: RegExp) {
+        test('throws', () => {
+            expect(subject).toThrow(message);
+        });
+    }
 
-    test('passes when both are set and identical', () => {
-        const deps = { defaults: '', lodash: 'SharedDependencies.Lodash' };
-        mockPackageJson({
-            cli: { 'shared-dependencies': deps, 'webpack': { 'shared-dependencies': deps } },
+    itDoesNotThrow();
+
+    describe('with conflicting {cli, cli.webpack}.shared-dependencies', () => {
+        beforeEach(() => {
+            cli['shared-dependencies'] = { defaults: '' };
+            cli.webpack = { 'shared-dependencies': { defaults: '', extra: 'foo' } };
         });
-        expect(() => validateSharedDependencies()).not.toThrow();
+
+        itThrows(/both set but differ/);
     });
 
-    test('throws when shared-dependencies both exist and differ', () => {
-        mockPackageJson({
-            cli: {
-                'shared-dependencies': { defaults: '' },
-                'webpack': { 'shared-dependencies': { defaults: '', extra: 'foo' } },
-            },
+    describe('with conflicting {cli, cli.webpack}.expose-shared-dependencies', () => {
+        beforeEach(() => {
+            cli['expose-shared-dependencies'] = true;
+            cli.webpack = { 'expose-shared-dependencies': false };
         });
-        expect(() => validateSharedDependencies()).toThrow(/both set but differ/);
+
+        itThrows(/both set but differ/);
     });
 
-    test('throws when expose-shared-dependencies both exist and differ', () => {
-        mockPackageJson({
-            cli: {
-                'expose-shared-dependencies': true,
-                'webpack': { 'expose-shared-dependencies': false },
-            },
+    describe('when configured as a web-component', () => {
+        beforeEach(() => (cli['web-component'] = true));
+
+        describe.each([
+            { cli: { 'expose-shared-dependencies': true } },
+            { cli: { webpack: { 'expose-shared-dependencies': true } } },
+        ])('with %o', config => {
+            beforeEach(() => Object.assign(cli, config.cli));
+
+            itThrows(/only applies to host applications/);
+        });
+
+        describe.each([
+            { cli: { 'expose-shared-dependencies': false } },
+            { cli: { webpack: { 'expose-shared-dependencies': false } } },
+        ])('with %o', config => {
+            beforeEach(() => Object.assign(cli, config.cli));
+
+            itDoesNotThrow();
         });
-        expect(() => validateSharedDependencies()).toThrow(/both set but differ/);
     });
 });