@salesforce/core 3.32.4 → 3.32.5

package/lib/org/connection.d.ts

@@ -40,6 +40,8 @@ export declare class Connection<S extends Schema = Schema> extends JSForceConnec
     private logger;
     private options;
     private username;
+    private hasResolved;
+    private maxApiVersion;
     /**
      * Constructor
      * **Do not directly construct instances of this class -- use {@link Connection.create} instead.**
@@ -164,7 +166,7 @@ export declare class Connection<S extends Schema = Schema> extends JSForceConnec
      * Useful for the raw methods (request, requestRaw) that use the accessToken directly and don't handle refreshes
      */
     refreshAuth(): Promise<void>;
-    private loadInstanceApiVersion;
+    private getCachedApiVersion;
 }
 export declare const SingleRecordQueryErrors: {
     NoRecords: string;

package/lib/org/connection.js

@@ -59,6 +59,8 @@ class Connection extends jsforce_1.Connection {
      */
     constructor(options) {
         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();
     }
@@ -93,10 +95,7 @@ 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 org-api-version ${baseOptions.version} was found from ${options.connectionOptions?.version ? 'passed in options' : 'config'}`);
@@ -109,7 +108,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;
     }
     /**
@@ -184,7 +183,12 @@ class Connection extends jsforce_1.Connection {
      * 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.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)) {
@@ -192,8 +196,15 @@ class Connection extends jsforce_1.Connection {
             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`.
@@ -215,6 +226,9 @@ class Connection extends jsforce_1.Connection {
      * Verify that instance has a reachable DNS entry, otherwise will throw error
      */
     async isResolvable() {
+        if (this.hasResolved) {
+            return this.hasResolved;
+        }
         if (!this.options.connectionOptions?.instanceUrl) {
             throw messages.createError('noInstanceUrlError');
         }
@@ -223,6 +237,7 @@ class Connection extends jsforce_1.Connection {
         });
         try {
             await resolver.resolve();
+            this.hasResolved = true;
             return true;
         }
         catch (e) {
@@ -345,10 +360,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 = authFileFields.instanceApiVersion;
+        const version = authFileFields.instanceApiVersion;
         let lastChecked;
         try {
             if (lastCheckedDateString && (0, ts_types_1.isString)(lastCheckedDateString)) {
@@ -358,35 +379,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 org-api-version ${version}`);
-        return version;
     }
 }
 exports.Connection = Connection;

package/package.json

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