feat: add --poll-interval flag for retrieve W-18649787

README.md

@@ -141,7 +141,7 @@ FLAG DESCRIPTIONS
     If you specify this flag, don’t specify --metadata or --source-dir.
 ```
 
-_See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/convert/mdapi.ts)_
+_See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/convert/mdapi.ts)_
 
 ## `sf project convert source`
 
@@ -214,7 +214,7 @@ FLAG DESCRIPTIONS
     Override the api version used for api requests made by this command
 ```
 
-_See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/convert/source.ts)_
+_See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/convert/source.ts)_
 
 ## `sf project convert source-behavior`
 
@@ -273,7 +273,7 @@ EXAMPLES
     $ sf project convert source-behavior --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir
 ```
 
-_See code: [src/commands/project/convert/source-behavior.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/convert/source-behavior.ts)_
+_See code: [src/commands/project/convert/source-behavior.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/convert/source-behavior.ts)_
 
 ## `sf project delete source`
 
@@ -413,7 +413,7 @@ FLAG DESCRIPTIONS
     - Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
 ```
 
-_See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/delete/source.ts)_
+_See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/delete/source.ts)_
 
 ## `sf project delete tracking`
 
@@ -450,7 +450,7 @@ EXAMPLES
     $ sf project delete tracking --target-org my-scratch
 ```
 
-_See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/delete/tracking.ts)_
+_See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/delete/tracking.ts)_
 
 ## `sf project deploy cancel`
 
@@ -522,7 +522,7 @@ FLAG DESCRIPTIONS
     project deploy report".
 ```
 
-_See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/deploy/cancel.ts)_
+_See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/deploy/cancel.ts)_
 
 ## `sf project deploy preview`
 
@@ -605,7 +605,7 @@ FLAG DESCRIPTIONS
     All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
 ```
 
-_See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/deploy/preview.ts)_
+_See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/deploy/preview.ts)_
 
 ## `sf project deploy quick`
 
@@ -689,7 +689,7 @@ FLAG DESCRIPTIONS
     deploy report".
 ```
 
-_See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/deploy/quick.ts)_
+_See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/deploy/quick.ts)_
 
 ## `sf project deploy report`
 
@@ -781,7 +781,7 @@ FLAG DESCRIPTIONS
     --coverage-formatters lcov --coverage-formatters clover
 ```
 
-_See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/deploy/report.ts)_
+_See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/deploy/report.ts)_
 
 ## `sf project deploy resume`
 
@@ -866,7 +866,7 @@ FLAG DESCRIPTIONS
     --coverage-formatters lcov --coverage-formatters clover
 ```
 
-_See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/deploy/resume.ts)_
+_See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/deploy/resume.ts)_
 
 ## `sf project deploy start`
 
@@ -1102,7 +1102,7 @@ FLAG DESCRIPTIONS
     --coverage-formatters lcov --coverage-formatters clover
 ```
 
-_See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/deploy/start.ts)_
+_See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/deploy/start.ts)_
 
 ## `sf project deploy validate`
 
@@ -1275,7 +1275,7 @@ FLAG DESCRIPTIONS
     --coverage-formatters lcov --coverage-formatters clover
 ```
 
-_See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/deploy/validate.ts)_
+_See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/deploy/validate.ts)_
 
 ## `sf project generate manifest`
 
@@ -1371,7 +1371,7 @@ EXAMPLES
     $ sf project generate manifest --from-org [email protected] --excluded-metadata StandardValueSet
 ```
 
-_See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/generate/manifest.ts)_
+_See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/generate/manifest.ts)_
 
 ## `sf project list ignored`
 
@@ -1413,7 +1413,7 @@ EXAMPLES
     $ sf project list ignored --source-dir package.xml
 ```
 
-_See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/list/ignored.ts)_
+_See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/list/ignored.ts)_
 
 ## `sf project reset tracking`
 
@@ -1462,7 +1462,7 @@ EXAMPLES
     $ sf project reset tracking --revision 30
 ```
 
-_See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/reset/tracking.ts)_
+_See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/reset/tracking.ts)_
 
 ## `sf project retrieve preview`
 
@@ -1516,7 +1516,7 @@ FLAG DESCRIPTIONS
     production orgs.
 ```
 
-_See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/retrieve/preview.ts)_
+_See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/retrieve/preview.ts)_
 
 ## `sf project retrieve start`
 
@@ -1526,7 +1526,7 @@ Retrieve metadata from an org to your local project.
 USAGE
   $ sf project retrieve start -o <value> [--json] [--flags-dir <value>] [-a <value>] [-c] [-x <value> | -m <value>... | -d
     <value>...] [-r <value> | -n <value>... | ] [--single-package -t <value>] [-w <value>] [-z ] [--zip-file-name
-    <value> ]
+    <value> ] [--poll-interval <seconds>]
 
 FLAGS
   -a, --api-version=<value>      Target API version for the retrieve.
@@ -1543,6 +1543,7 @@ FLAGS
   -w, --wait=<value>             [default: 33 minutes] Number of minutes to wait for the command to complete and display
                                  results to the terminal window.
   -x, --manifest=<value>         File path for the manifest (package.xml) that specifies the components to retrieve.
+      --poll-interval=<seconds>  Number of seconds to wait between status checks.
 
 METADATA API FORMAT FLAGS
   -t, --target-metadata-dir=<value>  Directory that will contain the retrieved metadata format files or ZIP.
@@ -1689,6 +1690,6 @@ FLAG DESCRIPTIONS
     If you specify this flag, don’t specify --metadata or --source-dir.
 ```
 
-_See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.37/src/commands/project/retrieve/start.ts)_
+_See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.22.38-dev.0/src/commands/project/retrieve/start.ts)_
 
 <!-- commandsstop -->

command-snapshot.json

@@ -291,6 +291,7 @@
       "metadata",
       "output-dir",
       "package-name",
+      "poll-interval",
       "single-package",
       "source-dir",
       "target-metadata-dir",

messages/retrieve.start.md

@@ -149,6 +149,10 @@ Extract all files from the retrieved zip file.
 
 File name to use for the retrieved zip file.
 
+# flags.poll-interval.summary
+
+Number of seconds to wait between status checks.
+
 # error.Conflicts
 
 There are changes in your local files that conflict with the org changes you're trying to retrieve.

package.json

@@ -1,20 +1,20 @@
 {
   "name": "@salesforce/plugin-deploy-retrieve",
   "description": "deploy and retrieve commands for sf",
-  "version": "3.22.37",
+  "version": "3.22.38-dev.0",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
     "@inquirer/prompts": "^7.5.3",
     "@oclif/core": "^4.3.0",
     "@oclif/multi-stage-output": "^0.8.19",
     "@salesforce/apex-node": "^8.1.31",
-    "@salesforce/core": "^8.18.1",
+    "@salesforce/core": "^8.18.7",
     "@salesforce/kit": "^3.2.3",
-    "@salesforce/plugin-info": "^3.4.67",
+    "@salesforce/plugin-info": "^3.4.77",
     "@salesforce/sf-plugins-core": "^12.2.2",
-    "@salesforce/source-deploy-retrieve": "^12.22.0",
-    "@salesforce/source-tracking": "^7.4.1",
+    "@salesforce/source-deploy-retrieve": "^12.22.3-dev.0",
+    "@salesforce/source-tracking": "^7.4.10-dev.0",
     "@salesforce/ts-types": "^2.0.12",
     "ansis": "^3.17.0",
     "terminal-link": "^3.0.0"

schemas/project-delete-source.json

@@ -164,7 +164,8 @@
         "Failed",
         "Canceling",
         "Canceled",
-        "Finalizing"
+        "Finalizing",
+        "FinalizingFailed"
       ]
     },
     "DeployDetails": {

schemas/project-deploy-cancel.json

@@ -212,7 +212,8 @@
         "Failed",
         "Canceling",
         "Canceled",
-        "Finalizing"
+        "Finalizing",
+        "FinalizingFailed"
       ]
     },
     "DeployDetails": {

schemas/project-deploy-quick.json

@@ -212,7 +212,8 @@
         "Failed",
         "Canceling",
         "Canceled",
-        "Finalizing"
+        "Finalizing",
+        "FinalizingFailed"
       ]
     },
     "DeployDetails": {

schemas/project-deploy-report.json

@@ -212,7 +212,8 @@
         "Failed",
         "Canceling",
         "Canceled",
-        "Finalizing"
+        "Finalizing",
+        "FinalizingFailed"
       ]
     },
     "DeployDetails": {

schemas/project-deploy-resume.json

@@ -212,7 +212,8 @@
         "Failed",
         "Canceling",
         "Canceled",
-        "Finalizing"
+        "Finalizing",
+        "FinalizingFailed"
       ]
     },
     "DeployDetails": {

schemas/project-deploy-start.json

@@ -212,7 +212,8 @@
         "Failed",
         "Canceling",
         "Canceled",
-        "Finalizing"
+        "Finalizing",
+        "FinalizingFailed"
       ]
     },
     "DeployDetails": {

schemas/project-deploy-validate.json

@@ -212,7 +212,8 @@
         "Failed",
         "Canceling",
         "Canceled",
-        "Finalizing"
+        "Finalizing",
+        "FinalizingFailed"
       ]
     },
     "DeployDetails": {

schemas/project-retrieve-start.json

@@ -200,7 +200,8 @@
         "Failed",
         "Canceling",
         "Canceled",
-        "Finalizing"
+        "Finalizing",
+        "FinalizingFailed"
       ]
     },
     "RetrieveMessage": {

src/commands/project/retrieve/start.ts

@@ -152,6 +152,13 @@ export default class RetrieveMetadata extends SfCommand<RetrieveResultJson> {
       exclusive: ['ignore-conflicts'],
       helpGroup: mdapiFlagGroup,
     }),
+    'poll-interval': Flags.duration({
+      min: Duration.milliseconds(500).seconds,
+      required: false,
+      helpValue: '<seconds>',
+      unit: 'seconds',
+      summary: messages.getMessage('flags.poll-interval.summary'),
+    }),
   };
 
   public static configurationVariablesSection = toHelpSection(
@@ -266,7 +273,7 @@ export default class RetrieveMetadata extends SfCommand<RetrieveResultJson> {
         throw error;
       });
 
-      this.retrieveResult = await retrieve.pollStatus(500, flags.wait.seconds);
+      this.retrieveResult = await retrieve.pollStatus(flags['poll-interval']?.milliseconds ?? 500, flags.wait.seconds);
     }
 
     this.ms.stop();