fix: include parent in manifest when retrieving - W-18650723

package.json

@@ -25,7 +25,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@salesforce/core": "^8.11.0",
+    "@salesforce/core": "^8.11.4",
     "@salesforce/kit": "^3.2.3",
     "@salesforce/ts-types": "^2.0.12",
     "@salesforce/types": "^1.3.0",

src/collections/componentSet.ts

@@ -81,6 +81,12 @@ export class ComponentSet extends LazyCollection<MetadataComponent> {
   // all components stored here, regardless of what manifest they belong to
   private components = new DecodeableMap<string, DecodeableMap<string, SourceComponent>>();
 
+  // whether this component set is being used for a deploy
+  // @ts-expect-error this is currently not used but could be used in the future
+  private forDeploy = false;
+  // whether this component set is being used for a retrieve
+  private forRetrieve = false;
+
   // internal component maps used by this.getObject() when building manifests.
   private destructiveComponents = {
     [DestructiveChangesType.PRE]: new DecodeableMap<string, DecodeableMap<string, SourceComponent>>(),
@@ -348,6 +354,8 @@ export class ComponentSet extends LazyCollection<MetadataComponent> {
       throw new SfError(messages.getMessage('error_no_source_to_deploy'), 'ComponentSetError');
     }
 
+    this.forDeploy = true;
+
     if (
       typeof options.usernameOrConnection !== 'string' &&
       this.apiVersion &&
@@ -384,6 +392,8 @@ export class ComponentSet extends LazyCollection<MetadataComponent> {
       apiVersion: this.apiVersion,
     });
 
+    this.forRetrieve = true;
+
     if (
       typeof options.usernameOrConnection !== 'string' &&
       this.apiVersion &&
@@ -427,8 +437,9 @@ export class ComponentSet extends LazyCollection<MetadataComponent> {
         .flatMap((c) => c.getChildren())
         .map((child) => addToTypeMap({ typeMap, type: child.type, fullName: child.fullName, destructiveType }));
 
-      // logic: if this is a decomposed type, skip its inclusion in the manifest if the parent is "empty"
+      // logic: if this is a decomposed type not being retrieved, skip its inclusion in the manifest if the parent is "empty"
       if (
+        !this.forRetrieve &&
         type.strategies?.transformer === 'decomposed' &&
         // exclude (ex: CustomObjectTranslation) where there are no addressable children
         Object.values(type.children?.types ?? {}).some((t) => t.unaddressableWithoutParent !== true) &&

test/collections/componentSet.test.ts

@@ -980,7 +980,7 @@ describe('ComponentSet', () => {
       ]);
     });
 
-    it('omits empty parents from the package manifest', async () => {
+    it('omits empty parents from the package manifest when not a retrieve', async () => {
       const set = new ComponentSet([
         DECOMPOSED_CHILD_COMPONENT_1_EMPTY,
         DECOMPOSED_CHILD_COMPONENT_2_EMPTY,
@@ -999,6 +999,30 @@ describe('ComponentSet', () => {
         },
       ]);
     });
+
+    it('does not omit empty parents from the package manifest for retrieves', async () => {
+      const set = new ComponentSet([
+        DECOMPOSED_CHILD_COMPONENT_1_EMPTY,
+        DECOMPOSED_CHILD_COMPONENT_2_EMPTY,
+        DECOMPOSED_COMPONENT_EMPTY,
+      ]);
+      // @ts-expect-error modifying private property
+      set.forRetrieve = true;
+      expect((await set.getObject()).Package.types).to.deep.equal([
+        {
+          name: DECOMPOSED_CHILD_COMPONENT_1_EMPTY.type.name,
+          members: [DECOMPOSED_CHILD_COMPONENT_1_EMPTY.fullName],
+        },
+        {
+          name: DECOMPOSED_COMPONENT_EMPTY.type.name,
+          members: [DECOMPOSED_COMPONENT_EMPTY.fullName],
+        },
+        {
+          name: DECOMPOSED_CHILD_COMPONENT_2_EMPTY.type.name,
+          members: [DECOMPOSED_CHILD_COMPONENT_2_EMPTY.fullName],
+        },
+      ]);
+    });
   });
 
   describe('getPackageXml', () => {

test/snapshot/sampleProjects/customObjects-and-children/__snapshots__/verify-md-files-deploy.expected/deployOutput/mdapi/objects/Broker__c.object

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
+    <fields>
+        <fullName>Title__c</fullName>
+        <externalId>false</externalId>
+        <label>Title</label>
+        <length>30</length>
+        <required>false</required>
+        <trackTrending>false</trackTrending>
+        <type>Text</type>
+        <unique>false</unique>
+    </fields>
+</CustomObject>

test/snapshot/sampleProjects/customObjects-and-children/__snapshots__/verify-md-files-deploy.expected/deployOutput/mdapi/package.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>Broker__c.Title__c</members>
+        <name>CustomField</name>
+    </types>
+    <version>59.0</version>
+</Package>

test/snapshot/sampleProjects/customObjects-and-children/__snapshots__/verify-md-files-retrieve.expected/retrieveOutput/mdapi/objects/Broker__c.object

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
+    <fields>
+        <fullName>Title__c</fullName>
+        <externalId>false</externalId>
+        <label>Title</label>
+        <length>30</length>
+        <required>false</required>
+        <trackTrending>false</trackTrending>
+        <type>Text</type>
+        <unique>false</unique>
+    </fields>
+</CustomObject>

test/snapshot/sampleProjects/customObjects-and-children/__snapshots__/verify-md-files-retrieve.expected/retrieveOutput/mdapi/package.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>Broker__c.Title__c</members>
+        <name>CustomField</name>
+    </types>
+    <types>
+        <members>Broker__c</members>
+        <name>CustomObject</name>
+    </types>
+    <version>59.0</version>
+</Package>

test/snapshot/sampleProjects/customObjects-and-children/originalMdapi2/objects/Broker__c.object

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
+    <fields>
+        <fullName>Title__c</fullName>
+        <externalId>false</externalId>
+        <label>Title</label>
+        <length>30</length>
+        <required>false</required>
+        <trackTrending>false</trackTrending>
+        <type>Text</type>
+        <unique>false</unique>
+    </fields>
+</CustomObject>

test/snapshot/sampleProjects/customObjects-and-children/originalMdapi2/package.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Package xmlns="http://soap.sforce.com/2006/04/metadata">
+    <types>
+        <members>Broker__c.Title__c</members>
+        <name>CustomField</name>
+    </types>
+    <version>63.0</version>
+</Package>

test/snapshot/sampleProjects/customObjects-and-children/snapshots.test.ts

@@ -9,11 +9,14 @@ import * as path from 'node:path';
 import {
   FORCE_APP,
   MDAPI_OUT,
+  dirEntsToPaths,
   dirsAreIdentical,
   fileSnap,
   mdapiToSource,
   sourceToMdapi,
 } from '../../helper/conversions';
+import { MetadataConverter } from '../../../../src/convert/metadataConverter';
+import { ComponentSetBuilder } from '../../../../src/collections/componentSetBuilder';
 
 // we don't want failing tests outputting over each other
 /* eslint-disable no-await-in-loop */
@@ -49,3 +52,138 @@ describe('Custom objects and children', () => {
     ]);
   });
 });
+
+/** Return only the files involved in the conversion */
+const getConvertedFilePaths = async (outputDir: string): Promise<string[]> =>
+  dirEntsToPaths(
+    await fs.promises.readdir(outputDir, {
+      recursive: true,
+      withFileTypes: true,
+    })
+  );
+
+describe('CustomField with empty CustomObject - retrieve', () => {
+  const testDir = path.join('test', 'snapshot', 'sampleProjects', 'customObjects-and-children');
+
+  // The directory of snapshots containing expected conversion results
+  const snapshotsDir = path.join(testDir, '__snapshots__');
+
+  // MDAPI format of the original source
+  const sourceDir = path.join(testDir, 'originalMdapi2');
+
+  // The directory where metadata is converted as part of retrieve testing
+  const retrieveOutput = path.join(testDir, 'retrieveOutput');
+
+  // This test verifies that 1 custom field with an empty parent
+  // does not omit the parent from the package manifest for a retrieve when
+  // converting from source to mdapi.
+  it('verify md files retrieve', async () => {
+    const cs = await ComponentSetBuilder.build({
+      metadata: {
+        metadataEntries: ['CustomObject:Broker__c'],
+        directoryPaths: [sourceDir],
+      },
+      projectDir: testDir,
+    });
+
+    const sourceOutputDir = path.join(retrieveOutput, 'source');
+    const mdOutputDir = path.join(retrieveOutput, 'mdapi');
+
+    await new MetadataConverter().convert(cs, 'source', {
+      type: 'directory',
+      outputDirectory: sourceOutputDir,
+      genUniqueDir: false,
+    });
+
+    const cs2 = await ComponentSetBuilder.build({
+      metadata: {
+        metadataEntries: ['CustomObject:Broker__c'],
+        directoryPaths: [sourceOutputDir],
+      },
+      projectDir: testDir,
+    });
+
+    // @ts-expect-error modifying private property
+    cs2.forRetrieve = true;
+
+    await new MetadataConverter().convert(cs2, 'metadata', {
+      type: 'directory',
+      outputDirectory: mdOutputDir,
+      genUniqueDir: false,
+    });
+
+    const convertedFiles = await getConvertedFilePaths(mdOutputDir);
+    for (const file of convertedFiles) {
+      await fileSnap(file, testDir);
+    }
+    const expectedOutputDir = path.join(snapshotsDir, 'verify-md-files-retrieve.expected', 'retrieveOutput', 'mdapi');
+    await dirsAreIdentical(expectedOutputDir, mdOutputDir);
+  });
+
+  after(async () => {
+    await Promise.all([fs.promises.rm(retrieveOutput, { recursive: true, force: true })]);
+  });
+});
+
+describe('CustomField with empty CustomObject - deploy', () => {
+  const testDir = path.join('test', 'snapshot', 'sampleProjects', 'customObjects-and-children');
+
+  // The directory of snapshots containing expected conversion results
+  const snapshotsDir = path.join(testDir, '__snapshots__');
+
+  // MDAPI format of the original source
+  const sourceDir = path.join(testDir, 'originalMdapi2');
+
+  // The directory where metadata is converted as part of deploy testing
+  const deployOutput = path.join(testDir, 'deployOutput');
+
+  // This test verifies that 1 custom field with an empty parent
+  // omits the parent from the package manifest for a deploy when
+  // converting from source to mdapi.
+  it('verify md files deploy', async () => {
+    const cs = await ComponentSetBuilder.build({
+      metadata: {
+        metadataEntries: ['CustomObject:Broker__c'],
+        directoryPaths: [sourceDir],
+      },
+      projectDir: testDir,
+    });
+
+    const sourceOutputDir = path.join(deployOutput, 'source');
+    const mdOutputDir = path.join(deployOutput, 'mdapi');
+
+    await new MetadataConverter().convert(cs, 'source', {
+      type: 'directory',
+      outputDirectory: sourceOutputDir,
+      genUniqueDir: false,
+    });
+
+    const cs2 = await ComponentSetBuilder.build({
+      metadata: {
+        metadataEntries: ['CustomObject:Broker__c'],
+        directoryPaths: [sourceOutputDir],
+      },
+      projectDir: testDir,
+    });
+
+    // @ts-expect-error modifying private property
+    cs2.forDeploy = true;
+
+    await new MetadataConverter().convert(cs2, 'metadata', {
+      type: 'directory',
+      outputDirectory: mdOutputDir,
+      genUniqueDir: false,
+    });
+
+    const convertedFiles = await getConvertedFilePaths(mdOutputDir);
+    for (const file of convertedFiles) {
+      await fileSnap(file, testDir);
+    }
+    const expectedOutputDir = path.join(snapshotsDir, 'verify-md-files-deploy.expected', 'deployOutput', 'mdapi');
+    await dirsAreIdentical(expectedOutputDir, mdOutputDir);
+  });
+
+  after(async () => {
+    await Promise.all([fs.promises.rm(deployOutput, { recursive: true, force: true })]);
+  });
+});