@salesforce/core 4.0.0 → 4.1.0

package/lib/org/orgConfigProperties.d.ts

@@ -1,8 +1,69 @@
+import { ConfigValue } from '../config/configStore';
 export declare enum OrgConfigProperties {
+    /**
+     * Username associate with the default org.
+     */
     TARGET_ORG = "target-org",
-    TARGET_DEV_HUB = "target-dev-hub"
+    /**
+     * Username associated with the default dev hub org.
+     */
+    TARGET_DEV_HUB = "target-dev-hub",
+    /**
+     * The api version
+     */
+    ORG_API_VERSION = "org-api-version",
+    /**
+     * Custom templates repo or local location.
+     */
+    ORG_CUSTOM_METADATA_TEMPLATES = "org-custom-metadata-templates",
+    /**
+     * Allows users to override the 10,000 result query limit.
+     */
+    ORG_MAX_QUERY_LIMIT = "org-max-query-limit",
+    /**
+     * The instance url of the org.
+     */
+    ORG_INSTANCE_URL = "org-instance-url",
+    /**
+     * The sid for the debugger configuration.
+     */
+    ORG_ISV_DEBUGGER_SID = "org-isv-debugger-sid",
+    /**
+     * The url for the debugger configuration.
+     */
+    ORG_ISV_DEBUGGER_URL = "org-isv-debugger-url"
 }
-export declare const ORG_CONFIG_ALLOWED_PROPERTIES: {
+export declare const ORG_CONFIG_ALLOWED_PROPERTIES: ({
     key: OrgConfigProperties;
     description: string;
-}[];
+    input?: undefined;
+    hidden?: undefined;
+    encrypted?: undefined;
+} | {
+    key: OrgConfigProperties;
+    description: string;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+    hidden?: undefined;
+    encrypted?: undefined;
+} | {
+    key: OrgConfigProperties;
+    description: string;
+    hidden: boolean;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+    encrypted?: undefined;
+} | {
+    key: OrgConfigProperties;
+    description: string;
+    encrypted: boolean;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+    hidden?: undefined;
+})[];

package/lib/org/orgConfigProperties.js

@@ -8,22 +8,114 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ORG_CONFIG_ALLOWED_PROPERTIES = exports.OrgConfigProperties = void 0;
 const path_1 = require("path");
+const ts_types_1 = require("@salesforce/ts-types");
 const messages_1 = require("../messages");
-messages_1.Messages.importMessagesDirectory((0, path_1.join)(__dirname));
-const messages = messages_1.Messages.load('@salesforce/core', 'config', ['targetOrg', 'targetDevHub']);
+const sfdcUrl_1 = require("../util/sfdcUrl");
+const sfdc_1 = require("../util/sfdc");
+const messages = new messages_1.Messages('@salesforce/core', 'config', new Map([["unknownConfigKey", "Unknown config name: %s."], ["deprecatedConfigKey", "Deprecated config name: %s. Please use %s instead."], ["invalidWrite", "The writeSync method is not allowed on SfdxConfig. Use the async write method instead."], ["invalidConfigValue", "Invalid config value: %s."], ["invalidInstanceUrl", "Specify a valid Salesforce instance URL."], ["invalidApiVersion", "Specify a valid Salesforce API version, for example, 42.0."], ["invalidCustomOrgMetadataTemplates", "Specify a valid repository URL or directory for the custom org metadata templates."], ["invalidIsvDebuggerSid", "Specify a valid Debugger SID."], ["invalidIsvDebuggerUrl", "Specify a valid Debugger URL."], ["invalidNumberConfigValue", "Specify a valid positive integer, for example, 150000."], ["invalidBooleanConfigValue", "The config value can only be set to true or false."], ["invalidProjectWorkspace", "This directory does not contain a valid Salesforce DX project."], ["schemaValidationError", "The config file \"%s\" is not schema valid.\nDue to: %s"], ["schemaValidationError.actions", ["Fix the invalid entries at %s."]], ["missingDefaultPath", "In sfdx-project.json, be sure to specify which package directory (path) is the default. Example: `[{ \"path\": \"packageDirectory1\", \"default\": true }, { \"path\": \"packageDirectory2\" }]`"], ["missingPackageDirectory", "The path \"%s\", specified in sfdx-project.json, does not exist. Be sure this directory is included in your project root."], ["invalidPackageDirectory", "The path \"%s\", specified in sfdx-project.json, must be indicated as a relative path to the project root."], ["multipleDefaultPaths", "In sfdx-project.json, indicate only one package directory (path) as the default."], ["singleNonDefaultPackage", "The sfdx-project.json file must include one, and only one, default package directory (path). Because your sfdx-project.json file contains only one package directory, it must be the default. Remove the `\"default\": false` key and try again."], ["target-org", "Username or alias of the org that all commands run against by default. (sf only)"], ["target-dev-hub", "Username or alias of your default Dev Hub org. (sf only)"], ["defaultUsername", "Username or alias of the org that all commands run against by default. (sfdx only)"], ["defaultDevHubUsername", "Username or alias of your default Dev Hub org. (sfdx only)"], ["isvDebuggerSid", "ISV debugger SID (sfdx only)"], ["isvDebuggerUrl", "ISV debugger URL (sfdx only)"], ["org-isv-debugger-sid", "ISV debugger SID."], ["org-isv-debugger-url", "ISV debugger URL."], ["apiVersion", "API version of your project. Default: API version of your Dev Hub org. (sfdx only)"], ["org-api-version", "API version of your project. Default: API version of your Dev Hub org."], ["disableTelemetry", "Disables the collection of usage and user environment information, etc. Default: false. (sfdx only)"], ["disable-telemetry", "Disables the collection of usage and user environment information, etc. Default: false."], ["maxQueryLimit", "Maximum number of Salesforce records returned by a CLI command. Default: 10,000. (sfdx only)"], ["org-max-query-limit", "Maximum number of Salesforce records returned by a CLI command. Default: 10,000."], ["restDeploy", "Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). (sfdx only)"], ["instanceUrl", "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)"], ["org-instance-url", "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com."], ["customOrgMetadataTemplates", "A valid repository URL or directory for the custom org metadata templates."], ["org-custom-metadata-templates", "A valid repository URL or directory for the custom org metadata templates."], ["invalidId", "The given id %s is not a valid 15 or 18 character Salesforce ID."]]));
 var OrgConfigProperties;
 (function (OrgConfigProperties) {
+    /**
+     * Username associate with the default org.
+     */
     OrgConfigProperties["TARGET_ORG"] = "target-org";
+    /**
+     * Username associated with the default dev hub org.
+     */
     OrgConfigProperties["TARGET_DEV_HUB"] = "target-dev-hub";
+    /**
+     * The api version
+     */
+    OrgConfigProperties["ORG_API_VERSION"] = "org-api-version";
+    /**
+     * Custom templates repo or local location.
+     */
+    OrgConfigProperties["ORG_CUSTOM_METADATA_TEMPLATES"] = "org-custom-metadata-templates";
+    /**
+     * Allows users to override the 10,000 result query limit.
+     */
+    OrgConfigProperties["ORG_MAX_QUERY_LIMIT"] = "org-max-query-limit";
+    /**
+     * The instance url of the org.
+     */
+    OrgConfigProperties["ORG_INSTANCE_URL"] = "org-instance-url";
+    /**
+     * The sid for the debugger configuration.
+     */
+    OrgConfigProperties["ORG_ISV_DEBUGGER_SID"] = "org-isv-debugger-sid";
+    /**
+     * The url for the debugger configuration.
+     */
+    OrgConfigProperties["ORG_ISV_DEBUGGER_URL"] = "org-isv-debugger-url";
 })(OrgConfigProperties = exports.OrgConfigProperties || (exports.OrgConfigProperties = {}));
 exports.ORG_CONFIG_ALLOWED_PROPERTIES = [
+    {
+        key: OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES,
+        description: messages.getMessage(OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES),
+    },
     {
         key: OrgConfigProperties.TARGET_ORG,
-        description: messages.getMessage('targetOrg'),
+        description: messages.getMessage(OrgConfigProperties.TARGET_ORG),
     },
     {
         key: OrgConfigProperties.TARGET_DEV_HUB,
-        description: messages.getMessage('targetDevHub'),
+        description: messages.getMessage(OrgConfigProperties.TARGET_DEV_HUB),
+    },
+    {
+        key: OrgConfigProperties.ORG_INSTANCE_URL,
+        description: messages.getMessage(OrgConfigProperties.ORG_INSTANCE_URL),
+        input: {
+            // If a value is provided validate it otherwise no value is unset.
+            validator: (value) => {
+                if (value == null)
+                    return true;
+                // validate if the value is a string and is a valid url and is either a salesforce domain
+                // or an internal url.
+                return ((0, ts_types_1.isString)(value) &&
+                    sfdcUrl_1.SfdcUrl.isValidUrl(value) &&
+                    (new sfdcUrl_1.SfdcUrl(value).isSalesforceDomain() || new sfdcUrl_1.SfdcUrl(value).isInternalUrl()));
+            },
+            failedMessage: messages.getMessage('invalidInstanceUrl'),
+        },
+    },
+    {
+        key: OrgConfigProperties.ORG_API_VERSION,
+        description: messages.getMessage(OrgConfigProperties.ORG_API_VERSION),
+        hidden: true,
+        input: {
+            // If a value is provided validate it otherwise no value is unset.
+            validator: (value) => value == null || ((0, ts_types_1.isString)(value) && (0, sfdc_1.validateApiVersion)(value)),
+            failedMessage: messages.getMessage('invalidApiVersion'),
+        },
+    },
+    {
+        key: OrgConfigProperties.ORG_ISV_DEBUGGER_SID,
+        description: messages.getMessage(OrgConfigProperties.ORG_ISV_DEBUGGER_SID),
+        encrypted: true,
+        input: {
+            // If a value is provided validate it otherwise no value is unset.
+            validator: (value) => value == null || (0, ts_types_1.isString)(value),
+            failedMessage: messages.getMessage('invalidIsvDebuggerSid'),
+        },
+    },
+    {
+        key: OrgConfigProperties.ORG_ISV_DEBUGGER_URL,
+        description: messages.getMessage(OrgConfigProperties.ORG_ISV_DEBUGGER_URL),
+        input: {
+            // If a value is provided validate it otherwise no value is unset.
+            validator: (value) => value == null || (0, ts_types_1.isString)(value),
+            failedMessage: messages.getMessage('invalidIsvDebuggerUrl'),
+        },
+    },
+    {
+        key: OrgConfigProperties.ORG_MAX_QUERY_LIMIT,
+        description: messages.getMessage(OrgConfigProperties.ORG_MAX_QUERY_LIMIT),
+        input: {
+            // the bit shift will remove the negative bit, and any decimal numbers
+            // then the parseFloat will handle converting it to a number from a string
+            validator: (value) => value >>> 0 === parseFloat(value) && value > 0,
+            failedMessage: messages.getMessage('invalidNumberConfigValue'),
+        },
     },
 ];
 //# sourceMappingURL=orgConfigProperties.js.map

package/lib/org/permissionSetAssignment.js

@@ -12,17 +12,8 @@ const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const logger_1 = require("../logger");
 const messages_1 = require("../messages");
-const sfdxError_1 = require("../sfdxError");
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'permissionSetAssignment', [
-    'errorsEncounteredCreatingAssignment',
-    'orgRequired',
-    'userIdRequired',
-    'permSetRequired',
-    'assignCommandPermissionSetNotFoundForNSError',
-    'assignCommandPermissionSetNotFoundError',
-    'notSuccessfulButNoErrorsReported',
-]);
+const sfError_1 = require("../sfError");
+const messages = new messages_1.Messages('@salesforce/core', 'permissionSetAssignment', new Map([["orgRequired", "An Org instance is required."], ["userIdRequired", "A Salesforce id for the user is required."], ["permSetRequired", "The name of a permission set is required."], ["unexpectedType", "An unexpected response was returned from the permission set assignment."], ["assignCommandPermissionSetNotFoundError", "Permission set \"%s\" not found in target org. Do you need to push source?"], ["assignCommandPermissionSetNotFoundForNSError", "Permission set \"%s\" for namespace \"%s\" not found in target org. Do you need to push source or install the package?"], ["errorsEncounteredCreatingAssignment", "Error(s) were reported."], ["notSuccessfulButNoErrorsReported", "The permission set assignment failed but no errors were reported."]]));
 /**
  * A class for assigning a Salesforce User to one or more permission sets.
  */
@@ -61,7 +52,7 @@ class PermissionSetAssignment {
             query += ` AND NamespacePrefix='${nsPrefix}'`;
         }
         const result = await this.org.getConnection().query(query);
-        const permissionSetId = (0, ts_types_1.getString)(result, 'records[0].Id');
+        const permissionSetId = result?.records[0]?.Id;
         if (!permissionSetId) {
             if (nsPrefix) {
                 throw messages.createError('assignCommandPermissionSetNotFoundForNSError', [permSetName, nsPrefix]);
@@ -86,7 +77,7 @@ class PermissionSetAssignment {
                 errors.forEach((_message) => {
                     message = `${message}${_message}${os_1.EOL}`;
                 });
-                throw new sfdxError_1.SfdxError(message, 'errorsEncounteredCreatingAssignment');
+                throw new sfError_1.SfError(message, 'errorsEncounteredCreatingAssignment');
             }
             else {
                 throw messages.createError('notSuccessfulButNoErrorsReported');

package/lib/org/scratchOrgCache.d.ts

@@ -0,0 +1,20 @@
+import { JsonMap } from '@salesforce/ts-types';
+import { TTLConfig } from '../config/ttlConfig';
+export type CachedOptions = {
+    hubUsername: string;
+    /** stores the scratch definition, including settings/objectSettings */
+    definitionjson: JsonMap;
+    hubBaseUrl: string;
+    /** may be required for auth*/
+    clientSecret?: string;
+    signupTargetLoginUrlConfig?: string;
+    apiVersion?: string;
+    alias?: string;
+    setDefault?: boolean;
+    tracksSource?: boolean;
+};
+export declare class ScratchOrgCache extends TTLConfig<TTLConfig.Options, CachedOptions> {
+    static getFileName(): string;
+    static getDefaultOptions(): TTLConfig.Options;
+    static unset(key: string): Promise<void>;
+}

package/lib/org/scratchOrgCache.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScratchOrgCache = void 0;
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+const kit_1 = require("@salesforce/kit");
+const global_1 = require("../global");
+const ttlConfig_1 = require("../config/ttlConfig");
+class ScratchOrgCache extends ttlConfig_1.TTLConfig {
+    static getFileName() {
+        return 'scratch-create-cache.json';
+    }
+    static getDefaultOptions() {
+        return {
+            isGlobal: true,
+            isState: true,
+            filename: ScratchOrgCache.getFileName(),
+            stateFolder: global_1.Global.SF_STATE_FOLDER,
+            ttl: kit_1.Duration.days(1),
+        };
+    }
+    static async unset(key) {
+        const cache = await ScratchOrgCache.create();
+        cache.unset(key);
+        await cache.write();
+    }
+}
+exports.ScratchOrgCache = ScratchOrgCache;
+//# sourceMappingURL=scratchOrgCache.js.map

package/lib/org/scratchOrgCreate.d.ts

@@ -1,6 +1,6 @@
 import { Duration } from '@salesforce/kit';
 import { Org } from './org';
-import { ScratchOrgInfo } from './scratchOrgInfoApi';
+import { ScratchOrgInfo } from './scratchOrgTypes';
 import { AuthFields, AuthInfo } from './authInfo';
 export declare const DEFAULT_STREAM_TIMEOUT_MINUTES = 6;
 export interface ScratchOrgCreateResult {
@@ -10,34 +10,45 @@ 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;
+    /** if false, do not use source tracking for this scratch org */
+    tracksSource?: 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.
@@ -12,22 +12,18 @@ const ts_types_1 = require("@salesforce/ts-types");
 const messages_1 = require("../messages");
 const logger_1 = require("../logger");
 const configAggregator_1 = require("../config/configAggregator");
-const sfdxProject_1 = require("../sfdxProject");
-const sfdxError_1 = require("../sfdxError");
+const orgConfigProperties_1 = require("../org/orgConfigProperties");
+const sfProject_1 = require("../sfProject");
+const stateAggregator_1 = require("../stateAggregator");
 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");
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'scratchOrgCreate', [
-    'SourceStatusResetFailureError',
-    'DurationDaysValidationMaxError',
-    'DurationDaysValidationMinError',
-    'RetryNotIntError',
-    'WaitValidationMaxError',
-    'DurationDaysNotIntError',
-]);
+const authInfo_1 = require("./authInfo");
+const scratchOrgLifecycleEvents_1 = require("./scratchOrgLifecycleEvents");
+const scratchOrgCache_1 = require("./scratchOrgCache");
+const scratchOrgErrorCodes_1 = require("./scratchOrgErrorCodes");
+const messages = new messages_1.Messages('@salesforce/core', 'scratchOrgCreate', new Map([["UnsupportedSnapshotOrgCreateOptionsError", "Org snapshots don\u2019t support one or more options you specified: %s."], ["DurationDaysValidationMinError", "Expected 'durationDays' greater than or equal to %s but received %s."], ["DurationDaysValidationMaxError", "Expected 'durationDays' less than or equal to %s but received %s."], ["DurationDaysNotIntError", "Expected 'durationDays' to be an integer number."], ["RetryNotIntError", "Expected 'retry' to be an integer number."], ["CacheMissError", "The ScratchOrgInfoId %s was not found in the cache."]]));
 exports.DEFAULT_STREAM_TIMEOUT_MINUTES = 6;
 const validateDuration = (durationDays) => {
     const min = 1;
@@ -48,20 +44,72 @@ 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) => {
+    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, tracksSource, } = 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 = soi.Username ?? soi.SignupUsername;
+    // re-auth only if the org isn't in StateAggregator
+    const stateAggregator = await stateAggregator_1.StateAggregator.getInstance();
+    const scratchOrgAuthInfo = (await stateAggregator.orgs.exists(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 });
+    const configAggregator = await configAggregator_1.ConfigAggregator.create();
+    await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'deploy settings', scratchOrgInfo: soi });
+    const settingsGenerator = new scratchOrgSettingsGenerator_1.default();
+    await settingsGenerator.extract({ ...soi, ...definitionjson });
+    const [authInfo] = await Promise.all([
+        (0, scratchOrgInfoApi_1.resolveUrl)(scratchOrgAuthInfo),
+        (0, scratchOrgInfoApi_1.deploySettings)(scratchOrg, settingsGenerator, apiVersion ??
+            configAggregator.getPropertyValue(orgConfigProperties_1.OrgConfigProperties.ORG_API_VERSION) ??
+            (await scratchOrg.retrieveMaxApiVersion())),
+    ]);
+    await scratchOrgAuthInfo.handleAliasAndDefaultSettings({
+        alias,
+        setDefault: setDefault ?? false,
+        setDefaultDevHub: false,
+        setTracksSource: tracksSource ?? true,
+    });
+    cache.unset(soi.Id ?? 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;
     const logger = await logger_1.Logger.child('scratchOrgCreate');
+    /** epoch milliseconds */
+    const startTimestamp = Date.now();
     logger.debug('scratchOrgCreate');
-    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;
+    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, alias, setDefault = false, tracksSource = true, } = options;
     validateDuration(durationDays);
     validateRetry(retry);
-    validateWait(wait);
     const { scratchOrgInfoPayload, ignoreAncestorIds, warnings } = await (0, scratchOrgInfoGenerator_1.getScratchOrgInfoPayload)({
         definitionjson,
         definitionfile,
@@ -79,43 +127,83 @@ 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 scratchOrgInfoId = (0, ts_types_1.ensureString)((0, ts_types_1.getString)(scratchOrgInfoRequestResult, 'id'));
+    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)(scratchOrgInfoRequestResult.id);
+    const cache = await scratchOrgCache_1.ScratchOrgCache.create();
+    cache.set(scratchOrgInfoId, {
+        hubUsername: hubOrg.getUsername(),
+        hubBaseUrl: hubOrg.getField(org_1.Org.Fields.INSTANCE_URL)?.toString(),
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        definitionjson: { ...(definitionjson ? JSON.parse(definitionjson) : {}), ...orgConfig, ...settings },
+        clientSecret,
+        alias,
+        setDefault,
+        tracksSource,
+    });
+    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: soi.Username ?? soi.SignupUsername,
+    });
     const username = scratchOrg.getUsername();
     logger.debug(`scratch org username ${username}`);
-    const configAggregator = new configAggregator_1.ConfigAggregator();
-    const authInfo = await (0, scratchOrgInfoApi_1.deploySettingsAndResolveUrl)(scratchOrgAuthInfo, (_a = apiversion !== null && apiversion !== void 0 ? apiversion : configAggregator.getPropertyValue('apiVersion')) !== 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: 'deploy settings', scratchOrgInfo: soi });
+    const configAggregator = await configAggregator_1.ConfigAggregator.create();
+    const [authInfo] = await Promise.all([
+        (0, scratchOrgInfoApi_1.resolveUrl)(scratchOrgAuthInfo),
+        (0, scratchOrgInfoApi_1.deploySettings)(scratchOrg, settingsGenerator, apiversion ??
+            configAggregator.getPropertyValue(orgConfigProperties_1.OrgConfigProperties.ORG_API_VERSION) ??
+            (await scratchOrg.retrieveMaxApiVersion()), 
+        // some of our "wait" time has already been used.  Calculate how much remains that we can spend on the deployment.
+        kit_1.Duration.milliseconds(wait.milliseconds - (Date.now() - startTimestamp))),
+    ]);
+    await scratchOrgAuthInfo.handleAliasAndDefaultSettings({
+        ...{
+            alias,
+            setDefault,
+            setDefaultDevHub: false,
+            setTracksSource: tracksSource === false ? false : true,
+        },
+    });
+    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(),
+        authFields: authInfo?.getFields(),
         warnings,
     };
 };
 exports.scratchOrgCreate = scratchOrgCreate;
 const getSignupTargetLoginUrl = async () => {
     try {
-        const project = await sfdxProject_1.SfdxProject.resolve();
+        const project = await sfProject_1.SfProject.resolve();
         const projectJson = await project.resolveProjectConfig();
         return projectJson.signupTargetLoginUrl;
     }
@@ -123,20 +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']);
-    try {
-        await conn.tooling
-            .sobject('SourceMember')
-            .update(queryResult.map((record) => ({ Id: record.Id, RevisionCounter: 0 })));
-    }
-    catch (err) {
-        const message = messages.getMessage('SourceStatusResetFailureError', [
-            scratchOrg.getOrgId(),
-            scratchOrg.getUsername(),
-        ]);
-        throw new sfdxError_1.SfdxError(message, 'SourceStatusResetFailure');
-    }
-};
 //# 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 './scratchOrgInfoApi';
-export declare const checkScratchOrgInfoForErrors: (orgInfo: Optional<ScratchOrgInfo>, hubUsername: Optional<string>, logger: Logger) => ScratchOrgInfo;
+import { ScratchOrgInfo } from './scratchOrgTypes';
+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>;