fix: modify beta2 permset transformer and finalizer - W-18308093 (#1554)

* fix: modify beta2 permset transformer and finalizer

* fix: remove snapshot files that should not be there

* chore: remove directives, deleting mdapi/force-app on snapshot UT

* chore: bump core

---------

Co-authored-by: Willie Ruemmele <[email protected]>

Author: shetzel

CHANGELOG.md

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

METADATA_SUPPORT.md

@@ -7,6 +7,7 @@
 import { join } from 'node:path';
 import { ensure, ensureString } from '@salesforce/ts-types';
 import type { PermissionSet } from '@jsforce/jsforce-node/lib/api/metadata/schema';
+import { ensureArray } from '@salesforce/kit';
 import { MetadataType } from '../../registry';
 import { XML_NS_KEY, XML_NS_URL } from '../../common/constants';
 import { JsToXml } from '../streams';
@@ -43,6 +44,23 @@ export class DecomposedPermissionSetFinalizer extends ConvertTransactionFinalize
 
     const agg: WriterFormat[] = [];
     this.transactionState.parentToChild.forEach((children, parent) => {
+      // iterate over children and build PermissionSet data structure
+      const permset = new Map<string, unknown[]>();
+      for (const child of children) {
+        for (const [key, value] of Object.entries(child)) {
+          const existingEntry = permset.get(key);
+          if (existingEntry) {
+            if (Array.isArray(value)) {
+              permset.set(key, existingEntry.concat(value));
+            } else {
+              existingEntry.push(value);
+              permset.set(key, existingEntry);
+            }
+          } else {
+            permset.set(key, ensureArray<unknown>(value));
+          }
+        }
+      }
       agg.push({
         component: {
           type: ensure(this.permissionSetType, 'DecomposedPermissionSetFinalizer should have set PermissionSetType'),
@@ -55,14 +73,9 @@ export class DecomposedPermissionSetFinalizer extends ConvertTransactionFinalize
               `${parent}.permissionset`
             ),
             source: new JsToXml({
-              // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
               PermissionSet: {
                 [XML_NS_KEY]: XML_NS_URL,
-                ...Object.assign(
-                  {},
-                  // sort the children by fullName
-                  ...Object.values(children.sort((a, b) => ((a.fullName ?? '') > (b.fullName ?? '') ? -1 : 1)))
-                ),
+                ...Object.fromEntries(permset),
               },
             }),
           },

package.json

@@ -7,6 +7,7 @@
 
 import { join } from 'node:path';
 import { AnyJson, ensureString, JsonMap } from '@salesforce/ts-types';
+import { ensureArray } from '@salesforce/kit';
 import type { PermissionSet } from '@jsforce/jsforce-node/lib/api/metadata/schema';
 import { calculateRelativePath } from '../../utils/path';
 import { unwrapAndOmitNS } from '../../utils/decomposed';
@@ -95,6 +96,7 @@ export class DecomposedPermissionSetTransformer extends BaseMetadataTransformer
       .filter(hasChildTypeId)
       .map(addChildType)
       .map((child) => toInfoContainer(mergeWith)(component)(child.childType)(child.tagValue as JsonMap))
+      .flat()
       .filter(forceIgnoreAllowsComponent(forceIgnore));
 
     const writeInfosForChildren = combineChildWriteInfos([
@@ -202,20 +204,41 @@ const toInfoContainer =
   (mergeWith: SourceComponent | undefined) =>
   (parent: SourceComponent) =>
   (childType: MetadataType) =>
-  (tagValue: JsonMap): InfoContainer => {
+  (tagValue: JsonMap): InfoContainer[] => {
     const tagEntry: JsonMap[] = Array.isArray(tagValue) ? tagValue : [tagValue];
-    const entryName = childType.directoryName
-      ? (tagEntry.at(0)?.[childType.uniqueIdElement!] as string).split('.')[0]
-      : parent.name;
-    return {
+
+    const buildInfoContainer = (entryName: string, value: JsonMap): InfoContainer => ({
       parentComponent: parent,
       entryName,
       childComponent: {
         fullName: `${parent.fullName}.${entryName}`,
         type: childType,
         parent,
       },
-      value: tagValue,
+      value,
       mergeWith,
-    };
+    });
+
+    // ObjectSettings, ObjectPermission (object), FieldPermission (field),
+    // RecordTypeVisibility (recordType), TabSetting (tab)
+    if (childType.directoryName) {
+      const infoContainers = new Map<string, InfoContainer>();
+      tagEntry.map((entry) => {
+        let entryName = (entry[childType.uniqueIdElement!] as string).split('.')[0];
+        // If the object name starts with `standard-`, we need to remove the prefix
+        if (entryName.startsWith('standard-')) {
+          entryName = entryName.replace('standard-', '');
+        }
+        const infoContainer = infoContainers.get(entryName);
+        if (infoContainer) {
+          // Add to the value of the existing InfoContainer
+          // @ts-expect-error this is either JsonMap or JsonArray
+          infoContainer.value = ensureArray(infoContainer.value).concat(entry);
+        } else {
+          infoContainers.set(entryName, buildInfoContainer(entryName, entry));
+        }
+      });
+      return Array.from(infoContainers.values());
+    }
+    return [buildInfoContainer(parent.name, tagValue)];
   };

src/convert/convertContext/decomposedPermissionSetFinalizer.ts

@@ -27,15 +27,18 @@ describe('DecomposedPermissionSetTransformer', () => {
         const component = MD_FORMAT_PS;
         const xf = new DecomposedPermissionSetTransformer(regAcc);
         const result = await xf.toSourceFormat({ component });
-        expect(result).to.have.length(5);
+        expect(result).to.have.length(8);
         result.map((l) => {
           expect(l.output).to.include(join('main', 'default', 'permissionsets'));
         });
         expect(result[0].output).to.match(/myPS.classAccess-meta.xml$/);
         expect(result[1].output).to.match(/myPS.userPermission-meta.xml$/);
         expect(result[2].output).to.match(/objectSettings[\\/]Account.objectSettings-meta.xml$/);
-        expect(result[3].output).to.match(/objectSettings[\\/]Broker__c.objectSettings-meta.xml$/);
-        expect(result[4].output).to.match(/myPS.permissionset-meta.xml$/);
+        expect(result[3].output).to.match(/objectSettings[\\/]AppAnalyticsQueryRequest.objectSettings-meta.xml$/);
+        expect(result[4].output).to.match(/objectSettings[\\/]Asset.objectSettings-meta.xml$/);
+        expect(result[5].output).to.match(/objectSettings[\\/]AssetAction.objectSettings-meta.xml$/);
+        expect(result[6].output).to.match(/objectSettings[\\/]Broker__c.objectSettings-meta.xml$/);
+        expect(result[7].output).to.match(/myPS.permissionset-meta.xml$/);
       });
 
       it('will write a singular child type', async () => {
@@ -57,8 +60,8 @@ describe('DecomposedPermissionSetTransformer', () => {
           component,
           mergeSet: new ComponentSet([ONLY_PS_PARENT], regAcc),
         });
-        expect(result).to.have.length(5);
-        expect(result[4].output).to.equal(ONLY_PS_PARENT.xml!);
+        expect(result).to.have.length(8);
+        expect(result[7].output).to.equal(ONLY_PS_PARENT.xml!);
       });
     });
   });

src/convert/transformers/decomposedPermissionSetTransformer.ts

@@ -6,4 +6,4 @@
         <customPermission>MYCP2</customPermission>
         <dependency>true</dependency>
     </requiredPermission>
-</CustomPermission>
+</CustomPermission>

test/convert/transformers/decompoedPermissionSetTransformer.test.ts renamed to test/convert/transformers/decomposedPermissionSetTransformer.test.ts

@@ -2,4 +2,4 @@
 <CustomPermission xmlns="http://soap.sforce.com/2006/04/metadata">
     <isLicensed>false</isLicensed>
     <label>MYCP2</label>
-</CustomPermission>
+</CustomPermission>

test/snapshot/sampleProjects/preset-decomposedPS2/__snapshots__/verify-md-files.expected/customPermissions/MYCP.customPermission

@@ -101,6 +101,14 @@
         <object>Broker__c</object>
         <viewAllRecords>true</viewAllRecords>
     </objectPermissions>
+    <tabSettings>
+        <tab>standard-AssetAction</tab>
+        <visibility>Visible</visibility>
+    </tabSettings>
+    <tabSettings>
+        <tab>Broker__c</tab>
+        <visibility>Available</visibility>
+    </tabSettings>
     <fieldPermissions>
         <editable>true</editable>
         <field>Broker__c.Broker_Id__c</field>
@@ -131,14 +139,6 @@
         <field>Broker__c.Picture__c</field>
         <readable>true</readable>
     </fieldPermissions>
-    <tabSettings>
-        <tab>Broker__c</tab>
-        <visibility>Available</visibility>
-    </tabSettings>
-    <tabSettings>
-        <tab>standard-AssetAction</tab>
-        <visibility>Visible</visibility>
-    </tabSettings>
     <description>my permission set description</description>
     <hasActivationRequired>false</hasActivationRequired>
     <label>decomposed</label>

test/snapshot/sampleProjects/preset-decomposedPS2/__snapshots__/verify-md-files.expected/customPermissions/MYCP2.customPermission

@@ -6,4 +6,4 @@
         <customPermission>MYCP2</customPermission>
         <dependency>true</dependency>
     </requiredPermission>
-</CustomPermission>
+</CustomPermission>