feat: report commands, restructuring

Author: iowillhoit

config/config.json renamed to config/generate-all.json

@@ -35,3 +35,7 @@ Number of minutes to wait for command to complete.
 # flags.async.summary
 
 Run the command asynchronously.
+
+# report.suggestion
+
+ - Check the status with: sf data-seeding generate report -i %s

config/migrate-products.json

@@ -0,0 +1,23 @@
+# summary
+
+View the status of a data-seeding generate job
+
+# description
+
+View the status of a data-seeding generate job that has already been initiated or completed 
+
+# examples
+
+- Display the status of a specific data seeding job
+  <%= config.bin %> <%= command.id %> --job-id="[XXXX-YYYY-ZZZZ-AAAA]"
+
+- Display the status of a the most recent data seeding job
+  <%= config.bin %> <%= command.id %> --use-most-recent
+
+# flags.job-id.summary
+
+ID of a specific `data-seeding generate` job.
+
+# flags.use-most-recent.summary
+
+View status of most recent `data-seeding generate` job.

messages/data-seeding.generate.md

@@ -0,0 +1,42 @@
+# summary
+
+Migrates data from one org to another
+
+# description
+
+Migrates selected data based on a configuration file from a source org and into a target org
+
+# examples
+
+- Migrate data using a specific configuration file and org aliases
+  
+  $ <%= config.bin %> <%= command.id %> -s sourceOrg -t targetOrg -f "/config/data-seed.json"
+
+- Migrate data using default configuration file and usernames for each org
+  
+  $ <%= config.bin %> <%= command.id %> --source-org="source@org.com" --target-org="target@org.com" --config-file="/config/data-seed.json"
+
+
+# flags.target-org.summary
+
+Username or alias of the Target org where data will be migrated to.
+
+# flags.source-org.summary
+
+Username or alias of the Source org where data will be migrated from.
+
+# flags.config-file.summary
+
+Path to data migration JSON configuration file.
+
+# flags.async.summary
+
+Run the command asynchronously.
+
+# flags.wait.summary
+
+Number of minutes to wait for command to complete.
+
+# report.suggestion
+
+ - Check the status with: sf data-seeding migrate report -i %s

messages/data-seeding.generate.report.md

@@ -1,10 +1,10 @@
 # summary
 
-View the status of a data seeding job
+View the status of a data-seeding migrate job
 
 # description
 
-View the status of a data seeding job that has already been initiated or completed 
+View the status of a data-seeding migrate job that has already been initiated or completed 
 
 # examples
 
@@ -13,10 +13,11 @@ View the status of a data seeding job that has already been initiated or complet
 
 - Display the status of a the most recent data seeding job
   <%= config.bin %> <%= command.id %> --use-most-recent
+
 # flags.job-id.summary
 
-ID of a specific data seeding job.
+ID of a specific `data-seeding migrate` job.
 
 # flags.use-most-recent.summary
 
-View status of most recent data seeding job.
+View status of most recent `data-seeding migrate` job.

messages/data-seeding.migrate.md

@@ -23,6 +23,7 @@
     "eslint-plugin-sf-plugin": "^1.20.5",
     "oclif": "^4.14.19",
     "ts-node": "^10.9.2",
+    "tsx": "^4.19.0",
     "typescript": "^5.5.4"
   },
   "engines": {
@@ -58,7 +59,15 @@
     ],
     "topics": {
       "data-seeding": {
-        "description": "Migrate real data, generate fake data using GenAI, or deploy data files to target orgs"
+        "description": "Migrate real data, generate fake data using GenAI, or deploy data files to target orgs",
+        "subtopics": {
+          "generate": {
+            "description": "description for data-seeding.generate"
+          },
+          "migrate": {
+            "description": "description for data-seeding.migrate"
+          }
+        }
       }
     },
     "flexibleTaxonomy": true
@@ -201,4 +210,4 @@
   },
   "exports": "./lib/index.js",
   "type": "module"
-}
+}

messages/data-seeding.report.md renamed to messages/data-seeding.migrate.report.md

@@ -8,13 +8,14 @@
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages, PollingClient, SfError, StatusResult } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
-import { initiateDataSeed, pollSeedStatus, PollSeedResponse } from '../../utils/api.js';
-import { getSeedGenerateMso, getSeedGenerateStage as getStage } from '../../utils/mso.js';
-import { DataSeedingGenerateResult } from '../../utils/types.js';
-import { GenerateRequestCache } from '../../utils/cache.js';
+import { initiateDataSeed, pollSeedStatus, PollSeedResponse } from '../../../utils/api.js';
+import { getSeedGenerateMso, getSeedGenerateStage as getStage } from '../../../utils/mso.js';
+import { DataSeedingGenerateResult } from '../../../utils/types.js';
+import { GenerateRequestCache } from '../../../utils/cache.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data-seeding', 'data-seeding.generate');
+
 export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateResult> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly description = messages.getMessage('description');
@@ -56,27 +57,27 @@ export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateRe
     const { flags } = await this.parse(DataSeedingGenerate);
     const { async, 'config-file': configFile, 'source-org': sourceOrg, 'target-org': targetOrg, wait } = flags;
 
-    const { request_id: jobId } = await initiateDataSeed(configFile);
+    const { request_id: jobId } = await initiateDataSeed(configFile, 'data-generation');
+
+    const reportMessage = messages.getMessage('report.suggestion', [jobId]);
 
     if (!jobId) throw new Error('Failed to receive job id');
 
+    const baseData = { jobId, sourceOrg, targetOrg };
+
     await (await GenerateRequestCache.create()).createCacheEntry(jobId);
 
     const buildResponse = (response: PollSeedResponse): DataSeedingGenerateResult => ({
       dataSeedingJob: 'generate',
-      jobId,
       startTime: response?.execution_start_time,
       endTime: response?.execution_end_time,
-      sourceOrg,
-      targetOrg,
       status: response.status,
+      ...baseData,
     });
 
-    // TODO: Cache the jobId so that it can be used by the `--use-most-recent` flag
-
     if (wait && !async) {
       const mso = getSeedGenerateMso({ jsonEnabled: this.jsonEnabled() });
-      mso.updateData({ jobId, sourceOrg, targetOrg });
+      mso.updateData(baseData);
 
       const options: PollingClient.Options = {
         poll: async (): Promise<StatusResult> => {
@@ -114,13 +115,12 @@ export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateRe
 
         if (err.message.includes('The client has timed out')) {
           mso.updateData({ status: 'Client Timeout' });
-          err.actions = [
-            '- Increase the value of the "--wait" flag',
-            `- Check the status with: sf data-seeding report -i ${jobId}`,
-          ];
+          err.actions = [ reportMessage ];
+          mso.stop('current');
+        } else {
+          mso.error();
         }
 
-        mso.stop();
         throw err;
       }
     } else {
@@ -133,15 +133,13 @@ export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateRe
       });
 
       mso.goto(getStage(response.step), {
-        jobId,
-        sourceOrg,
-        targetOrg,
+        ...baseData,
         startTime: response.execution_start_time,
         status: 'Initiated',
       });
 
-      mso.stop();
-      this.log(`- Check the status with: sf data-seeding report -i ${jobId}`);
+      mso.stop('current');
+      this.log(reportMessage);
 
       return buildResponse(response);
     }

package.json

@@ -7,18 +7,18 @@
 
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages, SfError } from '@salesforce/core';
-import { pollSeedStatus } from '../../utils/api.js';
-import { getSeedGenerateMso, getSeedGenerateStage as getStage } from '../../utils/mso.js';
-import { DataSeedingReportResult } from '../../utils/types.js';
-import { GenerateRequestCache } from '../../utils/cache.js';
+import { pollSeedStatus } from '../../../utils/api.js';
+import { getSeedGenerateMso, getSeedGenerateStage as getStage } from '../../../utils/mso.js';
+import { DataSeedingReportResult } from '../../../utils/types.js';
+import { GenerateRequestCache } from '../../../utils/cache.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
-const messages = Messages.loadMessages('@salesforce/plugin-data-seeding', 'data-seeding.report');
+const messages = Messages.loadMessages('@salesforce/plugin-data-seeding', 'data-seeding.generate.report');
 
 // TEMP failure (Querying Source Org): 9258aae5-e9b0-4c73-a340-962d299b71bd
 // TEMP failure (Populating Target Org): 0aab5c70-069d-48f5-aa0d-157f745c5dfe
 
-export default class DataSeedingReport extends SfCommand<DataSeedingReportResult> {
+export default class DataSeedingGenerateReport extends SfCommand<DataSeedingReportResult> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly description = messages.getMessage('description');
   public static readonly examples = messages.getMessages('examples');
@@ -37,35 +37,33 @@ export default class DataSeedingReport extends SfCommand<DataSeedingReportResult
   };
 
   public async run(): Promise<DataSeedingReportResult> {
-    const { flags } = await this.parse(DataSeedingReport);
+    const { flags } = await this.parse(DataSeedingGenerateReport);
 
     const jobId = flags['job-id'] ?? (await GenerateRequestCache.create()).resolveFromCache().jobId;
 
     if (!jobId) throw new SfError('No job ID provided or found in cache');
 
     const response = await pollSeedStatus(jobId);
 
+    const data = {
+      jobId,
+      startTime: response.execution_start_time,
+      endTime: response.execution_end_time,
+      status: response.status,
+    };
+
     const mso = getSeedGenerateMso({
       jsonEnabled: this.jsonEnabled(),
       showElapsedTime: false,
       showStageTime: false,
     });
 
-    mso.goto(getStage(response.step), {
-      jobId,
-      startTime: response.execution_start_time,
-      endTime: response.execution_end_time,
-      status: response.status,
-    });
+    mso.goto(getStage(response.step), data);
 
     switch (response.status) {
-      case 'Completed':
-        mso.stop();
+      case 'In Progress':
+        mso.stop('current');
         break;
-      // The 'current' status will be implemented in a future mso update
-      // case 'In Progress':
-      //   mso.stop('current');
-      //   break;
       case 'Failed':
         mso.error();
         throw new SfError(`Failed on step: ${response.step}\nLog Text: ${response.log_text}`);
@@ -75,10 +73,7 @@ export default class DataSeedingReport extends SfCommand<DataSeedingReportResult
 
     return {
       dataSeedingJob: 'generate',
-      jobId,
-      startTime: response.execution_start_time,
-      endTime: response.execution_end_time,
-      status: response.status,
+      ...data,
     };
   }
 }