@salesforce/core 3.14.0 → 3.15.0

package/lib/org/scratchOrgCreate.d.ts

@@ -10,34 +10,43 @@ export interface ScratchOrgCreateResult {
     authFields?: AuthFields;
     warnings: string[];
 }
-/**
- * interface ScratchOrgCreateOptions
- *
- * @param hubOrg the environment hub org
- * @param connectedAppConsumerKey The connected app consumer key.
- * @param durationDays duration of the scratch org (in days) (default:1, min:1, max:30)
- * @param nonamespace create the scratch org with no namespace
- * @param noancestors do not include second-generation package ancestors in the scratch org
- * @param wait the streaming client socket timeout (in minutes) must be an instance of the Duration utility class (default:6, min:2)
- * @param retry number of scratch org auth retries after scratch org is successfully signed up (default:0, min:0, max:10)
- * @param apiversion target server instance API version
- * @param definitionjson org definition in JSON format
- * @param definitionfile path to an org definition file
- * @param orgConfig overrides definitionjson
- * @param clientSecret OAuth client secret of personal connected app
- */
 export interface ScratchOrgCreateOptions {
+    /** the environment hub org */
     hubOrg: Org;
+    /** The connected app consumer key. */
     connectedAppConsumerKey?: string;
+    /** duration of the scratch org (in days) (default:1, min:1, max:30) */
     durationDays?: number;
+    /** create the scratch org with no namespace */
     nonamespace?: boolean;
+    /** create the scratch org with no second-generation package ancestors */
     noancestors?: boolean;
+    /** the streaming client socket timeout (in minutes) must be an instance of the Duration utility class (default:6) */
     wait?: Duration;
+    /** number of scratch org auth retries after scratch org is successfully signed up (default:0, min:0, max:10) */
     retry?: number;
+    /** target server instance API version */
     apiversion?: string;
+    /**
+     * org definition in JSON format, stringified
+     *
+     * @deprecated use orgConfig
+     */
     definitionjson?: string;
+    /**
+     * path to an org definition file
+     *
+     * @deprecated use orgConfig
+     * */
     definitionfile?: string;
+    /** overrides definitionjson */
     orgConfig?: Record<string, unknown>;
+    /** OAuth client secret of personal connected app */
     clientSecret?: string;
+    /** alias to set for the created org */
+    alias?: string;
+    /** after complete, set the org as the default */
+    setDefault?: boolean;
 }
+export declare const scratchOrgResume: (jobId: string) => Promise<ScratchOrgCreateResult>;
 export declare const scratchOrgCreate: (options: ScratchOrgCreateOptions) => Promise<ScratchOrgCreateResult>;

package/lib/org/scratchOrgCreate.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.scratchOrgCreate = exports.DEFAULT_STREAM_TIMEOUT_MINUTES = void 0;
+exports.scratchOrgCreate = exports.scratchOrgResume = exports.DEFAULT_STREAM_TIMEOUT_MINUTES = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
@@ -13,13 +13,15 @@ const messages_1 = require("../messages");
 const logger_1 = require("../logger");
 const configAggregator_1 = require("../config/configAggregator");
 const sfProject_1 = require("../sfProject");
-const lifecycleEvents_1 = require("../lifecycleEvents");
+const globalInfo_1 = require("../globalInfo");
 const org_1 = require("./org");
 const scratchOrgInfoApi_1 = require("./scratchOrgInfoApi");
 const scratchOrgSettingsGenerator_1 = require("./scratchOrgSettingsGenerator");
 const scratchOrgInfoGenerator_1 = require("./scratchOrgInfoGenerator");
-const connection_1 = require("./connection");
+const authInfo_1 = require("./authInfo");
 const scratchOrgLifecycleEvents_1 = require("./scratchOrgLifecycleEvents");
+const scratchOrgCache_1 = require("./scratchOrgCache");
+const scratchOrgErrorCodes_1 = require("./scratchOrgErrorCodes");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'scratchOrgCreate', [
     'SourceStatusResetFailureError',
@@ -28,6 +30,11 @@ const messages = messages_1.Messages.load('@salesforce/core', 'scratchOrgCreate'
     'RetryNotIntError',
     'WaitValidationMaxError',
     'DurationDaysNotIntError',
+    'NoScratchOrgInfoError',
+    'ScratchOrgDeletedError',
+    'StillInProgressError',
+    'CacheMissError',
+    'action.StillInProgress',
 ]);
 exports.DEFAULT_STREAM_TIMEOUT_MINUTES = 6;
 const validateDuration = (durationDays) => {
@@ -49,21 +56,70 @@ const validateRetry = (retry) => {
         throw messages.createError('RetryNotIntError');
     }
 };
-const validateWait = (wait) => {
-    const min = 2;
-    if (wait.minutes < min) {
-        throw messages.createError('WaitValidationMaxError', [min, wait.minutes]);
+const scratchOrgResume = async (jobId) => {
+    var _a, _b, _c;
+    const [logger, cache] = await Promise.all([
+        logger_1.Logger.child('scratchOrgResume'),
+        scratchOrgCache_1.ScratchOrgCache.create(),
+        (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'send request' }),
+    ]);
+    logger.debug(`resuming scratch org creation for jobId: ${jobId}`);
+    if (!cache.has(jobId)) {
+        throw messages.createError('CacheMissError', [jobId]);
     }
+    const { hubUsername, apiVersion, clientSecret, signupTargetLoginUrlConfig, definitionjson, alias, setDefault } = cache.get(jobId);
+    const hubOrg = await org_1.Org.create({ aliasOrUsername: hubUsername });
+    const soi = await (0, scratchOrgInfoApi_1.queryScratchOrgInfo)(hubOrg, jobId);
+    await (0, scratchOrgErrorCodes_1.validateScratchOrgInfoForResume)({ jobId, scratchOrgInfo: soi, cache, hubUsername });
+    // At this point, the scratch org is "good".
+    // Some hubs have all the usernames set to `null`
+    const username = (_a = soi.Username) !== null && _a !== void 0 ? _a : soi.SignupUsername;
+    // re-auth only if the org isn't in GlobalInfo
+    const globalInfo = await globalInfo_1.GlobalInfo.getInstance();
+    const scratchOrgAuthInfo = globalInfo.orgs.has(username)
+        ? await authInfo_1.AuthInfo.create({
+            username,
+        })
+        : await (0, scratchOrgInfoApi_1.authorizeScratchOrg)({
+            scratchOrgInfoComplete: soi,
+            hubOrg,
+            clientSecret,
+            signupTargetLoginUrlConfig,
+            retry: 0,
+        });
+    const scratchOrg = await org_1.Org.create({ aliasOrUsername: username });
+    await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'deploy settings', scratchOrgInfo: soi });
+    const settingsGenerator = new scratchOrgSettingsGenerator_1.default();
+    settingsGenerator.extract({ ...soi, ...definitionjson });
+    const [authInfo] = await Promise.all([
+        (0, scratchOrgInfoApi_1.resolveUrl)(scratchOrgAuthInfo),
+        (0, scratchOrgInfoApi_1.deploySettings)(scratchOrg, settingsGenerator, (_b = apiVersion !== null && apiVersion !== void 0 ? apiVersion : new configAggregator_1.ConfigAggregator().getPropertyValue('apiVersion')) !== null && _b !== void 0 ? _b : (await scratchOrg.retrieveMaxApiVersion())),
+    ]);
+    await scratchOrgAuthInfo.handleAliasAndDefaultSettings({
+        alias,
+        setDefault: setDefault !== null && setDefault !== void 0 ? setDefault : false,
+        setDefaultDevHub: false,
+    });
+    cache.unset((_c = soi.Id) !== null && _c !== void 0 ? _c : jobId);
+    const authFields = authInfo.getFields();
+    await Promise.all([(0, scratchOrgLifecycleEvents_1.emit)({ stage: 'done', scratchOrgInfo: soi }), cache.write(), (0, scratchOrgLifecycleEvents_1.emitPostOrgCreate)(authFields)]);
+    return {
+        username,
+        scratchOrgInfo: soi,
+        authInfo,
+        authFields,
+        warnings: [],
+    };
 };
+exports.scratchOrgResume = scratchOrgResume;
 const scratchOrgCreate = async (options) => {
-    var _a;
+    var _a, _b, _c;
     const logger = await logger_1.Logger.child('scratchOrgCreate');
     logger.debug('scratchOrgCreate');
     await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'prepare request' });
-    const { hubOrg, connectedAppConsumerKey, durationDays = 1, nonamespace, noancestors, wait = kit_1.Duration.minutes(exports.DEFAULT_STREAM_TIMEOUT_MINUTES), retry = 0, apiversion, definitionjson, definitionfile, orgConfig, clientSecret = undefined, } = options;
+    const { hubOrg, connectedAppConsumerKey, durationDays = 1, nonamespace, noancestors, wait = kit_1.Duration.minutes(exports.DEFAULT_STREAM_TIMEOUT_MINUTES), retry = 0, apiversion, definitionjson, definitionfile, orgConfig, clientSecret = undefined, alias, setDefault = false, } = options;
     validateDuration(durationDays);
     validateRetry(retry);
-    validateWait(wait);
     const { scratchOrgInfoPayload, ignoreAncestorIds, warnings } = await (0, scratchOrgInfoGenerator_1.getScratchOrgInfoPayload)({
         definitionjson,
         definitionfile,
@@ -81,36 +137,64 @@ const scratchOrgCreate = async (options) => {
     });
     // gets the scratch org settings (will use in both signup paths AND to deploy the settings)
     const settingsGenerator = new scratchOrgSettingsGenerator_1.default();
-    await settingsGenerator.extract(scratchOrgInfo);
+    const settings = await settingsGenerator.extract(scratchOrgInfo);
     logger.debug(`the scratch org def file has settings: ${settingsGenerator.hasSettings()}`);
-    // creates the scratch org info in the devhub
-    const scratchOrgInfoRequestResult = await (0, scratchOrgInfoApi_1.requestScratchOrgCreation)(hubOrg, scratchOrgInfo, settingsGenerator);
+    const [scratchOrgInfoRequestResult, signupTargetLoginUrlConfig] = await Promise.all([
+        // creates the scratch org info in the devhub
+        (0, scratchOrgInfoApi_1.requestScratchOrgCreation)(hubOrg, scratchOrgInfo, settingsGenerator),
+        getSignupTargetLoginUrl(),
+    ]);
     const scratchOrgInfoId = (0, ts_types_1.ensureString)((0, ts_types_1.getString)(scratchOrgInfoRequestResult, 'id'));
+    const cache = await scratchOrgCache_1.ScratchOrgCache.create();
+    cache.set(scratchOrgInfoId, {
+        hubUsername: hubOrg.getUsername(),
+        hubBaseUrl: (_a = hubOrg.getField(org_1.Org.Fields.INSTANCE_URL)) === null || _a === void 0 ? void 0 : _a.toString(),
+        definitionjson: { ...(definitionjson ? JSON.parse(definitionjson) : {}), ...orgConfig, ...settings },
+        clientSecret,
+        alias,
+        setDefault,
+    });
+    await cache.write();
     logger.debug(`scratch org has recordId ${scratchOrgInfoId}`);
-    const scratchOrgInfoResult = await (0, scratchOrgInfoApi_1.pollForScratchOrgInfo)(hubOrg, scratchOrgInfoId, wait);
-    const signupTargetLoginUrlConfig = await getSignupTargetLoginUrl();
+    // this is where we stop--no polling
+    if (wait.minutes === 0) {
+        const soi = await (0, scratchOrgInfoApi_1.queryScratchOrgInfo)(hubOrg, scratchOrgInfoId);
+        return {
+            username: soi.SignupUsername,
+            warnings: [],
+            scratchOrgInfo: soi,
+        };
+    }
+    const soi = await (0, scratchOrgInfoApi_1.pollForScratchOrgInfo)(hubOrg, scratchOrgInfoId, wait);
     const scratchOrgAuthInfo = await (0, scratchOrgInfoApi_1.authorizeScratchOrg)({
-        scratchOrgInfoComplete: scratchOrgInfoResult,
+        scratchOrgInfoComplete: soi,
         hubOrg,
         clientSecret,
         signupTargetLoginUrlConfig,
         retry: retry || 0,
     });
     // we'll need this scratch org connection later;
-    const connection = await connection_1.Connection.create({ authInfo: scratchOrgAuthInfo });
-    const scratchOrg = await org_1.Org.create({ connection }); // scartchOrg should come from command
+    const scratchOrg = await org_1.Org.create({
+        aliasOrUsername: (_b = soi.Username) !== null && _b !== void 0 ? _b : soi.SignupUsername,
+    });
     const username = scratchOrg.getUsername();
     logger.debug(`scratch org username ${username}`);
-    const configAggregator = new configAggregator_1.ConfigAggregator();
-    await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'deploy settings', scratchOrgInfo: scratchOrgInfoResult });
-    const authInfo = await (0, scratchOrgInfoApi_1.deploySettingsAndResolveUrl)(scratchOrgAuthInfo, (_a = apiversion !== null && apiversion !== void 0 ? apiversion : configAggregator.getPropertyValue('org-api-version')) !== null && _a !== void 0 ? _a : (await scratchOrg.retrieveMaxApiVersion()), settingsGenerator, scratchOrg);
-    logger.trace('Settings deployed to org');
-    /** updating the revision num to zero during org:creation if source members are created during org:create.This only happens for some specific scratch org definition file.*/
-    await updateRevisionCounterToZero(scratchOrg);
-    await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'done', scratchOrgInfo: scratchOrgInfoResult });
+    await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'deploy settings', scratchOrgInfo: soi });
+    const [authInfo] = await Promise.all([
+        (0, scratchOrgInfoApi_1.resolveUrl)(scratchOrgAuthInfo),
+        (0, scratchOrgInfoApi_1.deploySettings)(scratchOrg, settingsGenerator, (_c = apiversion !== null && apiversion !== void 0 ? apiversion : new configAggregator_1.ConfigAggregator().getPropertyValue('org-api-version')) !== null && _c !== void 0 ? _c : (await scratchOrg.retrieveMaxApiVersion())),
+    ]);
+    await scratchOrgAuthInfo.handleAliasAndDefaultSettings({
+        alias,
+        setDefault,
+        setDefaultDevHub: false,
+    });
+    cache.unset(scratchOrgInfoId);
+    const authFields = authInfo.getFields();
+    await Promise.all([(0, scratchOrgLifecycleEvents_1.emit)({ stage: 'done', scratchOrgInfo: soi }), cache.write(), (0, scratchOrgLifecycleEvents_1.emitPostOrgCreate)(authFields)]);
     return {
         username,
-        scratchOrgInfo: scratchOrgInfoResult,
+        scratchOrgInfo: soi,
         authInfo,
         authFields: authInfo === null || authInfo === void 0 ? void 0 : authInfo.getFields(),
         warnings,
@@ -127,19 +211,4 @@ const getSignupTargetLoginUrl = async () => {
         // a project isn't required for org:create
     }
 };
-const updateRevisionCounterToZero = async (scratchOrg) => {
-    const conn = scratchOrg.getConnection();
-    const queryResult = await conn.tooling.sobject('SourceMember').find({ RevisionCounter: { $gt: 0 } }, ['Id']);
-    if (queryResult.length === 0) {
-        return;
-    }
-    try {
-        await conn.tooling
-            .sobject('SourceMember')
-            .update(queryResult.map((record) => ({ Id: record.Id, RevisionCounter: 0 })));
-    }
-    catch (err) {
-        await lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('SourceStatusResetFailureError', [scratchOrg.getOrgId(), scratchOrg.getUsername()]));
-    }
-};
 //# sourceMappingURL=scratchOrgCreate.js.map

package/lib/org/scratchOrgErrorCodes.d.ts

@@ -1,4 +1,10 @@
 import { Optional } from '@salesforce/ts-types';
-import { Logger } from '../logger';
 import { ScratchOrgInfo } from './scratchOrgTypes';
-export declare const checkScratchOrgInfoForErrors: (orgInfo: Optional<ScratchOrgInfo>, hubUsername: Optional<string>, logger: Logger) => ScratchOrgInfo;
+import { ScratchOrgCache } from './scratchOrgCache';
+export declare const validateScratchOrgInfoForResume: ({ jobId, scratchOrgInfo, cache, hubUsername, }: {
+    jobId: string;
+    scratchOrgInfo: ScratchOrgInfo;
+    cache: ScratchOrgCache;
+    hubUsername: string;
+}) => Promise<ScratchOrgInfo>;
+export declare const checkScratchOrgInfoForErrors: (orgInfo: Optional<ScratchOrgInfo>, hubUsername: Optional<string>) => Promise<ScratchOrgInfo>;

package/lib/org/scratchOrgErrorCodes.js

@@ -6,9 +6,12 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkScratchOrgInfoForErrors = void 0;
+exports.checkScratchOrgInfoForErrors = exports.validateScratchOrgInfoForResume = void 0;
 const messages_1 = require("../messages");
 const sfError_1 = require("../sfError");
+const logger_1 = require("../logger");
+const scratchOrgCache_1 = require("./scratchOrgCache");
+const scratchOrgLifecycleEvents_1 = require("./scratchOrgLifecycleEvents");
 const WORKSPACE_CONFIG_FILENAME = 'sfdx-project.json';
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.loadMessages('@salesforce/core', 'scratchOrgErrorCodes');
@@ -34,14 +37,32 @@ const optionalErrorCodeMessage = (errorCode, args) => {
         return undefined;
     }
 };
-const checkScratchOrgInfoForErrors = (orgInfo, hubUsername, logger) => {
-    if (!orgInfo) {
+const validateScratchOrgInfoForResume = async ({ jobId, scratchOrgInfo, cache, hubUsername, }) => {
+    if (!scratchOrgInfo || !scratchOrgInfo.Id || scratchOrgInfo.Status === 'Deleted') {
+        // 1. scratch org info does not exist in that dev hub or has been deleted
+        cache.unset(jobId);
+        await cache.write();
+        throw scratchOrgInfo.Status === 'Deleted'
+            ? messages.createError('ScratchOrgDeletedError')
+            : messages.createError('NoScratchOrgInfoError');
+    }
+    if (['New', 'Creating'].includes(scratchOrgInfo.Status)) {
+        // 2. scratchOrgInfo exists, still isn't finished.  Stays in cache for future attempts
+        throw messages.createError('StillInProgressError', [scratchOrgInfo.Status], ['action.StillInProgress']);
+    }
+    return (0, exports.checkScratchOrgInfoForErrors)(scratchOrgInfo, hubUsername);
+};
+exports.validateScratchOrgInfoForResume = validateScratchOrgInfoForResume;
+const checkScratchOrgInfoForErrors = async (orgInfo, hubUsername) => {
+    if (!orgInfo || !orgInfo.Id) {
         throw new sfError_1.SfError('No scratch org info found.', 'ScratchOrgInfoNotFound');
     }
     if (orgInfo.Status === 'Active') {
+        await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'available', scratchOrgInfo: orgInfo });
         return orgInfo;
     }
     if (orgInfo.Status === 'Error' && orgInfo.ErrorCode) {
+        await scratchOrgCache_1.ScratchOrgCache.unset(orgInfo.Id);
         const message = optionalErrorCodeMessage(orgInfo.ErrorCode, [WORKSPACE_CONFIG_FILENAME]);
         if (message) {
             throw new sfError_1.SfError(message, 'RemoteOrgSignupFailed', [
@@ -51,6 +72,8 @@ const checkScratchOrgInfoForErrors = (orgInfo, hubUsername, logger) => {
         throw new sfError_1.SfError(namedMessages.getMessage('SignupFailedError', [orgInfo.ErrorCode]));
     }
     if (orgInfo.Status === 'Error') {
+        await scratchOrgCache_1.ScratchOrgCache.unset(orgInfo.Id);
+        const logger = await logger_1.Logger.child('ScratchOrgErrorCodes');
         // Maybe the request object can help the user somehow
         logger.error('No error code on signup error! Logging request.');
         logger.error(orgInfo);

package/lib/org/scratchOrgInfoApi.d.ts

@@ -1,4 +1,3 @@
-import { Optional } from '@salesforce/ts-types';
 import { Duration } from '@salesforce/kit';
 import { SaveResult } from 'jsforce';
 import { AuthInfo } from './authInfo';
@@ -9,6 +8,13 @@ export interface JsForceError extends Error {
     errorCode: string;
     fields: string[];
 }
+/**
+ *
+ * @param hubOrg Org
+ * @param id Record ID for the ScratchOrgInfoObject
+ * @returns Promise<ScratchOrgInfo>
+ */
+export declare const queryScratchOrgInfo: (hubOrg: Org, id: string) => Promise<ScratchOrgInfo>;
 /**
  * after we successfully signup an org we need to trade the auth token for access and refresh token.
  *
@@ -46,12 +52,17 @@ export declare const requestScratchOrgCreation: (hubOrg: Org, scratchOrgRequest:
  */
 export declare const pollForScratchOrgInfo: (hubOrg: Org, scratchOrgInfoId: string, timeout?: Duration) => Promise<ScratchOrgInfo>;
 /**
- * This authenticates into the newly created org and sets org preferences
+ * Deploy settings to the newly created scratch org
+ *
+ * @param scratchOrg an instance of the Org class
+ * @param orgSettings an instance of the SettingsGenerator class
+ * @param apiVersion the api version (used when created the package.xml)
+ */
+export declare const deploySettings: (scratchOrg: Org, orgSettings: SettingsGenerator, apiVersion: string) => Promise<void>;
+/**
  *
- * @param scratchOrgAuthInfo - an object containing the AuthInfo of the ScratchOrg
- * @param apiVersion - the target api version
- * @param orgSettings - The ScratchOrg settings
- * @param scratchOrg - The scratchOrg Org info
- * @returns {Promise<Optional<AuthInfo>>}
+ * @param scratchOrgAuthInfo an AuthInfo class from the scratch org
+ * @returns AuthInfo
  */
-export declare const deploySettingsAndResolveUrl: (scratchOrgAuthInfo: AuthInfo, apiVersion: string, orgSettings: SettingsGenerator, scratchOrg: Org) => Promise<Optional<AuthInfo>>;
+export declare const resolveUrl: (scratchOrgAuthInfo: AuthInfo) => Promise<AuthInfo>;
+export declare const updateRevisionCounterToZero: (scratchOrg: Org) => Promise<void>;

package/lib/org/scratchOrgInfoApi.js

@@ -6,7 +6,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deploySettingsAndResolveUrl = exports.pollForScratchOrgInfo = exports.requestScratchOrgCreation = exports.authorizeScratchOrg = void 0;
+exports.updateRevisionCounterToZero = exports.resolveUrl = exports.deploySettings = exports.pollForScratchOrgInfo = exports.requestScratchOrgCreation = exports.authorizeScratchOrg = exports.queryScratchOrgInfo = void 0;
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const ts_retry_promise_1 = require("ts-retry-promise");
@@ -17,6 +17,7 @@ const sfError_1 = require("../sfError");
 const sfdcUrl_1 = require("../util/sfdcUrl");
 const pollingClient_1 = require("../status/pollingClient");
 const myDomainResolver_1 = require("../status/myDomainResolver");
+const lifecycleEvents_1 = require("../lifecycleEvents");
 const authInfo_1 = require("./authInfo");
 const org_1 = require("./org");
 const scratchOrgErrorCodes_1 = require("./scratchOrgErrorCodes");
@@ -131,6 +132,16 @@ const getAuthInfo = async (options) => {
         });
     }
 };
+/**
+ *
+ * @param hubOrg Org
+ * @param id Record ID for the ScratchOrgInfoObject
+ * @returns Promise<ScratchOrgInfo>
+ */
+const queryScratchOrgInfo = async (hubOrg, id) => {
+    return (await hubOrg.getConnection().sobject('ScratchOrgInfo').retrieve(id));
+};
+exports.queryScratchOrgInfo = queryScratchOrgInfo;
 /**
  * after we successfully signup an org we need to trade the auth token for access and refresh token.
  *
@@ -144,7 +155,7 @@ const getAuthInfo = async (options) => {
  */
 const authorizeScratchOrg = async (options) => {
     var _a;
-    const { scratchOrgInfoComplete, hubOrg, clientSecret, signupTargetLoginUrlConfig, retry: maxRetries } = options;
+    const { scratchOrgInfoComplete, hubOrg, clientSecret, signupTargetLoginUrlConfig, retry } = options;
     await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'authenticate', scratchOrgInfo: scratchOrgInfoComplete });
     const logger = await logger_1.Logger.child('authorizeScratchOrg');
     logger.debug(`scratchOrgInfoComplete: ${JSON.stringify(scratchOrgInfoComplete, null, 4)}`);
@@ -156,7 +167,7 @@ const authorizeScratchOrg = async (options) => {
         hubOrg,
         clientSecret,
         scratchOrgInfoComplete,
-        retry: maxRetries,
+        retry,
         signupTargetLoginUrlConfig,
     });
     const authInfo = await getAuthInfo({
@@ -257,11 +268,10 @@ timeout = kit_1.Duration.minutes(15)) => {
     const pollingOptions = {
         async poll() {
             try {
-                const resultInProgress = await hubOrg.getConnection().sobject('ScratchOrgInfo').retrieve(scratchOrgInfoId);
+                const resultInProgress = await (0, exports.queryScratchOrgInfo)(hubOrg, scratchOrgInfoId);
                 logger.debug(`polling client result: ${JSON.stringify(resultInProgress, null, 4)}`);
                 // Once it's "done" we can return it
                 if (resultInProgress.Status === 'Active' || resultInProgress.Status === 'Error') {
-                    await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'available', scratchOrgInfo: resultInProgress });
                     return {
                         completed: true,
                         payload: resultInProgress,
@@ -289,12 +299,17 @@ timeout = kit_1.Duration.minutes(15)) => {
     const client = await pollingClient_1.PollingClient.create(pollingOptions);
     try {
         const resultInProgress = await client.subscribe();
-        return (0, scratchOrgErrorCodes_1.checkScratchOrgInfoForErrors)(resultInProgress, hubOrg.getUsername(), logger);
+        return (0, scratchOrgErrorCodes_1.checkScratchOrgInfoForErrors)(resultInProgress, hubOrg.getUsername());
     }
     catch (error) {
-        const err = error;
-        if (err.message) {
-            throw sfError_1.SfError.wrap(err);
+        if (error instanceof Error) {
+            const sfError = sfError_1.SfError.wrap(error);
+            sfError.setData({
+                username: hubOrg.getUsername(),
+                orgId: hubOrg.getOrgId(),
+                scratchOrgInfoId,
+            });
+            throw sfError;
         }
         throw new sfError_1.SfError(`The scratch org did not complete within ${timeout.minutes} minutes`, 'orgCreationTimeout', [
             'Try your force:org:create command again with a longer --wait value',
@@ -303,54 +318,88 @@ timeout = kit_1.Duration.minutes(15)) => {
 };
 exports.pollForScratchOrgInfo = pollForScratchOrgInfo;
 /**
- * This authenticates into the newly created org and sets org preferences
+ * Deploy settings to the newly created scratch org
  *
- * @param scratchOrgAuthInfo - an object containing the AuthInfo of the ScratchOrg
- * @param apiVersion - the target api version
- * @param orgSettings - The ScratchOrg settings
- * @param scratchOrg - The scratchOrg Org info
- * @returns {Promise<Optional<AuthInfo>>}
+ * @param scratchOrg an instance of the Org class
+ * @param orgSettings an instance of the SettingsGenerator class
+ * @param apiVersion the api version (used when created the package.xml)
  */
-const deploySettingsAndResolveUrl = async (scratchOrgAuthInfo, apiVersion, orgSettings, scratchOrg) => {
-    const logger = await logger_1.Logger.child('scratchOrgInfoApi-deploySettingsAndResolveUrl');
+const deploySettings = async (scratchOrg, orgSettings, apiVersion) => {
+    const logger = await logger_1.Logger.child('scratchOrgInfoApi-deploySettings');
     if (orgSettings.hasSettings()) {
         // deploy the settings to the newly created scratch org
         logger.debug(`deploying scratch org settings with apiVersion ${apiVersion}`);
         try {
             await orgSettings.createDeploy();
             await orgSettings.deploySettingsViaFolder(scratchOrg, apiVersion);
+            // updating the revision num to zero during org:creation if source members are created during org:create.
+            // This only happens for some specific scratch org definition file.
+            await (0, exports.updateRevisionCounterToZero)(scratchOrg);
+            logger.trace('Settings deployed to org');
         }
         catch (error) {
             throw sfError_1.SfError.wrap(error);
         }
     }
+};
+exports.deploySettings = deploySettings;
+/**
+ *
+ * @param scratchOrgAuthInfo an AuthInfo class from the scratch org
+ * @returns AuthInfo
+ */
+const resolveUrl = async (scratchOrgAuthInfo) => {
+    const logger = await logger_1.Logger.child('scratchOrgInfoApi-resolveUrl');
     const { instanceUrl } = scratchOrgAuthInfo.getFields();
-    if (instanceUrl) {
-        logger.debug(`processScratchOrgInfoResult - resultData.instanceUrl: ${instanceUrl}`);
-        const options = {
-            timeout: kit_1.Duration.minutes(3),
-            frequency: kit_1.Duration.seconds(10),
-            url: new sfdcUrl_1.SfdcUrl(instanceUrl),
-        };
-        try {
-            const resolver = await myDomainResolver_1.MyDomainResolver.create(options);
-            await resolver.resolve();
-        }
-        catch (error) {
-            const sfError = sfError_1.SfError.wrap(error);
-            logger.debug('processScratchOrgInfoResult - err: %s', error);
-            if (sfError.name === 'MyDomainResolverTimeoutError') {
-                sfError.setData({
-                    orgId: scratchOrgAuthInfo.getFields().orgId,
-                    username: scratchOrgAuthInfo.getFields().username,
-                    instanceUrl,
-                });
-                logger.debug('processScratchOrgInfoResult - err data: %s', sfError.data);
-            }
-            throw sfError;
-        }
+    if (!instanceUrl) {
+        const sfError = new sfError_1.SfError('Org does not have instanceUrl');
+        sfError.setData({
+            orgId: scratchOrgAuthInfo.getFields().orgId,
+            username: scratchOrgAuthInfo.getFields().username,
+            instanceUrl,
+        });
+        throw sfError;
+    }
+    logger.debug(`processScratchOrgInfoResult - resultData.instanceUrl: ${instanceUrl}`);
+    const options = {
+        timeout: kit_1.Duration.minutes(3),
+        frequency: kit_1.Duration.seconds(10),
+        url: new sfdcUrl_1.SfdcUrl(instanceUrl),
+    };
+    try {
+        const resolver = await myDomainResolver_1.MyDomainResolver.create(options);
+        await resolver.resolve();
         return scratchOrgAuthInfo;
     }
+    catch (error) {
+        const sfError = sfError_1.SfError.wrap(error);
+        logger.debug('processScratchOrgInfoResult - err: %s', error);
+        if (sfError.name === 'MyDomainResolverTimeoutError') {
+            sfError.setData({
+                orgId: scratchOrgAuthInfo.getFields().orgId,
+                username: scratchOrgAuthInfo.getFields().username,
+                instanceUrl,
+            });
+            logger.debug('processScratchOrgInfoResult - err data: %s', sfError.data);
+        }
+        throw sfError;
+    }
+};
+exports.resolveUrl = resolveUrl;
+const updateRevisionCounterToZero = async (scratchOrg) => {
+    const conn = scratchOrg.getConnection();
+    const queryResult = await conn.tooling.sobject('SourceMember').find({ RevisionCounter: { $gt: 0 } }, ['Id']);
+    if (queryResult.length === 0) {
+        return;
+    }
+    try {
+        await conn.tooling
+            .sobject('SourceMember')
+            .update(queryResult.map((record) => ({ Id: record.Id, RevisionCounter: 0 })));
+    }
+    catch (err) {
+        await lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('SourceStatusResetFailureError', [scratchOrg.getOrgId(), scratchOrg.getUsername()]));
+    }
 };
-exports.deploySettingsAndResolveUrl = deploySettingsAndResolveUrl;
+exports.updateRevisionCounterToZero = updateRevisionCounterToZero;
 //# sourceMappingURL=scratchOrgInfoApi.js.map

package/lib/org/scratchOrgLifecycleEvents.d.ts

@@ -1,3 +1,4 @@
+import { AuthFields } from './authInfo';
 import { ScratchOrgInfo } from './scratchOrgTypes';
 export declare const scratchOrgLifecycleEventName = "scratchOrgLifecycleEvent";
 export declare const scratchOrgLifecycleStages: readonly ["prepare request", "send request", "wait for org", "available", "authenticate", "deploy settings", "done"];
@@ -6,3 +7,4 @@ export interface ScratchOrgLifecycleEvent {
     scratchOrgInfo?: ScratchOrgInfo;
 }
 export declare const emit: (event: ScratchOrgLifecycleEvent) => Promise<void>;
+export declare const emitPostOrgCreate: (authFields: AuthFields) => Promise<void>;

package/lib/org/scratchOrgLifecycleEvents.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.emit = exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = void 0;
+exports.emitPostOrgCreate = exports.emit = exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
@@ -23,4 +23,23 @@ const emit = async (event) => {
     emitter.emit(exports.scratchOrgLifecycleEventName, event);
 };
 exports.emit = emit;
+const postOrgCreateHookFields = [
+    'accessToken',
+    'clientId',
+    'created',
+    'createdOrgInstance',
+    'devHubUsername',
+    'expirationDate',
+    'instanceUrl',
+    'loginUrl',
+    'orgId',
+    'username',
+];
+const isHookField = (key) => {
+    return postOrgCreateHookFields.includes(key);
+};
+const emitPostOrgCreate = async (authFields) => {
+    emitter.emit('postorgcreate', Object.fromEntries(Object.entries(authFields).filter(([key]) => isHookField(key))));
+};
+exports.emitPostOrgCreate = emitPostOrgCreate;
 //# sourceMappingURL=scratchOrgLifecycleEvents.js.map