Merge remote-tracking branch 'origin/main' into sm/preserve-comments-…

…alternative

METADATA_SUPPORT.md

@@ -4,7 +4,7 @@ This list compares metadata types found in Salesforce v60 with the [metadata reg
 
 This repository is used by both the Salesforce CLIs and Salesforce's VSCode Extensions.
 
-Currently, there are 564/596 supported metadata types.
+Currently, there are 565/598 supported metadata types.
 For status on any existing gaps, please search or file an issue in the [Salesforce CLI issues only repo](https://github.com/forcedotcom/cli/issues).
 To contribute a new metadata type, please see the [Contributing Metadata Types to the Registry](./contributing/metadata.md)
 
@@ -214,6 +214,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |EinsteinAISettings|✅||
 |EinsteinAgentSettings|✅||
 |EinsteinAssistantSettings|✅||
+|EinsteinCopilotSettings|✅||
 |EinsteinDealInsightsSettings|✅||
 |EinsteinDocumentCaptureSettings|✅||
 |EinsteinGptSettings|✅||
@@ -302,6 +303,7 @@ To contribute a new metadata type, please see the [Contributing Metadata Types t
 |GenAiFunction|❌|Not supported, but support could be added|
 |GenAiPlanner|❌|Not supported, but support could be added|
 |GenAiPlugin|❌|Not supported, but support could be added|
+|GenAiPluginInstructionDef|❌|Not supported, but support could be added|
 |GlobalValueSet|✅||
 |GlobalValueSetTranslation|✅||
 |GoogleAppsSettings|✅||
@@ -626,7 +628,7 @@ v61 introduces the following new types.  Here's their current level of support
 |LargeQuotesandOrdersForRlmSettings|✅||
 |RetrievalSummaryDefinition|❌|Not supported, but support could be added|
 |SearchCustomization|❌|Not supported, but support could be added (but not for tracking)|
-|SearchOrgWideObjectConfig|❌|Not supported, but support could be added|
+|SearchOrgWideObjectConfig|❌|Not supported, but support could be added (but not for tracking)|
 |WaveAnalyticAssetCollection|❌|Not supported, but support could be added|
 
 ## Additional Types

contributing/metadata.md

@@ -13,7 +13,7 @@ Got questions?
 
 - If you work for Salesforce,
   - For general questions, post in [#platform-cli](https://salesforce-internal.slack.com/archives/C01LKDT1P6J)
-  - For PR reviews, post in [#sfdx-cli-plugin-providers](https://salesforce.enterprise.slack.com/archives/C0298EE05PU) 
+  - For PR reviews, post in [#platform-cli-collaboration](https://salesforce.enterprise.slack.com/archives/C06V045BZD0) 
 - If not, [open an issue](https://github.com/forcedotcom/cli/issues)
 
 ## Adding new types to the registry via a script

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/source-deploy-retrieve",
-  "version": "11.0.1",
+  "version": "11.1.2",
   "description": "JavaScript library to run Salesforce metadata deploys and retrieves",
   "main": "lib/src/index.js",
   "author": "Salesforce",
@@ -25,8 +25,8 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@salesforce/core": "^7.2.0",
-    "@salesforce/kit": "^3.1.0",
+    "@salesforce/core": "^7.3.1",
+    "@salesforce/kit": "^3.1.1",
     "@salesforce/ts-types": "^2.0.9",
     "fast-levenshtein": "^3.0.0",
     "fast-xml-parser": "^4.3.6",
@@ -36,12 +36,11 @@
     "jszip": "^3.10.1",
     "mime": "2.6.0",
     "minimatch": "^5.1.6",
-    "proxy-agent": "^6.4.0",
-    "ts-retry-promise": "^0.7.1"
+    "proxy-agent": "^6.4.0"
   },
   "devDependencies": {
-    "@jsforce/jsforce-node": "^3.1.0",
-    "@salesforce/cli-plugins-testkit": "^5.2.1",
+    "@jsforce/jsforce-node": "^3.2.0",
+    "@salesforce/cli-plugins-testkit": "^5.3.1",
     "@salesforce/dev-scripts": "^9.0.0",
     "@types/deep-equal-in-any-order": "^1.0.1",
     "@types/fast-levenshtein": "^0.0.4",
@@ -50,7 +49,7 @@
     "@types/minimatch": "^5.1.2",
     "deep-equal-in-any-order": "^1.1.19",
     "deepmerge": "^4.3.1",
-    "eslint-plugin-sf-plugin": "^1.18.0",
+    "eslint-plugin-sf-plugin": "^1.18.2",
     "mocha-junit-reporter": "^1.23.3",
     "mocha-snap": "^5.0.0",
     "ts-node": "^10.9.2",

src/client/metadataApiRetrieve.ts

@@ -119,7 +119,7 @@ export class MetadataApiRetrieve extends MetadataTransfer<
   MetadataApiRetrieveOptions
 > {
   public static DEFAULT_OPTIONS: Partial<MetadataApiRetrieveOptions> = { merge: false };
-  private options: MetadataApiRetrieveOptions;
+  private readonly options: MetadataApiRetrieveOptions;
   private orgId?: string;
 
   public constructor(options: MetadataApiRetrieveOptions) {

src/collections/componentSetBuilder.ts

@@ -6,15 +6,17 @@
  */
 
 import * as path from 'node:path';
-import { StateAggregator, Logger, SfError, Messages } from '@salesforce/core';
+import { Logger, Messages, SfError, StateAggregator } from '@salesforce/core';
 import fs from 'graceful-fs';
 import minimatch from 'minimatch';
 import { MetadataComponent } from '../resolve/types';
+import { SourceComponent } from '../resolve/sourceComponent';
 import { ComponentSet } from '../collections/componentSet';
 import { RegistryAccess } from '../registry/registryAccess';
 import type { FileProperties } from '../client/types';
 import { MetadataType } from '../registry/types';
-import { FromConnectionOptions } from './types';
+import { MetadataResolver } from '../resolve';
+import { DestructiveChangesType, FromConnectionOptions } from './types';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/source-deploy-retrieve', 'sdr');
@@ -29,6 +31,14 @@ export type ManifestOption = {
 type MetadataOption = {
   metadataEntries: string[];
   directoryPaths: string[];
+  /**
+   * Array of metadata type:name pairs to delete before the deploy. Use of wildcards is not allowed.
+   */
+  destructiveEntriesPre?: string[];
+  /**
+   * Array of metadata type:name pairs to delete after the deploy. Use of wildcards is not allowed.
+   */
+  destructiveEntriesPost?: string[];
 };
 
 type OrgOption = {
@@ -60,6 +70,7 @@ export class ComponentSetBuilder {
    * @param options: options for creating a ComponentSet
    */
 
+  // eslint-disable-next-line complexity
   public static async build(options: ComponentSetOptions): Promise<ComponentSet> {
     const logger = Logger.childFromRoot('componentSetBuilder');
     let componentSet: ComponentSet | undefined;
@@ -114,12 +125,46 @@ export class ComponentSetBuilder {
           .map(addToComponentSet(componentSetFilter));
 
         logger.debug(`Searching for matching metadata in directories: ${directoryPaths.join(', ')}`);
+
+        // add destructive changes if defined. Because these are deletes, all entries
+        // are resolved to SourceComponents
+        if (metadata.destructiveEntriesPre) {
+          metadata.destructiveEntriesPre
+            .map(entryToTypeAndName(registryAccess))
+            .map(assertNoWildcardInDestructiveEntries)
+            .flatMap(typeAndNameToMetadataComponents({ directoryPaths, registry: registryAccess }))
+            .map((mdComponent) => new SourceComponent({ type: mdComponent.type, name: mdComponent.fullName }))
+            .map(addToComponentSet(componentSet, DestructiveChangesType.PRE));
+        }
+        if (metadata.destructiveEntriesPost) {
+          metadata.destructiveEntriesPost
+            .map(entryToTypeAndName(registryAccess))
+            .map(assertNoWildcardInDestructiveEntries)
+            .flatMap(typeAndNameToMetadataComponents({ directoryPaths, registry: registryAccess }))
+            .map((mdComponent) => new SourceComponent({ type: mdComponent.type, name: mdComponent.fullName }))
+            .map(addToComponentSet(componentSet, DestructiveChangesType.POST));
+        }
+
         const resolvedComponents = ComponentSet.fromSource({
           fsPaths: directoryPaths,
           include: componentSetFilter,
           registry: registryAccess,
         });
-        componentSet.forceIgnoredPaths = resolvedComponents.forceIgnoredPaths;
+
+        if (resolvedComponents.forceIgnoredPaths) {
+          // if useFsForceIgnore = true, then we won't be able to resolve a forceignored path,
+          // which we need to do to get the ignored source component
+          const resolver = new MetadataResolver(registryAccess, undefined, false);
+
+          for (const ignoredPath of resolvedComponents.forceIgnoredPaths ?? []) {
+            resolver.getComponentsFromPath(ignoredPath).map((ignored) => {
+              componentSet = componentSet?.filter(
+                (resolved) => !(resolved.fullName === ignored.name && resolved.type === ignored.type)
+              );
+            });
+          }
+        }
+
         resolvedComponents.toArray().map(addToComponentSet(componentSet));
       }
 
@@ -133,7 +178,7 @@ export class ComponentSetBuilder {
           }`
         );
 
-        const mdMap: MetadataMap = metadata
+        const mdMap = metadata
           ? buildMapFromComponents(metadata.metadataEntries.map(entryToTypeAndName(registryAccess)))
           : (new Map() as MetadataMap);
 
@@ -162,9 +207,9 @@ export class ComponentSetBuilder {
 }
 
 const addToComponentSet =
-  (cs: ComponentSet) =>
+  (cs: ComponentSet, deletionType?: DestructiveChangesType) =>
   (cmp: MetadataComponent): MetadataComponent => {
-    cs.add(cmp);
+    cs.add(cmp, deletionType);
     return cmp;
   };
 
@@ -195,6 +240,13 @@ const assertComponentSetIsNotUndefined = (componentSet: ComponentSet | undefined
   return componentSet;
 };
 
+const assertNoWildcardInDestructiveEntries = (mdEntry: MetadataTypeAndMetadataName): MetadataTypeAndMetadataName => {
+  if (mdEntry.metadataName.includes('*')) {
+    throw SfError.create({ message: 'Wildcards are not supported when providing destructive metadata entries' });
+  }
+  return mdEntry;
+};
+
 /** This is only for debug output of matched files based on the command flags.
  * It will log up to 20 file matches. */
 const logComponents = (logger: Logger, componentSet: ComponentSet): void => {
@@ -281,7 +333,7 @@ const typeAndNameToMetadataComponents =
 
 // TODO: use Map.groupBy when it's available
 const buildMapFromComponents = (components: MetadataTypeAndMetadataName[]): MetadataMap => {
-  const mdMap: MetadataMap = new Map();
+  const mdMap: MetadataMap = new Map<string, string[]>();
   components.map((cmp) => {
     mdMap.set(cmp.type.name, [...(mdMap.get(cmp.type.name) ?? []), cmp.metadataName]);
   });

src/convert/metadataConverter.ts

@@ -183,9 +183,7 @@ function getMergeConfigOutputs(
     mergeSet.add(component.parent ?? component);
   }
   const writer = new StandardWriter(output.defaultDirectory);
-  if (output.forceIgnoredPaths) {
-    writer.forceIgnoredPaths = output.forceIgnoredPaths;
-  }
+
   return {
     writer,
     mergeSet,

src/convert/streams.ts

@@ -4,7 +4,7 @@
  * 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, dirname, isAbsolute, join } from 'node:path';
+import { isAbsolute, join } from 'node:path';
 import { pipeline as cbPipeline, Readable, Stream, Transform, Writable } from 'node:stream';
 import { promisify } from 'node:util';
 import { Messages, SfError } from '@salesforce/core';
@@ -20,6 +20,7 @@ import { ComponentSet } from '../collections/componentSet';
 import { RegistryAccess } from '../registry/registryAccess';
 import { ensureFileExists } from '../utils/fileSystemHandler';
 import { ComponentStatus, FileResponseSuccess } from '../client/types';
+import { ForceIgnore } from '../resolve';
 import { MetadataTransformerFactory } from './transformers/metadataTransformerFactory';
 import { ConvertContext } from './convertContext/convertContext';
 import { SfdxFileFormat, WriteInfo, WriterFormat } from './types';
@@ -35,7 +36,6 @@ export const stream2buffer = async (stream: Stream): Promise<Buffer> =>
     const buf = Array<any>();
     stream.on('data', (chunk) => buf.push(chunk));
     stream.on('end', () => resolve(Buffer.concat(buf)));
-    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
     stream.on('error', (err) => reject(`error converting stream - ${err}`));
   });
 
@@ -113,7 +113,6 @@ export class ComponentConverter extends Transform {
 }
 
 export abstract class ComponentWriter extends Writable {
-  public forceIgnoredPaths: Set<string> = new Set<string>();
   protected rootDestination?: SourcePath;
   protected logger: Logger;
 
@@ -128,9 +127,11 @@ export class StandardWriter extends ComponentWriter {
   /** filepaths that converted files were written to */
   public readonly converted: string[] = [];
   public readonly deleted: FileResponseSuccess[] = [];
+  public readonly forceignore: ForceIgnore;
 
   public constructor(rootDestination: SourcePath) {
     super(rootDestination);
+    this.forceignore = ForceIgnore.findAndCreate(rootDestination);
   }
 
   public async _write(chunk: WriterFormat, encoding: string, callback: (err?: Error) => void): Promise<void> {
@@ -144,8 +145,7 @@ export class StandardWriter extends ComponentWriter {
         await Promise.all(
           chunk.writeInfos
             .map(makeWriteInfoAbsolute(this.rootDestination))
-            .filter(existsOrDoesntMatchIgnored(this.forceIgnoredPaths))
-            .filter((info) => !this.forceIgnoredPaths.has(info.output))
+            .filter(existsOrDoesntMatchIgnored(this.forceignore))
             .map((info) => {
               if (info.shouldDelete) {
                 this.deleted.push({
@@ -289,11 +289,6 @@ const makeWriteInfoAbsolute =
   });
 
 const existsOrDoesntMatchIgnored =
-  (ignoredPaths: Set<string>) =>
+  (forceignore: ForceIgnore) =>
   (writeInfo: WriteInfo): boolean =>
-    existsSync(writeInfo.output) ||
-    [...ignoredPaths].every(
-      (ignoredPath) =>
-        !dirname(ignoredPath).includes(dirname(writeInfo.output)) &&
-        !basename(ignoredPath).includes(basename(writeInfo.output))
-    );
+    existsSync(writeInfo.output) || forceignore.accepts(writeInfo.output);

src/registry/presets/decomposeCustomLabelsBeta.json

@@ -37,7 +37,8 @@
         "decomposition": "topLevel",
         "transformer": "decomposed"
       },
-      "suffix": "labels"
+      "suffix": "labels",
+      "supportsPartialDelete": true
     }
   }
 }

src/registry/presets/decomposePermissionSetBeta.json

@@ -180,7 +180,8 @@
         "transformer": "decomposed"
       },
       "strictDirectoryName": true,
-      "suffix": "permissionset"
+      "suffix": "permissionset",
+      "supportsPartialDelete": true
     }
   }
 }

src/registry/presets/decomposeSharingRulesBeta.json

@@ -75,7 +75,8 @@
         "transformer": "decomposed"
       },
       "strictDirectoryName": true,
-      "suffix": "sharingRules"
+      "suffix": "sharingRules",
+      "supportsPartialDelete": true
     }
   }
 }

src/resolve/adapters/baseSourceAdapter.ts

@@ -35,8 +35,8 @@ export abstract class BaseSourceAdapter implements SourceAdapter {
   public constructor(
     type: MetadataType,
     registry = new RegistryAccess(),
-    forceIgnore: ForceIgnore = new ForceIgnore(),
-    tree: TreeContainer = new NodeFSTreeContainer()
+    forceIgnore = new ForceIgnore(),
+    tree = new NodeFSTreeContainer()
   ) {
     this.type = type;
     this.registry = registry;