@salesforce/core 8.2.8 → 8.3.0

package/lib/config/configFile.js

@@ -175,6 +175,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
             // internally and updated persistently via write().
             if (!this.hasRead || force) {
                 this.logger.debug(`Reading config file: ${this.getPath()} because ${!this.hasRead ? 'hasRead is false' : 'force parameter is true'}`);
+                await (0, fileLocking_1.pollUntilUnlock)(this.getPath());
                 const obj = (0, kit_1.parseJsonMap)(await fs.promises.readFile(this.getPath(), 'utf8'), this.getPath());
                 this.setContentsFromFileContents(obj, (await fs.promises.stat(this.getPath(), { bigint: true })).mtimeNs);
             }
@@ -210,6 +211,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
             // Only need to read config files once.  They are kept up to date
             // internally and updated persistently via write().
             if (!this.hasRead || force) {
+                (0, fileLocking_1.pollUntilUnlockSync)(this.getPath());
                 this.logger.debug(`Reading config file: ${this.getPath()}`);
                 const obj = (0, kit_1.parseJsonMap)(fs.readFileSync(this.getPath(), 'utf8'));
                 this.setContentsFromFileContents(obj, fs.statSync(this.getPath(), { bigint: true }).mtimeNs);

package/lib/org/scratchOrgInfoGenerator.js

@@ -225,6 +225,8 @@ const parseDefinitionFile = async (definitionFile) => {
     try {
         const fileData = await node_fs_1.promises.readFile(definitionFile, 'utf8');
         const defFileContents = (0, kit_1.parseJson)(fileData);
+        // remove key '$schema' from the definition file
+        delete defFileContents['$schema'];
         return defFileContents;
     }
     catch (err) {

package/lib/util/fileLocking.d.ts

@@ -21,4 +21,11 @@ export declare const lockInit: (filePath: string) => Promise<LockInitResponse>;
  * See its documentation for details.
  */
 export declare const lockInitSync: (filePath: string) => LockInitSyncResponse;
+/**
+ * Poll until the file is unlocked.
+ *
+ * @param filePath file path to check
+ */
+export declare const pollUntilUnlock: (filePath: string) => Promise<void>;
+export declare const pollUntilUnlockSync: (filePath: string) => void;
 export {};

package/lib/util/fileLocking.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lockInitSync = exports.lockInit = void 0;
+exports.pollUntilUnlockSync = exports.pollUntilUnlock = exports.lockInitSync = exports.lockInit = void 0;
 /*
  * Copyright (c) 2023, salesforce.com, inc.
  * All rights reserved.
@@ -33,6 +33,8 @@ exports.lockInitSync = exports.lockInit = void 0;
 const fs = __importStar(require("node:fs"));
 const node_path_1 = require("node:path");
 const proper_lockfile_1 = require("proper-lockfile");
+const kit_1 = require("@salesforce/kit");
+const ts_retry_promise_1 = require("ts-retry-promise");
 const sfError_1 = require("../sfError");
 const logger_1 = require("../logger/logger");
 const lockRetryOptions_1 = require("./lockRetryOptions");
@@ -111,4 +113,40 @@ const lockInitSync = (filePath) => {
     };
 };
 exports.lockInitSync = lockInitSync;
+/**
+ * Poll until the file is unlocked.
+ *
+ * @param filePath file path to check
+ */
+const pollUntilUnlock = async (filePath) => {
+    try {
+        await (0, ts_retry_promise_1.retryDecorator)(proper_lockfile_1.check, {
+            timeout: kit_1.Duration.minutes(1).milliseconds,
+            delay: 10,
+            until: (locked) => locked === false,
+            // don't retry errors (typically enoent or access on the lockfile, therefore not locked)
+            retryIf: () => false,
+        })(filePath, lockRetryOptions_1.lockRetryOptions);
+    }
+    catch (e) {
+        // intentionally swallow the error, same reason as above
+    }
+};
+exports.pollUntilUnlock = pollUntilUnlock;
+const pollUntilUnlockSync = (filePath) => {
+    // Set a counter to ensure that the while loop does not run indefinitely
+    let counter = 0;
+    let locked = true;
+    while (locked && counter < 100) {
+        try {
+            locked = (0, proper_lockfile_1.checkSync)(filePath, lockRetryOptions_1.lockOptions);
+            counter++;
+        }
+        catch {
+            // Likely a file not found error, which means the file is not locked
+            locked = false;
+        }
+    }
+};
+exports.pollUntilUnlockSync = pollUntilUnlockSync;
 //# sourceMappingURL=fileLocking.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "8.2.8",
+  "version": "8.3.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/index",
   "types": "lib/index.d.ts",
@@ -35,6 +35,7 @@
     "prepack": "sf-prepack",
     "prepare": "sf-install",
     "test": "wireit",
+    "test:nuts": "mocha \"test/**/*.nut.ts\" --timeout 500000",
     "test:only": "wireit",
     "test:perf": "ts-node test/perf/logger/main.test.ts"
   },
@@ -146,7 +147,7 @@
       "output": []
     },
     "test:only": {
-      "command": "nyc mocha \"test/**/*Test.ts\"",
+      "command": "nyc mocha \"test/unit/**/*.test.ts\"",
       "env": {
         "FORCE_COLOR": "2"
       },