fix: async stop and partial complete

Author: iowillhoit

package.json

@@ -6,7 +6,7 @@
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
     "@oclif/core": "^4",
-    "@oclif/multi-stage-output": "^0.4.0",
+    "@oclif/multi-stage-output": "^0.5.0",
     "@salesforce/core": "^8.2.7",
     "@salesforce/kit": "^3.2.1",
     "@salesforce/sf-plugins-core": "^11.3.3",

src/commands/data-seeding/generate/index.ts

@@ -79,6 +79,8 @@ export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateRe
       const mso = getSeedGenerateMso({ jsonEnabled: this.jsonEnabled() });
       mso.updateData(baseData);
 
+      const completedStatus = ['Completed', 'Partially Completed', 'Failed'];
+
       const options: PollingClient.Options = {
         poll: async (): Promise<StatusResult> => {
           const response = await pollSeedStatus(jobId);
@@ -90,7 +92,7 @@ export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateRe
           });
 
           return {
-            completed: response.status === 'Completed' || response.status === 'Failed',
+            completed: completedStatus.includes(response.status),
             payload: response,
           };
         },
@@ -102,11 +104,16 @@ export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateRe
         const client = await PollingClient.create(options);
         const pollResult: PollSeedResponse = await client.subscribe();
 
-        if (pollResult.status === 'Failed') {
-          mso.error();
-          throw new SfError(`Data seeding job failed on step: ${pollResult.step}\nLog Text: ${pollResult.log_text}`);
-        } else {
-          mso.stop();
+        switch (pollResult.status) {
+          case 'Failed':
+            mso.error();
+            throw new SfError(`Data seeding job failed on step: ${pollResult.step}\nLog Text: ${pollResult.log_text}`);
+          case 'Partially Completed':
+            mso.stop('warning');
+            this.log(`Process partially completed: ${pollResult.log_text}`);
+            break;
+          default:
+            mso.stop('current');
         }
 
         return buildResponse(pollResult);
@@ -138,7 +145,7 @@ export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateRe
         status: 'Initiated',
       });
 
-      mso.stop('current');
+      mso.stop('async');
       this.log(reportMessage);
 
       return buildResponse(response);

src/commands/data-seeding/generate/report.ts

@@ -64,6 +64,10 @@ export default class DataSeedingGenerateReport extends SfCommand<DataSeedingRepo
       case 'In Progress':
         mso.stop('current');
         break;
+      case 'Partially Completed':
+        mso.stop('warning');
+        this.log(`Process partially completed: ${response.log_text}`);
+        break;
       case 'Failed':
         mso.error();
         throw new SfError(`Failed on step: ${response.step}\nLog Text: ${response.log_text}`);

src/commands/data-seeding/migrate/index.ts

@@ -79,6 +79,8 @@ export default class DataSeedingMigrate extends SfCommand<DataSeedingMigrateResu
       const mso = getSeedMigrateMso({ jsonEnabled: this.jsonEnabled() });
       mso.updateData(baseData);
 
+      const completedStatus = ['Completed', 'Partially Completed', 'Failed'];
+
       const options: PollingClient.Options = {
         poll: async (): Promise<StatusResult> => {
           const response = await pollSeedStatus(jobId);
@@ -90,7 +92,7 @@ export default class DataSeedingMigrate extends SfCommand<DataSeedingMigrateResu
           });
 
           return {
-            completed: response.status === 'Completed' || response.status === 'Failed',
+            completed: completedStatus.includes(response.status),
             payload: response,
           };
         },
@@ -102,11 +104,16 @@ export default class DataSeedingMigrate extends SfCommand<DataSeedingMigrateResu
         const client = await PollingClient.create(options);
         const pollResult: PollSeedResponse = await client.subscribe();
 
-        if (pollResult.status === 'Failed') {
-          mso.error();
-          throw new SfError(`Data migration job failed on step: ${pollResult.step}\nLog Text: ${pollResult.log_text}`);
-        } else {
-          mso.stop();
+        switch (pollResult.status) {
+          case 'Failed':
+            mso.error();
+            throw new SfError(`Data migration job failed on step: ${pollResult.step}\nLog Text: ${pollResult.log_text}`);
+          case 'Partially Completed':
+            mso.stop('warning');
+            this.log(`Process partially completed: ${pollResult.log_text}`);
+            break;
+          default:
+            mso.stop('current');
         }
 
         return buildResponse(pollResult);
@@ -138,7 +145,7 @@ export default class DataSeedingMigrate extends SfCommand<DataSeedingMigrateResu
         status: 'Initiated',
       });
 
-      mso.stop('current');
+      mso.stop('async');
       this.log(reportMessage);
 
       return buildResponse(response);

src/commands/data-seeding/migrate/report.ts

@@ -61,6 +61,10 @@ export default class DataSeedingMigrateReport extends SfCommand<DataSeedingRepor
       case 'In Progress':
         mso.stop('current');
         break;
+      case 'Partially Completed':
+        mso.stop('warning');
+        this.log(`Process partially completed: ${response.log_text}`);
+        break;
       case 'Failed':
         mso.error();
         throw new SfError(`Failed on step: ${response.step}\nLog Text: ${response.log_text}`);

src/utils/mso.ts

@@ -83,6 +83,7 @@ const getSeedMso = (overrides: SeedMsoOverrides = {}): MultiStageOutput<SeedGene
         get: (data): MsoGet => data?.jobId,
         type: 'static-key-value',
         label: 'Job ID',
+        neverCollapse: true,
       },
       {
         get: (data): MsoGet => data?.sourceOrg,
@@ -103,16 +104,18 @@ const getSeedMso = (overrides: SeedMsoOverrides = {}): MultiStageOutput<SeedGene
             case 'Completed':
             case 'Initiated':
               return StandardColors.success(status);
-            case 'Failed':
-              return StandardColors.error(status);
             case 'Client Timeout':
+            case 'Partially Completed':
               return StandardColors.warning(status);
+            case 'Failed':
+              return StandardColors.error(status);
             default:
               return status;
           }
         },
         type: 'static-key-value',
         label: 'Status',
+        neverCollapse: true,
       },
       {
         get: (data): MsoGet => data?.startTime,

yarn.lock

@@ -1682,13 +1682,13 @@
     wordwrap "^1.0.0"
     wrap-ansi "^7.0.0"
 
-"@oclif/multi-stage-output@^0.4.0":
-  version "0.4.0"
-  resolved "https://registry.yarnpkg.com/@oclif/multi-stage-output/-/multi-stage-output-0.4.0.tgz#353f43579e42d087bee3c6595d61dd05cd261327"
-  integrity sha512-nPXFhbYGBlXevzbinLCSg7ZSr87N/L70aQsvzDJjRMJK/b/fXr86khegPX4hIlLXJZOKgTCtko3hTWDH7P6cPw==
+"@oclif/multi-stage-output@^0.5.0":
+  version "0.5.0"
+  resolved "https://registry.yarnpkg.com/@oclif/multi-stage-output/-/multi-stage-output-0.5.0.tgz#92409f46c2825a794f63171f552b64b469b9fd81"
+  integrity sha512-XbeF7ASB7nHDlgyiGO9oxfkf/r5osSMu7C3RT/zl+RxANFEr7scCU2nAJ+9TCgMSGg9/EGgzZ1a1CmKpi/LLdQ==
   dependencies:
     "@oclif/core" "^4"
-    "@types/react" "^18.3.4"
+    "@types/react" "^18.3.5"
     change-case "^5.4.4"
     cli-spinners "^2"
     figures "^6.1.0"
@@ -2580,10 +2580,10 @@
   resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.12.tgz#12bb1e2be27293c1406acb6af1c3f3a1481d98c6"
   integrity sha512-5zvhXYtRNRluoE/jAp4GVsSduVUzNWKkOZrCDBWYtE7biZywwdC2AcEzg+cSMLFRfVgeAFqpfNabiPjxFddV1Q==
 
-"@types/react@^18.3.4":
-  version "18.3.4"
-  resolved "https://registry.yarnpkg.com/@types/react/-/react-18.3.4.tgz#dfdd534a1d081307144c00e325c06e00312c93a3"
-  integrity sha512-J7W30FTdfCxDDjmfRM+/JqLHBIyl7xUIp9kwK637FGmY7+mkSFSe6L4jpZzhj5QMfLssSDP4/i75AKkrdC7/Jw==
+"@types/react@^18.3.5":
+  version "18.3.5"
+  resolved "https://registry.yarnpkg.com/@types/react/-/react-18.3.5.tgz#5f524c2ad2089c0ff372bbdabc77ca2c4dbadf8f"
+  integrity sha512-WeqMfGJLGuLCqHGYRGHxnKrXcTitc6L/nBUWfWPcTarG3t9PsquqUMuVeXZeca+mglY4Vo5GZjCi0A3Or2lnxA==
   dependencies:
     "@types/prop-types" "*"
     csstype "^3.0.2"