Wr/decompose esr (#1492)

* chore: reset snapshots to main

* fix: deploy ESR yaml and -meta

* test: fix registry test

* chore: bump core

* chore: always decompose to yaml

The schema property contents in an esr can be either yaml of json.
For simplicity, given the property alwasy represents an Open API spec, the decomposed format of schema will be yaml.
Recomposition will use an existing xml property, schemaUploadFileExtension, to determine the format when build the MD type.

* chore: add missing expected artifacts

---------

Co-authored-by: peternhale <[email protected]>

Author: WillieRuemmele

package.json

@@ -25,8 +25,8 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@salesforce/core": "^8.8.0",
-    "@salesforce/kit": "^3.2.2",
+    "@salesforce/core": "^8.8.2",
+    "@salesforce/kit": "^3.2.3",
     "@salesforce/ts-types": "^2.0.12",
     "fast-levenshtein": "^3.0.0",
     "fast-xml-parser": "^4.5.1",

src/convert/transformers/decomposeExternalServiceRegistrationTransformer.ts

@@ -4,7 +4,6 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
 import { Readable } from 'node:stream';
 import * as yaml from 'yaml';
@@ -16,10 +15,15 @@ import { SourceComponent } from '../../resolve';
 import { DEFAULT_PACKAGE_ROOT_SFDX, META_XML_SUFFIX, XML_DECL, XML_NS_KEY } from '../../common';
 import { BaseMetadataTransformer } from './baseMetadataTransformer';
 
+type SchemaType = 'json' | 'yaml';
+
 type ESR = JsonMap & {
-  ExternalServiceRegistration: ExternalServiceRegistration;
+  ExternalServiceRegistration: ExternalServiceRegistration &
+    { schemaUploadFileExtension: SchemaType };
 };
 
+
+
 const xmlDeclaration = '<?xml version="1.0" encoding="UTF-8"?>\n';
 
 export class DecomposeExternalServiceRegistrationTransformer extends BaseMetadataTransformer {
@@ -40,13 +44,17 @@ export class DecomposeExternalServiceRegistrationTransformer extends BaseMetadat
     // Extract schema content
     // eslint-disable-next-line no-underscore-dangle
     const schemaContent: string = xmlContent.schema ?? '';
-    const schemaExtension = this.getSchemaExtension(schemaContent);
-    const schemaFileName = `${component.fullName}.${schemaExtension}`;
+    const schemaType = xmlContent.schemaUploadFileExtension ?? this.getSchemaType(schemaContent);
+    const asYaml = schemaType === 'yaml' ? schemaContent : yaml.stringify(JSON.parse(schemaContent));
+    const schemaFileName = `${component.fullName}.yaml`;
     const schemaFilePath = path.join(path.dirname(outputDir), schemaFileName);
 
+    // make sure the schema type is set
+    xmlContent.schemaUploadFileExtension = schemaType;
+
     // Write schema content to file
     writeInfos.push({
-      source: Readable.from(schemaContent),
+      source: Readable.from(asYaml),
       output: schemaFilePath,
     });
 
@@ -84,8 +92,11 @@ export class DecomposeExternalServiceRegistrationTransformer extends BaseMetadat
     // Read schema content from file
     const schemaFileName = `${component.fullName}.yaml`; // or .json based on your logic
     const schemaFilePath = path.join(path.dirname(esrFilePath ?? ''), schemaFileName);
-    // Add schema content back to ESR content
-    esrContent.schema = await this.readSchemaFile(schemaFilePath);
+    // load the schema content from the file
+    const schemaContent = (await component.tree.readFile(schemaFilePath)).toString();
+    // Add schema content back to ESR content in its original format
+    // if the original format was JSON, then convert the yaml to json otherwise leave as is
+    esrContent.schema = esrContent.schemaUploadFileExtension === 'json' ? JSON.stringify(yaml.parse(schemaContent), undefined, 2) : schemaContent;
 
     // Write combined content back to md format
     this.context.decomposedExternalServiceRegistration.transactionState.esrRecords.set(component.fullName, {
@@ -97,11 +108,6 @@ export class DecomposeExternalServiceRegistrationTransformer extends BaseMetadat
     return [];
   }
 
-  // eslint-disable-next-line class-methods-use-this
-  public readSchemaFile(schemaFilePath: string): Promise<string> {
-    return fs.readFile(schemaFilePath, 'utf8');
-  }
-
   // eslint-disable-next-line class-methods-use-this
   private getOutputFolder(format: string, component: SourceComponent, mergeWith?: SourceComponent): string {
     const base = format === 'source' ? DEFAULT_PACKAGE_ROOT_SFDX : '';
@@ -110,12 +116,7 @@ export class DecomposeExternalServiceRegistrationTransformer extends BaseMetadat
   }
 
   // eslint-disable-next-line class-methods-use-this
-  private getSchemaExtension(content: string): string {
-    try {
-      yaml.parse(content);
-      return 'yaml';
-    } catch {
-      return 'json';
-    }
+  private getSchemaType(content: string): SchemaType {
+    return content.trim().startsWith('{') ? 'json' : 'yaml';
   }
 }

src/registry/presets/decomposeExternalServiceRegistrationBeta.json

@@ -4,7 +4,10 @@
       "children": {
         "types": {
           "yaml": {
-            "directoryName": "",
+            "strategies": {
+              "adapter": "partiallyDecomposed"
+            },
+            "directoryName": "externalServiceRegistrations",
             "id": "yaml",
             "isAddressable": false,
             "name": "OAS Yaml Schema",
@@ -21,7 +24,7 @@
       "ignoreParsedFullName": false,
       "name": "ExternalServiceRegistration",
       "strategies": {
-        "adapter": "decomposed",
+        "adapter": "partiallyDecomposed",
         "decomposition": "topLevel",
         "transformer": "decomposeExternalServiceRegistration"
       },

src/registry/types.ts

@@ -139,7 +139,14 @@ export type MetadataType = {
    * Configuration for resolving and converting components of the type.
    */
   strategies?: {
-    adapter: 'mixedContent' | 'matchingContentFile' | 'decomposed' | 'digitalExperience' | 'bundle' | 'default';
+    adapter:
+      | 'mixedContent'
+      | 'matchingContentFile'
+      | 'decomposed'
+      | 'digitalExperience'
+      | 'bundle'
+      | 'default'
+      | 'partiallyDecomposed';
     transformer?:
       | 'decomposed'
       | 'staticResource'

src/resolve/adapters/partialDecomposedAdapter.ts

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2022, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { basename } from 'node:path';
+import { SourceComponent } from '../sourceComponent';
+import { extName } from '../../utils';
+import { DefaultSourceAdapter } from './defaultSourceAdapter';
+
+/**
+ * Handles types with partially decomposed content. This means that there will be 2+ files,
+ * one being the parent (-meta.xml) and more being the "children" - these children make up one XML tag of the parent
+ *
+ * __Example Types__:
+ *
+ * DecomposeExternalServiceRegistrationBeta Preset
+ *
+ * __Example Structures__:
+ *
+ *```text
+ * externalServiceRegistration/
+ * ├── myFoo.externalServiceRegistration-meta.xml
+ * ├── myFoo.yaml
+ * ├── myFoo.json
+ *```
+ */
+export class PartialDecomposedAdapter extends DefaultSourceAdapter {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  protected populate(trigger: string, component?: SourceComponent): SourceComponent {
+    const parentType = this.registry.getParentType(this.type.id);
+
+    // no children of this type,
+    // the parent has child types
+    // and the trigger starts with one of the parent's child's suffixes
+    // => we have a child path
+    if (
+      !this.type.children &&
+      parentType?.children &&
+      Object.keys(parentType.children.suffixes).find((suffix) => trigger.endsWith(`.${suffix}`))
+    ) {
+      // we have a child, return the parent for the transformer to rebundle together
+      return new SourceComponent(
+        {
+          name: getName(trigger),
+          type: parentType,
+
+          // change the xml to point to the parent, the transformer will reassemble all parts to form valid MD format files
+          xml: trigger.replace(extName(trigger), 'externalServiceRegistration-meta.xml'),
+        },
+        this.tree,
+        this.forceIgnore
+      );
+    } else {
+      // we were given a parent
+      return new SourceComponent(
+        {
+          name: getName(trigger),
+          type: this.type,
+          xml: trigger,
+        },
+        this.tree,
+        this.forceIgnore
+      );
+    }
+  }
+}
+
+function getName(contentPath: string): string {
+  return basename(contentPath).split('.').at(0)!;
+}

src/resolve/adapters/sourceAdapterFactory.ts

@@ -16,6 +16,7 @@ import { MatchingContentSourceAdapter } from './matchingContentSourceAdapter';
 import { MixedContentSourceAdapter } from './mixedContentSourceAdapter';
 import { DefaultSourceAdapter } from './defaultSourceAdapter';
 import { DigitalExperienceSourceAdapter } from './digitalExperienceSourceAdapter';
+import { PartialDecomposedAdapter } from './partialDecomposedAdapter';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/source-deploy-retrieve', 'sdr');
@@ -42,6 +43,8 @@ export class SourceAdapterFactory {
         return new MixedContentSourceAdapter(type, this.registry, forceIgnore, this.tree);
       case 'digitalExperience':
         return new DigitalExperienceSourceAdapter(type, this.registry, forceIgnore, this.tree);
+      case 'partiallyDecomposed':
+        return new PartialDecomposedAdapter(type, this.registry, forceIgnore, this.tree);
       case 'default':
       case undefined:
         return new DefaultSourceAdapter(type, this.registry, forceIgnore, this.tree);

test/convert/transformers/decomposedExternalServiceRegistration.test.ts

@@ -52,9 +52,6 @@ describe('DecomposeExternalServiceRegistrationTransformer', () => {
 
     beforeEach(() => {
       sandbox.stub(VirtualTreeContainer.prototype, 'readFileSync').returns(Buffer.from(SAMPLE_OAS_DOC));
-      sandbox
-        .stub(DecomposeExternalServiceRegistrationTransformer.prototype, 'readSchemaFile')
-        .resolves(SAMPLE_OAS_DOC);
     });
 
     afterEach(() => {

test/mock/type-constants/decomposeExternalServiceRegistrationConstants.ts

@@ -13,8 +13,11 @@ const regAcc = new RegistryAccess(getEffectiveRegistry({ presets: [presetMap.get
 
 const externalServiceRegistration = regAcc.getTypeByName('ExternalServiceRegistration');
 
-const MDAPI_XML_NAME = 'myESR.externalServiceRegistration';
-const SOURCE_XML_NAME = 'myESR.externalServiceRegistration-meta.xml';
+export const MDAPI_XML = 'myESR.externalServiceRegistration';
+export const SOURCE_META_FILE = 'myESR.externalServiceRegistration-meta.xml';
+export const CHILD_YAML = 'myESR.yaml';
+
+export const TYPE_DIRECTORY = 'externalServiceRegistrations';
 
 export const SAMPLE_OAS_DOC = `openapi: 3.0.0
 info:
@@ -70,14 +73,14 @@ export const MD_FORMAT_ESR = new SourceComponent(
   {
     name: 'myESR',
     type: externalServiceRegistration,
-    xml: join('externalServiceRegistrations', MDAPI_XML_NAME),
+    xml: join('externalServiceRegistrations', MDAPI_XML),
   },
   new VirtualTreeContainer([
     {
       dirPath: 'externalServiceRegistrations',
       children: [
         {
-          name: MDAPI_XML_NAME,
+          name: MDAPI_XML,
           data: Buffer.from(`<?xml version="1.0" encoding="UTF-8"?>
 <ExternalServiceRegistration xmlns="http://soap.sforce.com/2006/04/metadata">
     <description>external service</description>
@@ -105,7 +108,7 @@ export const SOURCE_FORMAT_ESR = new SourceComponent(
   {
     name: 'myESR',
     type: externalServiceRegistration,
-    xml: join('main', 'default', 'externalServiceRegistrations', SOURCE_XML_NAME),
+    xml: join('main', 'default', 'externalServiceRegistrations', SOURCE_META_FILE),
   },
   new VirtualTreeContainer([
     {

test/registry/registryValidation.test.ts

@@ -282,6 +282,7 @@ describe('will run preset tests', () => {
                 'bundle',
                 'matchingContentFile',
                 'decomposed',
+                'partiallyDecomposed',
                 'digitalExperience',
               ]).includes(type.strategies?.adapter);
             });

test/resolve/adapters/partialDecomposedAdapter.test.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { expect } from 'chai';
+import { MetadataRegistry, RegistryAccess, SourceComponent, VirtualTreeContainer } from '../../../src';
+import * as decomposeExternalServiceRegistrationBeta from '../../../src/registry/presets/decomposeExternalServiceRegistrationBeta.json';
+import { decomposeExternalServiceRegistration } from '../../mock/type-constants';
+import { PartialDecomposedAdapter } from '../../../src/resolve/adapters/partialDecomposedAdapter';
+
+describe('PartialDecomposedAdapter', () => {
+  const registryAccess = new RegistryAccess(decomposeExternalServiceRegistrationBeta as MetadataRegistry);
+  const type = registryAccess.getTypeByName('externalserviceregistration');
+  const { CHILD_YAML, TYPE_DIRECTORY, SOURCE_META_FILE } = decomposeExternalServiceRegistration;
+  const tree = new VirtualTreeContainer([
+    {
+      dirPath: TYPE_DIRECTORY,
+      children: [SOURCE_META_FILE, CHILD_YAML],
+    },
+  ]);
+  const expectedComponent = new SourceComponent({ name: 'myESR', xml: SOURCE_META_FILE, type }, tree);
+  const adapter = new PartialDecomposedAdapter(type, registryAccess, undefined, tree);
+
+  it('Should return expected SourceComponent when given a -meta.xml path', () => {
+    expect(adapter.getComponent(SOURCE_META_FILE)).to.deep.equal(expectedComponent);
+  });
+
+  it('Should return expected SourceComponent when given a child path', () => {
+    const ec = new SourceComponent({ name: 'myESR', type, xml: SOURCE_META_FILE }, tree);
+    const adapter = new PartialDecomposedAdapter(type.children!.types['yaml'], registryAccess, undefined, tree);
+    expect(adapter.getComponent(CHILD_YAML)).to.deep.equal(ec);
+  });
+});