@salesforce/core 3.16.0 → 3.17.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.17.0](https://github.com/forcedotcom/sfdx-core/compare/v3.16.2...v3.17.0) (2022-05-12)
+
+### Features
+
+- sandboxStatus for v3 ([#571](https://github.com/forcedotcom/sfdx-core/issues/571)) ([60a004b](https://github.com/forcedotcom/sfdx-core/commit/60a004b663d918ec8b37d6ded7ddf12ce112b7f8))
+
+### [3.16.2](https://github.com/forcedotcom/sfdx-core/compare/v3.16.1...v3.16.2) (2022-05-11)
+
+### [3.16.1](https://github.com/forcedotcom/sfdx-core/compare/v3.16.0...v3.16.1) (2022-05-11)
+
+### Bug Fixes
+
+- homedir can change after Core loads ([bb1e4f5](https://github.com/forcedotcom/sfdx-core/commit/bb1e4f5b1f59269f6d48a5389b1d76eeee252db0))
+
 ## [3.16.0](https://github.com/forcedotcom/sfdx-core/compare/v3.15.5...v3.16.0) (2022-05-04)
 
 ### Features

package/lib/crypto/keyChainImpl.js

@@ -317,7 +317,7 @@ const _darwinImpl = {
         }
     },
 };
-const secretFile = path.join((0, os_1.homedir)(), global_1.Global.SFDX_STATE_FOLDER, 'key.json');
+const getSecretFile = () => path.join(global_1.Global.SFDX_DIR, 'key.json');
 var SecretField;
 (function (SecretField) {
     SecretField["SERVICE"] = "service";
@@ -331,6 +331,7 @@ async function _writeFile(opts, fn) {
             [SecretField.KEY]: opts.password,
             [SecretField.SERVICE]: opts.service,
         };
+        const secretFile = getSecretFile();
         await mkdirp(path.dirname(secretFile));
         await fs.promises.writeFile(secretFile, JSON.stringify(contents, null, 4), { mode: '600' });
         fn(null, contents);
@@ -341,7 +342,7 @@ async function _writeFile(opts, fn) {
 }
 async function _readFile() {
     // The file and access is validated before this method is called
-    const fileContents = (0, kit_1.parseJsonMap)(await fs.promises.readFile(secretFile, 'utf8'));
+    const fileContents = (0, kit_1.parseJsonMap)(await fs.promises.readFile(getSecretFile(), 'utf8'));
     return {
         account: (0, ts_types_1.ensureString)(fileContents[SecretField.ACCOUNT]),
         password: (0, ts_types_1.asString)(fileContents[SecretField.KEY]),
@@ -368,7 +369,7 @@ class GenericKeychainAccess {
                     else {
                         // if the service and account names don't match then maybe someone or something is editing
                         // that file. #donotallow
-                        fn(messages.createError('genericKeychainServiceError', [secretFile]));
+                        fn(messages.createError('genericKeychainServiceError', [getSecretFile()]));
                     }
                 }
                 catch (readJsonErr) {
@@ -428,6 +429,7 @@ class GenericUnixKeychainAccess extends GenericKeychainAccess {
                 await cb(err);
             }
             else {
+                const secretFile = getSecretFile();
                 const stats = await fs.promises.stat(secretFile);
                 const octalModeStr = (stats.mode & 0o777).toString(8);
                 const EXPECTED_OCTAL_PERM_VALUE = '600';
@@ -453,7 +455,7 @@ class GenericWindowsKeychainAccess extends GenericKeychainAccess {
             }
             else {
                 try {
-                    await fs.promises.access(secretFile, fs.constants.R_OK | fs.constants.W_OK);
+                    await fs.promises.access(getSecretFile(), fs.constants.R_OK | fs.constants.W_OK);
                     await cb(null);
                 }
                 catch (e) {

package/lib/global.d.ts

@@ -33,13 +33,13 @@ export declare class Global {
      *
      * **See** {@link Global.SFDX_STATE_FOLDER}
      */
-    static readonly SFDX_DIR: string;
+    static get SFDX_DIR(): string;
     /**
      * The full system path to the global sf state folder.
      *
      * **See** {@link Global.SF_STATE_FOLDER}
      */
-    static readonly SF_DIR: string;
+    static get SF_DIR(): string;
     /**
      * The full system path to the global log file.
      */

package/lib/global.js

@@ -28,6 +28,22 @@ var Mode;
  * Global constants, methods, and configuration.
  */
 class Global {
+    /**
+     * The full system path to the global sfdx state folder.
+     *
+     * **See** {@link Global.SFDX_STATE_FOLDER}
+     */
+    static get SFDX_DIR() {
+        return path.join(os.homedir(), Global.SFDX_STATE_FOLDER);
+    }
+    /**
+     * The full system path to the global sf state folder.
+     *
+     * **See** {@link Global.SF_STATE_FOLDER}
+     */
+    static get SF_DIR() {
+        return path.join(os.homedir(), Global.SF_STATE_FOLDER);
+    }
     /**
      * Gets the current mode environment variable as a {@link Mode} instance.
      *
@@ -64,18 +80,6 @@ Global.SFDX_STATE_FOLDER = '.sfdx';
  * The global folder in which sf state is stored.
  */
 Global.SF_STATE_FOLDER = '.sf';
-/**
- * The full system path to the global sfdx state folder.
- *
- * **See** {@link Global.SFDX_STATE_FOLDER}
- */
-Global.SFDX_DIR = path.join(os.homedir(), Global.SFDX_STATE_FOLDER);
-/**
- * The full system path to the global sf state folder.
- *
- * **See** {@link Global.SF_STATE_FOLDER}
- */
-Global.SF_DIR = path.join(os.homedir(), Global.SF_STATE_FOLDER);
 /**
  * The full system path to the global log file.
  */

package/lib/org/connection.d.ts

@@ -20,15 +20,6 @@ export declare type DeployOptionsWithRest = Partial<DeployOptions> & {
 };
 export interface Tooling<S extends Schema = Schema> extends JSForceTooling<S> {
     _logger: any;
-    /**
-     * Executes a query and auto-fetches (i.e., "queryMore") all results.  This is especially
-     * useful with large query result sizes, such as over 2000 records.  The default maximum
-     * fetch size is 10,000 records.  Modify this via the options argument.
-     *
-     * @param soql The SOQL string.
-     * @param options The query options.  NOTE: the autoFetch option will always be true.
-     */
-    autoFetchQuery<T extends Schema = S>(soql: string, options?: QueryOptions): Promise<QueryResult<T>>;
 }
 /**
  * Handles connections and requests to Salesforce Orgs.

package/lib/org/connection.js

@@ -58,8 +58,6 @@ class Connection extends jsforce_1.Connection {
      */
     constructor(options) {
         super(options.connectionOptions || {});
-        // eslint-disable-next-line @typescript-eslint/unbound-method
-        this.tooling.autoFetchQuery = Connection.prototype.autoFetchQuery;
         this.options = options;
         this.username = options.authInfo.getUsername();
     }

package/lib/org/org.d.ts

@@ -140,6 +140,17 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * @returns {ScratchOrgCreateResult}
      */
     scratchOrgCreate(options: ScratchOrgRequest): Promise<ScratchOrgCreateResult>;
+    /**
+     * Reports sandbox org creation status. If the org is ready, authenticates to the org.
+     *
+     * @param {sandboxname} string the sandbox name
+     * @param options Wait: The amount of time to wait before timing out, Interval: The time interval between polling
+     * @returns {SandboxProcessObject} the sandbox process object
+     */
+    sandboxStatus(sandboxname: string, options: {
+        wait?: Duration;
+        interval?: Duration;
+    }): Promise<SandboxProcessObject>;
     /**
      * Clean all data files in the org's data path. Usually <workspace>/.sfdx/orgs/<username>.
      *
@@ -348,6 +359,29 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
      * **Throws** *{@link SfError}{ name: 'NotSupportedError' }* Throws an unsupported error.
      */
     protected getDefaultOptions(): Org.Options;
+    /**
+     * Gets the sandboxProcessObject and then polls for it to complete.
+     *
+     * @param sandboxProcessName sanbox process name
+     * @param options { wait?: Duration; interval?: Duration }
+     * @returns {SandboxProcessObject} The SandboxProcessObject for the sandbox
+     */
+    private authWithRetriesByName;
+    /**
+     * Polls the sandbox org for the sandboxProcessObject.
+     *
+     * @param sandboxProcessObj: The in-progress sandbox signup request
+     * @param options { wait?: Duration; interval?: Duration }
+     * @returns {SandboxProcessObject}
+     */
+    private authWithRetries;
+    /**
+     * Query the sandbox for the SandboxProcessObject by sandbox name
+     *
+     * @param sandboxName The name of the sandbox to query
+     * @returns {SandboxProcessObject} The SandboxProcessObject for the sandbox
+     */
+    private queryLatestSandboxProcessBySandboxName;
     private queryProduction;
     private destroySandbox;
     private destroyScratchOrg;

package/lib/org/org.js

@@ -41,6 +41,8 @@ const messages = messages_1.Messages.load('@salesforce/core', 'org', [
     'scratchOrgNotFound',
     'AuthInfoOrgIdUndefined',
     'sandboxCreateNotComplete',
+    'SandboxProcessNotFoundBySandboxName',
+    'MultiSandboxProcessNotFoundBySandboxName',
 ]);
 var OrgTypes;
 (function (OrgTypes) {
@@ -192,6 +194,16 @@ class Org extends kit_1.AsyncOptionalCreatable {
     async scratchOrgCreate(options) {
         return (0, scratchOrgCreate_1.scratchOrgCreate)({ ...options, hubOrg: this });
     }
+    /**
+     * Reports sandbox org creation status. If the org is ready, authenticates to the org.
+     *
+     * @param {sandboxname} string the sandbox name
+     * @param options Wait: The amount of time to wait before timing out, Interval: The time interval between polling
+     * @returns {SandboxProcessObject} the sandbox process object
+     */
+    async sandboxStatus(sandboxname, options) {
+        return this.authWithRetriesByName(sandboxname, options);
+    }
     /**
      * Clean all data files in the org's data path. Usually <workspace>/.sfdx/orgs/<username>.
      *
@@ -710,6 +722,58 @@ class Org extends kit_1.AsyncOptionalCreatable {
     getDefaultOptions() {
         throw new sfError_1.SfError('Not Supported', 'NotSupportedError');
     }
+    /**
+     * Gets the sandboxProcessObject and then polls for it to complete.
+     *
+     * @param sandboxProcessName sanbox process name
+     * @param options { wait?: Duration; interval?: Duration }
+     * @returns {SandboxProcessObject} The SandboxProcessObject for the sandbox
+     */
+    async authWithRetriesByName(sandboxProcessName, options) {
+        return this.authWithRetries(await this.queryLatestSandboxProcessBySandboxName(sandboxProcessName), options);
+    }
+    /**
+     * Polls the sandbox org for the sandboxProcessObject.
+     *
+     * @param sandboxProcessObj: The in-progress sandbox signup request
+     * @param options { wait?: Duration; interval?: Duration }
+     * @returns {SandboxProcessObject}
+     */
+    async authWithRetries(sandboxProcessObj, options = {
+        wait: kit_1.Duration.minutes(0),
+        interval: kit_1.Duration.seconds(30),
+    }) {
+        const [wait, pollInterval] = this.validateWaitOptions(options);
+        this.logger.debug(`AuthWithRetries sandboxProcessObj ${sandboxProcessObj}, max wait time of ${wait.minutes} minutes`);
+        return this.pollStatusAndAuth({
+            sandboxProcessObj,
+            wait,
+            pollInterval,
+        });
+    }
+    /**
+     * Query the sandbox for the SandboxProcessObject by sandbox name
+     *
+     * @param sandboxName The name of the sandbox to query
+     * @returns {SandboxProcessObject} The SandboxProcessObject for the sandbox
+     */
+    async queryLatestSandboxProcessBySandboxName(sandboxNameIn) {
+        var _a;
+        const { tooling } = this.getConnection();
+        this.logger.debug('QueryLatestSandboxProcessBySandboxName called with SandboxName: %s ', sandboxNameIn);
+        const queryStr = `SELECT Id, Status, SandboxName, SandboxInfoId, LicenseType, CreatedDate, CopyProgress, SandboxOrganization, SourceId, Description, EndDate FROM SandboxProcess WHERE SandboxName='${sandboxNameIn}' AND Status != 'D' ORDER BY CreatedDate DESC LIMIT 1`;
+        const queryResult = await tooling.query(queryStr);
+        this.logger.debug('Return from calling queryToolingApi: %s ', queryResult);
+        if (((_a = queryResult === null || queryResult === void 0 ? void 0 : queryResult.records) === null || _a === void 0 ? void 0 : _a.length) === 1) {
+            return queryResult.records[0];
+        }
+        else if (queryResult.records && queryResult.records.length > 1) {
+            throw messages.createError('MultiSandboxProcessNotFoundBySandboxName', [sandboxNameIn]);
+        }
+        else {
+            throw messages.createError('SandboxProcessNotFoundBySandboxName', [sandboxNameIn]);
+        }
+    }
     async queryProduction(org, field, value) {
         return org.connection.singleRecordQuery(`SELECT SandboxInfoId FROM SandboxProcess WHERE ${field} ='${value}' AND Status NOT IN ('D', 'E')`, { tooling: true });
     }

package/messages/org.md

@@ -53,3 +53,11 @@ AuthInfo orgId is undefined.
 # sandboxCreateNotComplete
 
 The sandbox creation has not completed.
+
+# SandboxProcessNotFoundBySandboxName
+
+We can't find a SandboxProcess with the SandboxName %s.
+
+# MultiSandboxProcessNotFoundBySandboxName
+
+We found more than one SandboxProcess with the SandboxName %s.

package/package.json

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