@servicetitan/startup 34.3.0 → 35.1.0

package/src/cli/commands/utils/purge-cache.ts

@@ -0,0 +1,13 @@
+import { runCommandOutput } from '../../utils';
+
+const DEV_MFE_REGISTRY = 'https://verdaccio.st.dev';
+const DEFAULT_UNPKG_HOST = 'https://unpkg.servicetitan.com';
+const DEV_UNPKG_HOST = 'https://unpkg.st.dev';
+
+export function purgeCache(options: { packageName: string; registry?: string; tag: string }) {
+    const { packageName, registry, tag } = options;
+    const host = registry === DEV_MFE_REGISTRY ? DEV_UNPKG_HOST : DEFAULT_UNPKG_HOST;
+    runCommandOutput(
+        `npx startup mfe-purge-cache --host ${host} --package-name ${packageName} --tag ${tag}`
+    );
+}

package/src/cli/utils/cli-os.ts

@@ -74,7 +74,7 @@ export function runCommandOutput(
     const result = execSync(fullCommand, execSyncOptions).toString();
 
     if (!quiet) {
-        log.info('command finished', result);
+        log.info('command finished', result.trim());
     }
 
     return result;

package/src/cypress-config/__tests__/webpack-config.test.ts

@@ -0,0 +1,124 @@
+import { fs, vol } from 'memfs';
+import { getSwcOptions } from '../../cli/tasks';
+import { TSConfig } from '../../cli/utils';
+import { getBaseTsConfig } from '../../utils';
+import { Overrides, rulesConfig } from '../../webpack/configs';
+import { webpackConfig } from '../webpack-config';
+
+jest.mock('fs', () => fs);
+jest.mock('../../webpack/configs');
+jest.mock('../../cli/tasks');
+
+describe(`[startup/cypress-config] ${webpackConfig.name}`, () => {
+    const mockRules: any[] = [
+        { test: /\.css$/, use: ['css-loader'] },
+        { test: /\.module\.less$/, use: ['style-loader', 'less-loader'] },
+    ];
+    const mockSwcOptions: any = { jsc: 'foobar' };
+    const mockTsConfig = { compilerOptions: { target: 'es2020' } };
+    const mockFallbackTsConfig = { compilerOptions: { target: 'es2018' } };
+    const fallbackConfig = getBaseTsConfig();
+
+    let overrides: Overrides | undefined;
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        jest.mocked(rulesConfig).mockReturnValue({ rules: mockRules });
+        jest.mocked(getSwcOptions).mockReturnValue(mockSwcOptions);
+        vol.fromJSON({
+            'tsconfig.json': JSON.stringify(mockTsConfig),
+            [fallbackConfig]: JSON.stringify(mockFallbackTsConfig),
+        });
+        overrides = undefined;
+    });
+
+    afterEach(() => vol.reset());
+
+    const subject = () => webpackConfig(overrides);
+
+    test('gets rules with non-production context', () => {
+        subject();
+
+        expect(rulesConfig).toHaveBeenCalledWith(
+            expect.objectContaining({ isProduction: false }),
+            expect.anything()
+        );
+    });
+
+    test('includes all rules from rulesConfig', () => {
+        const result = subject();
+
+        for (const rule of mockRules) {
+            expect(result.module!.rules).toContainEqual(rule);
+        }
+    });
+
+    test('adds swc-loader rule for TypeScript files', () => {
+        const result = subject();
+
+        expect(result.module!.rules).toContainEqual(
+            expect.objectContaining({
+                test: /\.tsx?$/,
+                exclude: /node_modules/,
+                use: { loader: 'swc-loader', options: mockSwcOptions },
+            })
+        );
+    });
+
+    test('passes tsconfig content to getSwcOptions', () => {
+        subject();
+
+        const tsConfigArg = jest.mocked(getSwcOptions).mock.calls[0][0];
+        expect(tsConfigArg).toStrictEqual(new TSConfig('tsconfig.json'));
+    });
+
+    describe('when no tsconfig is found', () => {
+        beforeEach(() => fs.rmSync('tsconfig.json'));
+
+        test('gets default swc config from base.json', () => {
+            subject();
+
+            const tsConfigArg = jest.mocked(getSwcOptions).mock.calls[0][0];
+            expect(tsConfigArg).toStrictEqual(new TSConfig(fallbackConfig));
+        });
+    });
+
+    test('includes resolve extensions for TypeScript and JavaScript', () => {
+        expect(subject().resolve!.extensions).toEqual(['.ts', '.tsx', '.js', '.jsx']);
+    });
+
+    describe('with overrides', () => {
+        beforeEach(() => (overrides = { plugins: { MiniCssExtractPlugin: {} } }));
+
+        test('passes overrides through to rulesConfig', () => {
+            subject();
+
+            expect(rulesConfig).toHaveBeenCalledWith(expect.anything(), overrides);
+        });
+
+        describe('with configuration overrides', () => {
+            beforeEach(
+                () =>
+                    (overrides = {
+                        configuration: {
+                            devtool: 'eval-source-map',
+                            resolve: {
+                                alias: {
+                                    '@': '/src',
+                                },
+                            },
+                        },
+                    })
+            );
+
+            test('merges configuration overrides into result', () => {
+                const result = subject();
+
+                expect(result.devtool).toBe(overrides!.configuration!.devtool);
+                expect(result.resolve?.alias).toEqual(overrides!.configuration!.resolve!.alias);
+                expect(result.resolve?.extensions).toEqual(['.ts', '.tsx', '.js', '.jsx']);
+                expect(result.module?.rules).toBeDefined();
+            });
+        });
+    });
+});

package/src/cypress-config/index.ts

@@ -0,0 +1 @@
+export * from './webpack-config';

package/src/cypress-config/webpack-config.ts

@@ -0,0 +1,58 @@
+import { inspect } from 'node:util';
+import type { Configuration } from 'webpack';
+import merge from 'webpack-merge';
+import { getSwcOptions } from '../cli/tasks';
+import { TSConfig } from '../cli/utils';
+import { getTsConfigWithFallback, log } from '../utils';
+import { Context, Overrides, rulesConfig } from '../webpack/configs';
+
+export function webpackConfig(overrides?: Overrides): Configuration {
+    const context = getContext();
+    const rules = getRules(context, overrides ?? {});
+
+    /* istanbul ignore next: debug only */
+    log.debug('cypress-config:webpack-config', () => inspect({ rules }, { depth: null }));
+
+    const config: Configuration = {
+        module: {
+            rules,
+        },
+        resolve: {
+            extensions: ['.ts', '.tsx', '.js', '.jsx'],
+        },
+    };
+
+    return merge(config, overrides?.configuration ?? {});
+}
+
+function getContext(): Context {
+    return {
+        destination: '',
+        isProduction: false,
+        name: '',
+        packageData: {} as any,
+        sharedDependencies: {},
+        source: '',
+    };
+}
+
+function getRules(context: Context, overrides: Overrides) {
+    const { rules } = rulesConfig(context, overrides);
+
+    return [getSwcLoaderRule(), ...rules];
+}
+
+function getSwcLoaderRule() {
+    const tsConfig = new TSConfig(getTsConfigWithFallback());
+
+    const swcOptions = getSwcOptions(tsConfig);
+
+    return {
+        test: /\.tsx?$/,
+        exclude: /node_modules/,
+        use: {
+            loader: 'swc-loader',
+            options: swcOptions,
+        },
+    };
+}

package/src/storybook-config/__tests__/swc.test.ts

@@ -2,16 +2,19 @@ import { SwcOptions } from '@swc/cli';
 import { fs, vol } from 'memfs';
 import { getSwcOptions } from '../../cli/tasks';
 import { TSConfig } from '../../cli/utils';
+import { getBaseTsConfig } from '../../utils';
 import { swc } from '../swc';
 
 jest.mock('fs', () => fs);
 
 describe(`[startup/storybook-config] ${swc.name}`, () => {
+    const baseJsonPath = getBaseTsConfig();
     const config: SwcOptions = { env: { bugfixes: true } };
     let tsConfig: TSConfig;
 
     function setTsConfig(config: Record<string, any> = {}) {
         return vol.fromJSON({
+            [baseJsonPath]: JSON.stringify({ compilerOptions: { sourceMap: true } }),
             'tsconfig.json': JSON.stringify(config),
         });
     }
@@ -34,4 +37,12 @@ describe(`[startup/storybook-config] ${swc.name}`, () => {
             expect(subject().jsc.target).toBeUndefined();
         });
     });
+
+    describe('when no tsconfig is found', () => {
+        beforeEach(() => fs.rmSync('tsconfig.json'));
+
+        test('gets default swc config from base.json', () => {
+            expect(subject()).toEqual({ ...config, ...getSwcOptions(new TSConfig(baseJsonPath)) });
+        });
+    });
 });

package/src/storybook-config/swc.ts

@@ -2,10 +2,10 @@ import type { SwcOptions } from '@swc/cli';
 import { inspect } from 'node:util';
 import { getSwcOptions } from '../cli/tasks';
 import { TSConfig } from '../cli/utils';
-import { getTsConfig, log } from '../utils';
+import { getTsConfigWithFallback, log } from '../utils';
 
 export function swc(config: SwcOptions) {
-    const tsConfig = new TSConfig(getTsConfig());
+    const tsConfig = new TSConfig(getTsConfigWithFallback());
     const swcOptions = getSwcOptions(tsConfig);
 
     /*

package/src/utils/__tests__/get-tsconfig-with-fallback.test.ts

@@ -0,0 +1,23 @@
+import { fs, vol } from 'memfs';
+import { getBaseTsConfig } from '../get-base-tsconfig';
+import { getTsConfigWithFallback } from '../get-tsconfig-with-fallback';
+
+jest.mock('fs', () => fs);
+
+describe(`[startup] Utils`, () => {
+    describe(`${getTsConfigWithFallback.name}`, () => {
+        afterEach(() => vol.reset());
+
+        test('returns base.json', () => {
+            expect(getTsConfigWithFallback()).toBe(getBaseTsConfig());
+        });
+
+        describe('when tsconfig exists', () => {
+            beforeEach(() => vol.fromJSON({ 'tsconfig.json': JSON.stringify({}) }));
+
+            test('returns tsconfig', () => {
+                expect(getTsConfigWithFallback()).toBe('tsconfig.json');
+            });
+        });
+    });
+});

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

@@ -1,5 +1,5 @@
 import { fs, vol } from 'memfs';
-import path from 'path';
+import path from 'node:path';
 import { getTsConfig } from '../get-tsconfig';
 
 jest.mock('fs', () => fs);
@@ -36,9 +36,9 @@ describe(`[startup] Utils`, () => {
             });
 
             describe(`when ${buildConfig} is present`, () => {
-                beforeEach(() => {
-                    vol.fromJSON({ [`packages/foo/${buildConfig}`]: JSON.stringify({}) });
-                });
+                beforeEach(() =>
+                    vol.fromJSON({ [`packages/foo/${buildConfig}`]: JSON.stringify({}) })
+                );
 
                 test(`returns {location}/${buildConfig}`, () => {
                     expect(subject()).toBe(path.join(location!, buildConfig));

package/src/utils/get-base-tsconfig.ts

@@ -0,0 +1,5 @@
+import path from 'node:path';
+
+export function getBaseTsConfig() {
+    return path.resolve(__dirname, '../../tsconfig/base.json');
+}

package/src/utils/get-configuration.ts

@@ -76,6 +76,7 @@ export enum CommandName {
     'mfe-package-publish' = 'mfe-package-publish',
     'mfe-package-rollback' = 'mfe-package-rollback',
     'mfe-publish' = 'mfe-publish',
+    'mfe-purge-cache' = 'mfe-purge-cache',
     'prepare-package' = 'prepare-package',
     'review' = 'review',
     'start' = 'start',

package/src/utils/get-tsconfig-with-fallback.ts

@@ -0,0 +1,12 @@
+import fs from 'node:fs';
+import { getBaseTsConfig } from './get-base-tsconfig';
+import { getTsConfig } from './get-tsconfig';
+
+/**
+ * Returns the tsconfig file to use for builds, falling back to startup's base.json
+ * if no tsconfig is found at the given location.
+ */
+export function getTsConfigWithFallback(location = './') {
+    const config = getTsConfig(location);
+    return fs.existsSync(config) ? config : getBaseTsConfig();
+}

package/src/utils/index.ts

@@ -2,6 +2,7 @@ export * from './find-packages';
 export * from './find-up';
 export * from './format-duration';
 export * from './format-relative-date';
+export * from './get-base-tsconfig';
 export * from './get-branch-configs';
 export * from './get-configuration';
 export * from './get-destination-folders';
@@ -12,6 +13,7 @@ export * from './get-package-name';
 export * from './get-packages';
 export * from './get-startup-version';
 export * from './get-tsconfig';
+export * from './get-tsconfig-with-fallback';
 export * from './load-shared-dependencies';
 export * from './log';
 export * from './log-errors';

package/dist/cli/commands/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/utils.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,uCAAuC,CAAC;AACzE,eAAO,MAAM,mBAAmB,gBAAgB,CAAC;AAEjD,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEpD"}

package/dist/cli/commands/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/cli/commands/utils.ts"],"sourcesContent":["export const DEFAULT_MFE_REGISTRY = 'https://verdaccio.servicetitan.com';\nexport const ROLLBACK_TAG_SUFFIX = '-rollback-1';\n\nexport function buildRollbackTag(tag: string): string {\n    return `${tag}${ROLLBACK_TAG_SUFFIX}`;\n}\n"],"names":["DEFAULT_MFE_REGISTRY","ROLLBACK_TAG_SUFFIX","buildRollbackTag","tag"],"mappings":";;;;;;;;;;;QAAaA;eAAAA;;QACAC;eAAAA;;QAEGC;eAAAA;;;AAHT,MAAMF,uBAAuB;AAC7B,MAAMC,sBAAsB;AAE5B,SAASC,iBAAiBC,GAAW;IACxC,OAAO,GAAGA,MAAMF,qBAAqB;AACzC"}