feat: report command, refactor, mso updates

Author: iowillhoit

messages/data-seeding.report.md

@@ -0,0 +1,22 @@
+# summary
+
+View the status of a data seeding job
+
+# description
+
+View the status of a data seeding 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 job.
+
+# flags.use-most-recent.summary
+
+View status of most recent data seeding job.

package.json

@@ -6,7 +6,7 @@
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
     "@oclif/core": "^4",
-    "@oclif/multi-stage-output": "^0.3.4",
+    "@oclif/multi-stage-output": "^0.4.0",
     "@salesforce/core": "^8.2.7",
     "@salesforce/kit": "^3.2.1",
     "@salesforce/sf-plugins-core": "^11.3.3",
@@ -201,4 +201,4 @@
   },
   "exports": "./lib/index.js",
   "type": "module"
-}
+}

src/commands/data-seeding/generate.ts

@@ -8,21 +8,12 @@
 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 } from '../../utils/mso.js';
+import { initiateDataSeed, pollSeedStatus, PollSeedResponse } from '../../utils/api.js';
+import { getSeedGenerateMso, getSeedGenerateStage as getStage } from '../../utils/mso.js';
+import { DataSeedingGenerateResult } from '../../utils/types.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data-seeding', 'data-seeding.generate');
-
-export type DataSeedingGenerateResult = {
-  dataSeedingJob: string;
-  jobId: string;
-  startTime?: string;
-  endTime?: string;
-  sourceOrg: string;
-  targetOrg: string;
-  status?: string;
-};
 export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateResult> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly description = messages.getMessage('description');
@@ -62,18 +53,22 @@ export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateRe
 
   public async run(): Promise<DataSeedingGenerateResult> {
     const { flags } = await this.parse(DataSeedingGenerate);
-    const {
-      async,
-      'config-file': configFile,
-      'source-org': sourceOrg,
-      'target-org': targetOrg,
-      wait
-    } = flags;
+    const { async, 'config-file': configFile, 'source-org': sourceOrg, 'target-org': targetOrg, wait } = flags;
 
     const { request_id: jobId } = await initiateDataSeed(configFile);
 
     if (!jobId) throw new Error('Failed to receive job id');
 
+    const buildResponse = (response: PollSeedResponse): DataSeedingGenerateResult => ({
+      dataSeedingJob: 'generate',
+      jobId,
+      startTime: response?.execution_start_time,
+      endTime: response?.execution_end_time,
+      sourceOrg,
+      targetOrg,
+      status: response.status,
+    });
+
     // TODO: Cache the jobId so that it can be used by the `--use-most-recent` flag
 
     if (wait && !async) {
@@ -83,57 +78,45 @@ export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateRe
       const options: PollingClient.Options = {
         poll: async (): Promise<StatusResult> => {
           const response = await pollSeedStatus(jobId);
-          mso.goto(response.step);
 
-          mso.updateData({
+          mso.goto(getStage(response.step), {
             startTime: response.execution_start_time,
             endTime: response.execution_end_time,
-            status: response.status
-          })
-
-          const completed = response.status === 'Completed'
-          const failed = response.status === 'Failed';
-
-          if (completed) mso.stop();
-          if (failed) {
-            const err = new SfError(`Data seeding job failed on step: ${response.step}\nLog Text: ${response.log_text}`);
-            mso.stop(err);
-            throw err;
-          }
+            status: response.status,
+          });
 
           return {
-            completed: completed || failed,
+            completed: response.status === 'Completed' || response.status === 'Failed',
             payload: response,
           };
         },
         frequency: Duration.seconds(1),
-        timeout: wait
+        timeout: wait,
       };
 
       try {
         const client = await PollingClient.create(options);
         const pollResult: PollSeedResponse = await client.subscribe();
 
-        return {
-          dataSeedingJob: 'generate',
-          jobId,
-          startTime: pollResult?.execution_start_time,
-          endTime: pollResult?.execution_end_time,
-          sourceOrg,
-          targetOrg,
-          status: pollResult.status
+        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();
         }
+
+        return buildResponse(pollResult);
       } catch (e) {
         const err = SfError.wrap(e as Error);
 
         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}`
+            `- Check the status with: sf data-seeding report -i ${jobId}`,
           ];
         }
+
         mso.stop();
         throw err;
       }
@@ -143,33 +126,21 @@ export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateRe
       const mso = getSeedGenerateMso({
         jsonEnabled: this.jsonEnabled(),
         showElapsedTime: false,
-        showStageTime: false
+        showStageTime: false,
       });
 
-      mso.goto(response.step);
-
-      mso.updateData({
+      mso.goto(getStage(response.step), {
         jobId,
         sourceOrg,
         targetOrg,
         startTime: response.execution_start_time,
-        status: 'Initiated'
-      })
+        status: 'Initiated',
+      });
 
       mso.stop();
-
-      this.log('Data seeding process has been initiated\n');
       this.log(`- Check the status with: sf data-seeding report -i ${jobId}`);
 
-      return {
-        dataSeedingJob: 'generate',
-        jobId,
-        startTime: response?.execution_start_time,
-        endTime: response?.execution_end_time,
-        sourceOrg,
-        targetOrg,
-        status: response.status
-      };
+      return buildResponse(response);
     }
   }
 }

src/commands/data-seeding/report.ts

@@ -0,0 +1,81 @@
+/*
+ * Copyright (c) 2023, 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 { 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';
+
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-data-seeding', 'data-seeding.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> {
+  public static readonly summary = messages.getMessage('summary');
+  public static readonly description = messages.getMessage('description');
+  public static readonly examples = messages.getMessages('examples');
+
+  public static readonly flags = {
+    'job-id': Flags.string({
+      summary: messages.getMessage('flags.job-id.summary'),
+      char: 'i',
+      exclusive: ['use-most-recent'],
+    }),
+    'use-most-recent': Flags.boolean({
+      summary: messages.getMessage('flags.use-most-recent.summary'),
+      char: 'r',
+      exclusive: ['job-id'],
+    }),
+  };
+
+  public async run(): Promise<DataSeedingReportResult> {
+    const { flags } = await this.parse(DataSeedingReport);
+
+    const jobId = flags['job-id'] ?? 'getMostRecentJobIdFromCache()';
+
+    const response = await pollSeedStatus(jobId);
+
+    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,
+    });
+
+    switch (response.status) {
+      case 'Completed':
+        mso.stop();
+        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}`);
+      default:
+        mso.stop();
+    }
+
+    return {
+      dataSeedingJob: 'generate',
+      jobId,
+      startTime: response.execution_start_time,
+      endTime: response.execution_end_time,
+      status: response.status,
+    };
+  }
+}

src/utils/api.ts

@@ -12,8 +12,8 @@ import FormData from 'form-data';
 import { SfError, Logger } from '@salesforce/core';
 
 export type SeedResponse = {
-  'request_id': string;
-}
+  request_id: string;
+};
 
 export type PollSeedResponse = {
   execution_end_time: string;
@@ -22,7 +22,7 @@ export type PollSeedResponse = {
   request_id: string;
   status: string;
   step: string;
-}
+};
 
 const baseUrl = process.env.SF_DATA_SEEDING_URL ?? 'https://data-seed-scratchpad5.sfdc-3vx9f4.svc.sfdcfc.net';
 const csrfUrl = `${baseUrl}/get-csrf-token`;
@@ -33,17 +33,17 @@ export const getCookieJar = async (): Promise<CookieJar> => {
   const cookieJar = new CookieJar();
   await got(csrfUrl, { cookieJar });
   return cookieJar;
-}
+};
 
 export const getCsrfToken = (cookieJar: CookieJar): string => {
   const csrfToken = cookieJar.getCookiesSync(csrfUrl).find((cookie) => cookie.key === 'csrf_token')?.value;
-  if (!csrfToken) throw new SfError('Failed to obtain CSRF token')
+  if (!csrfToken) throw new SfError('Failed to obtain CSRF token');
 
   return csrfToken;
-}
+};
 
 export const initiateDataSeed = async (config: string): Promise<SeedResponse> => {
-  const cookieJar = await getCookieJar()
+  const cookieJar = await getCookieJar();
   const csrf = getCsrfToken(cookieJar);
 
   const form = new FormData();
@@ -66,14 +66,21 @@ export const initiateDataSeed = async (config: string): Promise<SeedResponse> =>
   }
 
   return JSON.parse(response.body);
-}
+};
 
 export const pollSeedStatus = async (jobId: string): Promise<PollSeedResponse> => {
   const logger = await Logger.child('PollSeedStatus');
-  const body: PollSeedResponse = await got.get(`${pollUrl}/${jobId}`).json();
 
-  if (!body) throw new SfError('Polling endpoint failed to return a response');
-  logger.debug(body);
+  // NOTE: This could be updated to use .json() instead of JSON.parse once the Error response is changed to be JSON
+  const response = await got.get(`${pollUrl}/${jobId}`, { throwHttpErrors: false });
+
+  if (response.statusCode !== 200) {
+    // This endpoint returns debugger output... dont print body
+    throw new SfError(`Failed to poll data seeding status for ${jobId}`);
+  }
+
+  const json = JSON.parse(response.body);
+  logger.debug(json);
 
-  return body;
-}
+  return json;
+};