Merge pull request #804 from forcedotcom/2gp-readiness/w-20911193/unpackaged-md-conversion

[Conversion] [CLI] Support unpackaged metadata during conversion

Author: ravipanguluri

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/packaging",
-  "version": "4.18.12",
+  "version": "4.18.0",
   "description": "Packaging library for the Salesforce packaging platform",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -42,11 +42,11 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@jsforce/jsforce-node": "^3.10.10",
+    "@jsforce/jsforce-node": "^3.10.13",
     "@salesforce/core": "^8.25.0",
     "@salesforce/kit": "^3.2.4",
     "@salesforce/schemas": "^1.10.3",
-    "@salesforce/source-deploy-retrieve": "^12.31.8",
+    "@salesforce/source-deploy-retrieve": "^12.31.9",
     "@salesforce/ts-types": "^2.0.12",
     "@salesforce/types": "^1.6.0",
     "fast-xml-parser": "^4.5.0",

src/package/packageConvert.ts

@@ -202,8 +202,10 @@ export async function createPackageVersionCreateRequest(
   const packageVersTmpRoot = path.join(os.tmpdir(), uniqueId);
   const packageVersMetadataFolder = path.join(packageVersTmpRoot, 'md-files');
   const seedMetadataFolder = path.join(packageVersTmpRoot, 'seed-md-files');
+  const unpackagedMetadataFolder = path.join(packageVersTmpRoot, 'unpackaged-md-files');
   const packageVersBlobDirectory = path.join(packageVersTmpRoot, 'package-version-info');
   const seedMetadataZipFile = path.join(packageVersBlobDirectory, 'seed-metadata-package.zip');
+  const unpackagedMetadataZipFile = path.join(packageVersBlobDirectory, 'unpackaged-metadata-package.zip');
   const settingsZipFile = path.join(packageVersBlobDirectory, 'settings.zip');
   const metadataZipFile = path.join(packageVersBlobDirectory, 'package.zip');
   const packageVersBlobZipFile = path.join(packageVersTmpRoot, 'package-version-info.zip');
@@ -241,13 +243,31 @@ export async function createPackageVersionCreateRequest(
   await fs.promises.mkdir(packageVersMetadataFolder, { recursive: true });
 
   const seedMetadataPath = context.seedmetadata ?? packageDescriptorJson.seedMetadata?.path;
+
   const hasSeedMetadata = await new MetadataResolver().resolveMetadata(
     seedMetadataPath,
     seedMetadataFolder,
     'seedMDDirectoryDoesNotExist',
     apiVersion
   );
 
+  if (context.codecoverage) {
+    const unpackagedMetadataPath = packageDescriptorJson.unpackagedMetadata?.path;
+    const hasUnpackaged = await new MetadataResolver().resolveMetadata(
+      unpackagedMetadataPath,
+      unpackagedMetadataFolder,
+      'unpackagedMDDirectoryDoesNotExist',
+      apiVersion
+    );
+
+    if (hasUnpackaged) {
+      Logger.childFromRoot('packageConvert').debug(
+        `Including unpackaged metadata found in '${unpackagedMetadataPath ?? '<undefined unpackagedmetadata>'}'.`
+      );
+      await pkgUtils.zipDir(unpackagedMetadataFolder, unpackagedMetadataZipFile);
+    }
+  }
+
   if (hasSeedMetadata) {
     // Zip the seedMetadataFolder folder and put the zip in {packageVersBlobDirectory}/{seedMetadataZipFile}
     Logger.childFromRoot('packageConvert:pollForStatusWithInterval').debug(
@@ -295,7 +315,7 @@ function buildPackageDescriptorJson(args: {
     ...(base ?? {}),
   };
   if (packageObject && isPackagingDirectory(packageObject)) {
-    const allowedKeys: Array<keyof PackageDescriptorJson> = ['apexTestAccess', 'seedMetadata'];
+    const allowedKeys: Array<keyof PackageDescriptorJson> = ['apexTestAccess', 'seedMetadata', 'unpackagedMetadata'];
     for (const key of allowedKeys) {
       if (Object.prototype.hasOwnProperty.call(packageObject, key)) {
         const value = (packageObject as unknown as PackageDescriptorJson)[key];

test/package/packageConvert.test.ts

@@ -160,6 +160,61 @@ describe('packageConvert', () => {
       }
     });
 
+    it('should pick up unpackagedMetadata from sfdx-project.json when codecoverage is enabled', async () => {
+      $$.inProject(true);
+      const project = SfProject.getInstance();
+
+      await fs.promises.mkdir(path.join(project.getPath(), 'force-app'), { recursive: true });
+
+      project.getSfProjectJson().set('packageDirectories', [
+        {
+          path: 'force-app',
+          package: '0Ho3i000000Gmj6CAC',
+          unpackagedMetadata: { path: 'unpackaged-md' },
+        },
+      ]);
+      await project.getSfProjectJson().write();
+
+      $$.SANDBOX.stub(fs, 'existsSync').returns(true);
+      const resolveMetadataSpy = $$.SANDBOX.spy(MetadataResolver.prototype, 'resolveMetadata');
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      $$.SANDBOX.stub(MetadataResolver.prototype, 'generateMDFolderForArtifact' as any).resolves();
+
+      await createPackageVersionCreateRequest({ codecoverage: true }, '0Ho3i000000Gmj6CAC', '60.0', project);
+
+      // check that resolveMetadata was called with the unpackaged metadata directory
+      expect(resolveMetadataSpy.calledWith('unpackaged-md')).to.be.true;
+    });
+
+    it('should NOT pick up unpackagedMetadata from sfdx-project.json when codecoverage is disabled', async () => {
+      $$.inProject(true);
+      const project = SfProject.getInstance();
+
+      await fs.promises.mkdir(path.join(project.getPath(), 'force-app'), { recursive: true });
+
+      project.getSfProjectJson().set('packageDirectories', [
+        {
+          path: 'force-app',
+          package: '0Ho3i000000Gmj6CAC',
+          unpackagedMetadata: { path: 'unpackaged-md' },
+        },
+      ]);
+      await project.getSfProjectJson().write();
+
+      const resolveMetadataSpy = $$.SANDBOX.spy(MetadataResolver.prototype, 'resolveMetadata');
+
+      await createPackageVersionCreateRequest(
+        { codecoverage: false }, // disabled
+        '0Ho3i000000Gmj6CAC',
+        '60.0',
+        project
+      );
+
+      // Verify it was NOT called for the unpackaged directory
+      const unpackagedCall = resolveMetadataSpy.getCalls().find((call) => call.args[0] === 'unpackaged-md');
+      expect(unpackagedCall).to.be.undefined;
+    });
+
     it('should set apexTestAccess permissions in package2descriptor.json when codecoverage is enabled', async () => {
       $$.inProject(true);
       const project = SfProject.getInstance();

yarn.lock

@@ -451,7 +451,7 @@
     "@jridgewell/resolve-uri" "^3.1.0"
     "@jridgewell/sourcemap-codec" "^1.4.14"
 
-"@jsforce/jsforce-node@^3.10.10", "@jsforce/jsforce-node@^3.10.13":
+"@jsforce/jsforce-node@^3.10.13":
   version "3.10.13"
   resolved "https://registry.yarnpkg.com/@jsforce/jsforce-node/-/jsforce-node-3.10.13.tgz#d1e832178e2e74646c75b952e629ac5b8ceff7d0"
   integrity sha512-Ft42/lp3WaVxijcX88Rb3yIxujk/u3LwL3913OTcB4WCpwjB9xTqP6jkVTKt2riXg+ZlNiS62SMpQeC3U1Efkw==
@@ -558,7 +558,32 @@
     strip-ansi "6.0.1"
     ts-retry-promise "^0.8.1"
 
-"@salesforce/core@^8.23.1", "@salesforce/core@^8.24.0", "@salesforce/core@^8.25.0", "@salesforce/core@^8.8.0":
+"@salesforce/core@^8.23.1", "@salesforce/core@^8.24.0", "@salesforce/core@^8.8.0":
+  version "8.24.3"
+  resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-8.24.3.tgz#c18fb2481ab212c460fd351520712a4fa8b4329f"
+  integrity sha512-E9k4G3S8svS6QtsPVhUvxr0VHWyzg7KxH8sYM0o5pk7QEUXZCKQEQE5VjQOa+Gl3jRyX6zv/8Cp4UpQ2ZszOVg==
+  dependencies:
+    "@jsforce/jsforce-node" "^3.10.13"
+    "@salesforce/kit" "^3.2.4"
+    "@salesforce/ts-types" "^2.0.12"
+    ajv "^8.17.1"
+    change-case "^4.1.2"
+    fast-levenshtein "^3.0.0"
+    faye "^1.4.1"
+    form-data "^4.0.4"
+    js2xmlparser "^4.0.1"
+    jsonwebtoken "9.0.3"
+    jszip "3.10.1"
+    memfs "^4.30.1"
+    pino "^9.7.0"
+    pino-abstract-transport "^1.2.0"
+    pino-pretty "^11.3.0"
+    proper-lockfile "^4.1.2"
+    semver "^7.7.3"
+    ts-retry-promise "^0.8.1"
+    zod "^4.1.12"
+
+"@salesforce/core@^8.25.0":
   version "8.25.0"
   resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-8.25.0.tgz#2cf53f38aee8fb6ea1b0e6b6e301b66bc0d81d1c"
   integrity sha512-LdUDEK8mmiWpnKn6wtaSDcvZc2Svrg/xldint1OGyVhCGZUAQLjCWRKkBT5DdIVV3g9QrDNhLboi904jcwDe1g==
@@ -637,10 +662,10 @@
   resolved "https://registry.yarnpkg.com/@salesforce/schemas/-/schemas-1.10.3.tgz#52c867fdd60679cf216110aa49542b7ad391f5d1"
   integrity sha512-FKfvtrYTcvTXE9advzS25/DEY9yJhEyLvStm++eQFtnAaX1pe4G3oGHgiQ0q55BM5+0AlCh0+0CVtQv1t4oJRA==
 
-"@salesforce/source-deploy-retrieve@^12.31.8":
-  version "12.31.8"
-  resolved "https://registry.yarnpkg.com/@salesforce/source-deploy-retrieve/-/source-deploy-retrieve-12.31.8.tgz#0eade61d5f117722fed81a4f2c04eb7a7d5f4703"
-  integrity sha512-gp2yJUuAsR86v8QkGY50Sxyiup4H0QNyT7bC3rowxUnR/mw1q3gkXSDnhHOWt5toWsZr78oL1ztGQxG89l89XQ==
+"@salesforce/source-deploy-retrieve@^12.31.9":
+  version "12.31.9"
+  resolved "https://registry.yarnpkg.com/@salesforce/source-deploy-retrieve/-/source-deploy-retrieve-12.31.9.tgz#69592e0b1564157fce8b7c66b33412460fa62b6e"
+  integrity sha512-UVRmLVl+Es1jLGnSx4G2xxTNHR7L6v5uzOpBFbg1ADMOQ4b1v8cDwZO9noJa9xAG+MLJJ7zDkcqywgFxU/3mmQ==
   dependencies:
     "@salesforce/core" "^8.24.0"
     "@salesforce/kit" "^3.2.4"