cleanup

Author: clavery

packages/b2c-cli/src/commands/job/base.ts

@@ -1,12 +1,12 @@
 import {Flags} from '@oclif/core';
+import {JobCommand} from '@salesforce/b2c-tooling/cli';
 import {
   siteArchiveExportToPath,
   JobExecutionError,
   type SiteArchiveExportResult,
   type ExportDataUnitsConfiguration,
 } from '@salesforce/b2c-tooling/operations/jobs';
 import {t} from '../../i18n/index.js';
-import {JobCommand} from './base.js';
 
 export default class JobExport extends JobCommand<typeof JobExport> {
   static description = t(
@@ -157,7 +157,7 @@ export default class JobExport extends JobCommand<typeof JobExport> {
               const elapsedSec = Math.floor(elapsed / 1000);
               this.log(
                 t('commands.job.export.progress', '  Status: {{status}} ({{elapsed}}s elapsed)', {
-                  status: exec.executionStatus,
+                  status: exec.execution_status,
                   elapsed: elapsedSec.toString(),
                 }),
               );
@@ -169,7 +169,7 @@ export default class JobExport extends JobCommand<typeof JobExport> {
       const durationSec = result.execution.duration ? (result.execution.duration / 1000).toFixed(1) : 'N/A';
       this.log(
         t('commands.job.export.completed', 'Export completed: {{status}} (duration: {{duration}}s)', {
-          status: result.execution.exitStatus || result.execution.executionStatus,
+          status: result.execution.exit_status?.code || result.execution.execution_status,
           duration: durationSec,
         }),
       );
@@ -198,7 +198,7 @@ export default class JobExport extends JobCommand<typeof JobExport> {
         }
         this.error(
           t('commands.job.export.failed', 'Export failed: {{status}}', {
-            status: error.execution.exitStatus || 'ERROR',
+            status: error.execution.exit_status?.code || 'ERROR',
           }),
         );
       }

packages/b2c-cli/src/commands/job/export.ts

@@ -1,11 +1,11 @@
 import {Args, Flags} from '@oclif/core';
+import {JobCommand} from '@salesforce/b2c-tooling/cli';
 import {
   siteArchiveImport,
   JobExecutionError,
   type SiteArchiveImportResult,
 } from '@salesforce/b2c-tooling/operations/jobs';
 import {t} from '../../i18n/index.js';
-import {JobCommand} from './base.js';
 
 export default class JobImport extends JobCommand<typeof JobImport> {
   static args = {
@@ -88,7 +88,7 @@ export default class JobImport extends JobCommand<typeof JobImport> {
               const elapsedSec = Math.floor(elapsed / 1000);
               this.log(
                 t('commands.job.import.progress', '  Status: {{status}} ({{elapsed}}s elapsed)', {
-                  status: exec.executionStatus,
+                  status: exec.execution_status,
                   elapsed: elapsedSec.toString(),
                 }),
               );
@@ -100,7 +100,7 @@ export default class JobImport extends JobCommand<typeof JobImport> {
       const durationSec = result.execution.duration ? (result.execution.duration / 1000).toFixed(1) : 'N/A';
       this.log(
         t('commands.job.import.completed', 'Import completed: {{status}} (duration: {{duration}}s)', {
-          status: result.execution.exitStatus || result.execution.executionStatus,
+          status: result.execution.exit_status?.code || result.execution.execution_status,
           duration: durationSec,
         }),
       );
@@ -121,7 +121,7 @@ export default class JobImport extends JobCommand<typeof JobImport> {
         }
         this.error(
           t('commands.job.import.failed', 'Import failed: {{status}}', {
-            status: error.execution.exitStatus || 'ERROR',
+            status: error.execution.exit_status?.code || 'ERROR',
           }),
         );
       }

packages/b2c-cli/src/commands/job/import.ts

@@ -1,7 +1,7 @@
 import {Args, Flags} from '@oclif/core';
+import {JobCommand} from '@salesforce/b2c-tooling/cli';
 import {executeJob, waitForJob, JobExecutionError, type JobExecution} from '@salesforce/b2c-tooling/operations/jobs';
 import {t} from '../../i18n/index.js';
-import {JobCommand} from './base.js';
 
 export default class JobRun extends JobCommand<typeof JobRun> {
   static args = {
@@ -83,7 +83,7 @@ export default class JobRun extends JobCommand<typeof JobRun> {
     this.log(
       t('commands.job.run.started', 'Job started: {{executionId}} (status: {{status}})', {
         executionId: execution.id,
-        status: execution.executionStatus,
+        status: execution.execution_status,
       }),
     );
 
@@ -92,14 +92,14 @@ export default class JobRun extends JobCommand<typeof JobRun> {
       this.log(t('commands.job.run.waiting', 'Waiting for job to complete...'));
 
       try {
-        execution = await waitForJob(this.instance, jobId, execution.id, {
+        execution = await waitForJob(this.instance, jobId, execution.id!, {
           timeout: timeout ? timeout * 1000 : undefined,
           onProgress: (exec, elapsed) => {
             if (!this.jsonEnabled()) {
               const elapsedSec = Math.floor(elapsed / 1000);
               this.log(
                 t('commands.job.run.progress', '  Status: {{status}} ({{elapsed}}s elapsed)', {
-                  status: exec.executionStatus,
+                  status: exec.execution_status,
                   elapsed: elapsedSec.toString(),
                 }),
               );
@@ -110,7 +110,7 @@ export default class JobRun extends JobCommand<typeof JobRun> {
         const durationSec = execution.duration ? (execution.duration / 1000).toFixed(1) : 'N/A';
         this.log(
           t('commands.job.run.completed', 'Job completed: {{status}} (duration: {{duration}}s)', {
-            status: execution.exitStatus || execution.executionStatus,
+            status: execution.exit_status?.code || execution.execution_status,
             duration: durationSec,
           }),
         );
@@ -121,7 +121,7 @@ export default class JobRun extends JobCommand<typeof JobRun> {
           }
           this.error(
             t('commands.job.run.jobFailed', 'Job failed: {{status}}', {
-              status: error.execution.exitStatus || 'ERROR',
+              status: error.execution.exit_status?.code || 'ERROR',
             }),
           );
         }

packages/b2c-cli/src/commands/job/run.ts

@@ -113,13 +113,15 @@ export default class JobSearch extends InstanceCommand<typeof JobSearch> {
 
     // Rows
     for (const exec of executions) {
-      const status = exec.exitStatus || exec.executionStatus;
-      const startTime = exec.startTime ? exec.startTime.toISOString().replace('T', ' ').slice(0, 19) : 'N/A';
+      const status = exec.exit_status?.code || exec.execution_status;
+      const startTime = exec.start_time
+        ? new Date(exec.start_time).toISOString().replace('T', ' ').slice(0, 19)
+        : 'N/A';
 
       ui.div(
-        {text: exec.id, width: 38, padding: [0, 1, 0, 0]},
-        {text: exec.jobId, width: 30, padding: [0, 1, 0, 0]},
-        {text: status, width: 12, padding: [0, 1, 0, 0]},
+        {text: exec.id ?? '', width: 38, padding: [0, 1, 0, 0]},
+        {text: exec.job_id ?? '', width: 30, padding: [0, 1, 0, 0]},
+        {text: status ?? '', width: 12, padding: [0, 1, 0, 0]},
         {text: startTime, width: 20, padding: [0, 0, 0, 0]},
       );
     }

packages/b2c-cli/src/commands/job/search.ts

@@ -1,7 +1,7 @@
 import {Args, Flags} from '@oclif/core';
+import {JobCommand} from '@salesforce/b2c-tooling/cli';
 import {waitForJob, JobExecutionError, type JobExecution} from '@salesforce/b2c-tooling/operations/jobs';
 import {t} from '../../i18n/index.js';
-import {JobCommand} from './base.js';
 
 export default class JobWait extends JobCommand<typeof JobWait> {
   static args = {
@@ -63,7 +63,7 @@ export default class JobWait extends JobCommand<typeof JobWait> {
             const elapsedSec = Math.floor(elapsed / 1000);
             this.log(
               t('commands.job.wait.progress', '  Status: {{status}} ({{elapsed}}s elapsed)', {
-                status: exec.executionStatus,
+                status: exec.execution_status,
                 elapsed: elapsedSec.toString(),
               }),
             );
@@ -74,7 +74,7 @@ export default class JobWait extends JobCommand<typeof JobWait> {
       const durationSec = execution.duration ? (execution.duration / 1000).toFixed(1) : 'N/A';
       this.log(
         t('commands.job.wait.completed', 'Job completed: {{status}} (duration: {{duration}}s)', {
-          status: execution.exitStatus || execution.executionStatus,
+          status: execution.exit_status?.code || execution.execution_status,
           duration: durationSec,
         }),
       );
@@ -87,7 +87,7 @@ export default class JobWait extends JobCommand<typeof JobWait> {
         }
         this.error(
           t('commands.job.wait.jobFailed', 'Job failed: {{status}}', {
-            status: error.execution.exitStatus || 'ERROR',
+            status: error.execution.exit_status?.code || 'ERROR',
           }),
         );
       }

packages/b2c-cli/src/commands/job/wait.ts

@@ -4,6 +4,7 @@ export type {Flags, Args} from './base-command.js';
 export {OAuthCommand} from './oauth-command.js';
 export {InstanceCommand} from './instance-command.js';
 export {CartridgeCommand} from './cartridge-command.js';
+export {JobCommand} from './job-command.js';
 export {MrtCommand} from './mrt-command.js';
 export {OdsCommand} from './ods-command.js';
 

packages/b2c-tooling/src/cli/index.ts

@@ -0,0 +1,64 @@
+import {Command} from '@oclif/core';
+import {InstanceCommand} from './instance-command.js';
+import {getJobLog, getJobErrorMessage, type JobExecution} from '../operations/jobs/index.js';
+import {t} from '../i18n/index.js';
+
+/**
+ * Base command for job operations.
+ *
+ * Extends InstanceCommand with job-specific functionality like
+ * displaying job logs on failure.
+ *
+ * @example
+ * export default class MyJobCommand extends JobCommand<typeof MyJobCommand> {
+ *   async run(): Promise<void> {
+ *     try {
+ *       await executeJob(this.instance, 'my-job');
+ *     } catch (error) {
+ *       if (error instanceof JobExecutionError) {
+ *         await this.showJobLog(error.execution);
+ *       }
+ *       throw error;
+ *     }
+ *   }
+ * }
+ */
+export abstract class JobCommand<T extends typeof Command> extends InstanceCommand<T> {
+  /**
+   * Display a job's log file content and error message if available.
+   * Outputs to stderr since this is typically shown for failed jobs.
+   *
+   * @param execution - Job execution with log file info
+   */
+  protected async showJobLog(execution: JobExecution): Promise<void> {
+    // Extract error message from failed step executions
+    const errorMessage = getJobErrorMessage(execution);
+
+    if (!execution.is_log_file_existing) {
+      // No log file, but we may still have an error message
+      if (errorMessage) {
+        this.logger.error({errorMessage}, errorMessage);
+      }
+      return;
+    }
+
+    try {
+      const log = await getJobLog(this.instance, execution);
+      const logFileName = execution.log_file_path?.split('/').pop() ?? 'job.log';
+
+      const header = t('cli.job.logHeader', 'Job log ({{logFileName}}):', {logFileName});
+      this.logger.error({log, errorMessage}, `${header}\n${log}`);
+
+      // Log the error message separately if available
+      if (errorMessage) {
+        this.logger.error(t('cli.job.errorMessage', 'Error: {{message}}', {message: errorMessage}));
+      }
+    } catch {
+      this.warn(t('cli.job.logFetchFailed', 'Could not retrieve job log'));
+      // Still try to show error message even if log fetch failed
+      if (errorMessage) {
+        this.logger.error({errorMessage}, errorMessage);
+      }
+    }
+  }
+}

packages/b2c-tooling/src/cli/job-command.ts

@@ -113,13 +113,11 @@ export {
   searchJobExecutions,
   findRunningJobExecution,
   getJobLog,
+  getJobErrorMessage,
   JobExecutionError,
   siteArchiveImport,
   siteArchiveExport,
   siteArchiveExportToPath,
-  // Legacy exports (deprecated)
-  runJob,
-  getJobStatus,
 } from './operations/jobs/index.js';
 export type {
   JobExecution,
@@ -137,8 +135,6 @@ export type {
   ExportDataUnitsConfiguration,
   ExportSitesConfiguration,
   ExportGlobalDataConfiguration,
-  // Legacy exports (deprecated)
-  JobExecutionResult,
 } from './operations/jobs/index.js';
 
 // Operations - Sites

packages/b2c-tooling/src/index.ts

@@ -68,6 +68,7 @@ export {
   searchJobExecutions,
   findRunningJobExecution,
   getJobLog,
+  getJobErrorMessage,
   JobExecutionError,
 } from './run.js';
 
@@ -94,11 +95,3 @@ export type {
   ExportSitesConfiguration,
   ExportGlobalDataConfiguration,
 } from './site-archive.js';
-
-// Legacy exports for backwards compatibility (deprecated)
-/** @deprecated Use executeJob instead */
-export {executeJob as runJob} from './run.js';
-/** @deprecated Use getJobExecution instead */
-export {getJobExecution as getJobStatus} from './run.js';
-/** @deprecated Use JobExecution instead */
-export type {JobExecution as JobExecutionResult} from './run.js';