fix: revert MSO changes (#1192)

* Revert "fix: bump multi-stage-output"

This reverts commit 36ed590.

* Revert "Merge pull request #1120 from salesforcecli/mdonnalley/ink"

This reverts commit bfc34ef, reversing
changes made to 3499c53.

Author: mdonnalley

package.json

@@ -6,16 +6,14 @@
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
     "@oclif/core": "^4.0.16",
-    "@oclif/multi-stage-output": "^0.3.1",
     "@salesforce/core": "^8.4.0",
     "@salesforce/kit": "^3.2.0",
     "@salesforce/sf-plugins-core": "^11.3.3",
     "@salesforce/source-deploy-retrieve": "^12.5.1",
     "ansis": "^3.2.0",
     "change-case": "^5.4.4",
     "is-wsl": "^3.1.0",
-    "open": "^10.1.0",
-    "terminal-link": "^3.0.0"
+    "open": "^10.1.0"
   },
   "devDependencies": {
     "@oclif/plugin-command-snapshot": "^5.2.14",

src/commands/org/create/scratch.ts

@@ -5,28 +5,25 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { MultiStageOutput } from '@oclif/multi-stage-output';
 import {
   Lifecycle,
   Messages,
   Org,
   scratchOrgCreate,
   ScratchOrgLifecycleEvent,
   scratchOrgLifecycleEventName,
-  scratchOrgLifecycleStages,
   SfError,
 } from '@salesforce/core';
 import { Flags, SfCommand } from '@salesforce/sf-plugins-core';
 import { Duration } from '@salesforce/kit';
-import terminalLink from 'terminal-link';
 import { buildScratchOrgRequest } from '../../../shared/scratchOrgRequest.js';
+import { buildStatus } from '../../../shared/scratchOrgOutput.js';
 import { ScratchCreateResponse } from '../../../shared/orgTypes.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-org', 'create_scratch');
 
 const definitionFileHelpGroupName = 'Definition File Override';
-
 export default class OrgCreateScratch extends SfCommand<ScratchCreateResponse> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly description = messages.getMessage('description');
@@ -170,69 +167,38 @@ export default class OrgCreateScratch extends SfCommand<ScratchCreateResponse> {
       flags,
       flags['client-id'] ? await this.secretPrompt({ message: messages.getMessage('prompt.secret') }) : undefined
     );
+    let lastStatus: string | undefined;
 
-    const stager = new MultiStageOutput<ScratchOrgLifecycleEvent & { alias: string | undefined }>({
-      stages: flags.async ? ['prepare request', 'send request', 'done'] : scratchOrgLifecycleStages,
-      title: flags.async ? 'Creating Scratch Org (async)' : 'Creating Scratch Org',
-      data: { alias: flags.alias },
-      jsonEnabled: this.jsonEnabled(),
-      postStagesBlock: [
-        {
-          label: 'Request Id',
-          type: 'dynamic-key-value',
-          get: (data) =>
-            data?.scratchOrgInfo?.Id && terminalLink(data.scratchOrgInfo.Id, `${baseUrl}/${data.scratchOrgInfo.Id}`),
-          bold: true,
-        },
-        {
-          label: 'OrgId',
-          type: 'dynamic-key-value',
-          get: (data) => data?.scratchOrgInfo?.ScratchOrg,
-          bold: true,
-          color: 'cyan',
-        },
-        {
-          label: 'Username',
-          type: 'dynamic-key-value',
-          get: (data) => data?.scratchOrgInfo?.SignupUsername,
-          bold: true,
-          color: 'cyan',
-        },
-        {
-          label: 'Alias',
-          type: 'static-key-value',
-          get: (data) => data?.alias,
-        },
-      ],
-    });
-
-    lifecycle.on<ScratchOrgLifecycleEvent>(scratchOrgLifecycleEventName, async (data): Promise<void> => {
-      stager.goto(data.stage, data);
-      if (data.stage === 'done') {
-        stager.stop();
-      }
-      return Promise.resolve();
-    });
+    if (!flags.async) {
+      lifecycle.on<ScratchOrgLifecycleEvent>(scratchOrgLifecycleEventName, async (data): Promise<void> => {
+        lastStatus = buildStatus(data, baseUrl);
+        this.spinner.status = lastStatus;
+        return Promise.resolve();
+      });
+    }
+    this.log();
+    this.spinner.start(
+      flags.async ? 'Requesting Scratch Org (will not wait for completion because --async)' : 'Creating Scratch Org'
+    );
 
     try {
       const { username, scratchOrgInfo, authFields, warnings } = await scratchOrgCreate(createCommandOptions);
 
+      this.spinner.stop(lastStatus);
       if (!scratchOrgInfo) {
         throw new SfError('The scratch org did not return with any information');
       }
-
+      this.log();
       if (flags.async) {
-        stager.goto('done', { scratchOrgInfo });
-        stager.stop();
         this.info(messages.getMessage('action.resume', [this.config.bin, scratchOrgInfo.Id]));
       } else {
         this.logSuccess(messages.getMessage('success'));
       }
 
       return { username, scratchOrgInfo, authFields, warnings, orgId: authFields?.orgId };
     } catch (error) {
-      stager.stop(error as Error);
       if (error instanceof SfError && error.name === 'ScratchOrgInfoTimeoutError') {
+        this.spinner.stop(lastStatus);
         const scratchOrgInfoId = (error.data as { scratchOrgInfoId: string }).scratchOrgInfoId;
         const resumeMessage = messages.getMessage('action.resume', [this.config.bin, scratchOrgInfoId]);
 

src/commands/org/resume/scratch.ts

@@ -14,13 +14,11 @@ import {
   ScratchOrgCache,
   ScratchOrgLifecycleEvent,
   scratchOrgLifecycleEventName,
-  scratchOrgLifecycleStages,
   scratchOrgResume,
   SfError,
 } from '@salesforce/core';
-import terminalLink from 'terminal-link';
-import { MultiStageOutput } from '@oclif/multi-stage-output';
 import { ScratchCreateResponse } from '../../../shared/orgTypes.js';
+import { buildStatus } from '../../../shared/scratchOrgOutput.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-org', 'resume_scratch');
@@ -57,60 +55,26 @@ export default class OrgResumeScratch extends SfCommand<ScratchCreateResponse> {
 
     // oclif doesn't know that the exactlyOne flag will ensure that one of these is set, and there we definitely have a jobID.
     assert(jobId);
-    const cached = cache.get(jobId);
-    const hubBaseUrl = cached?.hubBaseUrl;
-
-    const stager = new MultiStageOutput<ScratchOrgLifecycleEvent & { alias: string | undefined }>({
-      stages: scratchOrgLifecycleStages,
-      title: 'Resuming Scratch Org',
-      data: { alias: cached?.alias },
-      jsonEnabled: this.jsonEnabled(),
-      postStagesBlock: [
-        {
-          label: 'Request Id',
-          type: 'dynamic-key-value',
-          get: (data) =>
-            data?.scratchOrgInfo?.Id && terminalLink(data.scratchOrgInfo.Id, `${hubBaseUrl}/${data.scratchOrgInfo.Id}`),
-          bold: true,
-        },
-        {
-          label: 'OrgId',
-          type: 'dynamic-key-value',
-          get: (data) => data?.scratchOrgInfo?.ScratchOrg,
-          bold: true,
-          color: 'cyan',
-        },
-        {
-          label: 'Username',
-          type: 'dynamic-key-value',
-          get: (data) => data?.scratchOrgInfo?.SignupUsername,
-          bold: true,
-          color: 'cyan',
-        },
-        {
-          label: 'Alias',
-          type: 'static-key-value',
-          get: (data) => data?.alias,
-        },
-      ],
-    });
+    const hubBaseUrl = cache.get(jobId)?.hubBaseUrl;
+    let lastStatus: string | undefined;
 
     lifecycle.on<ScratchOrgLifecycleEvent>(scratchOrgLifecycleEventName, async (data): Promise<void> => {
-      stager.goto(data.stage, data);
-      if (data.stage === 'done') {
-        stager.stop();
-      }
+      lastStatus = buildStatus(data, hubBaseUrl);
+      this.spinner.status = lastStatus;
       return Promise.resolve();
     });
 
+    this.log();
+    this.spinner.start('Creating Scratch Org');
+
     try {
       const { username, scratchOrgInfo, authFields, warnings } = await scratchOrgResume(jobId);
+      this.spinner.stop(lastStatus);
+
       this.log();
       this.logSuccess(messages.getMessage('success'));
       return { username, scratchOrgInfo, authFields, warnings, orgId: authFields?.orgId };
     } catch (e) {
-      stager.stop(e as Error);
-
       if (cache.keys() && e instanceof Error && e.name === 'CacheMissError') {
         // we have something in the cache, but it didn't match what the user passed in
         throw messages.createError('error.jobIdMismatch', [jobId]);

src/shared/scratchOrgOutput.ts

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { ScratchOrgLifecycleEvent, scratchOrgLifecycleStages } from '@salesforce/core';
+import ansis from 'ansis';
+import { capitalCase } from 'change-case';
+import { StandardColors } from '@salesforce/sf-plugins-core';
+
+const boldBlue = (input: string): string => ansis.rgb(81, 176, 235).bold(input);
+const boldPurple = (input: string): string => ansis.rgb(157, 129, 221).bold(input);
+
+export const buildStatus = (data: ScratchOrgLifecycleEvent, baseUrl: string): string => `
+RequestId: ${formatRequest(baseUrl, data.scratchOrgInfo?.Id)}
+OrgId: ${formatOrgId(data.scratchOrgInfo?.ScratchOrg)}
+Username: ${formatUsername(data.scratchOrgInfo?.SignupUsername)}
+${formatStage(data.stage)}`;
+
+export const formatStage = (currentStage: ScratchOrgLifecycleEvent['stage']): string =>
+  scratchOrgLifecycleStages
+    .map((stage, stageIndex) => {
+      // current stage
+      if (currentStage === stage) return formatCurrentStage(stage);
+      // completed stages
+      if (scratchOrgLifecycleStages.indexOf(currentStage) > stageIndex) return formatCompletedStage(stage);
+      // future stage
+      return formatFutureStage(stage);
+    })
+    .join('\n');
+
+export const formatRequest = (baseUrl: string, id?: string): string =>
+  `${id ? `${ansis.bold(id)} (${baseUrl}/${id})` : ''}`;
+
+export const formatUsername = (username?: string): string => `${username ? `${boldBlue(username)} ` : ''}`;
+export const formatOrgId = (id?: string): string => `${id ? `${boldBlue(id)} ` : ''}`;
+
+export const formatCurrentStage = (stage: string): string => boldPurple(capitalCase(stage));
+export const formatCompletedStage = (stage: string): string => StandardColors.success.bold(`✓ ${capitalCase(stage)}`);
+export const formatFutureStage = (stage: string): string => StandardColors.info(capitalCase(stage));

test/shared/scratchOrgOutput.test.ts

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { scratchOrgLifecycleStages, ScratchOrgInfo } from '@salesforce/core';
+import { expect } from 'chai';
+import {
+  buildStatus,
+  formatCompletedStage,
+  formatCurrentStage,
+  formatFutureStage,
+  formatOrgId,
+  formatRequest,
+  formatStage,
+  formatUsername,
+} from '../../src/shared/scratchOrgOutput.js';
+
+describe('human output', () => {
+  describe('stage formatter', () => {
+    it('highlights 1st stage with color, remaining are dimmed', () => {
+      const result = formatStage(scratchOrgLifecycleStages[0]);
+      expect(result).includes(formatCurrentStage(scratchOrgLifecycleStages[0]));
+      scratchOrgLifecycleStages.slice(1).forEach((stage) => {
+        expect(result).includes(formatFutureStage(stage));
+      });
+    });
+    it('highlights other stage with color and previous as green', () => {
+      const result = formatStage(scratchOrgLifecycleStages[1]);
+      expect(result).includes(formatCurrentStage(scratchOrgLifecycleStages[1]));
+      expect(result).includes(formatCompletedStage(scratchOrgLifecycleStages[0]));
+      scratchOrgLifecycleStages.slice(2).forEach((stage) => {
+        expect(result).includes(formatFutureStage(stage));
+      });
+    });
+  });
+  describe('overall output', () => {
+    const baseUrl = 'https://ut.my.salesforce.com';
+    const scratchOrgInfo: ScratchOrgInfo = {
+      Id: '2SR3u0000008VBXGA2',
+      ScratchOrg: '00D0x000000Lf9E',
+      SignupUsername: '[email protected]',
+      LoginUrl: 'https://ut.my.salesforce.com',
+      AuthCode: 'x',
+      Username: '[email protected]',
+      SignupEmail: 'x',
+      Status: 'Active',
+      SignupInstance: '',
+    };
+
+    it('shows all fields when all data is present', () => {
+      const output = buildStatus(
+        { stage: scratchOrgLifecycleStages[scratchOrgLifecycleStages.length - 1], scratchOrgInfo },
+        baseUrl
+      );
+      expect(output).includes(`RequestId: ${formatRequest(baseUrl, scratchOrgInfo.Id)}`);
+      expect(output).includes(`OrgId: ${formatOrgId(scratchOrgInfo.ScratchOrg)}`);
+      expect(output).includes(`Username: ${formatUsername(scratchOrgInfo.SignupUsername)}`);
+      expect(output).not.includes('}');
+      expect(output).not.includes('{');
+    });
+
+    it('still shows all field names when no data is present', () => {
+      const output = buildStatus({ stage: scratchOrgLifecycleStages[0] }, baseUrl);
+      expect(output).includes('RequestId: ');
+      expect(output).includes('OrgId: ');
+      expect(output).includes('RequestId: ');
+    });
+  });
+});

test/shared/scratchOrgRequest.test.ts

@@ -8,17 +8,17 @@ import { Config, Interfaces } from '@oclif/core';
 import { expect } from 'chai';
 import { MockTestOrgData, TestContext } from '@salesforce/core/testSetup';
 import { buildScratchOrgRequest } from '../../src/shared/scratchOrgRequest.js';
-import OrgCreateScratch from '../../src/commands/org/create/scratch.js';
+import EnvCreateScratch from '../../src/commands/org/create/scratch.js';
 
-class Wrapper extends OrgCreateScratch {
+class Wrapper extends EnvCreateScratch {
   // simple method to return the parsed flags so they can be used in the tests
   public async getFlags(): Promise<Interfaces.InferredFlags<typeof Wrapper.flags>> {
     return (await this.parse(Wrapper)).flags;
   }
 }
 
 /** pass in the params in array form, get back the parsed flags */
-const paramsToFlags = async (params: string[]): Promise<Interfaces.InferredFlags<typeof OrgCreateScratch.flags>> =>
+const paramsToFlags = async (params: string[]): Promise<Interfaces.InferredFlags<typeof EnvCreateScratch.flags>> =>
   new Wrapper(params, { runHook: () => ({ successes: [], failures: [] }) } as unknown as Config).getFlags();
 
 describe('buildScratchOrgRequest function', () => {

test/unit/org/resumeScratch.test.ts

@@ -34,7 +34,7 @@ describe('org:resume:scratch', () => {
     });
 
     try {
-      await OrgResumeScratch.run(['--job-id', '2SRFOOFOOFOOFOOFOO', '--json']);
+      await OrgResumeScratch.run(['--job-id', '2SRFOOFOOFOOFOOFOO']);
       expect(false, 'ResumeSandbox should have thrown sandboxCreateNotComplete');
     } catch (err: unknown) {
       const error = err as SfError;
@@ -50,7 +50,7 @@ describe('org:resume:scratch', () => {
     });
 
     try {
-      await OrgResumeScratch.run(['--job-id', '2SRFOOFOOFOOFOOFOO', '--json']);
+      await OrgResumeScratch.run(['--job-id', '2SRFOOFOOFOOFOOFOO']);
       expect(false, 'ResumeSandbox should have thrown sandboxCreateNotComplete');
     } catch (err: unknown) {
       const error = err as SfError;