@salesforce/core 3.19.4 → 3.20.0

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 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.20.0](https://github.com/forcedotcom/sfdx-core/compare/v3.19.6-dev.0...v3.20.0) (2022-06-08)
+
+### Features
+
+- cache crypto keys by homedir ([dcd493e](https://github.com/forcedotcom/sfdx-core/commit/dcd493e7745bb2717da3a4ed9aff528a51391be6))
+
+### [3.19.6-dev.0](https://github.com/forcedotcom/sfdx-core/compare/v3.19.5...v3.19.6-dev.0) (2022-06-07)
+
+### Features
+
+- stateAggregator by homedir ([6219b41](https://github.com/forcedotcom/sfdx-core/commit/6219b41a4d7bac5759a62663e71e16f4722fdeac))
+
+### [3.19.5](https://github.com/forcedotcom/sfdx-core/compare/v3.19.4...v3.19.5) (2022-06-06)
+
+### Bug Fixes
+
+- update `NamedOrgNotFound` err name ([6a6a627](https://github.com/forcedotcom/sfdx-core/commit/6a6a62782046858c062ecb24a1d28631ea1f3bbe))
+
 ### [3.19.4](https://github.com/forcedotcom/sfdx-core/compare/v3.19.3...v3.19.4) (2022-06-06)
 
 ### Bug Fixes

package/lib/crypto/crypto.js

@@ -16,6 +16,7 @@ const kit_1 = require("@salesforce/kit");
 const logger_1 = require("../logger");
 const messages_1 = require("../messages");
 const cache_1 = require("../util/cache");
+const global_1 = require("../global");
 const keyChain_1 = require("./keyChain");
 const secureBuffer_1 = require("./secureBuffer");
 const TAG_DELIMITER = ':';
@@ -49,20 +50,21 @@ const keychainPromises = {
      * @param account The keychain account name.
      */
     getPassword(_keychain, service, account) {
-        const sb = cache_1.Cache.get(`${service}:${account}`);
+        const cacheKey = `${global_1.Global.DIR}:${service}:${account}`;
+        const sb = cache_1.Cache.get(cacheKey);
         if (!sb) {
             return new Promise((resolve, reject) => {
                 return _keychain.getPassword({ service, account }, (err, password) => {
                     if (err)
                         return reject(err);
-                    cache_1.Cache.set(`${service}:${account}`, makeSecureBuffer(password));
+                    cache_1.Cache.set(cacheKey, makeSecureBuffer(password));
                     return resolve({ username: account, password: (0, ts_types_1.ensure)(password) });
                 });
             });
         }
         else {
             const pw = sb.value((buffer) => buffer.toString('utf8'));
-            cache_1.Cache.set(`${service}:${account}`, makeSecureBuffer(pw));
+            cache_1.Cache.set(cacheKey, makeSecureBuffer(pw));
             return new Promise((resolve) => {
                 return resolve({ username: account, password: (0, ts_types_1.ensure)(pw) });
             });

package/lib/crypto/keyChainImpl.js

@@ -317,7 +317,6 @@ const _darwinImpl = {
         }
     },
 };
-const getSecretFile = () => path.join(global_1.Global.DIR, 'key.json');
 var SecretField;
 (function (SecretField) {
     SecretField["SERVICE"] = "service";
@@ -331,7 +330,7 @@ async function _writeFile(opts, fn) {
             [SecretField.KEY]: opts.password,
             [SecretField.SERVICE]: opts.service,
         };
-        const secretFile = getSecretFile();
+        const secretFile = path.join(global_1.Global.DIR, 'key.json');
         await mkdirp(path.dirname(secretFile));
         await fs.promises.writeFile(secretFile, JSON.stringify(contents, null, 4), { mode: '600' });
         fn(null, contents);
@@ -342,7 +341,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(getSecretFile(), 'utf8'));
+    const fileContents = (0, kit_1.parseJsonMap)(await fs.promises.readFile(path.join(global_1.Global.DIR, 'key.json'), 'utf8'));
     return {
         account: (0, ts_types_1.ensureString)(fileContents[SecretField.ACCOUNT]),
         password: (0, ts_types_1.asString)(fileContents[SecretField.KEY]),
@@ -369,7 +368,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', [getSecretFile()]));
+                        fn(messages.createError('genericKeychainServiceError', [path.join(global_1.Global.DIR, 'key.json')]));
                     }
                 }
                 catch (readJsonErr) {
@@ -429,7 +428,7 @@ class GenericUnixKeychainAccess extends GenericKeychainAccess {
                 await cb(err);
             }
             else {
-                const secretFile = getSecretFile();
+                const secretFile = path.join(global_1.Global.DIR, 'key.json');
                 const stats = await fs.promises.stat(secretFile);
                 const octalModeStr = (stats.mode & 0o777).toString(8);
                 const EXPECTED_OCTAL_PERM_VALUE = '600';
@@ -455,7 +454,7 @@ class GenericWindowsKeychainAccess extends GenericKeychainAccess {
             }
             else {
                 try {
-                    await fs.promises.access(getSecretFile(), fs.constants.R_OK | fs.constants.W_OK);
+                    await fs.promises.access(path.join(global_1.Global.DIR, 'key.json'), fs.constants.R_OK | fs.constants.W_OK);
                     await cb(null);
                 }
                 catch (e) {

package/lib/global.d.ts

@@ -29,7 +29,7 @@ export declare class Global {
      */
     static readonly SF_STATE_FOLDER = ".sf";
     /**
-     * The peferred global folder in which state is stored.
+     * The preferred global folder in which state is stored.
      */
     static readonly STATE_FOLDER = ".sfdx";
     /**
@@ -41,11 +41,11 @@ export declare class Global {
     /**
      * The full system path to the global sf state folder.
      *
-     * **See** {@link Global.SF_STATE_FOLDER}
+     * **See**  {@link Global.SF_STATE_FOLDER}
      */
     static get SF_DIR(): string;
     /**
-     * The full system path to the peferred global state folder
+     * The  full system path to the preferred global state folder
      */
     static get DIR(): string;
     /**
@@ -53,7 +53,7 @@ export declare class Global {
      */
     static readonly LOG_FILE_PATH: string;
     /**
-     * Gets the current mode environment variable as a {@link Mode} instance.
+     * Gets the curr ent mode environment variable as a {@link Mode} instance.
      *
      * ```
      * console.log(Global.getEnvironmentMode() === Mode.PRODUCTION);

package/lib/global.js

@@ -39,19 +39,19 @@ class Global {
     /**
      * The full system path to the global sf state folder.
      *
-     * **See** {@link Global.SF_STATE_FOLDER}
+     * **See**  {@link Global.SF_STATE_FOLDER}
      */
     static get SF_DIR() {
         return path.join(os.homedir(), Global.SF_STATE_FOLDER);
     }
     /**
-     * The full system path to the peferred global state folder
+     * The  full system path to the preferred global state folder
      */
     static get DIR() {
         return path.join(os.homedir(), Global.SFDX_STATE_FOLDER);
     }
     /**
-     * Gets the current mode environment variable as a {@link Mode} instance.
+     * Gets the curr ent mode environment variable as a {@link Mode} instance.
      *
      * ```
      * console.log(Global.getEnvironmentMode() === Mode.PRODUCTION);
@@ -87,7 +87,7 @@ Global.SFDX_STATE_FOLDER = '.sfdx';
  */
 Global.SF_STATE_FOLDER = '.sf';
 /**
- * The peferred global folder in which state is stored.
+ * The preferred global folder in which state is stored.
  */
 Global.STATE_FOLDER = Global.SFDX_STATE_FOLDER;
 /**

package/lib/org/scratchOrgInfoApi.js

@@ -203,7 +203,7 @@ const checkOrgDoesntExist = async (scratchOrgInfo) => {
         catch (error) {
             const sfError = sfError_1.SfError.wrap(error);
             // if an AuthInfo couldn't be created that means no AuthFile exists.
-            if (sfError.name === 'NamedOrgNotFound') {
+            if (sfError.name === 'NamedOrgNotFoundError') {
                 return;
             }
             // Something unexpected

package/lib/stateAggregator/stateAggregator.d.ts

@@ -4,17 +4,22 @@ import { OrgAccessor } from './accessors/orgAccessor';
 import { SandboxAccessor } from './accessors/sandboxAccessor';
 import { TokenAccessor } from './accessors/tokenAccessor';
 export declare class StateAggregator extends AsyncOptionalCreatable {
-    private static instance;
+    private static instanceMap;
     aliases: AliasAccessor;
     orgs: OrgAccessor;
     sandboxes: SandboxAccessor;
     tokens: TokenAccessor;
+    /**
+     * Reuse a StateAggregator if one was already created for the current global state directory
+     * Otherwise, create one and adds it to map for future reuse.
+     * HomeDir might be stubbed in tests
+     */
     static getInstance(): Promise<StateAggregator>;
     /**
      * Clear the cache to force reading from disk.
      *
      * *NOTE: Only call this method if you must and you know what you are doing.*
      */
-    static clearInstance(): void;
+    static clearInstance(path?: string): void;
     protected init(): Promise<void>;
 }

package/lib/stateAggregator/stateAggregator.js

@@ -8,24 +8,31 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StateAggregator = void 0;
 const kit_1 = require("@salesforce/kit");
+const global_1 = require("../global");
 const aliasAccessor_1 = require("./accessors/aliasAccessor");
 const orgAccessor_1 = require("./accessors/orgAccessor");
 const sandboxAccessor_1 = require("./accessors/sandboxAccessor");
 const tokenAccessor_1 = require("./accessors/tokenAccessor");
 class StateAggregator extends kit_1.AsyncOptionalCreatable {
+    /**
+     * Reuse a StateAggregator if one was already created for the current global state directory
+     * Otherwise, create one and adds it to map for future reuse.
+     * HomeDir might be stubbed in tests
+     */
     static async getInstance() {
-        if (!StateAggregator.instance) {
-            StateAggregator.instance = await StateAggregator.create();
+        if (!StateAggregator.instanceMap.has(global_1.Global.DIR)) {
+            StateAggregator.instanceMap.set(global_1.Global.DIR, await StateAggregator.create());
         }
-        return StateAggregator.instance;
+        // TS assertion is valid because there either was one OR it was just now instantiated
+        return StateAggregator.instanceMap.get(global_1.Global.DIR);
     }
     /**
      * Clear the cache to force reading from disk.
      *
      * *NOTE: Only call this method if you must and you know what you are doing.*
      */
-    static clearInstance() {
-        delete StateAggregator.instance;
+    static clearInstance(path = global_1.Global.DIR) {
+        StateAggregator.instanceMap.delete(path);
     }
     async init() {
         this.orgs = await orgAccessor_1.OrgAccessor.create();
@@ -35,4 +42,5 @@ class StateAggregator extends kit_1.AsyncOptionalCreatable {
     }
 }
 exports.StateAggregator = StateAggregator;
+StateAggregator.instanceMap = new Map();
 //# sourceMappingURL=stateAggregator.js.map

package/lib/util/sfdcUrl.d.ts

@@ -48,7 +48,7 @@ export declare class SfdcUrl extends URL {
      */
     checkLightningDomain(): Promise<true | never>;
     /**
-     * Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again untill timeout
+     * Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again until timeout
      * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
      *
      * @returns the resolved ip address.

package/lib/util/sfdcUrl.js

@@ -155,7 +155,7 @@ class SfdcUrl extends url_1.URL {
         return true;
     }
     /**
-     * Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again untill timeout
+     * Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again until timeout
      * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
      *
      * @returns the resolved ip address.

package/package.json

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