refactor: add deploy url to json output

salesforcecli · Oct 14, 2024 · b512688 · b512688
1 parent 23bd739
commit b512688
Show file tree

Hide file tree

Showing 11 changed files with 79 additions and 13 deletions.
diff --git a/schemas/project-deploy-cancel.json b/schemas/project-deploy-cancel.json
@@ -106,6 +106,9 @@
             },
             "stateDetail": {
               "type": "string"
+            },
+            "deployUrl": {
+              "type": "string"
             }
           },
           "required": [
@@ -574,6 +577,9 @@
         "stateDetail": {
           "type": "string"
         },
+        "deployUrl": {
+          "type": "string"
+        },
         "id": {
           "type": "string"
         },

diff --git a/schemas/project-deploy-quick.json b/schemas/project-deploy-quick.json
@@ -106,6 +106,9 @@
             },
             "stateDetail": {
               "type": "string"
+            },
+            "deployUrl": {
+              "type": "string"
             }
           },
           "required": [
@@ -580,6 +583,9 @@
         "success": {
           "type": "boolean"
         },
+        "deployUrl": {
+          "type": "string"
+        },
         "done": {
           "type": "boolean"
         }

diff --git a/schemas/project-deploy-report.json b/schemas/project-deploy-report.json
@@ -106,6 +106,9 @@
             },
             "stateDetail": {
               "type": "string"
+            },
+            "deployUrl": {
+              "type": "string"
             }
           },
           "required": [
@@ -574,6 +577,9 @@
         "stateDetail": {
           "type": "string"
         },
+        "deployUrl": {
+          "type": "string"
+        },
         "id": {
           "type": "string"
         },

diff --git a/schemas/project-deploy-resume.json b/schemas/project-deploy-resume.json
@@ -106,6 +106,9 @@
             },
             "stateDetail": {
               "type": "string"
+            },
+            "deployUrl": {
+              "type": "string"
             }
           },
           "required": [
@@ -582,6 +585,9 @@
         },
         "done": {
           "type": "boolean"
+        },
+        "deployUrl": {
+          "type": "string"
         }
       },
       "required": ["files", "status"]

diff --git a/schemas/project-deploy-start.json b/schemas/project-deploy-start.json
@@ -106,6 +106,9 @@
             },
             "stateDetail": {
               "type": "string"
+            },
+            "deployUrl": {
+              "type": "string"
             }
           },
           "required": [
@@ -574,6 +577,9 @@
         "stateDetail": {
           "type": "string"
         },
+        "deployUrl": {
+          "type": "string"
+        },
         "id": {
           "type": "string"
         },

diff --git a/schemas/project-deploy-validate.json b/schemas/project-deploy-validate.json
@@ -71,6 +71,9 @@
             "errorStatusCode": {
               "type": "string"
             },
+            "deployUrl": {
+              "type": "string"
+            },
             "ignoreWarnings": {
               "type": "boolean"
             },
@@ -574,6 +577,9 @@
         "stateDetail": {
           "type": "string"
         },
+        "deployUrl": {
+          "type": "string"
+        },
         "id": {
           "type": "string"
         },

diff --git a/src/commands/project/deploy/quick.ts b/src/commands/project/deploy/quick.ts
@@ -76,6 +76,8 @@ export default class DeployMetadataQuick extends SfCommand<DeployResultJson> {
 
   public static errorCodes = toHelpSection('ERROR CODES', DEPLOY_STATUS_CODES_DESCRIPTIONS);
 
+  private deployUrl?: string;
+
   public async run(): Promise<DeployResultJson> {
     const [{ flags }, cache] = await Promise.all([this.parse(DeployMetadataQuick), DeployCache.create()]);
 
@@ -91,13 +93,13 @@ export default class DeployMetadataQuick extends SfCommand<DeployResultJson> {
       rest: api === API['REST'],
     });
     this.log(`Deploy ID: ${ansis.bold(deployId)}`);
-    const deployUrl = buildDeployUrl(deployId);
-    this.log(`Deploy URL: ${ansis.bold(deployUrl)}`);
+    this.deployUrl = buildDeployUrl(deployId);
+    this.log(`Deploy URL: ${ansis.bold(this.deployUrl)}`);
 
     if (flags.async) {
       const asyncFormatter = new AsyncDeployResultFormatter(deployId);
       if (!this.jsonEnabled()) asyncFormatter.display();
-      return asyncFormatter.getJson();
+      return this.mixinUrlMeta(await asyncFormatter.getJson());
     }
 
     const mdapiDeploy = new MetadataApiDeploy({
@@ -125,7 +127,7 @@ export default class DeployMetadataQuick extends SfCommand<DeployResultJson> {
       this.log(messages.getMessage('error.QuickDeployFailure', [deployId, result.response.status]));
     }
 
-    return formatter.getJson();
+    return this.mixinUrlMeta(await formatter.getJson());
   }
 
   protected catch(error: SfCommand.Error): Promise<never> {
@@ -140,6 +142,12 @@ export default class DeployMetadataQuick extends SfCommand<DeployResultJson> {
     }
     return super.catch(error);
   }
+  private mixinUrlMeta(json: DeployResultJson): DeployResultJson {
+    if (this.deployUrl) {
+      json.deployUrl = this.deployUrl;
+    }
+    return json;
+  }
 }
 
 /** Resolve a job ID for a validated deploy using cache, most recent, or a job ID flag. */

diff --git a/src/commands/project/deploy/resume.ts b/src/commands/project/deploy/resume.ts
@@ -85,6 +85,8 @@ export default class DeployMetadataResume extends SfCommand<DeployResultJson> {
 
   public static errorCodes = toHelpSection('ERROR CODES', DEPLOY_STATUS_CODES_DESCRIPTIONS);
 
+  private deployUrl?: string;
+
   public async run(): Promise<DeployResultJson> {
     const [{ flags }, cache] = await Promise.all([this.parse(DeployMetadataResume), DeployCache.create()]);
     const jobId = cache.resolveLatest(flags['use-most-recent'], flags['job-id'], true);
@@ -131,8 +133,8 @@ export default class DeployMetadataResume extends SfCommand<DeployResultJson> {
       );
 
       this.log(`Deploy ID: ${ansis.bold(jobId)}`);
-      const deployUrl = buildDeployUrl(jobId);
-      this.log(`Deploy URL: ${ansis.bold(deployUrl)}`);
+      this.deployUrl = buildDeployUrl(jobId);
+      this.log(`Deploy URL: ${ansis.bold(this.deployUrl)}`);
       new DeployProgress(deploy, this.jsonEnabled()).start();
       result = await deploy.pollStatus(500, wait.seconds);
 
@@ -154,6 +156,12 @@ export default class DeployMetadataResume extends SfCommand<DeployResultJson> {
 
     if (!this.jsonEnabled()) formatter.display();
 
-    return formatter.getJson();
+    return this.mixinUrlMeta(await formatter.getJson());
+  }
+  private mixinUrlMeta(json: DeployResultJson): DeployResultJson {
+    if (this.deployUrl) {
+      json.deployUrl = this.deployUrl;
+    }
+    return json;
   }
 }
diff --git a/src/commands/project/deploy/start.ts b/src/commands/project/deploy/start.ts
@@ -179,6 +179,7 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
 
   private zipSize?: number;
   private zipFileCount?: number;
+  private deployUrl?: string;
 
   public async run(): Promise<DeployResultJson> {
     const { flags } = await this.parse(DeployMetadata);
@@ -246,8 +247,8 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
       throw new SfError('The deploy id is not available.');
     }
     this.log(`Deploy ID: ${ansis.bold(deploy.id)}`);
-    const deployUrl = buildDeployUrl(deploy.id);
-    this.log(`Deploy URL: ${ansis.bold(deployUrl)}`);
+    this.deployUrl = buildDeployUrl(deploy.id);
+    this.log(`Deploy URL: ${ansis.bold(this.deployUrl)}`);
 
     if (flags.async) {
       if (flags['coverage-formatters']) {
@@ -306,6 +307,9 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
     if (this.zipFileCount) {
       json.zipFileCount = this.zipFileCount;
     }
+    if (this.deployUrl) {
+      json.deployUrl = this.deployUrl;
+    }
     return json;
   }
 }
diff --git a/src/commands/project/deploy/validate.ts b/src/commands/project/deploy/validate.ts
@@ -155,6 +155,8 @@ export default class DeployMetadataValidate extends SfCommand<DeployResultJson>
 
   public static errorCodes = toHelpSection('ERROR CODES', DEPLOY_STATUS_CODES_DESCRIPTIONS);
 
+  private deployUrl?: string;
+
   public async run(): Promise<DeployResultJson> {
     const [{ flags }, api] = await Promise.all([this.parse(DeployMetadataValidate), resolveApi(this.configAggregator)]);
 
@@ -196,13 +198,13 @@ export default class DeployMetadataValidate extends SfCommand<DeployResultJson>
       throw new SfError('The deploy id is not available.');
     }
     this.log(`Deploy ID: ${ansis.bold(deploy.id)}`);
-    const deployUrl = buildDeployUrl(deploy.id);
-    this.log(`Deploy URL: ${ansis.bold(deployUrl)}`);
+    this.deployUrl = buildDeployUrl(deploy.id);
+    this.log(`Deploy URL: ${ansis.bold(this.deployUrl)}`);
 
     if (flags.async) {
       const asyncFormatter = new AsyncDeployResultFormatter(deploy.id);
       if (!this.jsonEnabled()) asyncFormatter.display();
-      return asyncFormatter.getJson();
+      return this.mixinUrlMeta(await asyncFormatter.getJson());
     }
 
     new DeployProgress(deploy, this.jsonEnabled()).start();
@@ -252,6 +254,12 @@ export default class DeployMetadataValidate extends SfCommand<DeployResultJson>
         .setData({ deployId: deploy.id });
     }
 
-    return formatter.getJson();
+    return this.mixinUrlMeta(await formatter.getJson());
+  }
+  private mixinUrlMeta(json: DeployResultJson): DeployResultJson {
+    if (this.deployUrl) {
+      json.deployUrl = this.deployUrl;
+    }
+    return json;
   }
 }
diff --git a/src/utils/types.ts b/src/utils/types.ts
@@ -45,6 +45,7 @@ export type AsyncDeployResultJson = Omit<Partial<MetadataApiDeployStatus>, 'stat
   files: FileResponse[];
   zipSize?: number;
   zipFileCount?: number;
+  deployUrl?: string;
 };
 
 type ConvertEntry = {
@@ -79,6 +80,7 @@ export type DeployResultJson =
       replacements?: Record<string, string[]>;
       zipSize?: number;
       zipFileCount?: number;
+      deployUrl?: string;
     })
   | AsyncDeployResultJson;