@salesforce/core 3.24.1 → 3.24.4

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.24.4](https://github.com/forcedotcom/sfdx-core/compare/v3.24.3...v3.24.4) (2022-07-28)
+
+### [3.24.3](https://github.com/forcedotcom/sfdx-core/compare/v3.24.2...v3.24.3) (2022-07-28)
+
+### Bug Fixes
+
+- handle ancestor keywords when creating scratch org ([72af55a](https://github.com/forcedotcom/sfdx-core/commit/72af55a53b87f1d81d22dc4e53891b3b0ab2966f))
+
+### [3.24.2](https://github.com/forcedotcom/sfdx-core/compare/v3.24.1...v3.24.2) (2022-07-26)
+
+### Bug Fixes
+
+- use correct field for clone requests ([#623](https://github.com/forcedotcom/sfdx-core/issues/623)) ([2372f03](https://github.com/forcedotcom/sfdx-core/commit/2372f0364b87a7ac498c8d7ef637a9b5fdc725ea))
+
 ### [3.24.1](https://github.com/forcedotcom/sfdx-core/compare/v3.24.0...v3.24.1) (2022-07-21)
 
 ### Bug Fixes

package/lib/config/config.js

@@ -11,7 +11,6 @@ const path_1 = require("path");
 const fs = require("fs");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
-const mkdirp = require("mkdirp");
 const global_1 = require("../global");
 const logger_1 = require("../logger");
 const messages_1 = require("../messages");
@@ -510,7 +509,7 @@ class SfdxConfig {
         try {
             const translated = this.translate(config, 'toOld');
             const sfdxPath = this.getSfdxPath();
-            await mkdirp((0, path_1.dirname)(sfdxPath));
+            await fs.promises.mkdir((0, path_1.dirname)(sfdxPath), { recursive: true });
             await fs.promises.writeFile(sfdxPath, JSON.stringify(translated, null, 2));
         }
         catch (error) {

package/lib/config/configFile.js

@@ -13,7 +13,6 @@ const os_1 = require("os");
 const path_1 = require("path");
 const ts_types_1 = require("@salesforce/ts-types");
 const kit_1 = require("@salesforce/kit");
-const mkdirp = require("mkdirp");
 const global_1 = require("../global");
 const logger_1 = require("../logger");
 const sfError_1 = require("../sfError");
@@ -213,7 +212,12 @@ class ConfigFile extends configStore_1.BaseConfigStore {
         if (newContents) {
             this.setContents(newContents);
         }
-        await mkdirp((0, path_1.dirname)(this.getPath()));
+        try {
+            await fs.promises.mkdir((0, path_1.dirname)(this.getPath()), { recursive: true });
+        }
+        catch (err) {
+            throw sfError_1.SfError.wrap(err);
+        }
         this.logger.info(`Writing to config file: ${this.getPath()}`);
         await fs.promises.writeFile(this.getPath(), JSON.stringify(this.toObject(), null, 2));
         return this.getContents();
@@ -228,7 +232,12 @@ class ConfigFile extends configStore_1.BaseConfigStore {
         if ((0, ts_types_1.isPlainObject)(newContents)) {
             this.setContents(newContents);
         }
-        mkdirp.sync((0, path_1.dirname)(this.getPath()));
+        try {
+            fs.mkdirSync((0, path_1.dirname)(this.getPath()), { recursive: true });
+        }
+        catch (err) {
+            throw sfError_1.SfError.wrap(err);
+        }
         this.logger.info(`Writing to config file: ${this.getPath()}`);
         fs.writeFileSync(this.getPath(), JSON.stringify(this.toObject(), null, 2));
         return this.getContents();

package/lib/crypto/keyChainImpl.js

@@ -15,7 +15,6 @@ const os_1 = require("os");
 const path = require("path");
 const ts_types_1 = require("@salesforce/ts-types");
 const kit_1 = require("@salesforce/kit");
-const mkdirp = require("mkdirp");
 const global_1 = require("../global");
 const messages_1 = require("../messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
@@ -332,7 +331,7 @@ async function _writeFile(opts, fn) {
             [SecretField.SERVICE]: opts.service,
         };
         const secretFile = getSecretFile();
-        await mkdirp(path.dirname(secretFile));
+        await fs.promises.mkdir(path.dirname(secretFile), { recursive: true });
         await fs.promises.writeFile(secretFile, JSON.stringify(contents, null, 4), { mode: '600' });
         fn(null, contents);
     }

package/lib/global.js

@@ -7,10 +7,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Global = exports.Mode = void 0;
+const fs = require("fs");
 const os = require("os");
 const path = require("path");
 const kit_1 = require("@salesforce/kit");
-const mkdirp = require("mkdirp");
+const sfError_1 = require("./sfError");
 /**
  * Represents an environment mode.  Supports `production`, `development`, `demo`, and `test`
  * with the default mode being `production`.
@@ -68,7 +69,17 @@ class Global {
      */
     static async createDir(dirPath) {
         dirPath = dirPath ? path.join(Global.SFDX_DIR, dirPath) : Global.SFDX_DIR;
-        await mkdirp(dirPath, '700');
+        try {
+            if (process.platform === 'win32') {
+                await fs.promises.mkdir(dirPath, { recursive: true });
+            }
+            else {
+                await fs.promises.mkdir(dirPath, { recursive: true, mode: 0o700 });
+            }
+        }
+        catch (error) {
+            throw new sfError_1.SfError(`Failed to create directory or set permissions for: ${dirPath}`);
+        }
     }
 }
 exports.Global = Global;

package/lib/logger.js

@@ -18,7 +18,6 @@ const Bunyan = require("@salesforce/bunyan");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const Debug = require("debug");
-const mkdirp = require("mkdirp");
 const global_1 = require("./global");
 const sfError_1 = require("./sfError");
 /**
@@ -245,12 +244,15 @@ class Logger {
         }
         catch (err1) {
             try {
-                await mkdirp(path.dirname(logFile), {
-                    mode: '700',
-                });
+                if (process.platform === 'win32') {
+                    await fs.promises.mkdir(path.dirname(logFile), { recursive: true });
+                }
+                else {
+                    await fs.promises.mkdir(path.dirname(logFile), { recursive: true, mode: 0o700 });
+                }
             }
             catch (err2) {
-                // noop; directory exists already
+                throw sfError_1.SfError.wrap(err2);
             }
             try {
                 await fs.promises.writeFile(logFile, '', { mode: '600' });
@@ -285,9 +287,12 @@ class Logger {
         }
         catch (err1) {
             try {
-                mkdirp.sync(path.dirname(logFile), {
-                    mode: '700',
-                });
+                if (process.platform === 'win32') {
+                    fs.mkdirSync(path.dirname(logFile));
+                }
+                else {
+                    fs.mkdirSync(path.dirname(logFile), { mode: 0x700 });
+                }
             }
             catch (err2) {
                 // noop; directory exists already

package/lib/org/org.d.ts

@@ -61,6 +61,7 @@ export declare type SandboxProcessObject = {
 export declare type SandboxRequest = {
     SandboxName: string;
     LicenseType?: string;
+    /** Should match a SandboxInfoId, not a SandboxProcessId */
     SourceId?: string;
     Description?: string;
 };
@@ -129,11 +130,11 @@ export declare class Org extends AsyncOptionalCreatable<Org.Options> {
     /**
      *
      * @param sandboxReq SandboxRequest options to create the sandbox with
-     * @param sandboxName
+     * @param sourceSandboxName the name of the sandbox that your new sandbox will be based on
      * @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: {
+    cloneSandbox(sandboxReq: SandboxRequest, sourceSandboxName: string, options: {
         wait?: Duration;
         interval?: Duration;
     }): Promise<SandboxProcessObject>;

package/lib/org/org.js

@@ -129,12 +129,12 @@ class Org extends kit_1.AsyncOptionalCreatable {
     /**
      *
      * @param sandboxReq SandboxRequest options to create the sandbox with
-     * @param sandboxName
+     * @param sourceSandboxName the name of the sandbox that your new sandbox will be based on
      * @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;
+    async cloneSandbox(sandboxReq, sourceSandboxName, options) {
+        sandboxReq.SourceId = (await this.querySandboxProcessBySandboxName(sourceSandboxName)).SandboxInfoId;
         this.logger.debug('Clone sandbox sourceId %s', sandboxReq.SourceId);
         return this.createSandbox(sandboxReq, options);
     }
@@ -242,7 +242,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * @ignore
      */
     async retrieveOrgUsersConfig() {
-        return await orgUsersConfig_1.OrgUsersConfig.create(orgUsersConfig_1.OrgUsersConfig.getOptions(this.getOrgId()));
+        return orgUsersConfig_1.OrgUsersConfig.create(orgUsersConfig_1.OrgUsersConfig.getOptions(this.getOrgId()));
     }
     /**
      * Cleans up all org related artifacts including users, sandbox config(if a sandbox and auth file.
@@ -269,7 +269,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      *
      */
     async isSandbox() {
-        return await (await stateAggregator_1.StateAggregator.getInstance()).sandboxes.hasFile(this.getOrgId());
+        return (await stateAggregator_1.StateAggregator.getInstance()).sandboxes.hasFile(this.getOrgId());
     }
     /**
      * Check that this org is a scratch org by asking the dev hub if it knows about it.
@@ -636,7 +636,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * results in a warning.
      */
     async retrieveMaxApiVersion() {
-        return await this.getConnection().retrieveMaxApiVersion();
+        return this.getConnection().retrieveMaxApiVersion();
     }
     /**
      * Returns the admin username used to create the org.
@@ -707,7 +707,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * @private
      */
     async querySandboxProcessBySandboxName(name) {
-        return await this.querySandboxProcess(`SandboxName='${name}'`);
+        return this.querySandboxProcess(`SandboxName='${name}'`);
     }
     /**
      * query SandboxProcess via SandboxInfoId
@@ -716,7 +716,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * @private
      */
     async querySandboxProcessBySandboxInfoId(id) {
-        return await this.querySandboxProcess(`SandboxInfoId='${id}'`);
+        return this.querySandboxProcess(`SandboxInfoId='${id}'`);
     }
     /**
      * query SandboxProcess via Id
@@ -725,7 +725,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * @private
      */
     async querySandboxProcessById(id) {
-        return await this.querySandboxProcess(`Id='${id}'`);
+        return this.querySandboxProcess(`Id='${id}'`);
     }
     /**
      * Initialize async components.
@@ -1098,7 +1098,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      */
     async querySandboxProcess(where) {
         const queryStr = `SELECT Id, Status, SandboxName, SandboxInfoId, LicenseType, CreatedDate, CopyProgress, SandboxOrganization, SourceId, Description, EndDate FROM SandboxProcess WHERE ${where} AND Status != 'D'`;
-        return await this.connection.singleRecordQuery(queryStr, {
+        return this.connection.singleRecordQuery(queryStr, {
             tooling: true,
         });
     }

package/lib/org/scratchOrgInfoGenerator.js

@@ -67,13 +67,34 @@ const getAncestorIds = async (scratchOrgInfo, projectJson, hubOrg) => {
     const ancestorIds = await Promise.all(packagesWithAncestors.map(async (packageDir) => {
         // ancestorID can be 05i, or 04t, alias; OR "ancestorVersion": "4.6.0.1"
         // according to docs, 05i is not ok: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev2gp_config_file.htm
+        // package can be an ID, but not according to docs
+        const packageAliases = projectJson.get('packageAliases');
+        const packageId = packageAliases[(0, ts_types_1.ensureString)(packageDir.package)] ?? packageDir.package;
+        // Handle HIGHEST and NONE in ancestor(Version|Id).
+        // Precedence chain: NONE -> HIGHEST -> ancestorVersion & ancestoryId
+        if (packageDir.ancestorVersion === 'NONE' || packageDir.ancestorId === 'NONE') {
+            return '';
+        }
+        else if (packageDir.ancestorVersion === 'HIGHEST' || packageDir.ancestorId === 'HIGHEST') {
+            const query = 'SELECT Id FROM Package2Version ' +
+                `WHERE Package2Id = '${packageId}' AND IsReleased = True AND IsDeprecated = False AND PatchVersion = 0 ` +
+                'ORDER BY MajorVersion Desc, MinorVersion Desc, PatchVersion Desc, BuildNumber Desc LIMIT 1';
+            try {
+                return (await hubOrg.getConnection().singleRecordQuery(query, { tooling: true })).Id;
+            }
+            catch (err) {
+                if (packageDir.ancestorVersion === 'HIGHEST') {
+                    throw new sfError_1.SfError(messages.getMessage('NoMatchingAncestorError', [packageDir.ancestorVersion, packageDir.package]), 'NoMatchingAncestorError', [messages.getMessage('AncestorNotReleasedError', [packageDir.ancestorVersion])]);
+                }
+                else {
+                    throw new sfError_1.SfError(messages.getMessage('NoMatchingAncestorIdError', [packageDir.ancestorId, packageDir.package]), 'NoMatchingAncestorIdError', [messages.getMessage('AncestorNotReleasedError', [packageDir.ancestorId])]);
+                }
+            }
+        }
         if (packageDir.ancestorVersion) {
             if (!/^[0-9]+.[0-9]+.[0-9]+(.[0-9]+)?$/.test(packageDir.ancestorVersion)) {
                 throw messages.createError('InvalidAncestorVersionFormatError', [packageDir.ancestorVersion]);
             }
-            // package can be an ID, but not according to docs
-            const packageAliases = projectJson.get('packageAliases');
-            const packageId = packageAliases[(0, ts_types_1.ensureString)(packageDir.package)] ?? packageDir.package;
             const [major, minor, patch] = packageDir.ancestorVersion.split('.');
             let releasedAncestor;
             try {
@@ -102,14 +123,14 @@ const getAncestorIds = async (scratchOrgInfo, projectJson, hubOrg) => {
                 .getConnection()
                 .singleRecordQuery(`SELECT Id FROM Package2Version WHERE SubscriberPackageVersionId = '${packageDir.ancestorId}'`, { tooling: true })).Id;
         }
-        // ancestorID can be an alias get it from projectJson
-        const packageAliases = projectJson.get('packageAliases');
+        // ancestorID can be an alias; get it from projectJson
         if (packageDir.ancestorId && packageAliases?.[packageDir.ancestorId]) {
             return packageAliases[packageDir.ancestorId];
         }
         throw new sfError_1.SfError(`Invalid ancestorId ${packageDir.ancestorId}`, 'InvalidAncestorId');
     }));
-    return Array.from(new Set(ancestorIds)).join(';');
+    // strip out '' due to NONE
+    return Array.from(new Set(ancestorIds.filter((id) => id !== ''))).join(';');
 };
 exports.getAncestorIds = getAncestorIds;
 /**

package/messages/scratchOrgInfoGenerator.md

@@ -8,7 +8,11 @@ The ancestor versionNumber must be in the format major.minor.patch but the value
 
 # NoMatchingAncestorError
 
-The ancestorId for ancestorVersion %s can't be found. Package ID %s.",
+The ancestor for ancestorVersion %s can't be found. Package ID %s.",
+
+# NoMatchingAncestorIdError
+
+The ancestor for ancestorId [%s] can't be found. Package ID %s."
 
 # AncestorNotReleasedError
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.24.1",
+  "version": "3.24.4",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -39,7 +39,6 @@
     "@salesforce/schemas": "^1.1.0",
     "@salesforce/ts-types": "^1.5.20",
     "@types/graceful-fs": "^4.1.5",
-    "@types/mkdirp": "^1.0.2",
     "@types/semver": "^7.3.9",
     "ajv": "^8.11.0",
     "archiver": "^5.3.0",
@@ -51,7 +50,6 @@
     "js2xmlparser": "^4.0.1",
     "jsforce": "^2.0.0-beta.16",
     "jsonwebtoken": "8.5.1",
-    "mkdirp": "1.0.4",
     "ts-retry-promise": "^0.6.0"
   },
   "devDependencies": {