@salesforce/core 3.18.1 → 3.19.0

package/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 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.19.0](https://github.com/forcedotcom/sfdx-core/compare/v3.18.3...v3.19.0) (2022-05-20)
+
+### Features
+
+- missing prop and logic correction ([debe97e](https://github.com/forcedotcom/sfdx-core/commit/debe97e08f54bbd55edd2cb5b18e9d14abd3652f))
+- property on org with inteligent defaults and handling of undefined ([e7295d3](https://github.com/forcedotcom/sfdx-core/commit/e7295d38f2b8defdb54a77e61b4ef8862e5398f9))
+- tracking property on AuthFields ([2243d34](https://github.com/forcedotcom/sfdx-core/commit/2243d345c5cc81bd637c889adbe1db6eae6c93fc))
+- tracksSource in TestSetup mock ([7544c60](https://github.com/forcedotcom/sfdx-core/commit/7544c604bd4a32d21d105e8472f41b2d37fbf601))
+
+### [3.18.3](https://github.com/forcedotcom/sfdx-core/compare/v3.18.2...v3.18.3) (2022-05-20)
+
+### [3.18.2](https://github.com/forcedotcom/sfdx-core/compare/v3.18.1...v3.18.2) (2022-05-17)
+
+### Bug Fixes
+
+- remove unreachable code ([#585](https://github.com/forcedotcom/sfdx-core/issues/585)) ([2a6d611](https://github.com/forcedotcom/sfdx-core/commit/2a6d611a9ded7d4a0718864ca4023a0f7f259e8a))
+
 ### [3.18.1](https://github.com/forcedotcom/sfdx-core/compare/v3.18.0...v3.18.1) (2022-05-16)
 
 ## [3.18.0](https://github.com/forcedotcom/sfdx-core/compare/v3.17.0...v3.18.0) (2022-05-12)

package/lib/config/sandboxProcessCache.d.ts

@@ -6,6 +6,7 @@ export declare type SandboxRequestCacheEntry = {
     prodOrgUsername: string;
     sandboxProcessObject: Partial<SandboxProcessObject>;
     sandboxRequest: Partial<SandboxRequest>;
+    tracksSource?: boolean;
 };
 export declare class SandboxRequestCache extends TTLConfig<TTLConfig.Options, SandboxRequestCacheEntry> {
     static getDefaultOptions(): TTLConfig.Options;

package/lib/org/authInfo.d.ts

@@ -37,6 +37,7 @@ export declare type AuthFields = {
     usernames?: string[];
     userProfileName?: string;
     expirationDate?: string;
+    tracksSource?: boolean;
 };
 export declare type OrgAuthorization = {
     orgId: string;
@@ -64,6 +65,7 @@ export declare type AuthSideEffects = {
     alias?: string;
     setDefault: boolean;
     setDefaultDevHub: boolean;
+    setTracksSource?: boolean;
 };
 /**
  * A function to update a refresh token when the access token is expired.

package/lib/org/authInfo.js

@@ -463,14 +463,22 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
      * @param sideEffects - instance of AuthSideEffects
      */
     async handleAliasAndDefaultSettings(sideEffects) {
-        if (sideEffects.alias || sideEffects.setDefault || sideEffects.setDefaultDevHub) {
+        if (sideEffects.alias ||
+            sideEffects.setDefault ||
+            sideEffects.setDefaultDevHub ||
+            typeof sideEffects.setTracksSource === 'boolean') {
             if (sideEffects.alias)
                 await this.setAlias(sideEffects.alias);
             if (sideEffects.setDefault)
                 await this.setAsDefault({ org: true });
             if (sideEffects.setDefaultDevHub)
                 await this.setAsDefault({ devHub: true });
-            await this.save();
+            if (typeof sideEffects.setTracksSource === 'boolean') {
+                await this.save({ tracksSource: sideEffects.setTracksSource });
+            }
+            else {
+                await this.save();
+            }
         }
     }
     /**

package/lib/org/org.d.ts

@@ -119,6 +119,17 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
         interval?: Duration;
         async?: boolean;
     }): Promise<SandboxProcessObject>;
+    /**
+     *
+     * @param sandboxReq SandboxRequest options to create the sandbox with
+     * @param sandboxName
+     * @param options Wait: The amount of time to wait before timing out, defaults to 0, Interval: The time interval between polling defaults to 30 seconds
+     * @returns {SandboxProcessObject} the newly created sandbox process object
+     */
+    cloneSandbox(sandboxReq: SandboxRequest, sandboxName: string, options: {
+        wait?: Duration;
+        interval?: Duration;
+    }): Promise<SandboxProcessObject>;
     /**
      * resume a sandbox creation from a production org
      * 'this' needs to be a production org with sandbox licenses available
@@ -224,6 +235,17 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * scratch org**. If you need accuracy, use the {@link Org.determineIfScratch} method.
      */
     isScratch(): boolean;
+    /**
+     * Returns `true` if the org uses source tracking.
+     * Side effect: updates files where the property doesn't currently exist
+     */
+    tracksSource(): Promise<boolean>;
+    /**
+     * Set the tracking property on the org's auth file
+     *
+     * @param value true or false (whether the org should use source tracking or not)
+     */
+    setTracksSource(value: boolean): Promise<void>;
     /**
      * Returns `true` if the org is a scratch org.
      *
@@ -517,6 +539,11 @@ export declare namespace Org {
         /**
          * The snapshot used to create the scratch org.
          */
-        SNAPSHOT = "snapshot"
+        SNAPSHOT = "snapshot",
+        /**
+         * true: the org supports and wants source tracking
+         * false: the org opted out of tracking or can't support it
+         */
+        TRACKS_SOURCE = "tracksSource"
     }
 }

package/lib/org/org.js

@@ -104,14 +104,14 @@ class Org extends kit_1.AsyncOptionalCreatable {
         async: false,
         interval: kit_1.Duration.seconds(30),
     }) {
-        this.logger.debug('CreateSandbox called with SandboxRequest:', sandboxReq);
+        this.logger.debug(`CreateSandbox called with SandboxRequest: ${sandboxReq}`);
         const createResult = await this.connection.tooling.create('SandboxInfo', sandboxReq);
-        this.logger.debug('Return from calling tooling.create:', createResult);
+        this.logger.debug(`Return from calling tooling.create: ${createResult}`);
         if (Array.isArray(createResult) || !createResult.success) {
             throw messages.createError('sandboxInfoCreateFailed', [JSON.stringify(createResult)]);
         }
         const sandboxCreationProgress = await this.querySandboxProcessBySandboxInfoId(createResult.id);
-        this.logger.debug('Return from calling singleRecordQuery with tooling:', sandboxCreationProgress);
+        this.logger.debug(`Return from calling singleRecordQuery with tooling: ${sandboxCreationProgress}`);
         const isAsync = !!options.async;
         if (isAsync) {
             // The user didn't want us to poll, so simply return the status
@@ -119,13 +119,25 @@ class Org extends kit_1.AsyncOptionalCreatable {
             return sandboxCreationProgress;
         }
         const [wait, pollInterval] = this.validateWaitOptions(options);
-        this.logger.debug(`create - pollStatusAndAuth sandboxProcessObj, max wait time of ${wait.minutes} minutes`, sandboxCreationProgress);
+        this.logger.debug(`create - pollStatusAndAuth sandboxProcessObj ${sandboxCreationProgress}, max wait time of ${wait.minutes} minutes`);
         return this.pollStatusAndAuth({
             sandboxProcessObj: sandboxCreationProgress,
             wait,
             pollInterval,
         });
     }
+    /**
+     *
+     * @param sandboxReq SandboxRequest options to create the sandbox with
+     * @param sandboxName
+     * @param options Wait: The amount of time to wait before timing out, defaults to 0, Interval: The time interval between polling defaults to 30 seconds
+     * @returns {SandboxProcessObject} the newly created sandbox process object
+     */
+    async cloneSandbox(sandboxReq, sandboxName, options) {
+        sandboxReq.SourceId = (await this.querySandboxProcessBySandboxName(sandboxName)).Id;
+        this.logger.debug('Clone sandbox sourceId %s', sandboxReq.SourceId);
+        return this.createSandbox(sandboxReq, options);
+    }
     /**
      * resume a sandbox creation from a production org
      * 'this' needs to be a production org with sandbox licenses available
@@ -140,7 +152,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
         interval: kit_1.Duration.seconds(30),
     }) {
         var _a;
-        this.logger.debug('ResumeSandbox called with ResumeSandboxRequest:', resumeSandboxRequest);
+        this.logger.debug(`ResumeSandbox called with ResumeSandboxRequest: ${resumeSandboxRequest}`);
         let sandboxCreationProgress;
         // seed the sandboxCreationProgress via the resumeSandboxRequest options
         if (resumeSandboxRequest.SandboxName) {
@@ -154,7 +166,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
                 (_a = resumeSandboxRequest.SandboxName) !== null && _a !== void 0 ? _a : resumeSandboxRequest.SandboxProcessObjId,
             ]);
         }
-        this.logger.debug('Return from calling singleRecordQuery with tooling:', sandboxCreationProgress);
+        this.logger.debug(`Return from calling singleRecordQuery with tooling: ${sandboxCreationProgress}`);
         await lifecycleEvents_1.Lifecycle.getInstance().emit(SandboxEvents.EVENT_RESUME, sandboxCreationProgress);
         const [wait, pollInterval] = this.validateWaitOptions(options);
         // if wait is 0, return the sandboxCreationProgress immediately
@@ -165,7 +177,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
                 if (sandboxInfo) {
                     await lifecycleEvents_1.Lifecycle.getInstance().emit(SandboxEvents.EVENT_AUTH, sandboxInfo);
                     try {
-                        this.logger.debug('sandbox signup complete with', sandboxInfo);
+                        this.logger.debug(`sandbox signup complete with ${sandboxInfo}`);
                         await this.writeSandboxAuthFile(sandboxCreationProgress, sandboxInfo);
                         return sandboxCreationProgress;
                     }
@@ -177,7 +189,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
             await lifecycleEvents_1.Lifecycle.getInstance().emit(SandboxEvents.EVENT_ASYNC_RESULT, sandboxCreationProgress);
             throw messages.createError('sandboxCreateNotComplete');
         }
-        this.logger.debug(`resume - pollStatusAndAuth sandboxProcessObj, max wait time of ${wait.minutes} minutes`, sandboxCreationProgress);
+        this.logger.debug(`resume - pollStatusAndAuth sandboxProcessObj ${sandboxCreationProgress}, max wait time of ${wait.minutes} minutes`);
         return this.pollStatusAndAuth({
             sandboxProcessObj: sandboxCreationProgress,
             wait,
@@ -406,6 +418,41 @@ class Org extends kit_1.AsyncOptionalCreatable {
             return false;
         }
     }
+    /**
+     * Returns `true` if the org uses source tracking.
+     * Side effect: updates files where the property doesn't currently exist
+     */
+    async tracksSource() {
+        // use the property if it exists
+        const tracksSource = this.getField(Org.Fields.TRACKS_SOURCE);
+        if ((0, ts_types_1.isBoolean)(tracksSource)) {
+            return tracksSource;
+        }
+        // scratch orgs with no property use tracking by default
+        if (await this.determineIfScratch()) {
+            // save true for next time to avoid checking again
+            await this.setTracksSource(true);
+            return true;
+        }
+        if (await this.determineIfSandbox()) {
+            // does the sandbox know about the SourceMember object?
+            const supportsSourceMembers = await this.supportsSourceTracking();
+            await this.setTracksSource(supportsSourceMembers);
+            return supportsSourceMembers;
+        }
+        // any other non-sandbox, non-scratch orgs won't use tracking
+        await this.setTracksSource(false);
+        return false;
+    }
+    /**
+     * Set the tracking property on the org's auth file
+     *
+     * @param value true or false (whether the org should use source tracking or not)
+     */
+    async setTracksSource(value) {
+        const originalAuth = await authInfo_1.AuthInfo.create({ username: this.getUsername() });
+        originalAuth.handleAliasAndDefaultSettings({ setDefault: false, setDefaultDevHub: false, setTracksSource: value });
+    }
     /**
      * Returns `true` if the org is a scratch org.
      *
@@ -644,9 +691,8 @@ class Org extends kit_1.AsyncOptionalCreatable {
         if (this.isScratch()) {
             return true;
         }
-        const conn = this.getConnection();
         try {
-            await conn.tooling.sobject('SourceMember').describe();
+            await this.getConnection().tooling.sobject('SourceMember').describe();
             return true;
         }
         catch (err) {
@@ -673,10 +719,6 @@ class Org extends kit_1.AsyncOptionalCreatable {
      */
     async querySandboxProcessBySandboxInfoId(id) {
         return await this.querySandboxProcess(`SandboxInfoId='${id}'`);
-        const queryStr = `SELECT Id, Status, SandboxName, SandboxInfoId, LicenseType, CreatedDate, CopyProgress, SandboxOrganization, SourceId, Description, EndDate FROM SandboxProcess WHERE SandboxInfoId='${id}' AND Status != 'D'`;
-        return await this.connection.singleRecordQuery(queryStr, {
-            tooling: true,
-        });
     }
     /**
      * query SandboxProcess via Id
@@ -1199,6 +1241,11 @@ exports.Org = Org;
          * The snapshot used to create the scratch org.
          */
         Fields["SNAPSHOT"] = "snapshot";
+        /**
+         * true: the org supports and wants source tracking
+         * false: the org opted out of tracking or can't support it
+         */
+        Fields["TRACKS_SOURCE"] = "tracksSource";
         // Should it be on org? Leave it off for now, as it might
         // be confusing to the consumer what this actually is.
         // USERNAMES = 'usernames',

package/lib/org/scratchOrgCache.d.ts

@@ -11,6 +11,7 @@ export declare type CachedOptions = {
     apiVersion?: string;
     alias?: string;
     setDefault?: boolean;
+    tracksSource?: boolean;
 };
 export declare class ScratchOrgCache extends TTLConfig<TTLConfig.Options, CachedOptions> {
     static getFileName(): string;

package/lib/org/scratchOrgCreate.d.ts

@@ -47,6 +47,8 @@ export interface ScratchOrgCreateOptions {
     alias?: string;
     /** after complete, set the org as the default */
     setDefault?: boolean;
+    /** do not use source tracking for this org */
+    tracksSource?: boolean;
 }
 export declare const scratchOrgResume: (jobId: string) => Promise<ScratchOrgCreateResult>;
 export declare const scratchOrgCreate: (options: ScratchOrgCreateOptions) => Promise<ScratchOrgCreateResult>;

package/lib/org/scratchOrgCreate.js

@@ -67,7 +67,7 @@ const scratchOrgResume = async (jobId) => {
     if (!cache.has(jobId)) {
         throw messages.createError('CacheMissError', [jobId]);
     }
-    const { hubUsername, apiVersion, clientSecret, signupTargetLoginUrlConfig, definitionjson, alias, setDefault } = cache.get(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 });
@@ -99,6 +99,7 @@ const scratchOrgResume = async (jobId) => {
         alias,
         setDefault: setDefault !== null && setDefault !== void 0 ? setDefault : false,
         setDefaultDevHub: false,
+        setTracksSource: tracksSource !== null && tracksSource !== void 0 ? tracksSource : true,
     });
     cache.unset((_c = soi.Id) !== null && _c !== void 0 ? _c : jobId);
     const authFields = authInfo.getFields();
@@ -117,7 +118,7 @@ const scratchOrgCreate = async (options) => {
     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, alias, setDefault = false, } = 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, tracksSource = true, } = options;
     validateDuration(durationDays);
     validateRetry(retry);
     const { scratchOrgInfoPayload, ignoreAncestorIds, warnings } = await (0, scratchOrgInfoGenerator_1.getScratchOrgInfoPayload)({
@@ -153,6 +154,7 @@ const scratchOrgCreate = async (options) => {
         clientSecret,
         alias,
         setDefault,
+        tracksSource,
     });
     await cache.write();
     logger.debug(`scratch org has recordId ${scratchOrgInfoId}`);
@@ -185,9 +187,12 @@ const scratchOrgCreate = async (options) => {
         (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,
+        ...{
+            alias,
+            setDefault,
+            setDefaultDevHub: false,
+            setTracksSource: tracksSource === false ? false : true,
+        },
     });
     cache.unset(scratchOrgInfoId);
     const authFields = authInfo.getFields();

package/lib/testSetup.d.ts

@@ -389,6 +389,7 @@ export declare class MockTestOrgData {
     authcode: string;
     accessToken: string;
     refreshToken: string;
+    tracksSource: boolean | undefined;
     userId: string;
     redirectUri: string;
     isDevHub?: boolean;

package/lib/testSetup.js

@@ -543,6 +543,7 @@ class MockTestOrgData {
         config.createdOrgInstance = 'CS1';
         config.created = '1519163543003';
         config.userId = this.userId;
+        config.tracksSource = this.tracksSource;
         if (this.devHubUsername) {
             config.devHubUsername = this.devHubUsername;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.18.1",
+  "version": "3.19.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -35,7 +35,7 @@
   ],
   "dependencies": {
     "@salesforce/bunyan": "^2.0.0",
-    "@salesforce/kit": "^1.5.34",
+    "@salesforce/kit": "^1.5.41",
     "@salesforce/schemas": "^1.1.0",
     "@salesforce/ts-types": "^1.5.20",
     "@types/graceful-fs": "^4.1.5",
@@ -49,7 +49,7 @@
     "form-data": "^4.0.0",
     "graceful-fs": "^4.2.9",
     "js2xmlparser": "^4.0.1",
-    "jsforce": "2.0.0-beta.9",
+    "jsforce": "2.0.0-beta.10",
     "jsonwebtoken": "8.5.1",
     "mkdirp": "1.0.4",
     "ts-retry-promise": "^0.6.0"