@salesforce/core 3.9.0 → 3.10.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [3.10.0](https://github.com/forcedotcom/sfdx-core/compare/v3.9.0...v3.10.0) (2022-03-23)
+
+### Features
+
+- lifecycle events for scratch org create ([cba673b](https://github.com/forcedotcom/sfdx-core/commit/cba673b515df311165f3c392b155fcf5fbf9e2c6))
+- scratch org lifecycle events ([541349d](https://github.com/forcedotcom/sfdx-core/commit/541349d84b4784356d8bc504d1e331450487b6ec))
+
+### Bug Fixes
+
+- casing typo for import ([066a2bb](https://github.com/forcedotcom/sfdx-core/commit/066a2bbb37b07f62415f021ef511344976315128))
+- warnings about tracking aren't a throw (org will still auth, default) ([38114a3](https://github.com/forcedotcom/sfdx-core/commit/38114a3526267a615fa8f5d3470b79c9b36a8fa8))
+
 ## [3.9.0](https://github.com/forcedotcom/sfdx-core/compare/v3.8.1...v3.9.0) (2022-03-21)
 
 ### Features

package/lib/exported.d.ts

@@ -30,6 +30,7 @@ export { MyDomainResolver } from './status/myDomainResolver';
 export { DefaultUserFields, REQUIRED_FIELDS, User, UserFields } from './org/user';
 export { PermissionSetAssignment, PermissionSetAssignmentFields } from './org/permissionSetAssignment';
 export { ScratchOrgCreateOptions, ScratchOrgCreateResult, scratchOrgCreate } from './org/scratchOrgCreate';
-export { ScratchOrgInfo } from './org/scratchOrgInfoApi';
+export { ScratchOrgInfo } from './org/scratchOrgTypes';
+export { ScratchOrgLifecycleEvent, scratchOrgLifecycleEventName, scratchOrgLifecycleStages, } from './org/scratchOrgLifecycleEvents';
 export * from './util/sfdc';
 export * from './util/sfdcUrl';

package/lib/exported.js

@@ -17,6 +17,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = exports.MyDomainResolver = exports.StreamingClient = exports.CometClient = exports.PollingClient = exports.SfdxError = exports.SfError = exports.SchemaValidator = exports.SchemaPrinter = exports.SfdxProjectJson = exports.SfdxProject = exports.SfProjectJson = exports.SfProject = exports.ORG_CONFIG_ALLOWED_PROPERTIES = exports.OrgConfigProperties = exports.OrgTypes = exports.SandboxEvents = exports.Org = exports.Messages = exports.Logger = exports.LoggerLevel = exports.getJwtAudienceUrl = exports.SfdcUrl = exports.WebOAuthServer = exports.Lifecycle = exports.Global = exports.Mode = exports.SFDX_HTTP_HEADERS = exports.Connection = exports.AuthRemover = exports.AuthInfo = exports.ConfigAggregator = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.SfInfoKeys = exports.GlobalInfo = exports.BaseConfigStore = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.envVars = exports.TTLConfig = exports.ConfigFile = void 0;
+exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = void 0;
 const messages_1 = require("./messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
 var configFile_1 = require("./config/configFile");
@@ -100,6 +101,9 @@ var permissionSetAssignment_1 = require("./org/permissionSetAssignment");
 Object.defineProperty(exports, "PermissionSetAssignment", { enumerable: true, get: function () { return permissionSetAssignment_1.PermissionSetAssignment; } });
 var scratchOrgCreate_1 = require("./org/scratchOrgCreate");
 Object.defineProperty(exports, "scratchOrgCreate", { enumerable: true, get: function () { return scratchOrgCreate_1.scratchOrgCreate; } });
+var scratchOrgLifecycleEvents_1 = require("./org/scratchOrgLifecycleEvents");
+Object.defineProperty(exports, "scratchOrgLifecycleEventName", { enumerable: true, get: function () { return scratchOrgLifecycleEvents_1.scratchOrgLifecycleEventName; } });
+Object.defineProperty(exports, "scratchOrgLifecycleStages", { enumerable: true, get: function () { return scratchOrgLifecycleEvents_1.scratchOrgLifecycleStages; } });
 // Utility sub-modules
 __exportStar(require("./util/sfdc"), exports);
 __exportStar(require("./util/sfdcUrl"), exports);

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 {

package/lib/org/scratchOrgCreate.js

@@ -13,12 +13,13 @@ const messages_1 = require("../messages");
 const logger_1 = require("../logger");
 const configAggregator_1 = require("../config/configAggregator");
 const sfProject_1 = require("../sfProject");
-const sfError_1 = require("../sfError");
+const lifecycleEvents_1 = require("../lifecycleEvents");
 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 scratchOrgLifecycleEvents_1 = require("./scratchOrgLifecycleEvents");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'scratchOrgCreate', [
     'SourceStatusResetFailureError',
@@ -58,6 +59,7 @@ const scratchOrgCreate = async (options) => {
     var _a;
     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;
     validateDuration(durationDays);
     validateRetry(retry);
@@ -100,10 +102,12 @@ const scratchOrgCreate = async (options) => {
     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('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: 'done', scratchOrgInfo: scratchOrgInfoResult });
     return {
         username,
         scratchOrgInfo: scratchOrgInfoResult,
@@ -126,17 +130,16 @@ const getSignupTargetLoginUrl = async () => {
 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) {
-        const message = messages.getMessage('SourceStatusResetFailureError', [
-            scratchOrg.getOrgId(),
-            scratchOrg.getUsername(),
-        ]);
-        throw new sfError_1.SfError(message, 'SourceStatusResetFailure');
+        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,4 @@
 import { Optional } from '@salesforce/ts-types';
 import { Logger } from '../logger';
-import { ScratchOrgInfo } from './scratchOrgInfoApi';
+import { ScratchOrgInfo } from './scratchOrgTypes';
 export declare const checkScratchOrgInfoForErrors: (orgInfo: Optional<ScratchOrgInfo>, hubUsername: Optional<string>, logger: Logger) => ScratchOrgInfo;

package/lib/org/scratchOrgInfoApi.d.ts

@@ -3,45 +3,8 @@ import { Duration } from '@salesforce/kit';
 import { SaveResult } from 'jsforce';
 import { AuthInfo } from './authInfo';
 import { Org } from './org';
-import SettingsGenerator, { ObjectSetting } from './scratchOrgSettingsGenerator';
-export interface ScratchOrgInfo {
-    AdminEmail?: string;
-    readonly CreatedDate?: string;
-    ConnectedAppCallbackUrl?: string;
-    ConnectedAppConsumerKey?: string;
-    Country?: string;
-    Description?: string;
-    DurationDays?: string;
-    Edition?: string;
-    readonly ErrorCode?: string;
-    readonly ExpirationDate?: string;
-    Features?: string;
-    HasSampleData?: boolean;
-    readonly Id?: string;
-    Language?: string;
-    LoginUrl: string;
-    readonly Name?: string;
-    Namespace?: string;
-    OrgName?: string;
-    Release?: 'Current' | 'Previous' | 'Preview';
-    readonly ScratchOrg?: string;
-    SourceOrg?: string;
-    readonly AuthCode: string;
-    Snapshot: string;
-    readonly Status: 'New' | 'Creating' | 'Active' | 'Error' | 'Deleted';
-    readonly SignupEmail: string;
-    readonly SignupUsername: string;
-    readonly SignupInstance: string;
-    Username: string;
-    settings?: Record<string, unknown>;
-    objectSettings?: {
-        [objectName: string]: ObjectSetting;
-    };
-    orgPreferences?: {
-        enabled: string[];
-        disabled: string[];
-    };
-}
+import SettingsGenerator from './scratchOrgSettingsGenerator';
+import { ScratchOrgInfo } from './scratchOrgTypes';
 export interface JsForceError extends Error {
     errorCode: string;
     fields: string[];

package/lib/org/scratchOrgInfoApi.js

@@ -20,6 +20,7 @@ const myDomainResolver_1 = require("../status/myDomainResolver");
 const authInfo_1 = require("./authInfo");
 const org_1 = require("./org");
 const scratchOrgErrorCodes_1 = require("./scratchOrgErrorCodes");
+const scratchOrgLifecycleEvents_1 = require("./scratchOrgLifecycleEvents");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.loadMessages('@salesforce/core', 'scratchOrgInfoApi');
 const errorCodes = messages_1.Messages.load('@salesforce/core', 'scratchOrgErrorCodes', ['C-1007']);
@@ -144,6 +145,7 @@ const getAuthInfo = async (options) => {
 const authorizeScratchOrg = async (options) => {
     var _a;
     const { scratchOrgInfoComplete, hubOrg, clientSecret, signupTargetLoginUrlConfig, retry: maxRetries } = 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)}`);
     // if we didn't have it marked as a devhub but just successfully used it as one, this will update the authFile, fix cache, etc
@@ -225,6 +227,8 @@ const requestScratchOrgCreation = async (hubOrg, scratchOrgRequest, settings) =>
     const scratchOrgInfo = (0, mapKeys_1.default)(scratchOrgRequest, kit_1.upperFirst, true);
     await checkOrgDoesntExist(scratchOrgInfo); // throw if it does exist.
     try {
+        await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'send request' });
+        // return await will cause this catch block to run instead of the caller's catch block
         return await hubOrg.getConnection().sobject('ScratchOrgInfo').create(scratchOrgInfo);
     }
     catch (error) {
@@ -257,11 +261,13 @@ timeout = kit_1.Duration.minutes(15)) => {
                 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,
                     };
                 }
+                await (0, scratchOrgLifecycleEvents_1.emit)({ stage: 'wait for org', scratchOrgInfo: resultInProgress });
                 logger.debug(`Scratch org status is ${resultInProgress.Status}`);
                 return {
                     completed: false,

package/lib/org/scratchOrgInfoGenerator.d.ts

@@ -1,6 +1,6 @@
 import { SfProjectJson } from '../sfProject';
 import { Org } from './org';
-import { ScratchOrgInfo } from './scratchOrgInfoApi';
+import { ScratchOrgInfo } from './scratchOrgTypes';
 declare type PartialScratchOrgInfo = Pick<ScratchOrgInfo, 'ConnectedAppConsumerKey' | 'AuthCode' | 'Snapshot' | 'Status' | 'LoginUrl' | 'SignupEmail' | 'SignupUsername' | 'SignupInstance' | 'Username'>;
 export interface ScratchOrgInfoPayload extends PartialScratchOrgInfo {
     orgName: string;

package/lib/org/scratchOrgLifecycleEvents.d.ts

@@ -0,0 +1,8 @@
+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"];
+export interface ScratchOrgLifecycleEvent {
+    stage: typeof scratchOrgLifecycleStages[number];
+    scratchOrgInfo?: ScratchOrgInfo;
+}
+export declare const emit: (event: ScratchOrgLifecycleEvent) => Promise<void>;

package/lib/org/scratchOrgLifecycleEvents.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emit = exports.scratchOrgLifecycleStages = exports.scratchOrgLifecycleEventName = 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 lifecycleEvents_1 = require("../lifecycleEvents");
+const emitter = lifecycleEvents_1.Lifecycle.getInstance();
+exports.scratchOrgLifecycleEventName = 'scratchOrgLifecycleEvent';
+exports.scratchOrgLifecycleStages = [
+    'prepare request',
+    'send request',
+    'wait for org',
+    'available',
+    'authenticate',
+    'deploy settings',
+    'done',
+];
+const emit = async (event) => {
+    emitter.emit(exports.scratchOrgLifecycleEventName, event);
+};
+exports.emit = emit;
+//# sourceMappingURL=scratchOrgLifecycleEvents.js.map

package/lib/org/scratchOrgSettingsGenerator.d.ts

@@ -1,5 +1,5 @@
 import { JsonMap } from '@salesforce/ts-types';
-import { ScratchOrgInfo } from './scratchOrgInfoApi';
+import { ScratchOrgInfo } from './scratchOrgTypes';
 import { Org } from './org';
 export declare enum RequestStatus {
     Pending = "Pending",
@@ -10,10 +10,6 @@ export declare enum RequestStatus {
     Canceling = "Canceling",
     Canceled = "Canceled"
 }
-export interface ObjectSetting extends JsonMap {
-    sharingModel?: string;
-    defaultRecordType?: string;
-}
 export interface BusinessProcessFileContent extends JsonMap {
     fullName: string;
     isActive: boolean;

package/lib/org/scratchOrgTypes.d.ts

@@ -0,0 +1,43 @@
+import { JsonMap } from '@salesforce/ts-types';
+export interface ScratchOrgInfo {
+    AdminEmail?: string;
+    readonly CreatedDate?: string;
+    ConnectedAppCallbackUrl?: string;
+    ConnectedAppConsumerKey?: string;
+    Country?: string;
+    Description?: string;
+    DurationDays?: string;
+    Edition?: string;
+    readonly ErrorCode?: string;
+    readonly ExpirationDate?: string;
+    Features?: string;
+    HasSampleData?: boolean;
+    readonly Id?: string;
+    Language?: string;
+    LoginUrl: string;
+    readonly Name?: string;
+    Namespace?: string;
+    OrgName?: string;
+    Release?: 'Current' | 'Previous' | 'Preview';
+    readonly ScratchOrg?: string;
+    SourceOrg?: string;
+    readonly AuthCode: string;
+    Snapshot: string;
+    readonly Status: 'New' | 'Creating' | 'Active' | 'Error' | 'Deleted';
+    readonly SignupEmail: string;
+    readonly SignupUsername: string;
+    readonly SignupInstance: string;
+    Username: string;
+    settings?: Record<string, unknown>;
+    objectSettings?: {
+        [objectName: string]: ObjectSetting;
+    };
+    orgPreferences?: {
+        enabled: string[];
+        disabled: string[];
+    };
+}
+export interface ObjectSetting extends JsonMap {
+    sharingModel?: string;
+    defaultRecordType?: string;
+}

package/lib/org/scratchOrgTypes.js

@@ -0,0 +1,9 @@
+"use strict";
+/*
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=scratchOrgTypes.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.9.0",
+  "version": "3.10.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",