Wr/timeout message (#967)

* refactor: rename files to avoid using command when not a base command

* refactor: consolidate bulk utils

* refactor: consolidate types

* chore: delete defunct dataSoqlQueryTypes

* fix: catch timeout error, so timeout handler will handle

* chore: use type imports

* docs: update messages

Author: WillieRuemmele

messages/bulk.base.command.md

@@ -1,3 +1,28 @@
+# success
+
+Bulk %s request %s started successfully.
+
+# checkStatus
+
+Run the command "sf data %s resume -i %s -o %s" to check the status.
+
+# checkJobViaUi
+
+To review the details of this job, run:
+sf org open --target-org %s --path "/lightning/setup/AsyncApiJobStatus/page?address=%2F%s"
+
+# remainingTimeStatus
+
+Remaining time: %d minutes.
+
+# remainingRecordsStatus
+
+Processed %d | Success %d | Fail %d
+
+# bulkJobFailed
+
+The bulk job %s failed. Check the job status for more information.
+
 # perfLogLevelOption
 
 Get API performance data.

messages/messages.md

@@ -7,7 +7,6 @@
 
 import path from 'node:path';
 import fs from 'node:fs';
-
 import { Logger, Messages, Org, SfError, Lifecycle } from '@salesforce/core';
 import type { DescribeSObjectResult, QueryResult } from '@jsforce/jsforce-node';
 import { Ux } from '@salesforce/sf-plugins-core';
@@ -17,7 +16,7 @@ import {
   hasNestedRecords,
   SObjectTreeFileContents,
   SObjectTreeInput,
-} from '../../../dataSoqlQueryTypes.js';
+} from '../../../types.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data', 'exportApi');

src/BulkBaseCommand.ts

@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { SObjectTreeInput } from '../../../dataSoqlQueryTypes.js';
+import type { SObjectTreeInput } from '../../../types.js';
 
 /** This is the format for references created by the export command */
 const genericRefRegex = new RegExp('^@\\w+Ref\\d+$');

src/api/data/tree/exportApi.ts

@@ -11,10 +11,8 @@ import path, { dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { AnyJson, Dictionary, getString, JsonMap } from '@salesforce/ts-types';
 import { Logger, Messages, Org, SchemaValidator, SfError } from '@salesforce/core';
-import { DataPlanPart, hasNestedRecords, isAttributesElement, SObjectTreeInput } from '../../../dataSoqlQueryTypes.js';
-import { TreeResponse } from './importTypes.js';
-import { ResponseRefs } from './importTypes.js';
-import { ImportResults } from './importTypes.js';
+import { DataPlanPart, hasNestedRecords, isAttributesElement, SObjectTreeInput } from '../../../types.js';
+import { TreeResponse, ResponseRefs, ImportResults } from './importTypes.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data', 'importApi');

src/api/data/tree/functions.ts

@@ -5,8 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import { Connection, SfError, Messages } from '@salesforce/core';
-import { SObjectTreeInput, SObjectTreeFileContents } from '../../../dataSoqlQueryTypes.js';
-import { ResponseRefs, TreeResponse } from './importTypes.js';
+import type { SObjectTreeInput, SObjectTreeFileContents } from '../../../types.js';
+import type { ResponseRefs, TreeResponse } from './importTypes.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data', 'importApi');

src/api/data/tree/importApi.ts

@@ -8,14 +8,14 @@ import fs from 'node:fs';
 import { Logger, Connection, Messages } from '@salesforce/core';
 import { isFulfilled } from '@salesforce/kit';
 import { flattenNestedRecords } from '../../../export.js';
-import { SObjectTreeInput, isAttributesEntry } from '../../../dataSoqlQueryTypes.js';
+import { SObjectTreeInput, isAttributesEntry } from '../../../types.js';
 import {
   sendSObjectTreeRequest,
   treeSaveErrorHandler,
   parseDataFileContents,
   getResultsIfNoError,
 } from './importCommon.js';
-import { ImportResult, ResponseRefs, TreeResponse } from './importTypes.js';
+import type { ImportResult, ResponseRefs, TreeResponse } from './importTypes.js';
 import { hasUnresolvedRefs } from './functions.js';
 
 export type FileInfo = {

src/api/data/tree/importCommon.ts

@@ -12,9 +12,8 @@ import { createHash } from 'node:crypto';
 
 import { AnyJson, isString } from '@salesforce/ts-types';
 import { Logger, SchemaValidator, SfError, Connection, Messages } from '@salesforce/core';
-import { GenericObject } from '../../../types.js';
-import { SObjectTreeInput } from '../../../dataSoqlQueryTypes.js';
-import { DataPlanPartFilesOnly, ImportResult } from './importTypes.js';
+import type { GenericObject, SObjectTreeInput } from '../../../types.js';
+import type { DataPlanPartFilesOnly, ImportResult } from './importTypes.js';
 import {
   getResultsIfNoError,
   parseDataFileContents,

src/api/data/tree/importFiles.ts

@@ -4,8 +4,8 @@
  * 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 { Dictionary } from '@salesforce/ts-types';
-import { DataPlanPart } from '../../../dataSoqlQueryTypes.js';
+import type { Dictionary } from '@salesforce/ts-types';
+import type { DataPlanPart } from '../../../types.js';
 
 /*
  * Copyright (c) 2023, salesforce.com, inc.

src/api/data/tree/importPlan.ts

@@ -7,7 +7,7 @@
 
 import { TTLConfig, Global, Logger, Messages, Org } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
-import { ResumeOptions } from './types.js';
+import type { ResumeOptions } from './types.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data', 'messages');

src/api/data/tree/importTypes.ts

@@ -9,7 +9,7 @@ import { ReadStream } from 'node:fs';
 import os from 'node:os';
 import { Flags, SfCommand } from '@salesforce/sf-plugins-core';
 import { Duration } from '@salesforce/kit';
-import { Connection, Messages } from '@salesforce/core';
+import { Connection, Messages, SfError } from '@salesforce/core';
 import { Ux } from '@salesforce/sf-plugins-core/Ux';
 import type { Schema } from '@jsforce/jsforce-node';
 import {
@@ -21,15 +21,17 @@ import {
 } from '@jsforce/jsforce-node/lib/api/bulk2.js';
 import { orgFlags } from './flags.js';
 import { BulkDataRequestCache, BulkDeleteRequestCache, BulkUpsertRequestCache } from './bulkDataRequestCache.js';
-import { BulkResultV2 } from './types.js';
+import type { BulkResultV2 } from './types.js';
 import {
   POLL_FREQUENCY_MS,
   isBulkV2RequestDone,
   transformResults,
   validateSobjectType,
   remainingTime,
+  displayBulkV2Result,
+  getRemainingTimeStatus,
+  setupLifecycleListeners,
 } from './bulkUtils.js';
-import { displayBulkV2Result, getRemainingTimeStatus, setupLifecycleListeners } from './BulkBaseCommand.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data', 'bulk.operation.command');
@@ -100,7 +102,7 @@ export const runBulkOperation = async ({
   const isAsync = !wait;
   try {
     const [cache] = await Promise.all([getCache(operation), validateSobjectType(sobject, connection)]);
-    const csvRecords: ReadStream = fs.createReadStream(csvFileName, { encoding: 'utf-8' });
+    const csvRecords = fs.createReadStream(csvFileName, { encoding: 'utf-8' });
     cmd.spinner.start(`Running ${isAsync ? 'async ' : ''}bulk ${operation} request`);
     const endWaitTime = Date.now() + wait.milliseconds;
     // eslint-disable-next-line no-param-reassign
@@ -185,7 +187,14 @@ const executeBulkV2DataRequest = async <J extends Schema>(
   job.emit('jobProgress', { remainingTime: remainingTime(Date.now())(endWaitTime), stage: 'uploadComplete' });
   await job.close();
   if (endWaitTime && Date.now() < endWaitTime) {
-    await job.poll(POLL_FREQUENCY_MS, remainingTime(Date.now())(endWaitTime));
+    try {
+      await job.poll(POLL_FREQUENCY_MS, remainingTime(Date.now())(endWaitTime));
+    } catch (e) {
+      if (e instanceof Error && e.name !== 'JobPollingTimeout') {
+        // timeout errors are handled by the 'job.once('jobTimeout')' listener - throw anything else
+        throw SfError.wrap(e);
+      }
+    }
   }
   return job.check();
 };