Merge remote-tracking branch 'origin/main' into sm/skip-adapter-optimizations

mshanemc · mshanemc · commit 752a631d10d2 · 2024-06-28T17:39:54.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/METADATA_SUPPORT.md b/METADATA_SUPPORT.md
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/source-deploy-retrieve",
-  "version": "12.0.2",
+  "version": "12.1.4",
   "description": "JavaScript library to run Salesforce metadata deploys and retrieves",
   "main": "lib/src/index.js",
   "author": "Salesforce",
@@ -25,7 +25,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@salesforce/core": "^8.0.5",
+    "@salesforce/core": "^8.1.0",
     "@salesforce/kit": "^3.1.6",
     "@salesforce/ts-types": "^2.0.10",
     "fast-levenshtein": "^3.0.0",
@@ -35,7 +35,7 @@
     "ignore": "^5.3.1",
     "jszip": "^3.10.1",
     "mime": "2.6.0",
-    "minimatch": "^5.1.6",
+    "minimatch": "^9.0.5",
     "proxy-agent": "^6.4.0"
   },
   "devDependencies": {
diff --git a/src/client/deployMessages.ts b/src/client/deployMessages.ts
@@ -73,7 +73,7 @@ const shouldWalkContent = (component: SourceComponent): boolean =>
 export const createResponses = (component: SourceComponent, responseMessages: DeployMessage[]): FileResponse[] =>
   responseMessages.flatMap((message): FileResponse[] => {
     const state = getState(message);
-    const base = { fullName: component.fullName, type: component.type.name };
+    const base = { fullName: component.fullName, type: component.type.name } as const;
 
     if (state === ComponentStatus.Failed) {
       return [{ ...base, state, ...parseDeployDiagnostic(component, message) } satisfies FileResponseFailure];
diff --git a/src/client/metadataApiRetrieve.ts b/src/client/metadataApiRetrieve.ts
@@ -16,6 +16,7 @@ import {
   AsyncResult,
   ComponentStatus,
   FileResponse,
+  FileResponseSuccess,
   MetadataApiRetrieveStatus,
   MetadataTransferResult,
   PackageOptions,
@@ -88,20 +89,20 @@ export class RetrieveResult implements MetadataTransferResult {
     // construct successes
     for (const retrievedComponent of this.components.getSourceComponents()) {
       const { fullName, type, xml } = retrievedComponent;
-      const baseResponse: FileResponse = {
+      const baseResponse = {
         fullName,
         type: type.name,
         state: this.localComponents.has(retrievedComponent) ? ComponentStatus.Changed : ComponentStatus.Created,
-      };
+      } as const;
 
       if (!type.children || Object.values(type.children.types).some((t) => t.unaddressableWithoutParent)) {
         for (const filePath of retrievedComponent.walkContent()) {
-          this.fileResponses.push(Object.assign({}, baseResponse, { filePath }));
+          this.fileResponses.push({ ...baseResponse, filePath } satisfies FileResponseSuccess);
         }
       }
 
       if (xml) {
-        this.fileResponses.push(Object.assign({}, baseResponse, { filePath: xml }));
+        this.fileResponses.push({ ...baseResponse, filePath: xml } satisfies FileResponseSuccess);
       }
     }
 
diff --git a/src/client/types.ts b/src/client/types.ts
@@ -55,9 +55,9 @@ type FileResponseBase = {
   filePath?: string;
 };
 
-export type FileResponseSuccess = {
+export type FileResponseSuccess = Required<FileResponseBase> & {
   state: Exclude<ComponentStatus, ComponentStatus.Failed>;
-} & FileResponseBase;
+};
 
 export type FileResponseFailure = {
   state: ComponentStatus.Failed;
diff --git a/src/collections/componentSetBuilder.ts b/src/collections/componentSetBuilder.ts
@@ -8,7 +8,7 @@
 import * as path from 'node:path';
 import { Logger, Messages, SfError, StateAggregator } from '@salesforce/core';
 import fs from 'graceful-fs';
-import minimatch from 'minimatch';
+import { minimatch } from 'minimatch';
 import { MetadataComponent } from '../resolve/types';
 import { SourceComponent } from '../resolve/sourceComponent';
 import { ComponentSet } from '../collections/componentSet';
diff --git a/src/convert/replacements.ts b/src/convert/replacements.ts
@@ -8,7 +8,7 @@ import { readFile } from 'node:fs/promises';
 import { Transform, Readable } from 'node:stream';
 import { sep, posix, join, isAbsolute } from 'node:path';
 import { Lifecycle, Messages, SfError, SfProject } from '@salesforce/core';
-import minimatch from 'minimatch';
+import { minimatch } from 'minimatch';
 import { Env } from '@salesforce/kit';
 import { ensureString, isString } from '@salesforce/ts-types';
 import { SourcePath } from '../common/types';
diff --git a/src/index.ts b/src/index.ts
@@ -100,3 +100,5 @@ export {
   RecompositionStrategy,
   TransformerStrategy,
 } from './registry';
+
+export { presetMap } from './registry/presets/presetMap';
diff --git a/src/registry/metadataRegistry.json b/src/registry/metadataRegistry.json
@@ -9,7 +9,6 @@
     "customfield": "customobject",
     "customfieldtranslation": "customobjecttranslation",
     "customlabel": "customlabels",
-    "decisionmatrixdefinitionversion": "decisionmatrixdefinition",
     "digitalexperience": "digitalexperiencebundle",
     "escalationrule": "escalationrules",
     "extdatatranfieldtemplate": "extdatatranobjecttemplate",
@@ -203,7 +202,7 @@
     "datacategorygroup": "datacategorygroup",
     "datatype": "customdatatype",
     "decisionMatrixDefinition": "decisionmatrixdefinition",
-    "decisionMatrixDefinitionVersion": "decisionmatrixdefinitionversion",
+    "decisionMatrixVersion": "decisionmatrixdefinitionversion",
     "decisionTable": "decisiontable",
     "decisionTableDatasetLink": "decisiontabledatasetlink",
     "delegateGroup": "delegategroup",
@@ -250,6 +249,7 @@
     "explainabilityActionVersion": "explainabilityactionversion",
     "explainabilityMsgTemplate": "explainabilitymsgtemplate",
     "expressionSetDefinition": "expressionsetdefinition",
+    "expressionSetVersion": "expressionsetdefinitionversion",
     "expressionSetMessageToken": "expressionsetmessagetoken",
     "expressionSetObjectAlias": "expressionsetobjectalias",
     "extDataTranFieldTemplate": "extdatatranfieldtemplate",
@@ -1765,29 +1765,21 @@
       "suffix": "dwl"
     },
     "decisionmatrixdefinition": {
-      "children": {
-        "directories": {
-          "versions": "decisionmatrixdefinitionversion"
-        },
-        "suffixes": {
-          "decisionMatrixDefinitionVersion": "decisionmatrixdefinitionversion"
-        },
-        "types": {
-          "decisionmatrixdefinitionversion": {
-            "directoryName": "versions",
-            "id": "decisionmatrixdefinitionversion",
-            "name": "DecisionMatrixDefinitionVersion",
-            "suffix": "decisionMatrixDefinitionVersion"
-          }
-        }
-      },
       "directoryName": "decisionMatrixDefinition",
       "id": "decisionmatrixdefinition",
       "inFolder": false,
       "name": "DecisionMatrixDefinition",
       "strictDirectoryName": false,
       "suffix": "decisionMatrixDefinition"
     },
+    "decisionmatrixdefinitionversion": {
+      "directoryName": "decisionMatrixVersion",
+      "id": "decisionmatrixdefinitionversion",
+      "inFolder": false,
+      "name": "DecisionMatrixDefinitionVersion",
+      "strictDirectoryName": false,
+      "suffix": "decisionMatrixVersion"
+    },
     "decisiontable": {
       "directoryName": "decisionTables",
       "id": "decisiontable",
@@ -2237,6 +2229,14 @@
       "strictDirectoryName": false,
       "suffix": "expressionSetDefinition"
     },
+    "expressionsetdefinitionversion": {
+      "directoryName": "expressionSetVersion",
+      "id": "expressionsetdefinitionversion",
+      "inFolder": false,
+      "name": "ExpressionSetDefinitionVersion",
+      "strictDirectoryName": false,
+      "suffix": "expressionSetVersion"
+    },
     "expressionsetmessagetoken": {
       "directoryName": "expressionSetMessageToken",
       "id": "expressionsetmessagetoken",
diff --git a/src/registry/presets/presetMap.ts b/src/registry/presets/presetMap.ts
@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2023, 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 { MetadataRegistry } from '../types';
+
+// we have to import all presets explicitly for VSCE's esbuild bundling process
+import * as decomposeCustomLabelsBeta from './decomposeCustomLabelsBeta.json';
+import * as decomposePermissionSetBeta from './decomposePermissionSetBeta.json';
+import * as decomposeSharingRulesBeta from './decomposeSharingRulesBeta.json';
+import * as decomposeWorkflowBeta from './decomposeWorkflowBeta.json';
+
+export const presetMap = new Map<string, MetadataRegistry>([
+  ['decomposeCustomLabelsBeta', decomposeCustomLabelsBeta as MetadataRegistry],
+  ['decomposePermissionSetBeta', decomposePermissionSetBeta as MetadataRegistry],
+  ['decomposeSharingRulesBeta', decomposeSharingRulesBeta as MetadataRegistry],
+  ['decomposeWorkflowBeta', decomposeWorkflowBeta as MetadataRegistry],
+]);
diff --git a/src/registry/variants.ts b/src/registry/variants.ts
@@ -4,12 +4,11 @@
  * 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';
-import * as path from 'node:path';
-import { Logger, SfProject, SfProjectJson, Lifecycle } from '@salesforce/core';
+import { Logger, SfProject, SfProjectJson, Lifecycle, SfError } from '@salesforce/core';
 import { deepFreeze } from '../utils/collections';
 import { MetadataRegistry } from './types';
 import * as registryData from './metadataRegistry.json';
+import { presetMap } from './presets/presetMap';
 
 export type RegistryLoadInput = {
   /** The project directory to look at sfdx-project.json file
@@ -76,14 +75,18 @@ const maybeGetProject = (projectDir?: string): SfProjectJson | undefined => {
 };
 
 const loadPreset = (preset: string): MetadataRegistry => {
-  const pathToCheck = path.join(__dirname, 'presets', `${preset}.json`);
-
-  try {
-    const rawPreset = fs.readFileSync(pathToCheck, 'utf-8');
-    return JSON.parse(rawPreset) as MetadataRegistry;
-  } catch (e) {
-    throw new Error(`Failed to load preset ${preset} in ${pathToCheck}`);
+  const matchedPreset = presetMap.get(preset);
+  if (matchedPreset) {
+    return matchedPreset;
   }
+  throw SfError.create({
+    message: `Failed to load preset "${preset}"`,
+    name: 'InvalidPreset',
+    actions: [
+      `Use a valid preset.  Currently available presets are: [${[...presetMap.keys()].join(', ')}]`,
+      'Updating your CLI may be required to get newer presets',
+    ],
+  });
 };
 
 const emptyRegistry = {
diff --git a/src/resolve/sourceComponent.ts b/src/resolve/sourceComponent.ts
@@ -232,7 +232,9 @@ export class SourceComponent implements MetadataComponent {
     const uniqueElement = this.type.uniqueIdElement;
     const matched = uniqueElement ? children.find((c) => getString(c, uniqueElement) === this.name) : undefined;
     if (!matched) {
-      throw new SfError(`Unable to find matching parent xml file for ${this.xml}`);
+      throw new SfError(
+        `Invalid XML tags or unable to find matching parent xml file for ${this.type.name} "${this.name}"`
+      );
     }
     return matched;
   }
diff --git a/src/utils/collections.ts b/src/utils/collections.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021, salesforce.com, inc.
+ * Copyright (c) 2024, 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
diff --git a/test/client/metadataApiDeploy.test.ts b/test/client/metadataApiDeploy.test.ts
@@ -7,7 +7,7 @@
 import { basename, join, sep } from 'node:path';
 import { MockTestOrgData, TestContext } from '@salesforce/core/testSetup';
 import chai, { assert, expect } from 'chai';
-import { AnyJson, getString } from '@salesforce/ts-types';
+import { AnyJson, ensureString, getString } from '@salesforce/ts-types';
 import { Lifecycle, Messages, PollingClient, StatusResult } from '@salesforce/core';
 import { Duration } from '@salesforce/kit';
 import deepEqualInAnyOrder = require('deep-equal-in-any-order');
@@ -548,13 +548,13 @@ describe('MetadataApiDeploy', () => {
             fullName,
             type: type.name,
             state: ComponentStatus.Changed,
-            filePath: content,
+            filePath: ensureString(content),
           },
           {
             fullName,
             type: type.name,
             state: ComponentStatus.Changed,
-            filePath: xml,
+            filePath: ensureString(xml),
           },
         ];
 
@@ -584,13 +584,13 @@ describe('MetadataApiDeploy', () => {
             fullName,
             type: type.name,
             state: ComponentStatus.Created,
-            filePath: content,
+            filePath: ensureString(content),
           },
           {
             fullName,
             type: type.name,
             state: ComponentStatus.Created,
-            filePath: xml,
+            filePath: ensureString(xml),
           },
         ];
 
@@ -620,13 +620,13 @@ describe('MetadataApiDeploy', () => {
             fullName,
             type: type.name,
             state: ComponentStatus.Deleted,
-            filePath: content,
+            filePath: ensureString(content),
           },
           {
             fullName,
             type: type.name,
             state: ComponentStatus.Deleted,
-            filePath: xml,
+            filePath: ensureString(xml),
           },
         ];
 
@@ -695,13 +695,13 @@ describe('MetadataApiDeploy', () => {
             fullName,
             type: type.name,
             state: ComponentStatus.Unchanged,
-            filePath: content,
+            filePath: ensureString(content),
           },
           {
             fullName,
             type: type.name,
             state: ComponentStatus.Unchanged,
-            filePath: xml,
+            filePath: ensureString(xml),
           },
         ];
 
@@ -1031,19 +1031,19 @@ describe('MetadataApiDeploy', () => {
             fullName: DECOMPOSED_CHILD_COMPONENT_1.fullName,
             type: DECOMPOSED_CHILD_COMPONENT_1.type.name,
             state: ComponentStatus.Changed,
-            filePath: DECOMPOSED_CHILD_COMPONENT_1.xml,
+            filePath: ensureString(DECOMPOSED_CHILD_COMPONENT_1.xml),
           },
           {
             fullName: DECOMPOSED_CHILD_COMPONENT_2.fullName,
             type: DECOMPOSED_CHILD_COMPONENT_2.type.name,
             state: ComponentStatus.Changed,
-            filePath: DECOMPOSED_CHILD_COMPONENT_2.xml,
+            filePath: ensureString(DECOMPOSED_CHILD_COMPONENT_2.xml),
           },
           {
             fullName: component.fullName,
             type: component.type.name,
             state: ComponentStatus.Changed,
-            filePath: component.xml,
+            filePath: ensureString(component.xml),
           },
         ];
 
@@ -1074,13 +1074,13 @@ describe('MetadataApiDeploy', () => {
             fullName: component.fullName,
             type: component.type.name,
             state: ComponentStatus.Deleted,
-            filePath: component.content,
+            filePath: ensureString(component.content),
           },
           {
             fullName: component.fullName,
             type: component.type.name,
             state: ComponentStatus.Deleted,
-            filePath: component.xml,
+            filePath: ensureString(component.xml),
           },
         ];
 
diff --git a/test/client/metadataApiRetrieve.test.ts b/test/client/metadataApiRetrieve.test.ts
diff --git a/test/registry/presetTesting.ts b/test/registry/presetTesting.ts
diff --git a/test/resolve/sourceComponent.test.ts b/test/resolve/sourceComponent.test.ts
diff --git a/yarn.lock b/yarn.lock
