fix: cache everything as a manifest

Author: mshanemc

messages/deploy.metadata.cancel.md

@@ -26,10 +26,10 @@ Job ID of the deploy operation you want to cancel.
 
 These commands return a job ID if they time out or you specified the --async flag:
 
-- sf project deploy start
-- sf project deploy validate
-- sf project deploy quick
-- sf project deploy cancel
+- <%= config.bin %> project deploy start
+- <%= config.bin %> project deploy validate
+- <%= config.bin %> project deploy quick
+- <%= config.bin %> project deploy cancel
 
 The job ID is valid for 10 days from when you started the deploy operation.
 
@@ -47,16 +47,20 @@ Number of minutes to wait for the command to complete and display results.
 
 # flags.wait.description
 
-If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run "sf project deploy resume". To check the status of the cancellation, run "sf project deploy report".
+If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run "sf project deploy resume". To check the status of the cancellation, run "<%= config.bin %> project deploy report".
 
 # flags.async.summary
 
 Run the command asynchronously.
 
 # flags.async.description
 
-The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run "sf project deploy resume". To check the status of the cancellation, run "sf project deploy report".
+The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run "sf project deploy resume". To check the status of the cancellation, run "<%= config.bin %> project deploy report".
 
 # error.CannotCancelDeploy
 
 Can't cancel deploy because it's already completed.
+
+# error.CannotCancelDeployPre
+
+Can't cancel deploy with Job Id %s because it's already completed (status is %s)

src/commands/project/deploy/cancel.ts

@@ -8,6 +8,7 @@
 import { Messages } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { RequestStatus } from '@salesforce/source-deploy-retrieve';
 import { cancelDeploy, cancelDeployAsync } from '../../../utils/deploy';
 import { DeployCache } from '../../../utils/deployCache';
 import { AsyncDeployCancelResultFormatter, DeployCancelResultFormatter } from '../../../utils/output';
@@ -62,6 +63,15 @@ export default class DeployMetadataCancel extends SfCommand<DeployResultJson> {
     const jobId = cache.resolveLatest(flags['use-most-recent'], flags['job-id']);
 
     const deployOpts = cache.get(jobId);
+    // we may already know the job finished
+    if (
+      deployOpts.status &&
+      [RequestStatus.Canceled, RequestStatus.Failed, RequestStatus.Succeeded, RequestStatus.SucceededPartial].includes(
+        deployOpts.status
+      )
+    ) {
+      messages.createError('error.CannotCancelDeployPre', [jobId, deployOpts.status]);
+    }
 
     if (flags.async) {
       const asyncResult = await cancelDeployAsync({ 'target-org': deployOpts['target-org'] }, jobId);

src/commands/project/deploy/quick.ts

@@ -91,7 +91,6 @@ export default class DeployMetadataQuick extends SfCommand<DeployResultJson> {
 
     await org.getConnection(flags['api-version']).deployRecentValidation({ id: jobId, rest: api === 'REST' });
     const componentSet = await buildComponentSet({ ...deployOpts, wait: flags.wait });
-
     this.log(getVersionMessage('Deploying', componentSet, api));
     this.log(`Deploy ID: ${bold(jobId)}`);
 

src/utils/deploy.ts

@@ -22,6 +22,8 @@ import { getPackageDirs, getSourceApiVersion } from './project';
 import { API, PathInfo, TestLevel } from './types';
 import { DEPLOY_STATUS_CODES } from './errorCodes';
 import { DeployCache } from './deployCache';
+import { writeManifest } from './manifestCache';
+
 Messages.importMessagesDirectory(__dirname);
 export const cacheMessages = Messages.load('@salesforce/plugin-deploy-retrieve', 'cache', [
   'error.NoRecentJobId',
@@ -55,7 +57,10 @@ export type DeployOptions = {
   status?: RequestStatus;
 };
 
-export type CachedOptions = Omit<DeployOptions, 'wait'> & { wait: number };
+/** Manifest is expected.  You cannot pass metadata and source-dir array--use those to get a manifest */
+export type CachedOptions = Omit<DeployOptions, 'wait' | 'metadata' | 'source-dir'> & {
+  wait: number;
+} & Partial<Pick<DeployOptions, 'manifest'>>;
 
 export function validateTests(testLevel: TestLevel, tests: Nullable<string[]>): boolean {
   if (testLevel === TestLevel.RunSpecifiedTests && (tests ?? []).length === 0) return false;
@@ -155,10 +160,11 @@ export async function executeDeploy(
           usernameOrConnection,
           apiOptions,
         });
-    await DeployCache.set(deploy.id, { ...opts, wait: opts.wait?.minutes ?? 33 });
   }
 
-  await DeployCache.set(deploy.id, { ...opts, wait: opts.wait?.minutes ?? 33 });
+  // does not apply to mdapi deploys
+  const manifestPath = componentSet ? await writeManifest(deploy.id, componentSet) : undefined;
+  await DeployCache.set(deploy.id, { ...opts, manifest: manifestPath });
 
   return { deploy, componentSet };
 }
@@ -170,7 +176,7 @@ export async function cancelDeploy(opts: Partial<DeployOptions>, id: string): Pr
   const deploy = new MetadataApiDeploy({ usernameOrConnection, id });
 
   const componentSet = await buildComponentSet({ ...opts });
-  await DeployCache.set(deploy.id, { ...opts, wait: opts.wait?.minutes ?? 33 });
+  await DeployCache.set(deploy.id, { ...opts });
 
   await deploy.cancel();
   return poll(org, deploy.id, opts.wait ?? Duration.minutes(33), componentSet);

src/utils/deployCache.ts

@@ -7,7 +7,8 @@
 import { Global, TTLConfig } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import { JsonMap } from '@salesforce/ts-types';
-import { CachedOptions, cacheMessages } from './deploy';
+import { DeployOptions, CachedOptions, cacheMessages } from './deploy';
+import { maybeDestroyManifest } from './manifestCache';
 
 export class DeployCache extends TTLConfig<TTLConfig.Options, CachedOptions> {
   public static getFileName(): string {
@@ -24,16 +25,24 @@ export class DeployCache extends TTLConfig<TTLConfig.Options, CachedOptions> {
     };
   }
 
-  public static async set(key: string, value: Partial<CachedOptions>): Promise<void> {
+  /**
+   *
+   * @param key jobId
+   * @param value a DeployOptions object (wait is a duration, can use non-manifest options)
+   * @param manifestFilePath the path to the manifest file generated by the deploy
+   */
+  public static async set(key: string, value: Partial<DeployOptions>, manifestFilePath?: string): Promise<void> {
     const cache = await DeployCache.create();
-    cache.set(key, value);
+    const { manifest, 'metadata-dir': mdDir, wait, 'source-dir': sourceDir, ...cleanValue } = value;
+    const modifiedValue = { ...cleanValue, manifest: manifest ?? manifestFilePath, wait: wait?.minutes ?? 33 };
+    cache.set(key, modifiedValue);
     await cache.write();
   }
 
   public static async unset(key: string): Promise<void> {
     const cache = await DeployCache.create();
     cache.unset(key);
-    await cache.write();
+    await Promise.all([cache.write(), maybeDestroyManifest(key)]);
   }
 
   public static async update(key: string, obj: JsonMap): Promise<void> {

src/utils/manifestCache.ts

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2020, 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 * as path from 'path';
+import { homedir } from 'os';
+import * as fs from 'fs';
+import { ComponentSet } from '@salesforce/source-deploy-retrieve';
+import { Global } from '@salesforce/core';
+
+const MANIFEST_CACHE_DIR = 'manifestCache';
+
+/** Give it a jobId, ComponentSet it will write the manifest file
+ * returns the file path it wrote to */
+export const writeManifest = async (jobId: string, componentSet: ComponentSet): Promise<string> => {
+  const xml = await componentSet.getPackageXml();
+  const filePath = getManifestFilePath(jobId);
+  await fs.promises.mkdir(path.dirname(filePath), { recursive: true });
+  await fs.promises.writeFile(filePath, xml);
+  return filePath;
+};
+
+export const maybeDestroyManifest = async (jobId: string): Promise<void> => {
+  try {
+    return await fs.promises.rm(getManifestFilePath(jobId));
+  } catch (e) {
+    // that's ok in a maybe
+  }
+};
+
+const getManifestFilePath = (jobId: string): string =>
+  path.join(homedir(), Global.SF_STATE_FOLDER, MANIFEST_CACHE_DIR, `${jobId}.xml`);