@salesforce/core 4.3.2 → 4.3.4

package/README.md

@@ -1,15 +1,10 @@
 [![NPM](https://img.shields.io/npm/v/@salesforce/core.svg)](https://www.npmjs.com/package/@salesforce/core)
-[![CircleCI](https://circleci.com/gh/forcedotcom/sfdx-core.svg?style=svg&circle-token=2377ca31221869e9d13448313620486da80e595f)](https://circleci.com/gh/forcedotcom/sfdx-core)
 
 - [Description](#description)
 - [Usage](#usage)
   - [Contributing](#contributing)
 - [Using TestSetup](#using-testsetup)
-  - [Mocking Authorizations](#mocking-authorizations)
-  - [Mocking Config Files](#mocking-config-files)
-  - [Using the Built-in Sinon Sandboxes](#using-the-built-in-sinon-sandboxes)
-  - [Testing Expected Failures](#testing-expected-failures)
-  - [Testing Log Lines](#testing-log-lines)
+- [Message Transformer](#message-transformer)
 
 # Description
 
@@ -21,213 +16,21 @@ See the [API documentation](https://forcedotcom.github.io/sfdx-core/).
 
 ## Contributing
 
-If you are interested in contributing, please take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.
+If you're interested in contributing, take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.
 
 ## Issues
 
-Please report all issues to [issues only repository](https://github.com/forcedotcom/cli/issues).
+Report all issues to the [issues only repository](https://github.com/forcedotcom/cli/issues).
 
 # Using TestSetup
 
 The Salesforce DX Core Library provides a unit testing utility to help with mocking and sand-boxing core components. This feature allows unit tests to execute without needing to make API calls to salesforce.com.
 
-## Mocking Authorizations
-
-Here you can mock authorization for a Salesforce scratch org.
-
-```typescript
-import { strictEqual } from 'assert';
-import { MockTestOrgData, TestContext } from '@salesforce/core/lib/testSetup';
-import { AuthInfo } from '@salesforce/core';
-
-describe('Mocking Auth data', () => {
-  const $$ = new TestContext();
-  it('example', async () => {
-    const testData = new MockTestOrgData();
-    await $$.stubAuths(testData);
-    const auth = await AuthInfo.create({ username: testData.username });
-    strictEqual(auth.getUsername(), testData.username);
-  });
-});
-```
-
-After having a valid AuthInfo object you can then create fake connections to a Salesforce.com scratch org. This allows for writing tests that can validate result responses for SOQL queries and REST endpoints.
-
-```typescript
-import { AuthInfo, Connection, SfError } from '@salesforce/core';
-import { MockTestOrgData, TestContext } from '@salesforce/core/lib/testSetup';
-import { AnyJson, ensureJsonMap, JsonMap } from '@salesforce/ts-types';
-import { ensureString } from '@salesforce/ts-types';
-import { deepStrictEqual } from 'assert';
-import { QueryResult } from 'jsforce';
-
-describe('Mocking a force server call', () => {
-  const $$ = new TestContext();
-  it('example', async () => {
-    const records: AnyJson = { records: ['123456', '234567'] };
-    const testData = new MockTestOrgData();
-    await $$.stubAuths(testData);
-    $$.fakeConnectionRequest = (request: AnyJson): Promise<AnyJson> => {
-      const _request = ensureJsonMap(request);
-      if (request && ensureString(_request.url).includes('Account')) {
-        return Promise.resolve(records);
-      } else {
-        return Promise.reject(new SfError(`Unexpected request: ${_request.url}`));
-      }
-    };
-    const connection = await Connection.create({
-      authInfo: await AuthInfo.create({ username: testData.username }),
-    });
-    const result = await connection.query('select Id From Account');
-    deepStrictEqual(result, records);
-  });
-});
-```
-
-## Mocking Config Files
-
-You can mock the contents of various config files
-
-```typescript
-import { strictEqual } from 'assert';
-import { MockTestOrgData, TestContext } from '@salesforce/core/lib/testSetup';
-import { StateAggregator, OrgConfigProperties } from '@salesforce/core';
-
-describe('Mocking Aliases', () => {
-  const $$ = new TestContext();
-  it('example', async () => {
-    const testData = new MockTestOrgData();
-    await $$.stubAliases({ myAlias: testData.username });
-    const alias = (await StateAggregator.getInstance()).aliases.get(testData.username);
-    strictEqual(alias, 'myAlias');
-  });
-});
-
-describe('Mocking Config', () => {
-  it('example', async () => {
-    const testData = new MockTestOrgData();
-    await $$.stubConfig({ [OrgConfigProperties.TARGET_ORG]: testData.username });
-    const { value } = (await ConfigAggregator.create()).getInfo(OrgConfigProperties.TARGET_ORG);
-    strictEqual(value, testData.username);
-  });
-});
-
-describe('Mocking Arbitrary Config Files', () => {
-  it('example', async () => {
-    // MyConfigFile must extend the ConfigFile class in order for this to work properly.
-    $$.setConfigStubContents('MyConfigFile', { contents: { foo: 'bar' } });
-  });
-});
-```
-
-## Using the Built-in Sinon Sandboxes
-
-sfdx-core uses Sinon as its underlying mocking system. If you're unfamiliar with Sinon and its sandboxing concept you can find more information here:
-https://sinonjs.org/
-Sinon `stub`s and `spy`s must be cleaned up after test invocations. To ease the use of Sinon with sfdx core we've exposed our sandbox in TestSetup. After adding your own `stub`s and/or `spy`s they will automatically be cleaned up after each test using mocha's afterEach method.
-
-```typescript
-import { strictEqual } from 'assert';
-
-import { TestContext } from '@salesforce/core/lib/testSetup';
-import * as os from 'os';
-
-describe('Using the built in Sinon sandbox.', () => {
-  const $$ = new TestContext();
-  it('example', async () => {
-    const unsupportedOS = 'LEO';
-    $$.SANDBOX.stub(os, 'platform').returns(unsupportedOS);
-    strictEqual(os.platform(), unsupportedOS);
-  });
-});
-```
-
-## Testing Expected Failures
-
-It's important to have negative tests that ensure proper error handling. With `shouldThrow` it's easy to test for expected async rejections.
-
-```typescript
-import { SfError } from '@salesforce/core';
-import { shouldThrow } from '@salesforce/core/lib/testSetup';
-import { strictEqual } from 'assert';
-
-class TestObject {
-  public static async method() {
-    throw new SfError('Error', 'ExpectedError');
-  }
-}
-
-describe('Testing for expected errors', () => {
-  it('example', async () => {
-    try {
-      await shouldThrow(TestObject.method());
-    } catch (e) {
-      strictEqual(e.name, 'ExpectedError');
-    }
-  });
-});
-```
-
-You can also use `shouldThrowSync` for syncrhonous functions you expect to fail
-
-```typescript
-import { SfError } from '@salesforce/core';
-import { shouldThrowSync } from '@salesforce/core/lib/testSetup';
-import { strictEqual } from 'assert';
-
-class TestObject {
-  public static method() {
-    throw new SfError('Error', 'ExpectedError');
-  }
-}
-
-describe('Testing for expected errors', () => {
-  it('example', async () => {
-    try {
-      shouldThrowSync(() => TestObject.method());
-    } catch (e) {
-      strictEqual(e.name, 'ExpectedError');
-    }
-  });
-});
-```
-
-## Testing Log Lines
-
-It's also useful to check expected values and content from log lines. TestSetup configures the sfdx-core logger to use an in memory LogLine storage structure. These can be easily accessed from tests.
-
-```typescript
-import { Logger, LogLine } from '@salesforce/core';
-import { TestContext } from '@salesforce/core/lib/testSetup';
-import { strictEqual } from 'assert';
-
-const TEST_STRING = 'foo was here';
-
-class TestObject {
-  constructor(private logger: Logger) {
-    this.logger = logger.child('TestObject');
-  }
-
-  public method() {
-    this.logger.error(TEST_STRING);
-  }
-}
-
-describe('Testing log lines', () => {
-  const $$ = new TestContext();
-  it('example', async () => {
-    const obj = new TestObject($$.TEST_LOGGER);
-    obj.method();
-    const records = $$.TEST_LOGGER.getBufferedRecords();
-    strictEqual(records.length, 1);
-    strictEqual(records[0].msg, TEST_STRING);
-  });
-});
-```
+See the [Test Setup documentation](TEST_SETUP.md).
 
 ## Message Transformer
 
-the Messages class, by default, will load message text during run time. It's optimized to do this only per file.
+The Messages class, by default, loads message text during run time. It's optimized to do this only per file.
 
 If you're using @salesforce/core or other code that uses its Messages class in a bundler (webpack, esbuild, etc) it may struggle with these runtime references.
 

package/lib/config/configFile.js

@@ -147,24 +147,25 @@ class ConfigFile extends configStore_1.BaseConfigStore {
             // internally and updated persistently via write().
             if (!this.hasRead || force) {
                 this.logger.info(`Reading config file: ${this.getPath()}`);
-                const obj = (0, kit_1.parseJsonMap)(await fs.promises.readFile(this.getPath(), 'utf8'));
+                const obj = (0, kit_1.parseJsonMap)(await fs.promises.readFile(this.getPath(), 'utf8'), this.getPath());
                 this.setContentsFromObject(obj);
             }
+            // Necessarily set this even when an error happens to avoid infinite re-reading.
+            // To attempt another read, pass `force=true`.
+            this.hasRead = true;
             return this.getContents();
         }
         catch (err) {
+            this.hasRead = true;
             if (err.code === 'ENOENT') {
                 if (!throwOnNotFound) {
                     this.setContents();
                     return this.getContents();
                 }
             }
-            throw err;
-        }
-        finally {
             // Necessarily set this even when an error happens to avoid infinite re-reading.
             // To attempt another read, pass `force=true`.
-            this.hasRead = true;
+            throw err;
         }
     }
     /**

package/lib/org/authInfo.d.ts

@@ -1,6 +1,6 @@
 import { AsyncOptionalCreatable } from '@salesforce/kit';
 import { Nullable } from '@salesforce/ts-types';
-import { JwtOAuth2Config, OAuth2 } from 'jsforce';
+import { OAuth2Config, OAuth2 } from 'jsforce';
 import { Connection } from './connection';
 import { Org } from './org';
 /**
@@ -67,6 +67,13 @@ export type AuthSideEffects = {
     setDefaultDevHub: boolean;
     setTracksSource?: boolean;
 };
+export type JwtOAuth2Config = OAuth2Config & {
+    privateKey?: string;
+    privateKeyFile?: string;
+    authCode?: string;
+    refreshToken?: string;
+    username?: string;
+};
 /**
  * A function to update a refresh token when the access token is expired.
  */

package/lib/org/authInfo.js

@@ -702,10 +702,12 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         }, privateKeyContents, {
             algorithm: 'RS256',
         });
-        const oauth2 = new jsforce_1.JwtOAuth2({ loginUrl });
-        // jsforce has it types as any
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-        return (0, ts_types_1.ensureJsonMap)(await oauth2.jwtAuthorize(jwtToken));
+        const oauth2 = new jsforce_1.OAuth2({ loginUrl });
+        return (0, ts_types_1.ensureJsonMap)(await oauth2.requestToken({
+            // eslint-disable-next-line camelcase
+            grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
+            assertion: jwtToken,
+        }));
     }
     // Build OAuth config for a refresh token auth flow
     async buildRefreshTokenConfig(options) {

package/lib/org/scratchOrgLifecycleEvents.d.ts

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

package/lib/stateAggregator/accessors/orgAccessor.js

@@ -14,6 +14,7 @@ const authInfoConfig_1 = require("../../config/authInfoConfig");
 const global_1 = require("../../global");
 const logger_1 = require("../../logger");
 const messages_1 = require("../../messages");
+const lifecycleEvents_1 = require("../../lifecycleEvents");
 function chunk(array, chunkSize) {
     const final = [];
     for (let i = 0, len = array.length; i < len; i += chunkSize)
@@ -40,6 +41,9 @@ class BaseOrgAccessor extends kit_1.AsyncOptionalCreatable {
             return this.get(username, decrypt);
         }
         catch (err) {
+            if (err instanceof Error && err.name === 'JsonParseError') {
+                throw err;
+            }
             return null;
         }
     }
@@ -53,8 +57,13 @@ class BaseOrgAccessor extends kit_1.AsyncOptionalCreatable {
         for (const fileChunk of fileChunks) {
             const promises = fileChunk.map(async (f) => {
                 const username = this.parseUsername(f);
-                const config = await this.initAuthFile(username);
-                this.configs.set(username, config);
+                try {
+                    const config = await this.initAuthFile(username);
+                    this.configs.set(username, config);
+                }
+                catch (e) {
+                    await lifecycleEvents_1.Lifecycle.getInstance().emitWarning(`The auth file for ${username} is invalid.`);
+                }
             });
             // eslint-disable-next-line no-await-in-loop
             await Promise.all(promises);

package/lib/webOAuthServer.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="node" />
 import * as http from 'http';
-import { JwtOAuth2Config } from 'jsforce';
 import { AsyncCreatable } from '@salesforce/kit';
 import { AuthInfo } from './org';
+import { JwtOAuth2Config } from './org/authInfo';
 /**
  * Handles the creation of a web server for web based login flows.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "4.3.2",
+  "version": "4.3.4",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -49,7 +49,7 @@
     "faye": "^1.4.0",
     "form-data": "^4.0.0",
     "js2xmlparser": "^4.0.1",
-    "jsforce": "^2.0.0-beta.24",
+    "jsforce": "^2.0.0-beta.27",
     "jsonwebtoken": "9.0.0",
     "jszip": "3.10.1",
     "proper-lockfile": "^4.1.2",