@salesforce/core 4.0.0 → 4.0.1

package/lib/org/connection.js

@@ -9,7 +9,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SingleRecordQueryErrors = exports.Connection = exports.DNS_ERROR_NAME = exports.SFDX_HTTP_HEADERS = void 0;
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 const url_1 = require("url");
-const FormData = require("form-data");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const jsforce_1 = require("jsforce");
@@ -17,17 +16,13 @@ const tooling_1 = require("jsforce/lib/api/tooling");
 const myDomainResolver_1 = require("../status/myDomainResolver");
 const configAggregator_1 = require("../config/configAggregator");
 const logger_1 = require("../logger");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 const sfdc_1 = require("../util/sfdc");
 const messages_1 = require("../messages");
 const lifecycleEvents_1 = require("../lifecycleEvents");
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'connection', [
-    'incorrectAPIVersionError',
-    'domainNotFoundError',
-    'noInstanceUrlError',
-]);
-const clientId = `sfdx toolbelt:${process.env.SFDX_SET_CLIENT_IDS || ''}`;
+const orgConfigProperties_1 = require("./orgConfigProperties");
+const messages = new messages_1.Messages('@salesforce/core', 'connection', new Map([["incorrectAPIVersionError", "Invalid API version %s. Expecting format \"[1-9][0-9].0\", i.e. 42.0"], ["domainNotFoundError", "The org cannot be found"], ["domainNotFoundError.actions", ["Verify that the org still exists',", "If your org is newly created, wait a minute and run your command again',", "If you deployed or updated the org's My Domain, logout from the CLI and authenticate again\",", "If you are running in a CI environment with a DNS that blocks external IPs, try setting SFDX_DISABLE_DNS_CHECK=true'"]], ["noInstanceUrlError", "Connection has no instanceUrl."], ["noInstanceUrlError.actions", "Make sure the instanceUrl is set in your command or config."], ["noApiVersionsError", "Org failed to respond with its list of API versions. This is usually the result of domain changes like activating MyDomain or Enhanced Domains"], ["noApiVersionsError.actions", "Re-authenticate to the org."]]));
+const clientId = `sfdx toolbelt:${process.env.SFDX_SET_CLIENT_IDS ?? ''}`;
 exports.SFDX_HTTP_HEADERS = {
     'content-type': 'application/json',
     'user-agent': clientId,
@@ -57,13 +52,12 @@ class Connection extends jsforce_1.Connection {
      * @ignore
      */
     constructor(options) {
-        super(options.connectionOptions || {});
-        // eslint-disable-next-line @typescript-eslint/unbound-method
-        this.tooling.autoFetchQuery = Connection.prototype.autoFetchQuery;
+        super(options.connectionOptions ?? {});
+        // Save whether we've successfully resolved this connection's instance URL.
+        this.hasResolved = false;
         this.options = options;
         this.username = options.authInfo.getUsername();
     }
-    // The following are all initialized in either this constructor or the super constructor, sometimes conditionally...
     /**
      * Tooling api reference.
      */
@@ -76,17 +70,16 @@ class Connection extends jsforce_1.Connection {
      * @param options Constructor options.
      */
     static async create(options) {
-        var _a, _b;
         const baseOptions = {
-            version: (_a = options.connectionOptions) === null || _a === void 0 ? void 0 : _a.version,
+            version: options.connectionOptions?.version,
             callOptions: {
                 client: clientId,
             },
         };
         if (!baseOptions.version) {
             // Set the API version obtained from the config aggregator.
-            const configAggregator = options.configAggregator || (await configAggregator_1.ConfigAggregator.create());
-            baseOptions.version = (0, ts_types_1.asString)(configAggregator.getInfo('apiVersion').value);
+            const configAggregator = options.configAggregator ?? (await configAggregator_1.ConfigAggregator.create());
+            baseOptions.version = (0, ts_types_1.asString)(configAggregator.getInfo('org-api-version').value);
         }
         const providedOptions = options.authInfo.getConnectionOptions();
         // Get connection options from auth info and create a new jsForce connection
@@ -96,13 +89,10 @@ class Connection extends jsforce_1.Connection {
         try {
             // No version passed in or in the config, so load one.
             if (!baseOptions.version) {
-                const cachedVersion = await conn.loadInstanceApiVersion();
-                if (cachedVersion) {
-                    conn.setApiVersion(cachedVersion);
-                }
+                await conn.useLatestApiVersion();
             }
             else {
-                conn.logger.debug(`The apiVersion ${baseOptions.version} was found from ${((_b = options.connectionOptions) === null || _b === void 0 ? void 0 : _b.version) ? 'passed in options' : 'config'}`);
+                conn.logger.debug(`The org-api-version ${baseOptions.version} was found from ${options.connectionOptions?.version ? 'passed in options' : 'config'}`);
             }
         }
         catch (err) {
@@ -112,7 +102,7 @@ class Connection extends jsforce_1.Connection {
             }
             conn.logger.debug(`Error trying to load the API version: ${e.name} - ${e.message}`);
         }
-        conn.logger.debug(`Using apiVersion ${conn.getApiVersion()}`);
+        conn.logger.debug(`Connection created with apiVersion ${conn.getApiVersion()}`);
         return conn;
     }
     /**
@@ -123,14 +113,10 @@ class Connection extends jsforce_1.Connection {
         this.logger = this.tooling._logger = await logger_1.Logger.child('connection');
     }
     /**
-     * TODO: This should be moved into JSForce V2 once ready
-     * this is only a temporary solution to support both REST and SOAP APIs
-     *
      * deploy a zipped buffer from the SDRL with REST or SOAP
      *
      * @param zipInput data to deploy
      * @param options JSForce deploy options + a boolean for rest
-     * @param callback
      */
     async deploy(zipInput, options) {
         const rest = options.rest;
@@ -139,27 +125,7 @@ class Connection extends jsforce_1.Connection {
         if (rest) {
             this.logger.debug('deploy with REST');
             await this.refreshAuth();
-            const headers = {
-                Authorization: this && `OAuth ${this.accessToken}`,
-                'Sforce-Call-Options': 'client=sfdx-core',
-            };
-            const client = this.oauth2 && this.oauth2.clientId;
-            if (client) {
-                headers.clientId = client;
-            }
-            const form = new FormData();
-            // Add the zip file
-            form.append('file', zipInput, {
-                contentType: 'application/zip',
-                filename: 'package.xml',
-            });
-            // Add the deploy options
-            form.append('entity_content', JSON.stringify({ deployOptions: options }), {
-                contentType: 'application/json',
-            });
-            const url = `${this.baseUrl()}/metadata/deployRequest`;
-            const httpRequest = { method: 'POST', url, headers, body: form };
-            return this.request(httpRequest);
+            return this.metadata.deployRest(zipInput, options);
         }
         else {
             this.logger.debug('deploy with SOAP');
@@ -175,9 +141,15 @@ class Connection extends jsforce_1.Connection {
      */
     request(request, options) {
         const httpRequest = (0, ts_types_1.isString)(request) ? { method: 'GET', url: request } : request;
-        httpRequest.headers = Object.assign({}, exports.SFDX_HTTP_HEADERS, httpRequest.headers);
+        // prevent duplicate headers by lowercasing the keys on the incoming request
+        const lowercasedHeaders = httpRequest.headers
+            ? Object.fromEntries(Object.entries(httpRequest.headers).map(([key, value]) => [key.toLowerCase(), value]))
+            : {};
+        httpRequest.headers = {
+            ...exports.SFDX_HTTP_HEADERS,
+            ...lowercasedHeaders,
+        };
         this.logger.debug(`request: ${JSON.stringify(httpRequest)}`);
-        //  The "as" is a workaround for the jsforce typings.
         return super.request(httpRequest, options);
     }
     /**
@@ -185,50 +157,35 @@ class Connection extends jsforce_1.Connection {
      */
     baseUrl() {
         // essentially the same as pathJoin(super.instanceUrl, 'services', 'data', `v${super.version}`);
+        // eslint-disable-next-line no-underscore-dangle
         return super._baseUrl();
     }
-    /**
-     * TODO: This should be moved into JSForce V2 once ready
-     * this is only a temporary solution to support both REST and SOAP APIs
-     *
-     * Will deploy a recently validated deploy request
-     *
-     * @param options.id = the deploy ID that's been validated already from a previous checkOnly deploy request
-     * @param options.rest = a boolean whether or not to use the REST API
-     */
-    async deployRecentValidation(options) {
-        const rest = options.rest;
-        delete options.rest;
-        if (rest) {
-            const url = `${this.baseUrl()}/metadata/deployRequest`;
-            const messageBody = JSON.stringify({
-                validatedDeployRequestId: options.id,
-            });
-            const requestInfo = {
-                method: 'POST',
-                url,
-                body: messageBody,
-            };
-            const requestOptions = { headers: 'json' };
-            return this.request(requestInfo, requestOptions);
-        }
-        else {
-            // the _invoke is private in jsforce, we can call the SOAP deployRecentValidation like this
-            // @ts-ignore
-            return this.metadata['_invoke']('deployRecentValidation', {
-                validationId: options.id,
-            });
-        }
-    }
     /**
      * Retrieves the highest api version that is supported by the target server instance.
      */
     async retrieveMaxApiVersion() {
+        // Check saved value first, then cache.
+        if ((this.maxApiVersion ??= this.getCachedApiVersion())) {
+            return this.maxApiVersion;
+        }
         await this.isResolvable();
+        this.logger.debug(`Fetching API versions supported for org: ${this.getUsername()}`);
         const versions = await this.request(`${this.instanceUrl}/services/data`);
+        // if the server doesn't return a list of versions, it's possibly a instanceUrl issue where the local file is out of date.
+        if (!Array.isArray(versions)) {
+            this.logger.debug(`server response for retrieveMaxApiVersion: ${versions}`);
+            throw messages.createError('noApiVersionsError');
+        }
         this.logger.debug(`response for org versions: ${versions.map((item) => item.version).join(',')}`);
-        const max = (0, ts_types_1.ensure)((0, kit_1.maxBy)(versions, (version) => version.version));
-        return max.version;
+        this.maxApiVersion = (0, ts_types_1.ensure)((0, kit_1.maxBy)(versions, (version) => version.version)).version;
+        // cache the max API version just fetched
+        await this.options.authInfo.save({
+            instanceApiVersion: this.maxApiVersion,
+            // This will get messed up if the user changes their local time on their machine.
+            // Not a big deal since it will just get updated sooner/later.
+            instanceApiVersionLastRetrieved: new Date().toLocaleString(),
+        });
+        return this.maxApiVersion;
     }
     /**
      * Use the latest API version available on `this.instanceUrl`.
@@ -250,8 +207,10 @@ class Connection extends jsforce_1.Connection {
      * Verify that instance has a reachable DNS entry, otherwise will throw error
      */
     async isResolvable() {
-        var _a;
-        if (!((_a = this.options.connectionOptions) === null || _a === void 0 ? void 0 : _a.instanceUrl)) {
+        if (this.hasResolved) {
+            return this.hasResolved;
+        }
+        if (!this.options.connectionOptions?.instanceUrl) {
             throw messages.createError('noInstanceUrlError');
         }
         const resolver = await myDomainResolver_1.MyDomainResolver.create({
@@ -259,6 +218,7 @@ class Connection extends jsforce_1.Connection {
         });
         try {
             await resolver.resolve();
+            this.hasResolved = true;
             return true;
         }
         catch (e) {
@@ -274,12 +234,12 @@ class Connection extends jsforce_1.Connection {
     /**
      * Set the API version for all connection requests.
      *
-     * **Throws** *{@link SfdxError}{ name: 'IncorrectAPIVersionError' }* Incorrect API version.
+     * **Throws** *{@link SfError}{ name: 'IncorrectAPIVersionError' }* Incorrect API version.
      *
      * @param version The API version.
      */
     setApiVersion(version) {
-        if (!sfdc_1.sfdc.validateApiVersion(version)) {
+        if (!(0, sfdc_1.validateApiVersion)(version)) {
             throw messages.createError('incorrectAPIVersionError', [version]);
         }
         this.version = version;
@@ -294,7 +254,7 @@ class Connection extends jsforce_1.Connection {
      * Getter for the AuthInfo fields.
      */
     getAuthInfoFields() {
-        // If the GlobalInfo.unsetOrg is called, the AuthFields are no longer accessible.
+        // If the StateAggregator.orgs.remove is called, the AuthFields are no longer accessible.
         return this.options.authInfo.getFields() || {};
     }
     /**
@@ -321,6 +281,7 @@ class Connection extends jsforce_1.Connection {
      * @param url Partial url.
      */
     normalizeUrl(url) {
+        // eslint-disable-next-line no-underscore-dangle
         return this._normalizeUrl(url);
     }
     /**
@@ -331,15 +292,16 @@ class Connection extends jsforce_1.Connection {
      * @param soql The SOQL string.
      * @param queryOptions The query options. NOTE: the autoFetch option will always be true.
      */
-    async autoFetchQuery(soql, queryOptions = {}) {
+    async autoFetchQuery(soql, queryOptions = { tooling: false }) {
         const config = await configAggregator_1.ConfigAggregator.create();
         // take the limit from the calling function, then the config, then default 10,000
-        const maxFetch = config.getInfo('maxQueryLimit').value || queryOptions.maxFetch || 10000;
-        const options = Object.assign(queryOptions, {
+        const maxFetch = (config.getInfo(orgConfigProperties_1.OrgConfigProperties.ORG_MAX_QUERY_LIMIT).value || queryOptions.maxFetch) ?? 10000;
+        const { tooling, ...queryOptionsWithoutTooling } = queryOptions;
+        const options = Object.assign(queryOptionsWithoutTooling, {
             autoFetch: true,
             maxFetch,
         });
-        const query = await this.query(soql, options);
+        const query = tooling ? await this.tooling.query(soql, options) : await this.query(soql, options);
         if (query.records.length && query.totalSize > query.records.length) {
             void lifecycleEvents_1.Lifecycle.getInstance().emitWarning(`The query result is missing ${query.totalSize - query.records.length} records due to a ${maxFetch} record limit. Increase the number of records returned by setting the config value "maxQueryLimit" or the environment variable "SFDX_MAX_QUERY_LIMIT" to ${query.totalSize} or greater than ${maxFetch}.`);
         }
@@ -357,11 +319,12 @@ class Connection extends jsforce_1.Connection {
     }) {
         const result = options.tooling ? await this.tooling.query(soql) : await this.query(soql);
         if (result.totalSize === 0) {
-            throw new sfdxError_1.SfdxError(`No record found for ${soql}`, exports.SingleRecordQueryErrors.NoRecords);
+            throw new sfError_1.SfError(`No record found for ${soql}`, exports.SingleRecordQueryErrors.NoRecords);
         }
         if (result.totalSize > 1) {
-            throw new sfdxError_1.SfdxError(options.returnChoicesOnMultiple
-                ? `Multiple records found. ${result.records.map((item) => item[options.choiceField]).join(',')}`
+            throw new sfError_1.SfError(options.returnChoicesOnMultiple
+                ? // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+                    `Multiple records found. ${result.records.map((item) => item[options.choiceField]).join(',')}`
                 : 'The query returned more than 1 record', exports.SingleRecordQueryErrors.MultipleRecords);
         }
         return result.records[0];
@@ -378,10 +341,16 @@ class Connection extends jsforce_1.Connection {
         };
         await this.request(requestInfo);
     }
-    async loadInstanceApiVersion() {
+    getCachedApiVersion() {
+        // Exit early if the API version cache is disabled.
+        if (kit_1.env.getBoolean('SFDX_IGNORE_API_VERSION_CACHE', false)) {
+            this.logger.debug('Using latest API version since SFDX_IGNORE_API_VERSION_CACHE = true');
+            return;
+        }
+        // Get API version cache data
         const authFileFields = this.options.authInfo.getFields();
         const lastCheckedDateString = authFileFields.instanceApiVersionLastRetrieved;
-        let version = (0, ts_types_1.getString)(authFileFields, 'instanceApiVersion');
+        const version = authFileFields.instanceApiVersion;
         let lastChecked;
         try {
             if (lastCheckedDateString && (0, ts_types_1.isString)(lastCheckedDateString)) {
@@ -391,35 +360,20 @@ class Connection extends jsforce_1.Connection {
         catch (e) {
             /* Do nothing, it will just request the version again */
         }
-        // Grab the latest api version from the server and cache it in the auth file
-        const useLatest = async () => {
-            // verifies DNS
-            await this.useLatestApiVersion();
-            version = this.getApiVersion();
-            await this.options.authInfo.save({
-                instanceApiVersion: version,
-                // This will get messed up if the user changes their local time on their machine.
-                // Not a big deal since it will just get updated sooner/later.
-                instanceApiVersionLastRetrieved: new Date().toLocaleString(),
-            });
-        };
-        const ignoreCache = kit_1.env.getBoolean('SFDX_IGNORE_API_VERSION_CACHE', false);
-        if (lastChecked && !ignoreCache) {
+        // Check if the cache has expired
+        if (lastChecked) {
             const now = new Date();
             const has24HoursPastSinceLastCheck = now.getTime() - lastChecked > kit_1.Duration.hours(24).milliseconds;
-            this.logger.debug(`Last checked on ${lastCheckedDateString} (now is ${now.toLocaleString()}) - ${has24HoursPastSinceLastCheck ? '' : 'not '}getting latest`);
-            if (has24HoursPastSinceLastCheck) {
-                await useLatest();
+            this.logger.debug(`API version cache last checked on ${lastCheckedDateString} (now is ${now.toLocaleString()})`);
+            if (!has24HoursPastSinceLastCheck && version) {
+                // return cached API version
+                this.logger.debug(`Using cached API version: ${version}`);
+                return version;
+            }
+            else {
+                this.logger.debug('API version cache expired. Re-fetching latest.');
             }
         }
-        else {
-            this.logger.debug(`Using the latest because lastChecked=${lastChecked} and SFDX_IGNORE_API_VERSION_CACHE=${ignoreCache}`);
-            // No version found in the file (we never checked before)
-            // so get the latest.
-            await useLatest();
-        }
-        this.logger.debug(`Loaded latest apiVersion ${version}`);
-        return version;
     }
 }
 exports.Connection = Connection;

package/lib/org/index.js

@@ -7,7 +7,11 @@
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];