Metadata format deploys (#245)

* feat: support metadata format deploys

* chore: regenerate yarn.lock

* chore: update snapshot

* chore: add NUTs

* chore: add file

* ci: exclude windows maintenance

* fix: correctly resume deployments

* fix: dont remove completed deploys from cache

* fix: handle 15 char ids and bump SDR

* chore: update nuts

* chore: fix tests

* chore: fix cancel nut

Co-authored-by: mshanemc <[email protected]>

Author: mdonnalley

.circleci/config.yml

@@ -51,6 +51,9 @@ workflows:
                 - latest
                 - lts
                 - maintenance
+            exclude:
+              - os: windows
+                node_version: maintenance
       - release-management/test-nut:
           context:
             - na40-auth-url
@@ -65,6 +68,7 @@ workflows:
               command:
                 [
                   'yarn test:nuts:deploy:metadata:manifest',
+                  'yarn test:nuts:deploy:metadata:metadata-dir',
                   'yarn test:nuts:deploy:metadata:metadata',
                   'yarn test:nuts:deploy:metadata:source-dir',
                   'yarn test:nuts:deploy:metadata:test-level',

command-snapshot.json

@@ -20,6 +20,8 @@
             "json",
             "manifest",
             "metadata",
+            "metadata-dir",
+            "single-package",
             "source-dir",
             "target-org",
             "test-level",
@@ -89,6 +91,8 @@
             "json",
             "manifest",
             "metadata",
+            "metadata-dir",
+            "single-package",
             "source-dir",
             "target-org",
             "test-level",

messages/deploy.metadata.md

@@ -154,6 +154,14 @@ Run the command asynchronously.
 
 The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run "sf deploy metadata resume". To check the status of the deployment, run "sf deploy metadata report".
 
+# flags.metadata-dir.summary
+
+Root of directory or zip file of metadata formatted files to deploy.
+
+# flags.single-package.summary
+
+Indicates that the metadata zip file points to a directory structure for a single package.
+
 # save.as.default
 
 Save %s as default target-org?

messages/deploy.metadata.resume.md

@@ -56,3 +56,7 @@ Show verbose output of the deploy operation result.
 # flags.concise.summary
 
 Show concise output of the deploy operation result.
+
+# error.DeployNotResumable
+
+Job ID %s is not resumable with status %s.

messages/deploy.metadata.validate.md

@@ -14,7 +14,7 @@ To validate the deployment of multiple metadata components, either set multiple
 
 # examples
 
-- NOTE: These examples focus on validating large deployments.  See the help for "sf deploy metadata" for examples of deploying smaller sets of metadata which you can also use to validate.
+- NOTE: These examples focus on validating large deployments. See the help for "sf deploy metadata" for examples of deploying smaller sets of metadata which you can also use to validate.
 
 - Validate the deployment of all source files in a directory to the default org:
 
@@ -53,9 +53,9 @@ Valid values are:
 - RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.
 
 - RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.
-  
+
 If you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the "Metadata API Developer Guide".
-        
+
 # flags.source-dir.summary
 
 Path to the local source files to validate for deployment.
@@ -114,6 +114,14 @@ Run the command asynchronously.
 
 The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume watching the validation, run "sf deploy metadata resume". To check the status of the validation, run "sf deploy metadata report".
 
+# flags.metadata-dir.summary
+
+Root of directory or zip file of metadata formatted files to deploy.
+
+# flags.single-package.summary
+
+Indicates that the metadata zip file points to a directory structure for a single package.
+
 # info.SuccessfulValidation
 
 Successfully validated the deployment (%s).

package.json

@@ -9,7 +9,7 @@
     "@salesforce/core": "^3.15.5",
     "@salesforce/kit": "^1.5.41",
     "@salesforce/sf-plugins-core": "^1.12.3",
-    "@salesforce/source-deploy-retrieve": "^5.12.4",
+    "@salesforce/source-deploy-retrieve": "^5.13.1",
     "chalk": "^4.1.2",
     "fs-extra": "^10.0.1",
     "shelljs": "^0.8.5",
@@ -28,10 +28,12 @@
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/source-testkit": "^0.0.18",
     "@salesforce/ts-sinon": "1.3.21",
+    "@types/archiver": "^5.3.1",
     "@types/fs-extra": "^9.0.13",
     "@types/shelljs": "^0.8.11",
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "^4.33.0",
+    "archiver": "^5.3.1",
     "chai": "^4.3.6",
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
@@ -138,6 +140,7 @@
     "test:json-schema": "./bin/dev schema:compare",
     "test:nuts": "ts-node ./test/nuts/generateNuts.ts && nyc mocha \"**/*.nut.ts\"  --slow 4500 --timeout 600000 --parallel --retries 0",
     "test:nuts:deploy:metadata:manifest": "cross-env PLUGIN_DEPLOY_RETRIEVE_SEED_FILTER=deploy.metadata.manifest ts-node ./test/nuts/generateNuts.ts && mocha \"test/nuts/generated/*.nut.ts\" --slow 4500 --timeout 600000 --parallel --retries 0",
+    "test:nuts:deploy:metadata:metadata-dir": "cross-env PLUGIN_DEPLOY_RETRIEVE_SEED_FILTER=deploy.metadata.metadata-dir ts-node ./test/nuts/generateNuts.ts && mocha \"test/nuts/generated/*.nut.ts\" --slow 4500 --timeout 600000 --parallel --retries 0",
     "test:nuts:deploy:metadata:metadata": "cross-env PLUGIN_DEPLOY_RETRIEVE_SEED_FILTER=deploy.metadata.metadata ts-node ./test/nuts/generateNuts.ts && mocha \"test/nuts/generated/*.nut.ts\" --slow 4500 --timeout 600000 --parallel --retries 0",
     "test:nuts:deploy:metadata:source-dir": "cross-env PLUGIN_DEPLOY_RETRIEVE_SEED_FILTER=deploy.metadata.source-dir ts-node ./test/nuts/generateNuts.ts && mocha \"test/nuts/generated/*.nut.ts\" --slow 4500 --timeout 600000 --parallel --retries 0",
     "test:nuts:deploy:metadata:test-level": "cross-env PLUGIN_DEPLOY_RETRIEVE_SEED_FILTER=deploy.metadata.test-level ts-node ./test/nuts/generateNuts.ts && mocha \"test/nuts/generated/*.nut.ts\" --slow 4500 --timeout 600000 --parallel --retries 0",

src/commands/deploy/metadata.ts

@@ -11,21 +11,16 @@ import { SfCommand, toHelpSection, Flags } from '@salesforce/sf-plugins-core';
 import { AsyncDeployResultFormatter, DeployResultFormatter, getVersionMessage } from '../../utils/output';
 import { DeployProgress } from '../../utils/progressBar';
 import { DeployResultJson, TestLevel } from '../../utils/types';
-import {
-  executeDeploy,
-  testLevelFlag,
-  resolveApi,
-  validateTests,
-  determineExitCode,
-  DeployCache,
-  shouldRemoveFromCache,
-} from '../../utils/deploy';
+import { executeDeploy, resolveApi, validateTests, determineExitCode, DeployCache } from '../../utils/deploy';
 import { DEPLOY_STATUS_CODES_DESCRIPTIONS } from '../../utils/errorCodes';
 import { ConfigVars } from '../../configMeta';
+import { fileOrDirFlag, testLevelFlag } from '../../utils/flags';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'deploy.metadata');
 
+const EXACTLY_ONE_FLAGS = ['manifest', 'source-dir', 'metadata', 'metadata-dir'];
+
 export default class DeployMetadata extends SfCommand<DeployResultJson> {
   public static readonly description = messages.getMessage('description');
   public static readonly summary = messages.getMessage('summary');
@@ -68,21 +63,30 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
       char: 'x',
       description: messages.getMessage('flags.manifest.description'),
       summary: messages.getMessage('flags.manifest.summary'),
-      exactlyOne: ['manifest', 'source-dir', 'metadata'],
+      exactlyOne: EXACTLY_ONE_FLAGS,
       exists: true,
     }),
     metadata: Flags.string({
       char: 'm',
       summary: messages.getMessage('flags.metadata.summary'),
       multiple: true,
-      exactlyOne: ['manifest', 'source-dir', 'metadata'],
+      exactlyOne: EXACTLY_ONE_FLAGS,
+    }),
+    'metadata-dir': fileOrDirFlag({
+      summary: messages.getMessage('flags.metadata-dir.summary'),
+      exactlyOne: EXACTLY_ONE_FLAGS,
+      exists: true,
+    }),
+    'single-package': Flags.boolean({
+      summary: messages.getMessage('flags.single-package.summary'),
+      dependsOn: ['metadata-dir'],
     }),
     'source-dir': Flags.string({
       char: 'd',
       description: messages.getMessage('flags.source-dir.description'),
       summary: messages.getMessage('flags.source-dir.summary'),
       multiple: true,
-      exactlyOne: ['manifest', 'source-dir', 'metadata'],
+      exactlyOne: EXACTLY_ONE_FLAGS,
     }),
     'target-org': Flags.requiredOrg({
       char: 'o',
@@ -166,9 +170,7 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
       if (flags['dry-run']) this.logSuccess('Dry-run complete.');
     }
 
-    if (shouldRemoveFromCache(result.response.status)) {
-      await DeployCache.unset(deploy.id);
-    }
+    await DeployCache.update(deploy.id, { status: result.response.status });
 
     return formatter.getJson();
   }

src/commands/deploy/metadata/cancel.ts

@@ -8,7 +8,7 @@
 import { Messages } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
-import { DeployCache, cancelDeploy, shouldRemoveFromCache, cancelDeployAsync } from '../../../utils/deploy';
+import { DeployCache, cancelDeploy, cancelDeployAsync } from '../../../utils/deploy';
 import { AsyncDeployCancelResultFormatter, DeployCancelResultFormatter } from '../../../utils/output';
 import { DeployResultJson } from '../../../utils/types';
 
@@ -70,11 +70,9 @@ export default class DeployMetadataCancel extends SfCommand<DeployResultJson> {
       const formatter = new DeployCancelResultFormatter(result);
       if (!this.jsonEnabled()) formatter.display();
 
-      if (shouldRemoveFromCache(result.response.status)) {
-        cache.unset(result.response.id);
-        cache.unset(jobId);
-        await cache.write();
-      }
+      cache.update(result.response.id, { status: result.response.status });
+      await cache.write();
+
       return formatter.getJson();
     }
   }

src/commands/deploy/metadata/quick.ts

@@ -16,7 +16,6 @@ import {
   determineExitCode,
   poll,
   resolveApi,
-  shouldRemoveFromCache,
 } from '../../../utils/deploy';
 import { DEPLOY_STATUS_CODES_DESCRIPTIONS } from '../../../utils/errorCodes';
 import { AsyncDeployResultFormatter, DeployResultFormatter, getVersionMessage } from '../../../utils/output';
@@ -106,9 +105,7 @@ export default class DeployMetadataQuick extends SfCommand<DeployResultJson> {
 
     if (!this.jsonEnabled()) formatter.display();
 
-    if (shouldRemoveFromCache(result.response.status)) {
-      await DeployCache.unset(jobId);
-    }
+    await DeployCache.update(jobId, { status: result.response.status });
 
     this.setExitCode(result);
 

src/commands/deploy/metadata/resume.ts

@@ -13,7 +13,7 @@ import { Duration } from '@salesforce/kit';
 import { DeployResultFormatter, getVersionMessage } from '../../../utils/output';
 import { DeployProgress } from '../../../utils/progressBar';
 import { DeployResultJson } from '../../../utils/types';
-import { DeployCache, determineExitCode, executeDeploy, shouldRemoveFromCache } from '../../../utils/deploy';
+import { DeployCache, determineExitCode, executeDeploy, isNotResumable } from '../../../utils/deploy';
 import { DEPLOY_STATUS_CODES_DESCRIPTIONS } from '../../../utils/errorCodes';
 
 Messages.importMessagesDirectory(__dirname);
@@ -69,6 +69,11 @@ export default class DeployMetadataResume extends SfCommand<DeployResultJson> {
     const jobId = cache.resolveLatest(flags['use-most-recent'], flags['job-id']);
 
     const deployOpts = cache.get(jobId);
+
+    if (isNotResumable(deployOpts.status)) {
+      throw messages.createError('error.DeployNotResumable', [jobId, deployOpts.status]);
+    }
+
     const wait = flags.wait || Duration.minutes(deployOpts.wait);
     const { deploy, componentSet } = await executeDeploy({ ...deployOpts, wait, 'dry-run': false }, jobId);
 
@@ -87,11 +92,8 @@ export default class DeployMetadataResume extends SfCommand<DeployResultJson> {
 
     if (!this.jsonEnabled()) formatter.display();
 
-    if (shouldRemoveFromCache(result.response.status)) {
-      cache.unset(deploy.id);
-      cache.unset(jobId);
-      await cache.write();
-    }
+    cache.update(deploy.id, { status: result.response.status });
+    await cache.write();
 
     return formatter.getJson();
   }