fix: check cache file existence before deletion (#19648)

sethamus · web-flow · commit 96e84de55ad1 · 2025-05-02T09:38:01.000+02:00
* fix: check cache file existence before deletion

* fix test

* tweak api

* fix tests

* refactor
diff --git a/lib/eslint/eslint.js b/lib/eslint/eslint.js
@@ -704,15 +704,11 @@ class ESLint {
 			debug(`Deleting cache file at ${cacheFilePath}`);
 
 			try {
-				await fs.unlink(cacheFilePath);
+				if (existsSync(cacheFilePath)) {
+					await fs.unlink(cacheFilePath);
+				}
 			} catch (error) {
-				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" && !existsSync(cacheFilePath))
-				) {
+				if (existsSync(cacheFilePath)) {
 					throw error;
 				}
 			}
diff --git a/tests/lib/eslint/eslint.js b/tests/lib/eslint/eslint.js
@@ -12504,25 +12504,90 @@ describe("ESLint", () => {
 			);
 		});
 
-		it("should not throw an error if the cache file to be deleted does not exist on a read-only file system", async () => {
+		it("should not attempt to delete the cache file if it does not exist", async () => {
 			cacheFilePath = getFixturePath(".eslintcache");
 			doDelete(cacheFilePath);
 			assert(
 				!shell.test("-f", cacheFilePath),
 				"the cache file already exists and wasn't successfully deleted",
 			);
 
+			const spy = sinon.spy(fsp, "unlink");
+
+			const eslintOptions = {
+				overrideConfigFile: true,
+				cache: false,
+				cacheLocation: cacheFilePath,
+				overrideConfig: {
+					rules: {
+						"no-console": 0,
+						"no-unused-vars": 2,
+					},
+				},
+				cwd: path.join(fixtureDir, ".."),
+			};
+
+			eslint = new ESLint(eslintOptions);
+
+			const file = getFixturePath("cache/src", "test-file.js");
+
+			await eslint.lintFiles([file]);
+
+			assert(
+				spy.notCalled,
+				"Expected attempt to delete the cache was not made.",
+			);
+
+			spy.restore();
+		});
+
+		it("should throw an error if the cache file to be deleted exist on a read-only file system", async () => {
+			cacheFilePath = getFixturePath(".eslintcache");
+			fs.writeFileSync(cacheFilePath, "");
+
 			// Simulate a read-only file system.
-			sinon.stub(fsp, "unlink").rejects(
+			const unlinkStub = sinon.stub(fsp, "unlink").rejects(
 				Object.assign(new Error("read-only file system"), {
 					code: "EROFS",
 				}),
 			);
 
 			const eslintOptions = {
 				overrideConfigFile: true,
+				cache: false,
+				cacheLocation: cacheFilePath,
+				overrideConfig: {
+					rules: {
+						"no-console": 0,
+						"no-unused-vars": 2,
+					},
+				},
+				cwd: path.join(fixtureDir, ".."),
+			};
+
+			eslint = new ESLint(eslintOptions);
+
+			const file = getFixturePath("cache/src", "test-file.js");
+
+			await assert.rejects(
+				async () => await eslint.lintFiles([file]),
+				/read-only file system/u,
+			);
 
-				// specifying cache false the cache will be deleted
+			unlinkStub.restore();
+		});
+
+		it("should not throw an error if deleting fails but cache file no longer exists", async () => {
+			cacheFilePath = getFixturePath(".eslintcache");
+			fs.writeFileSync(cacheFilePath, "");
+
+			const unlinkStub = sinon.stub(fsp, "unlink").callsFake(() => {
+				doDelete(cacheFilePath);
+				throw new Error("Failed to delete cache file");
+			});
+
+			const eslintOptions = {
+				overrideConfigFile: true,
 				cache: false,
 				cacheLocation: cacheFilePath,
 				overrideConfig: {
@@ -12540,10 +12605,9 @@ describe("ESLint", () => {
 
 			await eslint.lintFiles([file]);
 
-			assert(
-				fsp.unlink.calledWithExactly(cacheFilePath),
-				"Expected attempt to delete the cache was not made.",
-			);
+			assert(unlinkStub.calledWithExactly(cacheFilePath));
+
+			unlinkStub.restore();
 		});
 
 		it("should store in the cache a file that has lint messages and a file that doesn't have lint messages", async () => {
