feat: zipSize and zipFileCount in DeployResult (#1138)

shetzel · cristiand391 · web-flow · commit a03a580afdd8 · 2024-08-27T16:01:01.000-03:00
* feat: handle event from SDR to display zip file size and file count

* feat: zipSize and zipFileCount in DeployResult

* test: tests for verbose zip file size and file count

* test: tests for verbose zip file size and file count

* fix: always add zipSize and zipFileCount to JSON

* chore: bump SDR

* fix: check size range to allow for OS differences

---------

Co-authored-by: Cristian Dominguez &lt;cdominguez@salesforce.com&gt;
diff --git a/package.json b/package.json
@@ -11,7 +11,7 @@
     "@salesforce/kit": "^3.2.1",
     "@salesforce/plugin-info": "^3.3.28",
     "@salesforce/sf-plugins-core": "^11.3.2",
-    "@salesforce/source-deploy-retrieve": "^12.5.1",
+    "@salesforce/source-deploy-retrieve": "^12.6.0",
     "@salesforce/source-tracking": "^7.1.7",
     "@salesforce/ts-types": "^2.0.12",
     "ansis": "^3.3.2"
diff --git a/schemas/project-deploy-cancel.json b/schemas/project-deploy-cancel.json
@@ -8,6 +8,12 @@
           "type": "object",
           "additionalProperties": false,
           "properties": {
+            "files": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/FileResponse"
+              }
+            },
             "replacements": {
               "type": "object",
               "additionalProperties": {
@@ -17,11 +23,11 @@
                 }
               }
             },
-            "files": {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/FileResponse"
-              }
+            "zipSize": {
+              "type": "number"
+            },
+            "zipFileCount": {
+              "type": "number"
             },
             "id": {
               "type": "string"
@@ -496,6 +502,12 @@
             "$ref": "#/definitions/FileResponse"
           }
         },
+        "zipSize": {
+          "type": "number"
+        },
+        "zipFileCount": {
+          "type": "number"
+        },
         "canceledBy": {
           "type": "string"
         },
diff --git a/schemas/project-deploy-quick.json b/schemas/project-deploy-quick.json
@@ -8,6 +8,12 @@
           "type": "object",
           "additionalProperties": false,
           "properties": {
+            "files": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/FileResponse"
+              }
+            },
             "replacements": {
               "type": "object",
               "additionalProperties": {
@@ -17,11 +23,11 @@
                 }
               }
             },
-            "files": {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/FileResponse"
-              }
+            "zipSize": {
+              "type": "number"
+            },
+            "zipFileCount": {
+              "type": "number"
             },
             "id": {
               "type": "string"
@@ -496,6 +502,12 @@
             "$ref": "#/definitions/FileResponse"
           }
         },
+        "zipSize": {
+          "type": "number"
+        },
+        "zipFileCount": {
+          "type": "number"
+        },
         "canceledBy": {
           "type": "string"
         },
diff --git a/schemas/project-deploy-report.json b/schemas/project-deploy-report.json
@@ -8,6 +8,12 @@
           "type": "object",
           "additionalProperties": false,
           "properties": {
+            "files": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/FileResponse"
+              }
+            },
             "replacements": {
               "type": "object",
               "additionalProperties": {
@@ -17,11 +23,11 @@
                 }
               }
             },
-            "files": {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/FileResponse"
-              }
+            "zipSize": {
+              "type": "number"
+            },
+            "zipFileCount": {
+              "type": "number"
             },
             "id": {
               "type": "string"
@@ -496,6 +502,12 @@
             "$ref": "#/definitions/FileResponse"
           }
         },
+        "zipSize": {
+          "type": "number"
+        },
+        "zipFileCount": {
+          "type": "number"
+        },
         "canceledBy": {
           "type": "string"
         },
diff --git a/schemas/project-deploy-resume.json b/schemas/project-deploy-resume.json
@@ -8,6 +8,12 @@
           "type": "object",
           "additionalProperties": false,
           "properties": {
+            "files": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/FileResponse"
+              }
+            },
             "replacements": {
               "type": "object",
               "additionalProperties": {
@@ -17,11 +23,11 @@
                 }
               }
             },
-            "files": {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/FileResponse"
-              }
+            "zipSize": {
+              "type": "number"
+            },
+            "zipFileCount": {
+              "type": "number"
             },
             "id": {
               "type": "string"
@@ -496,6 +502,12 @@
             "$ref": "#/definitions/FileResponse"
           }
         },
+        "zipSize": {
+          "type": "number"
+        },
+        "zipFileCount": {
+          "type": "number"
+        },
         "canceledBy": {
           "type": "string"
         },
diff --git a/schemas/project-deploy-start.json b/schemas/project-deploy-start.json
@@ -8,6 +8,12 @@
           "type": "object",
           "additionalProperties": false,
           "properties": {
+            "files": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/FileResponse"
+              }
+            },
             "replacements": {
               "type": "object",
               "additionalProperties": {
@@ -17,11 +23,11 @@
                 }
               }
             },
-            "files": {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/FileResponse"
-              }
+            "zipSize": {
+              "type": "number"
+            },
+            "zipFileCount": {
+              "type": "number"
             },
             "id": {
               "type": "string"
@@ -496,6 +502,12 @@
             "$ref": "#/definitions/FileResponse"
           }
         },
+        "zipSize": {
+          "type": "number"
+        },
+        "zipFileCount": {
+          "type": "number"
+        },
         "canceledBy": {
           "type": "string"
         },
diff --git a/schemas/project-deploy-validate.json b/schemas/project-deploy-validate.json
@@ -8,6 +8,12 @@
           "type": "object",
           "additionalProperties": false,
           "properties": {
+            "files": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/FileResponse"
+              }
+            },
             "replacements": {
               "type": "object",
               "additionalProperties": {
@@ -17,11 +23,11 @@
                 }
               }
             },
-            "files": {
-              "type": "array",
-              "items": {
-                "$ref": "#/definitions/FileResponse"
-              }
+            "zipSize": {
+              "type": "number"
+            },
+            "zipFileCount": {
+              "type": "number"
             },
             "id": {
               "type": "string"
@@ -496,6 +502,12 @@
             "$ref": "#/definitions/FileResponse"
           }
         },
+        "zipSize": {
+          "type": "number"
+        },
+        "zipFileCount": {
+          "type": "number"
+        },
         "canceledBy": {
           "type": "string"
         },
diff --git a/src/commands/project/deploy/start.ts b/src/commands/project/deploy/start.ts
@@ -7,21 +7,22 @@
 
 import ansis from 'ansis';
 import { EnvironmentVariable, Lifecycle, Messages, OrgConfigProperties, SfError } from '@salesforce/core';
-import { DeployVersionData } from '@salesforce/source-deploy-retrieve';
+import { type DeployVersionData, DeployZipData } from '@salesforce/source-deploy-retrieve';
 import { Duration } from '@salesforce/kit';
 import { SfCommand, toHelpSection, Flags } from '@salesforce/sf-plugins-core';
 import { SourceConflictError } from '@salesforce/source-tracking';
 import { AsyncDeployResultFormatter } from '../../../formatters/asyncDeployResultFormatter.js';
 import { DeployResultFormatter } from '../../../formatters/deployResultFormatter.js';
+import { AsyncDeployResultJson, DeployResultJson, TestLevel } from '../../../utils/types.js';
 import { DeployProgress } from '../../../utils/progressBar.js';
-import { DeployResultJson, TestLevel } from '../../../utils/types.js';
 import { executeDeploy, resolveApi, validateTests, determineExitCode } from '../../../utils/deploy.js';
 import { DeployCache } from '../../../utils/deployCache.js';
 import { DEPLOY_STATUS_CODES_DESCRIPTIONS } from '../../../utils/errorCodes.js';
 import { ConfigVars } from '../../../configMeta.js';
 import { coverageFormattersFlag, fileOrDirFlag, testLevelFlag, testsFlag } from '../../../utils/flags.js';
 import { writeConflictTable } from '../../../utils/conflicts.js';
 import { getOptionalProject } from '../../../utils/project.js';
+import { getZipFileSize } from '../../../utils/output.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'deploy.metadata');
@@ -176,6 +177,9 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
 
   public static errorCodes = toHelpSection('ERROR CODES', DEPLOY_STATUS_CODES_DESCRIPTIONS);
 
+  private zipSize?: number;
+  private zipFileCount?: number;
+
   public async run(): Promise<DeployResultJson> {
     const { flags } = await this.parse(DeployMetadata);
     const project = await getOptionalProject();
@@ -214,6 +218,16 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
       );
     });
 
+    // eslint-disable-next-line @typescript-eslint/require-await
+    Lifecycle.getInstance().on('deployZipData', async (zipData: DeployZipData) => {
+      this.zipSize = zipData.zipSize;
+      if (flags.verbose && this.zipSize) this.log(`Deploy size: ${getZipFileSize(this.zipSize)} of ~39 MB limit`);
+      if (zipData.zipFileCount) {
+        this.zipFileCount = zipData.zipFileCount;
+        if (flags.verbose && this.zipSize) this.log(`Deployed files count: ${this.zipFileCount} of 10,000 limit`);
+      }
+    });
+
     const { deploy } = await executeDeploy(
       {
         ...flags,
@@ -239,7 +253,8 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
       }
       const asyncFormatter = new AsyncDeployResultFormatter(deploy.id);
       if (!this.jsonEnabled()) asyncFormatter.display();
-      return asyncFormatter.getJson();
+
+      return this.mixinZipMeta(await asyncFormatter.getJson());
     }
 
     new DeployProgress(deploy, this.jsonEnabled()).start();
@@ -255,7 +270,7 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
 
     await DeployCache.update(deploy.id, { status: result.response.status });
 
-    return formatter.getJson();
+    return this.mixinZipMeta(await formatter.getJson());
   }
 
   protected catch(error: Error | SfError): Promise<never> {
@@ -281,4 +296,14 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
     }
     return super.catch(error);
   }
+
+  private mixinZipMeta(json: AsyncDeployResultJson | DeployResultJson): AsyncDeployResultJson | DeployResultJson {
+    if (this.zipSize) {
+      json.zipSize = this.zipSize;
+    }
+    if (this.zipFileCount) {
+      json.zipFileCount = this.zipFileCount;
+    }
+    return json;
+  }
 }
diff --git a/src/utils/output.ts b/src/utils/output.ts
@@ -38,6 +38,15 @@ export const exitCodeAsNumber = (): number | undefined => {
   }
 };
 
+export const getZipFileSize = (bytes: number): string => {
+  const units = ['B', 'KB', 'MB', 'GB'];
+  while (bytes > 1024 && units.length) {
+    bytes /= 1024;
+    units.shift();
+  }
+  return parseFloat(bytes.toFixed(2)) + ' ' + units[0];
+};
+
 /** oclif table doesn't like "interface" but likes "type".  SDR exports an interface  */
 export const getFileResponseSuccessProps = (
   s: FileResponseSuccess
diff --git a/src/utils/types.ts b/src/utils/types.ts
@@ -43,6 +43,8 @@ export type Verbosity = 'verbose' | 'concise' | 'normal';
 export type AsyncDeployResultJson = Omit<Partial<MetadataApiDeployStatus>, 'status'> & {
   status: RequestStatus | 'Queued' | 'Nothing to deploy';
   files: FileResponse[];
+  zipSize?: number;
+  zipFileCount?: number;
 };
 
 type ConvertEntry = {
@@ -72,7 +74,12 @@ export type DeleteSourceJson = {
 export type CoverageResultsFileInfo = Record<keyof Partial<typeof DefaultReportOptions>, string>;
 
 export type DeployResultJson =
-  | (MetadataApiDeployStatus & { files: FileResponse[] } & { replacements?: Record<string, string[]> })
+  | (MetadataApiDeployStatus & {
+      files: FileResponse[];
+      replacements?: Record<string, string[]>;
+      zipSize?: number;
+      zipFileCount?: number;
+    })
   | AsyncDeployResultJson;
 
 export type MetadataRetrieveResultJson = Omit<MetadataApiRetrieveStatus, 'zipFile'> & {
diff --git a/test/nuts/deploy/verbose.nut.ts b/test/nuts/deploy/verbose.nut.ts
diff --git a/test/utils/output.test.ts b/test/utils/output.test.ts
diff --git a/yarn.lock b/yarn.lock
