fix: TypeError: fs.exists is not a function on read-only file system (#17846)

fasttime · web-flow · commit 7d5e5f68849a · 2023-12-13T11:09:00.000-05:00
diff --git a/lib/eslint/flat-eslint.js b/lib/eslint/flat-eslint.js
@@ -11,6 +11,7 @@
 
 // Note: Node.js 12 does not support fs/promises.
 const fs = require("fs").promises;
+const { existsSync } = require("fs");
 const path = require("path");
 const findUp = require("find-up");
 const { version } = require("../../package.json");
@@ -766,7 +767,7 @@ class FlatESLint {
                 const errorCode = error && error.code;
 
                 // Ignore errors when no such file exists or file system is read only (and cache file does not exist)
-                if (errorCode !== "ENOENT" && !(errorCode === "EROFS" && !(await fs.exists(cacheFilePath)))) {
+                if (errorCode !== "ENOENT" && !(errorCode === "EROFS" && !existsSync(cacheFilePath))) {
                     throw error;
                 }
             }
diff --git a/tests/lib/eslint/eslint.js b/tests/lib/eslint/eslint.js
@@ -2711,6 +2711,41 @@ describe("ESLint", () => {
                 assert(!shell.test("-f", cacheFilePath), "the cache for eslint should have been deleted since last run did not use the cache");
             });
 
+            it("should not throw an error if the cache file to be deleted does not exist on a read-only file system", async () => {
+                cacheFilePath = getFixturePath(".eslintcache");
+                doDelete(cacheFilePath);
+                assert(!shell.test("-f", cacheFilePath), "the cache file already exists and wasn't successfully deleted");
+
+                // Simulate a read-only file system.
+                sinon.stub(fs, "unlinkSync").throws(
+                    Object.assign(new Error("read-only file system"), { code: "EROFS" })
+                );
+
+                const eslintOptions = {
+                    useEslintrc: false,
+
+                    // specifying cache true the cache will be created
+                    cache: false,
+                    cacheLocation: cacheFilePath,
+                    overrideConfig: {
+                        rules: {
+                            "no-console": 0,
+                            "no-unused-vars": 2
+                        }
+                    },
+                    extensions: ["js"],
+                    cwd: path.join(fixtureDir, "..")
+                };
+
+                eslint = new ESLint(eslintOptions);
+
+                const file = getFixturePath("cache/src", "test-file.js");
+
+                await eslint.lintFiles([file]);
+
+                assert(fs.unlinkSync.calledWithExactly(cacheFilePath), "Expected attempt to delete the cache was not made.");
+            });
+
             it("should store in the cache a file that has lint messages and a file that doesn't have lint messages", async () => {
                 cacheFilePath = getFixturePath(".eslintcache");
                 doDelete(cacheFilePath);
diff --git a/tests/lib/eslint/flat-eslint.js b/tests/lib/eslint/flat-eslint.js
@@ -2601,6 +2601,40 @@ describe("FlatESLint", () => {
                 assert(!shell.test("-f", cacheFilePath), "the cache for eslint should have been deleted since last run did not use the cache");
             });
 
+            it("should not throw an error if the cache file to be deleted does not exist on a read-only file system", async () => {
+                cacheFilePath = getFixturePath(".eslintcache");
+                doDelete(cacheFilePath);
+                assert(!shell.test("-f", cacheFilePath), "the cache file already exists and wasn't successfully deleted");
+
+                // Simulate a read-only file system.
+                sinon.stub(fsp, "unlink").rejects(
+                    Object.assign(new Error("read-only file system"), { code: "EROFS" })
+                );
+
+                const eslintOptions = {
+                    overrideConfigFile: true,
+
+                    // specifying cache false the cache will be deleted
+                    cache: false,
+                    cacheLocation: cacheFilePath,
+                    overrideConfig: {
+                        rules: {
+                            "no-console": 0,
+                            "no-unused-vars": 2
+                        }
+                    },
+                    cwd: path.join(fixtureDir, "..")
+                };
+
+                eslint = new FlatESLint(eslintOptions);
+
+                const file = getFixturePath("cache/src", "test-file.js");
+
+                await eslint.lintFiles([file]);
+
+                assert(fsp.unlink.calledWithExactly(cacheFilePath), "Expected attempt to delete the cache was not made.");
+            });
+
             it("should store in the cache a file that has lint messages and a file that doesn't have lint messages", async () => {
                 cacheFilePath = getFixturePath(".eslintcache");
                 doDelete(cacheFilePath);

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`// Note: Node.js 12 does not support fs/promises.`
`13`	`13`	`const fs = require("fs").promises;`
	`14`	`+const { existsSync } = require("fs");`
`14`	`15`	`const path = require("path");`
`15`	`16`	`const findUp = require("find-up");`
`16`	`17`	`const { version } = require("../../package.json");`
`@@ -766,7 +767,7 @@ class FlatESLint {`
`766`	`767`	`const errorCode = error && error.code;`
`767`	`768`
`768`	`769`	`// Ignore errors when no such file exists or file system is read only (and cache file does not exist)`
`769`		`- if (errorCode !== "ENOENT" && !(errorCode === "EROFS" && !(await fs.exists(cacheFilePath)))) {`
	`770`	`+ if (errorCode !== "ENOENT" && !(errorCode === "EROFS" && !existsSync(cacheFilePath))) {`
`770`	`771`	`throw error;`
`771`	`772`	`}`
`772`	`773`	`}`