@servicetitan/startup 34.3.0 → 35.0.0

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

@@ -22,7 +22,7 @@ import {
     runCommand,
 } from '../utils';
 import { Command, CommandOptions } from './types';
-import { buildRollbackTag, DEFAULT_MFE_REGISTRY } from './utils';
+import { DEFAULT_MFE_REGISTRY, buildRollbackTag, purgeCache } from './utils';
 
 export const mfePackagePublishOptions = {
     branch: {
@@ -59,6 +59,11 @@ export const mfePackagePublishOptions = {
         description: 'Upload source maps to Datadog?',
         defaultDescription: 'true',
     },
+    purgeCache: {
+        boolean: true,
+        description: 'Purge unpkg cache after publishing?',
+        defaultDescription: 'true',
+    },
 } satisfies CommandOptions;
 
 interface PublishData {
@@ -100,6 +105,11 @@ export class MFEPackagePublish extends Command<typeof mfePackagePublishOptions>
 
         await this.maybePublishPackage(packageJson, data);
 
+        const { dry, tag } = data;
+        if (this.args.purgeCache !== false && !dry) {
+            purgeCache({ packageName: packageJson.name, tag });
+        }
+
         if (data.uploadSourcemaps) {
             this.uploadSourcemaps(data);
         }

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

@@ -1,7 +1,7 @@
 import { log, logErrors, readJson } from '../../utils';
 import { DRY_RUN_PREFIX, npmTagVersion, npmView } from '../utils';
 import { Command, CommandOptions } from './types';
-import { buildRollbackTag, DEFAULT_MFE_REGISTRY } from './utils';
+import { DEFAULT_MFE_REGISTRY, buildRollbackTag, purgeCache } from './utils';
 
 export const mfePackageRollbackOptions = {
     dry: {
@@ -18,6 +18,11 @@ export const mfePackageRollbackOptions = {
         description: 'The tag to rollback to its previous version',
         required: true,
     },
+    purgeCache: {
+        boolean: true,
+        description: 'Purge unpkg cache after rolling back?',
+        defaultDescription: 'true',
+    },
 } satisfies CommandOptions;
 
 interface PackageJson {
@@ -25,8 +30,6 @@ interface PackageJson {
 }
 
 export class MFEPackageRollback extends Command<typeof mfePackageRollbackOptions> {
-    static readonly description = 'Rollback a package to a previous tagged version';
-
     static readonly options = mfePackageRollbackOptions;
 
     private get dryRunPrefix() {
@@ -35,11 +38,16 @@ export class MFEPackageRollback extends Command<typeof mfePackageRollbackOptions
 
     @logErrors
     async execute() {
-        if (this.args.dry) {
+        const { dry, tag } = this.args;
+        if (dry) {
             log.warning('DRY-RUN MODE ENABLED, WILL NOT PERFORM ROLLBACK');
         }
 
-        await this.handleRollback();
+        const packageName = await this.handleRollback();
+
+        if (packageName && this.args.purgeCache !== false && !dry) {
+            purgeCache({ packageName, tag });
+        }
     }
 
     private async handleRollback() {
@@ -96,5 +104,7 @@ export class MFEPackageRollback extends Command<typeof mfePackageRollbackOptions
                 tag,
             });
         }
+
+        return packageName;
     }
 }

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

@@ -111,17 +111,28 @@ export class MFEPublish extends Command<MFEPublishOptions> {
     }
 
     getPublishOptions() {
-        const { build, branch, dry, force, registry, tag, uploadSourcemaps, trackHistory } =
-            this.args;
+        const {
+            build,
+            branch,
+            dry,
+            force,
+            purgeCache,
+            registry,
+            tag,
+            uploadSourcemaps,
+            trackHistory,
+        } = this.args;
         return [
             ...[branch && `--branch ${branch}`],
             ...[build && `--build ${build}`],
             ...[dry && '--dry'],
             ...[force && '--force'],
+            ...[purgeCache === true && '--purge-cache'],
+            ...[purgeCache === false && '--no-purge-cache'],
             ...[registry && `--registry ${registry}`],
+            ...[typeof tag === 'string' && `--tag ${tag}`],
             ...[trackHistory === true && '--track-history'],
             ...[trackHistory === false && '--no-track-history'],
-            ...[typeof tag === 'string' && `--tag ${tag}`],
             ...[uploadSourcemaps === true && `--upload-sourcemaps`],
             ...[uploadSourcemaps === false && `--no-upload-sourcemaps`],
         ].filter(item => !!item) as string[];

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

@@ -0,0 +1,75 @@
+import { log, logErrors } from '../../utils';
+import { Command, CommandOptions } from './types';
+
+const mfePurgeCacheOptions = {
+    host: {
+        string: true,
+        description: 'Host URL to send purge requests to',
+        demandOption: true,
+    },
+    packageName: {
+        string: true,
+        description: 'Package name to purge',
+        demandOption: true,
+    },
+    tag: {
+        string: true,
+        description: 'Package tag to purge',
+        demandOption: true,
+    },
+    token: {
+        string: true,
+        description: 'X-Purge-Token header value',
+        defaultDescription: 'process.env.UNPKG_PURGE_TOKEN',
+    },
+} satisfies CommandOptions;
+
+export type PurgeResponse = {
+    pod: string;
+    status: number;
+    cache: string | null;
+    location: string | null;
+}[];
+
+export class MFEPurgeCache extends Command<typeof mfePurgeCacheOptions> {
+    static readonly options = mfePurgeCacheOptions;
+
+    @logErrors
+    async execute() {
+        const { host: rawHost, packageName, tag } = this.args;
+        const host = rawHost.replace(/\/$/, '');
+        const token = this.args.token ?? process.env.UNPKG_PURGE_TOKEN;
+        const packageNameAndTag = `${packageName}@${tag}`;
+        const path = `${packageNameAndTag}/dist/metadata.json`;
+
+        log.info(`Purging cache for ${packageNameAndTag}`);
+
+        if (!token) {
+            log.warning('Token is not defined, skipping purge');
+            return;
+        }
+
+        const response = await fetch(`${host}/_purge/${path}`, {
+            method: 'POST',
+            headers: { 'X-Purge-Token': token },
+        });
+
+        if (!response.ok) {
+            throw new Error(`Purge request failed: ${response.status} ${response.statusText}`);
+        }
+
+        const responseJson = await response.json();
+        /* istanbul ignore next: debug only */
+        log.debug('mfe-purge-cache', () => JSON.stringify(responseJson, null, 2));
+
+        log.info(`Cache purged: ${path} -> ${this.getLocation(responseJson)}`);
+    }
+
+    private getLocation(responseJson: PurgeResponse) {
+        let location: string | null = null;
+        if (Array.isArray(responseJson)) {
+            location = responseJson[0]?.location?.replace(/^\//, '') ?? null;
+        }
+        return location;
+    }
+}

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

@@ -0,0 +1,40 @@
+import { runCommandOutput } from '../../../utils';
+import { purgeCache } from '../purge-cache';
+
+jest.mock('../../../utils', () => ({
+    ...jest.requireActual('../../../utils'),
+    runCommandOutput: jest.fn(),
+}));
+
+describe(purgeCache.name, () => {
+    let args: Parameters<typeof purgeCache>[0];
+    const packageName = '@servicetitan/foo';
+    const tag = 'prod';
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        args = { packageName, tag };
+    });
+
+    const subject = () => purgeCache(args);
+
+    test('runs mfe-purge-cache with host "https://unpkg.servicetitan.com", package name and tag', () => {
+        subject();
+
+        expect(runCommandOutput).toHaveBeenCalledWith(
+            `npx startup mfe-purge-cache --host https://unpkg.servicetitan.com --package-name ${packageName} --tag ${tag}`
+        );
+    });
+
+    describe('when registry is "https://verdaccio.st.dev"', () => {
+        beforeEach(() => (args.registry = 'https://verdaccio.st.dev'));
+
+        test('runs mfe-purge-cache with host "https://unpkg.st.dev"', () => {
+            subject();
+
+            expect(runCommandOutput).toHaveBeenCalledWith(
+                expect.stringContaining(`--host https://unpkg.st.dev`)
+            );
+        });
+    });
+});

package/src/cli/commands/{utils.ts → utils/build-rollback-tag.ts}

@@ -1,4 +1,3 @@
-export const DEFAULT_MFE_REGISTRY = 'https://verdaccio.servicetitan.com';
 export const ROLLBACK_TAG_SUFFIX = '-rollback-1';
 
 export function buildRollbackTag(tag: string): string {

package/src/cli/commands/utils/constants.ts

@@ -0,0 +1 @@
+export const DEFAULT_MFE_REGISTRY = 'https://verdaccio.servicetitan.com';

package/src/cli/commands/utils/index.ts

@@ -0,0 +1,3 @@
+export * from './build-rollback-tag';
+export * from './constants';
+export * from './purge-cache';

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/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/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"}