Merge pull request #899 from salesforcecli/mahanteshnp27/W-17606033/Add-TotalNumberOfMetadataFiles-Field

Mahanteshnp27/w 17606033/add total number of metadata files field

Author: shetzel

.gitignore

@@ -48,3 +48,5 @@ node_modules
 .DS_Store
 .idea
 .iml
+plugin-packaging.iml
+.codegenie

messages/package_version_create.md

@@ -228,3 +228,7 @@ Create version status: %s
 # unknownError
 
 An unknown error occurred.
+
+# warnOnTotalFileCountExceedingThreshold
+
+This package contains more than %s metadata files. The maximum number of metadata files in a package is %s. If you reach the file limit, you won’t be able to create new package versions. To confirm the exact file count for this package, run sf package version report and review the “# Metadata Files” column.

package.json

@@ -8,7 +8,7 @@
     "@oclif/core": "^4",
     "@salesforce/core": "^8.8.2",
     "@salesforce/kit": "^3.2.3",
-    "@salesforce/packaging": "^4.2.15",
+    "@salesforce/packaging": "^4.3.0",
     "@salesforce/sf-plugins-core": "^12.1.4",
     "chalk": "^5.4.1"
   },

schemas/package-convert.json

@@ -53,6 +53,9 @@
         },
         "ConvertedFromVersionId": {
           "type": ["string", "null"]
+        },
+        "TotalNumberOfMetadataFiles": {
+          "type": ["number", "null"]
         }
       },
       "required": [
@@ -71,7 +74,8 @@
         "CodeCoverage",
         "VersionNumber",
         "CreatedBy",
-        "ConvertedFromVersionId"
+        "ConvertedFromVersionId",
+        "TotalNumberOfMetadataFiles"
       ],
       "additionalProperties": false
     },

schemas/package-list.json

@@ -10,16 +10,11 @@
     },
     "Package2Result": {
       "type": "object",
+      "additionalProperties": false,
       "properties": {
-        "Id": {
-          "type": "string"
-        },
         "SubscriberPackageId": {
           "type": "string"
         },
-        "Name": {
-          "type": "string"
-        },
         "Description": {
           "type": "string"
         },
@@ -46,9 +41,14 @@
         },
         "IsOrgDependent": {
           "type": "string"
+        },
+        "Id": {
+          "type": "string"
+        },
+        "Name": {
+          "type": "string"
         }
-      },
-      "additionalProperties": false
+      }
     },
     "PackageType": {
       "type": "string",

schemas/package-version-create-list.json

@@ -59,6 +59,9 @@
           },
           "ConvertedFromVersionId": {
             "type": ["string", "null"]
+          },
+          "TotalNumberOfMetadataFiles": {
+            "type": ["number", "null"]
           }
         },
         "required": [
@@ -77,6 +80,7 @@
           "Status",
           "SubscriberPackageVersionId",
           "Tag",
+          "TotalNumberOfMetadataFiles",
           "VersionNumber"
         ]
       }

schemas/package-version-create-report.json

@@ -59,6 +59,9 @@
         },
         "ConvertedFromVersionId": {
           "type": ["string", "null"]
+        },
+        "TotalNumberOfMetadataFiles": {
+          "type": ["number", "null"]
         }
       },
       "required": [
@@ -77,7 +80,8 @@
         "CodeCoverage",
         "VersionNumber",
         "CreatedBy",
-        "ConvertedFromVersionId"
+        "ConvertedFromVersionId",
+        "TotalNumberOfMetadataFiles"
       ],
       "additionalProperties": false
     },

schemas/package-version-create.json

@@ -53,6 +53,9 @@
         },
         "ConvertedFromVersionId": {
           "type": ["string", "null"]
+        },
+        "TotalNumberOfMetadataFiles": {
+          "type": ["number", "null"]
         }
       },
       "additionalProperties": false

schemas/package-version-list.json

@@ -55,6 +55,9 @@
         "CreatedBy": {
           "type": "string"
         },
+        "ValidatedAsync": {
+          "type": "boolean"
+        },
         "Id": {
           "type": "string"
         },
@@ -100,9 +103,6 @@
         "ValidationSkipped": {
           "type": "boolean"
         },
-        "ValidatedAsync": {
-          "type": "boolean"
-        },
         "ConvertedFromVersionId": {
           "type": "string"
         },

schemas/package-version-report.json

@@ -173,6 +173,12 @@
         "Language": {
           "type": "string"
         },
+        "EndToEndBuildDurationInSeconds": {
+          "type": "number"
+        },
+        "TotalNumberOfMetadataFiles": {
+          "type": "number"
+        },
         "SubscriberPackageVersion": {
           "type": "object",
           "properties": {
@@ -191,9 +197,6 @@
         },
         "AncestorId": {
           "type": ["string", "null"]
-        },
-        "EndToEndBuildDurationInSeconds": {
-          "type": "number"
         }
       },
       "required": ["HasMetadataRemoved", "Package2", "Version"]

src/commands/package/version/create.ts

@@ -22,7 +22,8 @@ import Package2VersionStatus = PackagingSObjects.Package2VersionStatus;
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_version_create');
-
+const fileCountThreshold = 7000;
+const maxFileCountLimit = 10000;
 export type PackageVersionCommandResult = Partial<PackageVersionCreateRequestResult>;
 
 export class PackageVersionCreateCommand extends SfCommand<PackageVersionCommandResult> {
@@ -284,6 +285,11 @@ export class PackageVersionCreateCommand extends SfCommand<PackageVersionCommand
             this.config.bin,
           ])
         );
+        if ((result.TotalNumberOfMetadataFiles ?? 0) > fileCountThreshold) {
+          this.warn(
+            messages.getMessage('warnOnTotalFileCountExceedingThreshold', [fileCountThreshold, maxFileCountLimit])
+          );
+        }
         break;
       default:
         this.log(

test/commands/package/packageConvert.test.ts

@@ -69,6 +69,7 @@ describe('package:convert', () => {
       Tag: '',
       CodeCoverage: null,
       VersionNumber: null,
+      TotalNumberOfMetadataFiles: null,
     } satisfies PackageVersionCreateRequestResult;
 
     convertStub = $$.SANDBOX.stub(Package, 'convert').resolves(pvc);
@@ -100,6 +101,7 @@ describe('package:convert', () => {
       Tag: '',
       CodeCoverage: null,
       VersionNumber: null,
+      TotalNumberOfMetadataFiles: null,
     };
 
     convertStub.restore();
@@ -130,6 +132,7 @@ describe('package:convert', () => {
       Tag: '',
       CodeCoverage: null,
       VersionNumber: null,
+      TotalNumberOfMetadataFiles: null,
     };
 
     convertStub.restore();

test/commands/package/packageVersion.nut.ts

@@ -42,6 +42,28 @@ const expectedPVCRkeys = [
   'ConvertedFromVersionId',
   'CodeCoverage',
   'VersionNumber',
+  'TotalNumberOfMetadataFiles',
+];
+
+// Keys expected for Package version create list.
+// TotalNumberOfMetadataFiles is not included.
+const expectedPVCLkeys = [
+  'Id',
+  'Status',
+  'Package2Id',
+  'Package2Name',
+  'Package2VersionId',
+  'SubscriberPackageVersionId',
+  'Tag',
+  'Branch',
+  'Error',
+  'CreatedDate',
+  'HasMetadataRemoved',
+  'HasPassedCodeCoverageCheck',
+  'CreatedBy',
+  'ConvertedFromVersionId',
+  'CodeCoverage',
+  'VersionNumber',
 ];
 
 describe('package:version:*', () => {
@@ -215,7 +237,7 @@ describe('package:version:*', () => {
       expect(output).to.be.ok;
       expect(output?.status).to.equal(0);
       expect(output?.result).to.have.length.greaterThan(0);
-      expect(output?.result[0]).to.have.keys(expectedPVCRkeys);
+      expect(output?.result[0]).to.have.keys(expectedPVCLkeys);
       const current = Date.now();
       // @ts-ignore
       const created = Date.parse(output?.result?.at(0).CreatedDate);
@@ -234,7 +256,7 @@ describe('package:version:*', () => {
       expect(output).to.be.ok;
       expect(output?.status).to.equal(0);
       expect(output?.result).to.have.length.greaterThan(0);
-      expect(output?.result[0]).to.have.keys(expectedPVCRkeys);
+      expect(output?.result[0]).to.have.keys(expectedPVCLkeys);
     });
 
     it('should list the package versions created as part of package conversion from 1GP --show-conversions-only flag (human)', async () => {
@@ -248,7 +270,7 @@ describe('package:version:*', () => {
     it('should list the package versions created --verbose (json)', async () => {
       const command = `package:version:create:list --status Success --created-last-days 10 -v ${session.hubOrg.username} --json --verbose`;
       const output = execCmd<CreateListCommandResult>(command, { ensureExitCode: 0 }).jsonOutput;
-      const expectedVerboseKeys = [...expectedPVCRkeys, 'VersionName'];
+      const expectedVerboseKeys = [...expectedPVCLkeys, 'VersionName'];
       expect(output).to.be.ok;
       expect(output?.status).to.equal(0);
       expect(output?.result).to.have.length.greaterThan(0);

test/commands/package/packageVersionCreate.test.ts

@@ -36,6 +36,7 @@ const pkgVersionCreateErrorResult: PackageVersionCreateRequestResult = {
   CodeCoverage: null,
   VersionNumber: null,
   ConvertedFromVersionId: null,
+  TotalNumberOfMetadataFiles: null,
 };
 
 const pkgVersionCreateSuccessResult: PackageVersionCreateRequestResult = {
@@ -55,6 +56,27 @@ const pkgVersionCreateSuccessResult: PackageVersionCreateRequestResult = {
   CodeCoverage: null,
   VersionNumber: null,
   ConvertedFromVersionId: null,
+  TotalNumberOfMetadataFiles: null,
+};
+
+const pkgVersionCreateSuccessResultExceedsFileCount: PackageVersionCreateRequestResult = {
+  Id: '08c3i000000fylgAAA',
+  Status: Package2VersionStatus.success,
+  Package2Id: '0Ho3i000000TNHYCA4',
+  Package2VersionId: '05i3i000000fxw1AAA',
+  SubscriberPackageVersionId: '04t3i000002eya2AAA',
+  Tag: '',
+  Branch: '',
+  Error: [],
+  CreatedDate: '2022-11-03 09:46',
+  HasMetadataRemoved: false,
+  CreatedBy: '0053i000001ZIyGAAW',
+  Package2Name: null,
+  HasPassedCodeCoverageCheck: null,
+  CodeCoverage: null,
+  VersionNumber: null,
+  ConvertedFromVersionId: null,
+  TotalNumberOfMetadataFiles: 8000,
 };
 
 describe('package:version:create - tests', () => {
@@ -65,6 +87,7 @@ describe('package:version:create - tests', () => {
 
   // stubs
   let logStub: sinon.SinonStub;
+  let warnStub: sinon.SinonStub;
 
   const stubSpinner = (cmd: PackageVersionCreateCommand) => {
     $$.SANDBOX.stub(cmd.spinner, 'start');
@@ -78,6 +101,7 @@ describe('package:version:create - tests', () => {
 
   beforeEach(async () => {
     logStub = $$.SANDBOX.stub(SfCommand.prototype, 'log');
+    warnStub = $$.SANDBOX.stub(SfCommand.prototype, 'warn');
   });
 
   afterEach(() => {
@@ -110,7 +134,9 @@ describe('package:version:create - tests', () => {
         CodeCoverage: null,
         VersionNumber: null,
         ConvertedFromVersionId: null,
+        TotalNumberOfMetadataFiles: null,
       });
+      expect(warnStub.callCount).to.equal(0);
       expect(logStub.callCount).to.equal(1);
       expect(logStub.args[0]).to.deep.equal([
         `Successfully created the package version [08c3i000000fylgAAA]. Subscriber Package Version Id: 04t3i000002eya2AAA${os.EOL}Package Installation URL: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t3i000002eya2AAA${os.EOL}As an alternative, you can use the "sf package:install" command.`,
@@ -146,7 +172,50 @@ describe('package:version:create - tests', () => {
         CodeCoverage: null,
         VersionNumber: null,
         ConvertedFromVersionId: null,
+        TotalNumberOfMetadataFiles: null,
       });
+      expect(warnStub.callCount).to.equal(0);
+      expect(logStub.callCount).to.equal(1);
+      expect(logStub.args[0]).to.deep.equal([
+        `Successfully created the package version [08c3i000000fylgAAA]. Subscriber Package Version Id: 04t3i000002eya2AAA${os.EOL}Package Installation URL: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t3i000002eya2AAA${os.EOL}As an alternative, you can use the "sf package:install" command.`,
+      ]);
+    });
+
+    it('should create a new package version with total file-count exceeding threshold', async () => {
+      createStub = $$.SANDBOX.stub(PackageVersion, 'create');
+      createStub.resolves(pkgVersionCreateSuccessResultExceedsFileCount);
+      const envSpy = $$.SANDBOX.spy(env, 'setBoolean').withArgs('SF_APPLY_REPLACEMENTS_ON_CONVERT', true);
+
+      const cmd = new PackageVersionCreateCommand(
+        ['-p', '05i3i000000Gmj6XXX', '-v', 'test@hub.org', '-x', '--async-validation'],
+        config
+      );
+      stubSpinner(cmd);
+      const res = await cmd.run();
+      expect(envSpy.calledOnce).to.equal(true);
+      expect(res).to.deep.equal({
+        Branch: '',
+        CreatedBy: '0053i000001ZIyGAAW',
+        CreatedDate: '2022-11-03 09:46',
+        Error: [],
+        HasMetadataRemoved: false,
+        Id: '08c3i000000fylgAAA',
+        Package2Id: '0Ho3i000000TNHYCA4',
+        Package2VersionId: '05i3i000000fxw1AAA',
+        Status: 'Success',
+        SubscriberPackageVersionId: '04t3i000002eya2AAA',
+        Tag: '',
+        Package2Name: null,
+        HasPassedCodeCoverageCheck: null,
+        CodeCoverage: null,
+        VersionNumber: null,
+        ConvertedFromVersionId: null,
+        TotalNumberOfMetadataFiles: 8000,
+      });
+      expect(warnStub.callCount).to.equal(1);
+      expect(warnStub.args[0]).to.deep.equal([
+        'This package contains more than 7000 metadata files. The maximum number of metadata files in a package is 10000. If you reach the file limit, you won’t be able to create new package versions. To confirm the exact file count for this package, run sf package version report and review the “# Metadata Files” column.',
+      ]);
       expect(logStub.callCount).to.equal(1);
       expect(logStub.args[0]).to.deep.equal([
         `Successfully created the package version [08c3i000000fylgAAA]. Subscriber Package Version Id: 04t3i000002eya2AAA${os.EOL}Package Installation URL: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t3i000002eya2AAA${os.EOL}As an alternative, you can use the "sf package:install" command.`,