Merge pull request #1443 from salesforcecli/sl/W-18539941

feat: add features when cloning sandbox - W-18539941

Author: shetzel

messages/create.sandbox.md

@@ -22,6 +22,10 @@ You can also use this command to clone an existing sandbox. Use the --source-san
 
   <%= config.bin %> <%= command.id %> --source-sandbox-name ExistingSandbox --name NewClonedSandbox --target-org prodOrg --alias MyDevSandbox --set-default --wait 30
 
+- Clone the existing sandbox with ID "0GQB0000000TVobOAG" and do not wait.
+
+  <%= config.bin %> <%= command.id %> --source-id 0GQB0000000TVobOAG --name SbxClone --target-org prodOrg --async
+
 # flags.setDefault.summary
 
 Set the sandbox org as your default org.
@@ -74,7 +78,7 @@ ID of the sandbox org to clone.
 
 # flags.source-id.description
 
-The value of --source-id must be an existing sandbox. The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.
+The value of --source-id must be an existing sandbox (SandboxInfo.Id). The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.
 
 You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
 

package.json

@@ -7,7 +7,7 @@
   "dependencies": {
     "@oclif/core": "^4.4.0",
     "@oclif/multi-stage-output": "^0.8.14",
-    "@salesforce/core": "^8.13.0",
+    "@salesforce/core": "^8.15.0",
     "@salesforce/kit": "^3.2.3",
     "@salesforce/sf-plugins-core": "^12.2.2",
     "@salesforce/source-deploy-retrieve": "^12.20.1",

schemas/org-create-sandbox.json

@@ -44,6 +44,12 @@
         },
         "EndDate": {
           "type": "string"
+        },
+        "Features": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "required": ["CreatedDate", "Id", "LicenseType", "SandboxInfoId", "SandboxName", "Status"]

schemas/org-refresh-sandbox.json

@@ -44,6 +44,12 @@
         },
         "EndDate": {
           "type": "string"
+        },
+        "Features": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "required": ["CreatedDate", "Id", "LicenseType", "SandboxInfoId", "SandboxName", "Status"]

schemas/org-resume-sandbox.json

@@ -44,6 +44,12 @@
         },
         "EndDate": {
           "type": "string"
+        },
+        "Features": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "required": ["CreatedDate", "Id", "LicenseType", "SandboxInfoId", "SandboxName", "Status"]

src/commands/org/create/sandbox.ts

@@ -90,8 +90,9 @@ export default class CreateSandbox extends SandboxCommandBase<SandboxCommandResp
     'source-id': Flags.salesforceId({
       summary: messages.getMessage('flags.source-id.summary'),
       description: messages.getMessage('flags.source-id.description'),
-      exclusive: ['license-type'],
+      exclusive: ['license-type', 'source-sandbox-name'],
       length: 'both',
+      startsWith: '0GQ',
       char: undefined,
     }),
     'license-type': Flags.custom<SandboxLicenseType>({
@@ -137,7 +138,6 @@ export default class CreateSandbox extends SandboxCommandBase<SandboxCommandResp
   }
 
   private async createSandboxRequest(): Promise<SandboxRequest> {
-    // reuse the existing sandbox request generator, with this command's flags as the varargs
     const requestOptions = {
       ...(this.flags.name ? { SandboxName: this.flags.name } : {}),
       ...(this.flags['source-sandbox-name']
@@ -175,6 +175,16 @@ export default class CreateSandbox extends SandboxCommandBase<SandboxCommandResp
       delete sandboxReq.ActivationUserGroupName;
     }
 
+    const nameOrId = srcSandboxName ?? srcId;
+
+    // Get source sandbox features if cloning
+    if (nameOrId) {
+      const sourceFeatures = await this.getSandboxFeatures(nameOrId);
+      if (sourceFeatures) {
+        sandboxReq.Features = sourceFeatures;
+      }
+    }
+
     return {
       ...sandboxReq,
       ...(srcSandboxName
@@ -186,6 +196,33 @@ export default class CreateSandbox extends SandboxCommandBase<SandboxCommandResp
     };
   }
 
+  private async getSandboxFeatures(sandboxNameOrId: string): Promise<string[] | undefined> {
+    const prodOrg = this.flags['target-org'];
+
+    try {
+      if (sandboxNameOrId?.startsWith('0GQ')) {
+        const sbxInfo = await prodOrg.querySandboxInfo({ id: sandboxNameOrId });
+        if (sbxInfo?.Features) {
+          return sbxInfo.Features;
+        }
+
+        return (await prodOrg.querySandboxProcessBySandboxInfoId(sandboxNameOrId)).Features;
+      }
+
+      const sbxInfo = await prodOrg.querySandboxInfo({ name: sandboxNameOrId });
+      if (sbxInfo?.Features) {
+        return sbxInfo.Features;
+      }
+
+      return (await prodOrg.querySandboxProcessBySandboxName(sandboxNameOrId)).Features;
+    } catch (err) {
+      if (err instanceof SfError && (err.name.includes('AUTH') ?? err.name.includes('CONNECTION'))) {
+        this.warn(`Warning: Could not retrieve sandbox features due to ${err.name}.`);
+      }
+      throw err;
+    }
+  }
+
   private async createSandbox(): Promise<SandboxCommandResponse> {
     const lifecycle = Lifecycle.getInstance();
     this.prodOrg = this.flags['target-org'];

src/shared/sandboxRequest.ts

@@ -55,7 +55,7 @@ export function readSandboxDefFile(
 export async function createSandboxRequest(
   definitionFile: string | undefined,
   logger?: Logger | undefined,
-  properties?: Record<string, string | undefined>
+  properties?: Record<string, string | undefined | string[]>
 ): Promise<{
   sandboxReq: SandboxRequest & {
     ApexClassName: string | undefined;
@@ -67,7 +67,7 @@ export async function createSandboxRequest(
 export async function createSandboxRequest(
   definitionFile: string | undefined,
   logger?: Logger | undefined,
-  properties?: Record<string, string | undefined>
+  properties?: Record<string, string | undefined | string[]>
 ): Promise<{
   sandboxReq: SandboxRequest & {
     ApexClassName: string | undefined;
@@ -77,7 +77,7 @@ export async function createSandboxRequest(
 export async function createSandboxRequest(
   definitionFile: string | undefined,
   logger?: Logger | undefined,
-  properties?: Record<string, string | undefined>
+  properties?: Record<string, string | undefined | string[]>
 ): Promise<{ sandboxReq: SandboxRequest; srcSandboxName?: string; srcId?: string }> {
   if (!logger) {
     logger = await Logger.child('createSandboxRequest');
@@ -88,7 +88,9 @@ export async function createSandboxRequest(
 
   const capitalizedVarArgs = properties ? lowerToUpper(properties) : {};
   // varargs override file input
-  const sandboxReqWithName: SandboxRequest & { SourceSandboxName?: string; SourceId?: string } = {
+  const sandboxReqWithName: SandboxRequest & {
+    SourceSandboxName?: string;
+  } = {
     ...(sandboxDefFileContents as Record<string, unknown>),
     ...capitalizedVarArgs,
     SandboxName:
@@ -116,6 +118,7 @@ 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;
@@ -124,6 +127,7 @@ export async function getApexClassIdByName(conn: Connection, className: string):
     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;
@@ -132,6 +136,7 @@ export async function getUserGroupIdByName(conn: Connection, groupName: string):
     throw cloneMessages.createError('error.userGroupQueryFailed', [groupName], [], err as Error);
   }
 }
+
 export async function getSrcIdByName(conn: Connection, sandboxName: string): Promise<string | undefined> {
   try {
     const result = (

test/shared/sandboxMockUtils.ts

@@ -66,6 +66,7 @@ const sandboxProcessFields = [
   'SourceId',
   'Description',
   'EndDate',
+  'Features',
 ];
 
 export const updateSuccessResponse: SaveResult = {

test/shared/sandboxRequest.test.ts

@@ -96,6 +96,30 @@ describe('sandboxRequest builder', () => {
       assert(res);
       expect(res.sandboxReq.SandboxName).equals('realName');
     });
+
+    it('srcSandboxName with features', async () => {
+      const res = await createSandboxRequest(undefined, $$.TEST_LOGGER, {
+        SourceSandboxName: 'sbox',
+        SandboxName: 'foo',
+        Features: ['DataStorage'],
+      });
+      assert(res);
+      expect(res.sandboxReq.SandboxName).equals('foo');
+      expect(res.srcSandboxName).equals('sbox');
+      expect(res.sandboxReq.Features).deep.equals(['DataStorage']);
+    });
+
+    it('srcId with features', async () => {
+      const res = await createSandboxRequest(undefined, $$.TEST_LOGGER, {
+        SourceId: '0GQ000000000001',
+        SandboxName: 'foo',
+        Features: ['DataStorage'],
+      });
+      assert(res);
+      expect(res.sandboxReq.SandboxName).equals('foo');
+      expect(res.srcId).equals('0GQ000000000001');
+      expect(res.sandboxReq.Features).deep.equals(['DataStorage']);
+    });
   });
   describe('not clone', () => {
     it('throws without licenseType', async () => {

yarn.lock

@@ -1685,10 +1685,10 @@
     strip-ansi "6.0.1"
     ts-retry-promise "^0.8.1"
 
-"@salesforce/core@^8.10.0", "@salesforce/core@^8.12.0", "@salesforce/core@^8.13.0", "@salesforce/core@^8.14.0", "@salesforce/core@^8.5.1", "@salesforce/core@^8.8.0":
-  version "8.14.0"
-  resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-8.14.0.tgz#fcdd8b641221fee668b95ed2ede56b251668077c"
-  integrity sha512-Ta1aY15TfgxLyFNNlkw60Mm3dDtiEb50TSp3/wzrbuMgkEGvFBEZQca/ChrjANXhpw8pURDUTzL4VV/1eGCHrQ==
+"@salesforce/core@^8.10.0", "@salesforce/core@^8.12.0", "@salesforce/core@^8.14.0", "@salesforce/core@^8.15.0", "@salesforce/core@^8.5.1", "@salesforce/core@^8.8.0":
+  version "8.15.0"
+  resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-8.15.0.tgz#95d337a7a219c2d305117c9f5594617784a8642f"
+  integrity sha512-vTobdBQ7JRlApUDezUAVlC7O7VUk1e+9AM8+TZIVnj2Glub7E5vtwTJRDT48MJ/wWjdhH+9MFfUi2GPHymHmrQ==
   dependencies:
     "@jsforce/jsforce-node" "^3.8.2"
     "@salesforce/kit" "^3.2.2"