fix: update the features to string[] and schemas

Author: soridalac

schemas/org-create-sandbox.json

@@ -46,7 +46,10 @@
           "type": "string"
         },
         "Features": {
-          "type": "string"
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "required": ["CreatedDate", "Id", "LicenseType", "SandboxInfoId", "SandboxName", "Status"]

schemas/org-refresh-sandbox.json

@@ -46,7 +46,10 @@
           "type": "string"
         },
         "Features": {
-          "type": "string"
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "required": ["CreatedDate", "Id", "LicenseType", "SandboxInfoId", "SandboxName", "Status"]

schemas/org-resume-sandbox.json

@@ -46,7 +46,10 @@
           "type": "string"
         },
         "Features": {
-          "type": "string"
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "required": ["CreatedDate", "Id", "LicenseType", "SandboxInfoId", "SandboxName", "Status"]

src/commands/org/create/sandbox.ts

@@ -174,11 +174,13 @@ export default class CreateSandbox extends SandboxCommandBase<SandboxCommandResp
       delete sandboxReq.ActivationUserGroupName;
     }
 
+    const nameOrId = srcSandboxName ?? srcId;
+
     // Get source sandbox features if cloning
-    if (srcSandboxName ?? srcId) {
-      const sourceFeatures = await this.getSandboxFeatures(srcSandboxName ?? srcId);
+    if (nameOrId) {
+      const sourceFeatures = await this.getSandboxFeatures(nameOrId);
       if (sourceFeatures) {
-        (sandboxReq as SandboxRequest & { Features?: string }).Features = sourceFeatures;
+        (sandboxReq as SandboxRequest & { Features?: string[] }).Features = sourceFeatures;
       }
     }
 
@@ -193,26 +195,25 @@ export default class CreateSandbox extends SandboxCommandBase<SandboxCommandResp
     };
   }
 
-  private async getSandboxFeatures(sandboxName: string): Promise<string | undefined> {
+  private async getSandboxFeatures(sandboxName: string): Promise<string[] | undefined> {
     const prodOrg = this.flags['target-org'];
 
     try {
       if (sandboxName?.startsWith('0GQ')) {
-        const sbxId = await prodOrg.querySandboxInfo({ id: sandboxName, name: '' });
+        const sbxId = await prodOrg.querySandboxInfo({ id: sandboxName, name: undefined });
         if (sbxId?.Features) {
           return sbxId.Features;
         }
-        const sandboxProcess = await prodOrg.querySandboxProcessBySandboxInfoId(sandboxName);
-        return sandboxProcess?.Features;
+
+        return (await prodOrg.querySandboxProcessBySandboxInfoId(sandboxName)).Features;
       }
 
-      const sbxName = await prodOrg.querySandboxInfo({ id: '', name: sandboxName });
+      const sbxName = await prodOrg.querySandboxInfo({ id: undefined, name: sandboxName });
       if (sbxName?.Features) {
         return sbxName.Features;
       }
 
-      const sandboxProcess = await prodOrg.querySandboxProcessBySandboxName(sandboxName);
-      return sandboxProcess?.Features;
+      return (await prodOrg.querySandboxProcessBySandboxName(sandboxName)).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}.`);

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,7 @@ export async function createSandboxRequest(
 
   const capitalizedVarArgs = properties ? lowerToUpper(properties) : {};
   // varargs override file input
-  const sandboxReqWithName: (SandboxRequest & { Features?: string }) & {
+  const sandboxReqWithName: (SandboxRequest & { Features?: string[] }) & {
     SourceSandboxName?: string;
     SourceId?: string;
   } = {

test/shared/sandboxRequest.test.ts

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