@servicetitan/startup 24.0.4 → 24.1.0

package/src/cli/commands/mfe-publish.ts

@@ -45,6 +45,10 @@ interface Args extends ArgsPackagePublish, ArgsPackageClean {
 export class MFEPublish implements Command {
     constructor(private args: Args) {}
 
+    description() {
+        return 'publish or unpublish MFE packages';
+    }
+
     @logErrors
     async execute() {
         let packages = splitPackagesByType(getPackages())[PackageType.Webpack] ?? [];
@@ -93,6 +97,10 @@ export class MFEPublish implements Command {
 export class MFEPackagePublish implements Command {
     constructor(private args: ArgsPackagePublish) {}
 
+    description() {
+        return undefined;
+    }
+
     @logErrors
     async execute() {
         if (!isWebComponent()) {
@@ -197,6 +205,10 @@ export class MFEPackagePublish implements Command {
 export class MFEPackageClean implements Command {
     constructor(private args: ArgsPackageClean) {}
 
+    description() {
+        return undefined;
+    }
+
     @logErrors
     async execute() {
         if (!isWebComponent()) {

package/src/cli/commands/prepare-package.ts

@@ -9,6 +9,10 @@ interface Args {
 export class PreparePackage implements Command {
     constructor(private args: Args) {}
 
+    description() {
+        return undefined;
+    }
+
     @logErrors
     async execute() {
         if (!this.args.watch) {

package/src/cli/commands/start.ts

@@ -14,6 +14,10 @@ interface Args {
 export class Start implements Command {
     constructor(private args: Args) {}
 
+    description() {
+        return 'run project in development mode';
+    }
+
     @logErrors
     async execute() {
         const packages = splitPackagesByType(

package/src/cli/commands/styles-check.ts

@@ -121,6 +121,10 @@ function checkStylesWebComponent(files: FileInfo[]) {
 }
 
 export class StylesCheck implements Command {
+    description() {
+        return undefined;
+    }
+
     // eslint-disable-next-line @typescript-eslint/require-await
     async execute() {
         if (isLegacy()) {

package/src/cli/commands/tests.ts

@@ -9,6 +9,10 @@ import { Command } from '.';
 export class Tests implements Command {
     constructor(private args: Config.Argv) {}
 
+    description() {
+        return 'run tests';
+    }
+
     @logErrors
     async execute() {
         const jestConfig = getJestConfigCLI(this.args);

package/src/cli/commands/types.ts

@@ -0,0 +1,4 @@
+export interface Command {
+    execute(): Promise<void>;
+    description(): string | undefined;
+}

package/src/cli/index.ts

@@ -1,69 +1,23 @@
 import execa from 'execa';
 import { argv, Arguments } from 'yargs';
-
-import { CommandName, log } from '../utils';
-import {
-    Build,
-    BundlePackage,
-    Command,
-    ESLintCommand,
-    Init,
-    Install,
-    KendoUILicense,
-    Lint,
-    MFEPackageClean,
-    MFEPackagePublish,
-    MFEPublish,
-    PreparePackage,
-    Start,
-    StylesCheck,
-    Tests,
-} from './commands';
+import { CommandName, getStartupVersion, log } from '../utils';
+import { getCommand, getUserCommands } from './commands';
 import { setNodeOptions } from './utils';
 
-interface Newable<T> {
-    new (...args: any[]): T;
-}
-
-function getCommand(name: CommandName): Newable<Command> {
-    switch (name) {
-        case CommandName.build:
-            return Build;
-        case CommandName['bundle-package']:
-            return BundlePackage;
-        case CommandName.eslint:
-            return ESLintCommand;
-        case CommandName.init:
-            return Init;
-        case CommandName.install:
-            return Install;
-        case CommandName['kendo-ui-license']:
-            return KendoUILicense;
-        case CommandName.lint:
-            return Lint;
-        case CommandName['mfe-package-clean']:
-            return MFEPackageClean;
-        case CommandName['mfe-package-publish']:
-            return MFEPackagePublish;
-        case CommandName['mfe-publish']:
-            return MFEPublish;
-        case CommandName['prepare-package']:
-            return PreparePackage;
-        case CommandName.start:
-            return Start;
-        case CommandName['styles-check']:
-            return StylesCheck;
-        case CommandName.test:
-            return Tests;
-        default:
-            log.error(`${name}: command not found!`);
-            process.exit(127);
-    }
+const argvSync = argv as Arguments;
+const name = argvSync._[0]?.toString() as CommandName;
+if (!name) {
+    log.info(`startup cli v${getStartupVersion()}`);
+    usage();
+    process.exit(0);
 }
 
-const argvSync = argv as Arguments;
-const name = argvSync._[0].toString() as CommandName;
 const Command = getCommand(name);
+if (!Command) {
+    log.error(`Unknown command: "${name}"`);
+    usage();
+    process.exit(127);
+}
 
 if (setNodeOptions(name)) {
     // Run command in child process with amended NODE_OPTIONS
@@ -77,3 +31,17 @@ if (setNodeOptions(name)) {
         process.exit(1);
     });
 }
+
+function usage() {
+    write('\nUsage:\n');
+
+    const commands = getUserCommands().filter(({ name }) => !!name);
+    const maxNameLength = commands.reduce((result, { name }) => Math.max(result, name.length), 0);
+    commands.forEach(({ name, description }) => {
+        write(`startup ${name.padEnd(maxNameLength, ' ')}  ${description}`);
+    });
+}
+
+function write(text: string) {
+    return console.info(text); // eslint-disable-line no-console
+}

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

@@ -1,5 +1,6 @@
 import execa from 'execa';
 import { isBundle, isLegacy } from '../get-configuration';
+import { log } from '../log';
 import { maybeCreateGitFolder } from '../maybe-create-git-folder';
 
 import {
@@ -21,6 +22,15 @@ describe('[startup] Utils', () => {
         { name: 'baz', location: 'packages/baz', type: PackageType.Webpack },
     ];
 
+    beforeEach(() => jest.clearAllMocks());
+
+    function expectExecaToBeCalledWith(command: string, options?: execa.SyncOptions) {
+        const [file, ...args] = command.split(' ');
+        const { calls } = jest.mocked(execa.sync).mock;
+        const expected: any[] = [file, args, ...(options ? [options] : [])];
+        expect(calls).toContainEqual(expect.arrayContaining(expected));
+    }
+
     describe(`${getPackages.name}`, () => {
         let options: Parameters<typeof getPackages>[0] | undefined;
         let dependencies: Record<string, string[]> | undefined;
@@ -72,7 +82,7 @@ describe('[startup] Utils', () => {
 
         test('returns lerna packages with type metadata', () => {
             expect(subject()).toEqual(packages);
-            expect(execa.sync).toHaveBeenCalledWith('npx', 'lerna la --json'.split(' '));
+            expectExecaToBeCalledWith('npx lerna la --json');
         });
 
         test('conditionally creates .git folder', () => {
@@ -81,16 +91,34 @@ describe('[startup] Utils', () => {
             expect(maybeCreateGitFolder).toHaveBeenCalled();
         });
 
+        describe('when running on Windows', () => {
+            const originalPlatform = process.platform;
+            beforeEach(() => {
+                Object.defineProperty(process, 'platform', { value: 'win32' });
+            });
+
+            afterEach(() => {
+                Object.defineProperty(process, 'platform', { value: originalPlatform });
+            });
+
+            test('sets NX_CACHE_PROJECT_GRAPH=false', () => {
+                subject();
+
+                expectExecaToBeCalledWith('npx lerna la --json', {
+                    extendEnv: true,
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    env: { NX_CACHE_PROJECT_GRAPH: 'false' },
+                });
+            });
+        });
+
         describe.each(['scope', 'ignore'])('with "%s"', option => {
             beforeEach(() => (options = { [option]: 'foo' }));
 
             test(`passes "${option}" option to lerna`, () => {
                 subject();
 
-                expect(execa.sync).toHaveBeenCalledWith(
-                    'npx',
-                    `lerna la --${option} foo --json`.split(' ')
-                );
+                expectExecaToBeCalledWith(`npx lerna la --${option} foo --json`);
             });
         });
 
@@ -111,6 +139,18 @@ describe('[startup] Utils', () => {
                 });
             });
         });
+
+        describe('when execa returns unexpected output', () => {
+            beforeEach(() =>
+                jest.mocked(execa.sync).mockReturnValue({ stdout: Buffer.from('foo') } as any)
+            );
+
+            test('throws an error and logs the output', () => {
+                const logSpy = jest.spyOn(log, 'error');
+                expect(() => subject()).toThrow();
+                expect(logSpy).toHaveBeenCalledWith(expect.stringContaining('\nfoo'));
+            });
+        });
     });
 
     describe(`${getPackagesGraph.name}`, () => {
@@ -128,7 +168,7 @@ describe('[startup] Utils', () => {
 
         test('returns lerna package graph', () => {
             expect(subject()).toEqual(packageGraph);
-            expect(execa.sync).toHaveBeenCalledWith('npx', 'lerna la --graph'.split(' '));
+            expectExecaToBeCalledWith('npx lerna la --graph');
         });
 
         describe.each(['scope', 'ignore'])('with "%s"', option => {
@@ -137,10 +177,7 @@ describe('[startup] Utils', () => {
             test(`passes "${option}" option to lerna`, () => {
                 subject();
 
-                expect(execa.sync).toHaveBeenCalledWith(
-                    'npx',
-                    `lerna la --${option} foo --graph`.split(' ')
-                );
+                expectExecaToBeCalledWith(`npx lerna la --${option} foo --graph`);
             });
         });
     });

package/src/utils/get-packages.ts

@@ -2,6 +2,7 @@ import execa from 'execa';
 import { isBundle, isLegacy } from './get-configuration';
 import { maybeCreateGitFolder } from './maybe-create-git-folder';
 import { toArray } from './to-array';
+import { log } from './log';
 
 export enum PackageType {
     TSC,
@@ -29,23 +30,13 @@ export function getPackages(options: GetPackagesOptions = {}) {
     const ignore = toArray(options.ignore);
 
     maybeCreateGitFolder();
-    const allPackages: RawPackage[] = JSON.parse(
-        execa.sync('npx', ['lerna', 'la', '--json']).stdout
-    );
+    const allPackages: RawPackage[] = listPackages();
 
     if (!scope.length && !ignore.length) {
         return withMetadata(allPackages);
     }
 
-    const filteredPackages: RawPackage[] = JSON.parse(
-        execa.sync('npx', [
-            'lerna',
-            'la',
-            ...scope.map(v => ['--scope', v]).flat(),
-            ...ignore.map(v => ['--ignore', v]).flat(),
-            '--json',
-        ]).stdout
-    );
+    const filteredPackages: RawPackage[] = listPackages(options);
 
     const graph: Record<string, string[]> = getPackagesGraph();
 
@@ -86,18 +77,42 @@ interface GetPackagesGraphOptions {
  * Returns packages and their direct dependencies
  */
 export function getPackagesGraph(options: GetPackagesGraphOptions = {}): Record<string, string[]> {
+    return listPackages({ ...options, graph: true });
+}
+
+function listPackages(options: GetPackagesOptions & { graph?: boolean } = {}) {
     const scope = toArray(options.scope);
     const ignore = toArray(options.ignore);
 
-    return JSON.parse(
-        execa.sync('npx', [
+    let execaOptions: execa.SyncOptions | undefined;
+    if (process.platform === 'win32') {
+        /*
+         * Disabled the project graph cache to workaround issue when nx fails with
+         * "Error: EPERM: operation not permitted, rename ..." error when multiple
+         * processes simultaneously generate the project graph.
+         */
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        execaOptions = { extendEnv: true, env: { NX_CACHE_PROJECT_GRAPH: 'false' } };
+    }
+
+    const output = execa.sync(
+        'npx',
+        [
             'lerna',
             'la',
             ...scope.map(v => ['--scope', v]).flat(),
             ...ignore.map(v => ['--ignore', v]).flat(),
-            '--graph',
-        ]).stdout
-    );
+            options.graph ? '--graph' : '--json',
+        ],
+        execaOptions
+    ).stdout;
+
+    try {
+        return JSON.parse(output);
+    } catch (error) {
+        log.error(`error: could not parse lerna output:\n${output}`);
+        throw error;
+    }
 }
 
 function withMetadata(packages: RawPackage[]): Package[] {