Merge branch 'main' into prerelease/beta

Author: mdonnalley

CHANGELOG.md

@@ -1,3 +1,9 @@
+# [4.6.0](https://github.com/salesforcecli/plugin-org/compare/4.5.10...4.6.0) (2024-09-25)
+
+### Features
+
+- **sbx:** support new `Name` fields in def. file ([#1221](https://github.com/salesforcecli/plugin-org/issues/1221)) ([7a64c03](https://github.com/salesforcecli/plugin-org/commit/7a64c03ec2e9e17e212f7c3643fa264e5f1d05e0))
+
 ## [4.5.10](https://github.com/salesforcecli/plugin-org/compare/4.5.9...4.5.10) (2024-09-22)
 
 ### Bug Fixes

README.md

@@ -99,20 +99,29 @@ the [SandboxNuts](https://github.com/salesforcecli/plugin-org/actions/workflows/
 
 <!-- commands -->
 
-- [`sf org create sandbox`](#sf-org-create-sandbox)
-- [`sf org create scratch`](#sf-org-create-scratch)
-- [`sf org delete sandbox`](#sf-org-delete-sandbox)
-- [`sf org delete scratch`](#sf-org-delete-scratch)
-- [`sf org disable tracking`](#sf-org-disable-tracking)
-- [`sf org display`](#sf-org-display)
-- [`sf org enable tracking`](#sf-org-enable-tracking)
-- [`sf org list`](#sf-org-list)
-- [`sf org list metadata`](#sf-org-list-metadata)
-- [`sf org list metadata-types`](#sf-org-list-metadata-types)
-- [`sf org open`](#sf-org-open)
-- [`sf org refresh sandbox`](#sf-org-refresh-sandbox)
-- [`sf org resume sandbox`](#sf-org-resume-sandbox)
-- [`sf org resume scratch`](#sf-org-resume-scratch)
+- [plugin-org](#plugin-org)
+  - [About Salesforce CLI plugins](#about-salesforce-cli-plugins)
+  - [Install](#install)
+  - [Issues](#issues)
+  - [Contributing](#contributing)
+    - [CLA](#cla)
+    - [Build](#build)
+    - [Sandbox NUTs](#sandbox-nuts)
+  - [Commands](#commands)
+  - [`sf org create sandbox`](#sf-org-create-sandbox)
+  - [`sf org create scratch`](#sf-org-create-scratch)
+  - [`sf org delete sandbox`](#sf-org-delete-sandbox)
+  - [`sf org delete scratch`](#sf-org-delete-scratch)
+  - [`sf org disable tracking`](#sf-org-disable-tracking)
+  - [`sf org display`](#sf-org-display)
+  - [`sf org enable tracking`](#sf-org-enable-tracking)
+  - [`sf org list`](#sf-org-list)
+  - [`sf org list metadata`](#sf-org-list-metadata)
+  - [`sf org list metadata-types`](#sf-org-list-metadata-types)
+  - [`sf org open`](#sf-org-open)
+  - [`sf org refresh sandbox`](#sf-org-refresh-sandbox)
+  - [`sf org resume sandbox`](#sf-org-resume-sandbox)
+  - [`sf org resume scratch`](#sf-org-resume-scratch)
 
 ## `sf org create sandbox`
 
@@ -229,7 +238,7 @@ FLAG DESCRIPTIONS
     sandbox.
 ```
 
-_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/create/sandbox.ts)_
+_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/create/sandbox.ts)_
 
 ## `sf org create scratch`
 
@@ -383,7 +392,7 @@ FLAG DESCRIPTIONS
     Omit this flag to have Salesforce generate a unique username for your org.
 ```
 
-_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/create/scratch.ts)_
+_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/create/scratch.ts)_
 
 ## `sf org delete sandbox`
 
@@ -429,7 +438,7 @@ EXAMPLES
     $ sf org delete sandbox --target-org my-sandbox --no-prompt
 ```
 
-_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/delete/sandbox.ts)_
+_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/delete/sandbox.ts)_
 
 ## `sf org delete scratch`
 
@@ -473,7 +482,7 @@ EXAMPLES
     $ sf org delete scratch --target-org my-scratch-org --no-prompt
 ```
 
-_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/delete/scratch.ts)_
+_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/delete/scratch.ts)_
 
 ## `sf org disable tracking`
 
@@ -512,7 +521,7 @@ EXAMPLES
     $ sf org disable tracking
 ```
 
-_See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/disable/tracking.ts)_
+_See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/disable/tracking.ts)_
 
 ## `sf org display`
 
@@ -557,7 +566,7 @@ EXAMPLES
     $ sf org display --target-org TestOrg1 --verbose
 ```
 
-_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/display.ts)_
+_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/display.ts)_
 
 ## `sf org enable tracking`
 
@@ -599,7 +608,7 @@ EXAMPLES
     $ sf org enable tracking
 ```
 
-_See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/enable/tracking.ts)_
+_See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/enable/tracking.ts)_
 
 ## `sf org list`
 
@@ -638,7 +647,7 @@ EXAMPLES
     $ sf org list --clean
 ```
 
-_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/list.ts)_
+_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/list.ts)_
 
 ## `sf org list metadata`
 
@@ -705,7 +714,7 @@ FLAG DESCRIPTIONS
     Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
 ```
 
-_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/list/metadata.ts)_
+_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/list/metadata.ts)_
 
 ## `sf org list metadata-types`
 
@@ -760,7 +769,7 @@ FLAG DESCRIPTIONS
     Override the api version used for api requests made by this command
 ```
 
-_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/list/metadata-types.ts)_
+_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/list/metadata-types.ts)_
 
 ## `sf org open`
 
@@ -832,7 +841,7 @@ EXAMPLES
     $ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
 ```
 
-_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/open.ts)_
+_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/open.ts)_
 
 ## `sf org refresh sandbox`
 
@@ -909,7 +918,7 @@ FLAG DESCRIPTIONS
     By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.
 ```
 
-_See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/refresh/sandbox.ts)_
+_See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/refresh/sandbox.ts)_
 
 ## `sf org resume sandbox`
 
@@ -972,7 +981,7 @@ FLAG DESCRIPTIONS
     returns the job ID. To resume checking the sandbox creation, rerun this command.
 ```
 
-_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/resume/sandbox.ts)_
+_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/resume/sandbox.ts)_
 
 ## `sf org resume scratch`
 
@@ -1019,6 +1028,6 @@ FLAG DESCRIPTIONS
     The job ID is valid for 24 hours after you start the scratch org creation.
 ```
 
-_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.5.11-dev.0/src/commands/org/resume/scratch.ts)_
+_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/4.6.0/src/commands/org/resume/scratch.ts)_
 
 <!-- commandsstop -->

messages/clone.md

@@ -5,3 +5,19 @@ Specify a value for %s in a definition file or on the command line.
 # missingSourceSandboxNameAction
 
 To indicate which sandbox org you want to clone, specify %s in a definition file or as a command line argument.
+
+# error.bothApexClassIdAndNameProvided
+
+You can't specify both `apexClassId` and `apexClassName` in the definition file at the same time.
+
+# error.bothUserGroupIdAndNameProvided
+
+You can't specify both `ActivationUserGroupId` and `ActivationUserGroupName` in the definition file at the same time.
+
+# error.userGroupQueryFailed
+
+Unable to find the ID of the activation user group "%s" that's defined in the definition file.
+
+# error.apexClassQueryFailed
+
+Unable to find the ID of the Apex class "%s" that's defined in the definition file.

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@salesforce/plugin-org",
   "description": "Commands to interact with Salesforce orgs",
-  "version": "4.5.11-dev.0",
+  "version": "4.6.0",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {
     "@oclif/core": "^4.0.16",
-    "@oclif/multi-stage-output": "^0.5.5",
-    "@salesforce/core": "^8.5.5",
+    "@oclif/multi-stage-output": "^0.7.0",
+    "@salesforce/core": "^8.6.1",
     "@salesforce/kit": "^3.2.3",
     "@salesforce/sf-plugins-core": "^11.3.7",
     "@salesforce/source-deploy-retrieve": "^12.7.1",

src/commands/org/create/sandbox.ts

@@ -135,9 +135,31 @@ export default class CreateSandbox extends SandboxCommandBase<SandboxCommandResp
     const { sandboxReq } = !this.flags.clone
       ? await requestFunctions.createSandboxRequest(false, this.flags['definition-file'], undefined, requestOptions)
       : await requestFunctions.createSandboxRequest(true, this.flags['definition-file'], undefined, requestOptions);
+
+    let apexId: string | undefined;
+    let groupId: string | undefined;
+
+    // Determine which value to use
+    if (sandboxReq.ApexClassName) {
+      apexId = await requestFunctions.getApexClassIdByName(
+        this.flags['target-org'].getConnection(),
+        sandboxReq.ApexClassName
+      ); // convert  name to ID
+      delete sandboxReq.ApexClassName;
+    }
+
+    if (sandboxReq.ActivationUserGroupName) {
+      groupId = await requestFunctions.getUserGroupIdByName(
+        this.flags['target-org'].getConnection(),
+        sandboxReq.ActivationUserGroupName
+      );
+      delete sandboxReq.ActivationUserGroupName;
+    }
     return {
       ...sandboxReq,
       ...(this.flags.clone ? { SourceId: await this.getSourceId() } : {}),
+      ...(apexId ? { ApexClassId: apexId } : {}),
+      ...(groupId ? { ActivationUserGroupId: groupId } : {}),
     };
   }
 

src/commands/org/refresh/sandbox.ts

@@ -186,11 +186,28 @@ export default class RefreshSandbox extends SandboxCommandBase<SandboxCommandRes
       throw messages.createError('error.NoSandboxName');
     }
 
+    let apexId: string | undefined;
+    let groupId: string | undefined;
+
+    if (defFileContent.ApexClassName) {
+      apexId = await requestFunctions.getApexClassIdByName(
+        this.flags['target-org'].getConnection(),
+        defFileContent.ApexClassName
+      ); // convert  name to ID
+      delete defFileContent.ApexClassName;
+    }
+
+    if (defFileContent.ActivationUserGroupName) {
+      groupId = await requestFunctions.getUserGroupIdByName(
+        this.flags['target-org'].getConnection(),
+        defFileContent.ActivationUserGroupName
+      );
+      delete defFileContent.ActivationUserGroupName;
+    }
     // Warn if sandbox name is in `--name` and `--definition-file` flags and they differ.
     if (defFileContent?.SandboxName && sbxName && sbxName !== defFileContent?.SandboxName) {
       this.warn(messages.createWarning('warning.ConflictingSandboxNames', [sbxName, defFileContent?.SandboxName]));
     }
-
     sbxName ??= defFileContent.SandboxName as string; // The code above ensures a value for sbxName
 
     const prodOrg = this.flags['target-org'];
@@ -213,6 +230,8 @@ export default class RefreshSandbox extends SandboxCommandBase<SandboxCommandRes
     sandboxInfo = Object.assign(sandboxInfo, defFileContent, {
       SandboxName: sbxName,
       AutoActivate: !this.flags['no-auto-activate'],
+      ...(apexId ? { ApexClassId: apexId } : {}),
+      ...(groupId ? { ActivationUserGroupId: groupId } : {}),
     });
 
     return sandboxInfo;

src/shared/sandboxRequest.ts

@@ -6,7 +6,7 @@
  */
 import fs from 'node:fs';
 
-import { Logger, SandboxInfo, SandboxRequest, Messages, SfError, Lifecycle } from '@salesforce/core';
+import { Logger, SandboxInfo, SandboxRequest, Messages, SfError, Lifecycle, Connection } from '@salesforce/core';
 import { lowerToUpper } from './utils.js';
 import { SandboxLicenseType } from './orgTypes.js';
 
@@ -22,24 +22,46 @@ export const generateSboxName = async (): Promise<string> => {
 };
 
 // Reads the sandbox definition file and converts properties to CapCase.
-export function readSandboxDefFile(defFile: string): Partial<SandboxInfo> {
+export function readSandboxDefFile(
+  defFile: string
+): Partial<SandboxInfo & { ApexClassName?: string; ActivationUserGroupName?: string }> {
   const fileContent = fs.readFileSync(defFile, 'utf-8');
-  const parsedContent = JSON.parse(fileContent) as Record<string, unknown>;
-  return lowerToUpper(parsedContent) as Partial<SandboxInfo>;
+  const parsedContent = lowerToUpper(JSON.parse(fileContent) as Record<string, unknown>);
+
+  // validate input
+  if (parsedContent.ApexClassName && parsedContent.ApexClassId) {
+    throw cloneMessages.createError('error.bothApexClassIdAndNameProvided');
+  }
+
+  if (parsedContent.ActivationUserGroupId && parsedContent.ActivationUserGroupName) {
+    throw cloneMessages.createError('error.bothUserGroupIdAndNameProvided');
+  }
+  return parsedContent as Partial<SandboxInfo>;
 }
 
 export async function createSandboxRequest(
   isClone: true,
   definitionFile: string | undefined,
   logger?: Logger | undefined,
   properties?: Record<string, string | undefined>
-): Promise<{ sandboxReq: SandboxRequest; srcSandboxName: string }>;
+): Promise<{
+  sandboxReq: SandboxRequest & {
+    ApexClassName: string | undefined;
+    ActivationUserGroupName: string | undefined;
+  };
+  srcSandboxName: string;
+}>;
 export async function createSandboxRequest(
   isClone: false,
   definitionFile: string | undefined,
   logger?: Logger | undefined,
   properties?: Record<string, string | undefined>
-): Promise<{ sandboxReq: SandboxRequest }>;
+): Promise<{
+  sandboxReq: SandboxRequest & {
+    ApexClassName: string | undefined;
+    ActivationUserGroupName: string | undefined;
+  };
+}>;
 export async function createSandboxRequest(
   isClone = false,
   definitionFile: string | undefined,
@@ -52,6 +74,7 @@ export async function createSandboxRequest(
   logger.debug('Varargs: %s ', properties);
 
   const sandboxDefFileContents = definitionFile ? readSandboxDefFile(definitionFile) : {};
+
   const capitalizedVarArgs = properties ? lowerToUpper(properties) : {};
 
   // varargs override file input
@@ -83,9 +106,26 @@ export async function createSandboxRequest(
     return { sandboxReq };
   }
 }
-
+export async function getApexClassIdByName(conn: Connection, className: string): Promise<string | undefined> {
+  try {
+    const result = (await conn.singleRecordQuery(`SELECT Id FROM ApexClass WHERE Name = '${className}'`)).Id;
+    return result;
+  } catch (err) {
+    throw cloneMessages.createError('error.apexClassQueryFailed', [className], [], err as Error);
+  }
+}
+export async function getUserGroupIdByName(conn: Connection, groupName: string): Promise<string | undefined> {
+  try {
+    const result = (await conn.singleRecordQuery(`SELECT id FROM Group WHERE NAME = '${groupName}'`)).Id;
+    return result;
+  } catch (err) {
+    throw cloneMessages.createError('error.userGroupQueryFailed', [groupName], [], err as Error);
+  }
+}
 export default {
   createSandboxRequest,
   generateSboxName,
   readSandboxDefFile,
+  getApexClassIdByName,
+  getUserGroupIdByName,
 };