@servicetitan/startup 28.5.0 → 29.0.0

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

@@ -2,13 +2,7 @@ import path from 'path';
 import fs from 'fs';
 import { getFolders, isWebComponent, log, logErrors, readJson } from '../../utils';
 import { gitGetBranch, gitGetCommitHash } from '../utils/cli-git';
-import {
-    npmGetPackageVersions,
-    npmPackageSet,
-    npmPublish,
-    npmPublishDry,
-    npmTagVersion,
-} from '../utils/cli-npm';
+import { npmGetPackageVersions, npmPackageSet, npmPublish, npmTagVersion } from '../utils/cli-npm';
 import { getBranchesConfigs } from '../../utils/get-branch-configs';
 import { getDefaultBuildVersion } from '../utils/publish';
 import { EntryPoint, EntryPoints, Metadata } from '../../webpack/configs';
@@ -20,7 +14,7 @@ export interface ArgsPackagePublish {
     dry?: boolean;
     force?: boolean;
     registry?: string;
-    tag?: string | false;
+    tag?: string;
 }
 
 export class MFEPackagePublish implements Command {
@@ -92,11 +86,7 @@ export class MFEPackagePublish implements Command {
             await npmPackageSet('files[1]', 'package.json');
         }
 
-        if (data.dry) {
-            await npmPublishDry();
-        } else {
-            await npmPublish(data.tag);
-        }
+        await npmPublish({ dry: data.dry, tag: data.tag || data.fallbackTag });
 
         log.info(`${dryRunPrefix}published ${packageName} version ${data.version}`);
     }
@@ -104,11 +94,12 @@ export class MFEPackagePublish implements Command {
     private getPublishData(): {
         version: string;
         buildVersion: string;
-        tag?: string;
+        tag: string;
         registry: string;
         dry: boolean;
         force: boolean;
         isBranchConfigured: boolean;
+        fallbackTag: string;
     } {
         const cli = this.args;
         const branch = cli.branch ?? gitGetBranch();
@@ -119,15 +110,9 @@ export class MFEPackagePublish implements Command {
             buildVersion = getDefaultBuildVersion(branch, gitGetCommitHash());
         }
 
-        if (!buildVersion) {
-            throw new Error('build version is not set');
-        }
-
         let tag: string;
 
-        if (cli.tag === false) {
-            tag = '';
-        } else if (cli.tag) {
+        if (cli.tag) {
             tag = cli.tag;
         } else {
             tag = branchConfig?.publishTag ?? '';
@@ -143,6 +128,7 @@ export class MFEPackagePublish implements Command {
             dry: !!cli.dry,
             force: !!cli.force,
             isBranchConfigured: !!branchConfig,
+            fallbackTag: 'latest',
         };
     }
 

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

@@ -58,17 +58,18 @@ export class MFEPublish implements Command {
             ...[dry && '--dry'],
             ...[force && '--force'],
             ...[registry && `--registry ${registry}`],
-            ...[tag && `--tag ${tag}`],
-            ...[tag === false && `--no-tag`],
+            ...[typeof tag === 'string' && `--tag ${tag}`],
         ].filter(item => !!item) as string[];
     }
 
     getCleanOptions() {
-        const { branch, count } = this.args as ArgsPackageClean;
+        const { all, branch, count, dry, registry } = this.args as ArgsPackageClean;
         return [
-            ...[branch && typeof branch === 'string' && `--branch ${branch}`],
-            ...[branch && branch === true && '--branch'],
+            ...[all && '--all'],
+            ...[typeof branch === 'string' && `--branch ${branch}`],
             ...[count && `--count ${count}`],
+            ...[dry && '--dry'],
+            ...[registry && `--registry ${registry}`],
         ].filter(item => !!item) as string[];
     }
 }

package/src/cli/utils/__tests__/cli-npm.test.ts

@@ -1,11 +1,10 @@
 import { runCommand, runCommandOutput } from '../cli-os';
 
 import {
-    npmGetPackageVersionDates,
     npmGetPackageVersions,
+    npmGetPackageVersionsDetails,
     npmPackageSet,
     npmPublish,
-    npmPublishDry,
     npmTagVersion,
     npmUnpublish,
 } from '../cli-npm';
@@ -48,7 +47,7 @@ describe('[startup] Cli Utils (Npm)', () => {
         });
     }
 
-    describe(`${npmGetPackageVersions.name}`, () => {
+    describe(npmGetPackageVersions.name, () => {
         let args: Parameters<typeof npmGetPackageVersions>;
 
         beforeEach(() => (args = ['{registry}', '{packageName}']));
@@ -82,30 +81,42 @@ describe('[startup] Cli Utils (Npm)', () => {
         });
     });
 
-    describe(`${npmGetPackageVersionDates.name}`, () => {
-        let args: Parameters<typeof npmGetPackageVersionDates>;
+    describe(npmGetPackageVersionsDetails.name, () => {
+        let args: Parameters<typeof npmGetPackageVersionsDetails>;
 
-        beforeEach(() => (args = ['{registry}', '{packageName}']));
+        beforeEach(() => {
+            jest.useFakeTimers();
+            args = ['{registry}', '{packageName}'];
+        });
 
-        const subject = () => npmGetPackageVersionDates(...args);
+        afterEach(() => jest.useRealTimers());
 
-        itRunsCommandOutput(subject, 'npm view {packageName} time --registry {registry} --json', {
-            timeout: 10000,
-        });
+        const subject = () => npmGetPackageVersionsDetails(...args);
+
+        itRunsCommandOutput(
+            subject,
+            'npm view {packageName} time dist-tags --registry {registry} --json',
+            { timeout: 10000 }
+        );
 
-        test('converts results to Array<[string, Date]>', () => {
+        test('converts results to Version[]', () => {
             function dayAgo(count: number) {
                 const date = new Date();
                 date.setDate(-count);
                 return date;
             }
-            const result = { '1.0.1': dayAgo(3), '2.1.0': dayAgo(2), '3.0.0': dayAgo(1) };
+            const result = {
+                'time': { '1.0.1': dayAgo(3), '2.1.0': dayAgo(2), '3.0.0': dayAgo(1) },
+                'dist-tags': { latest: '3.0.0' },
+            };
 
             jest.mocked(runCommandOutput).mockReturnValue(JSON.stringify(result));
 
-            expect(subject()).toEqual(
-                Object.entries(result).map(([version, date]) => [version, date])
-            );
+            expect(subject()).toEqual([
+                { name: '1.0.1', date: dayAgo(3) },
+                { name: '2.1.0', date: dayAgo(2) },
+                { name: '3.0.0', date: dayAgo(1), tag: 'latest' },
+            ]);
         });
 
         describe('when an error occurs', () => {
@@ -121,7 +132,7 @@ describe('[startup] Cli Utils (Npm)', () => {
         });
     });
 
-    describe(`${npmPackageSet.name}`, () => {
+    describe(npmPackageSet.name, () => {
         let args: Parameters<typeof npmPackageSet>;
 
         beforeEach(() => (args = ['{key}', '{value}']));
@@ -131,27 +142,29 @@ describe('[startup] Cli Utils (Npm)', () => {
         itRunsCommand(subject, 'npm pkg set {key}={value}');
     });
 
-    describe(`${npmPublish.name}`, () => {
-        let args: Parameters<typeof npmPublish>;
+    describe(npmPublish.name, () => {
+        let options: Parameters<typeof npmPublish>[0];
 
-        beforeEach(() => (args = []));
+        beforeEach(() => (options = {}));
 
-        const subject = async () => npmPublish(...args);
+        const subject = async () => npmPublish(options);
 
         itRunsCommand(subject, 'npm publish');
 
         describe('with a tag', () => {
-            beforeEach(() => args.push('{tag}'));
+            beforeEach(() => (options.tag = '{tag}'));
 
             itRunsCommand(subject, 'npm publish --tag {tag}');
         });
-    });
 
-    describe(`${npmPublishDry.name}`, () => {
-        itRunsCommand(npmPublishDry, 'npm publish --dry-run');
+        describe('with {dry: true}', () => {
+            beforeEach(() => (options.dry = true));
+
+            itRunsCommand(subject, 'npm publish --dry-run');
+        });
     });
 
-    describe(`${npmUnpublish.name}`, () => {
+    describe(npmUnpublish.name, () => {
         let args: Parameters<typeof npmUnpublish>;
 
         beforeEach(() => (args = ['{registry}', '{packageName}', '{packageVersion}']));
@@ -165,7 +178,7 @@ describe('[startup] Cli Utils (Npm)', () => {
         );
     });
 
-    describe(`${npmTagVersion.name}`, () => {
+    describe(npmTagVersion.name, () => {
         let args: Parameters<typeof npmTagVersion>[0];
 
         beforeEach(() => {

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

@@ -1,10 +1,18 @@
 import { runCommand, runCommandOutput } from './cli-os';
 
+export interface Version {
+    name: string;
+    date: Date;
+    tag?: string;
+}
+
+const NPM_TIMEOUT = 10000;
+
 export function npmGetPackageVersions(registry: string, packageName: string): string[] {
     try {
         const v = runCommandOutput(
             `npm show ${packageName} versions --registry ${registry} --json`,
-            { timeout: 10000 }
+            { timeout: NPM_TIMEOUT }
         );
 
         return JSON.parse(v);
@@ -13,17 +21,22 @@ export function npmGetPackageVersions(registry: string, packageName: string): st
     }
 }
 
-export function npmGetPackageVersionDates(registry: string, packageName: string): [string, Date][] {
+export function npmGetPackageVersionsDetails(registry: string, packageName: string): Version[] {
     try {
-        const v = runCommandOutput(`npm view ${packageName} time --registry ${registry} --json`, {
-            timeout: 10000,
-        });
-        const map = JSON.parse(v);
+        const result = runCommandOutput(
+            `npm view ${packageName} time dist-tags --registry ${registry} --json`,
+            { timeout: NPM_TIMEOUT }
+        );
 
-        return Object.keys(map).reduce(
-            (out, version) => [...out, [version, new Date(map[version])]],
-            []
+        const { time, 'dist-tags': distTags } = JSON.parse(result);
+
+        const tags = Object.fromEntries(
+            Object.entries(distTags).map(([tag, version]) => [version, tag])
         );
+
+        return Object.keys(time).reduce((out, version) => {
+            return [...out, { name: version, date: new Date(time[version]), tag: tags[version] }];
+        }, []);
     } catch {
         return [];
     }
@@ -31,16 +44,12 @@ export function npmGetPackageVersionDates(registry: string, packageName: string)
 
 export async function npmUnpublish(registry: string, packageName: string, packageVersion: string) {
     await runCommand(`npm unpublish ${packageName}@${packageVersion} --registry ${registry}`, {
-        timeout: 10000,
+        timeout: NPM_TIMEOUT,
     });
 }
 
-export async function npmPublishDry() {
-    await runCommand('npm publish --dry-run');
-}
-
-export async function npmPublish(tag?: string) {
-    await runCommand(['npm publish', !!tag && `--tag ${tag}`]);
+export async function npmPublish({ dry, tag }: { dry?: boolean; tag?: string }) {
+    await runCommand(['npm publish', !!tag && `--tag ${tag}`, !!dry && `--dry-run`]);
 }
 
 export async function npmPackageSet(key: string, value: string) {