feat(pool): Add an option to Pool Configuration for scratch org creation time (#903)

azlam-abdulsalam · web-flow · commit 5ce4033b2a23 · 2022-03-24T13:07:35.000+11:00
* feat(prepare): add wait time as an addition parameter in pool config

Add waitTime as an optional config in pool defintion. This allows the command to wait for longer to
create scratch orgs,as scratch orgs often created from shape take a considerable time

Co-authored-by: azlam-abdulsalam &lt;azlam-abdulsalam@users.noreply.github.com&gt;
diff --git a/packages/core/src/scratchorg/ScratchOrgOperator.ts b/packages/core/src/scratchorg/ScratchOrgOperator.ts
@@ -1,17 +1,28 @@
-import { Aliases, AuthInfo, Org, ScratchOrgRequest } from '@salesforce/core';
+import { Aliases, AuthInfo, Org } from '@salesforce/core';
 import ScratchOrg from './ScratchOrg';
 import PasswordGenerator from './PasswordGenerator';
 import SFPLogger, { LoggerLevel } from '../logger/SFPLogger';
 import { Duration } from '@salesforce/kit';
+import { ScratchOrgRequest } from '@salesforce/core';
 const retry = require('async-retry');
 
 export default class ScratchOrgOperator {
     constructor(private hubOrg: Org) {}
 
-    public async create(alias: string, config_file_path: string, expiry: number): Promise<ScratchOrg> {
+    public async create(
+        alias: string,
+        config_file_path: string,
+        expiry: number,
+        waitTime: number = 6
+    ): Promise<ScratchOrg> {
         SFPLogger.log('Parameters: ' + alias + ' ' + config_file_path + ' ' + expiry + ' ', LoggerLevel.TRACE);
 
-        let scatchOrgResult = await this.requestAScratchOrg(alias, config_file_path, Duration.days(expiry));
+        let scatchOrgResult = await this.requestAScratchOrg(
+            alias,
+            config_file_path,
+            Duration.days(expiry),
+            Duration.minutes(waitTime)
+        );
         SFPLogger.log(JSON.stringify(scatchOrgResult), LoggerLevel.TRACE);
 
         //create scratchOrg object
@@ -57,12 +68,12 @@ export default class ScratchOrgOperator {
         );
     }
 
-    private async requestAScratchOrg(alias: string, definitionFile: string, expireIn: Duration) {
+    private async requestAScratchOrg(alias: string, definitionFile: string, expireIn: Duration, waitTime: Duration) {
         const createCommandOptions: ScratchOrgRequest = {
             durationDays: expireIn.days,
             nonamespace: false,
             noancestors: false,
-            wait: Duration.minutes(6),
+            wait: waitTime,
             retry: 3,
             definitionfile: definitionFile,
         };
diff --git a/packages/sfpowerscripts-cli/package-lock.json b/packages/sfpowerscripts-cli/package-lock.json
diff --git a/packages/sfpowerscripts-cli/resources/schemas/pooldefinition.schema.json b/packages/sfpowerscripts-cli/resources/schemas/pooldefinition.schema.json
@@ -20,6 +20,12 @@
       "description": "Tag or name to identify the scratch org pool",
       "type": "string"
     },
+    "waitTime": {
+      "title": "wait time",
+      "description": "Time to wait for scratch org creation in minutes (default:6 mins)",
+      "type": "integer",
+      "default": 6
+    },
     "expiry": {
       "title": "expiry",
       "description": "Duration of the scratch org (in days) (default:2)",
diff --git a/packages/sfpowerscripts-cli/src/impl/pool/PoolConfig.ts b/packages/sfpowerscripts-cli/src/impl/pool/PoolConfig.ts
@@ -3,6 +3,7 @@ import ScratchOrg from '@dxatscale/sfpowerscripts.core/lib/scratchorg/ScratchOrg
 export interface PoolConfig {
     tag: string;
     maxAllocation: number;
+    waitTime?: number;
     expiry?: number;
     batchSize?: number;
     configFilePath: string;
diff --git a/packages/sfpowerscripts-cli/src/impl/pool/PoolCreateImpl.ts b/packages/sfpowerscripts-cli/src/impl/pool/PoolCreateImpl.ts
@@ -159,7 +159,8 @@ export default class PoolCreateImpl extends PoolBaseImpl {
                 let scratchOrg: ScratchOrg = await this.scratchOrgOperator.create(
                     `SO` + count,
                     this.pool.configFilePath,
-                    this.pool.expiry
+                    this.pool.expiry,
+                    this.pool.waitTime
                 );
 
                 let orgDetails = await new OrgDetailsFetcher(scratchOrg.username).getOrgDetails();
diff --git a/packages/sfpowerscripts-cli/src/impl/prepare/PrepareImpl.ts b/packages/sfpowerscripts-cli/src/impl/prepare/PrepareImpl.ts
@@ -30,6 +30,8 @@ export default class PrepareImpl {
         if (!this.pool.batchSize) this.pool.batchSize = 5;
 
         if (this.pool.succeedOnDeploymentErrors === undefined) this.pool.succeedOnDeploymentErrors = true;
+
+        if (!this.pool.waitTime) this.pool.waitTime = 6;
     }
 
     public async exec() {

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,8 @@ export default class PrepareImpl {`
`30`	`30`	`if (!this.pool.batchSize) this.pool.batchSize = 5;`
`31`	`31`
`32`	`32`	`if (this.pool.succeedOnDeploymentErrors === undefined) this.pool.succeedOnDeploymentErrors = true;`
	`33`	`+`
	`34`	`+ if (!this.pool.waitTime) this.pool.waitTime = 6;`
`33`	`35`	`}`
`34`	`36`
`35`	`37`	`public async exec() {`