feat: handle unpackaged md for conversion

Author: ravipanguluri

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();