file-entry-cache - feat: adding in key as absolute path (#1394)

* file-entry-cache - feat: adding in keyAsAbsolutePath

* updating tests

* moving to useAbsolutePathAsKey

* updating tests

Author: jaredwray

packages/file-entry-cache/src/index.ts

@@ -36,6 +36,8 @@ export type FileEntryCacheOptions = {
 	cwd?: string;
 	/** Restrict file access to within cwd boundaries (default: true) */
 	strictPaths?: boolean;
+	/** Whether to use absolute path as cache key (default: false) */
+	useAbsolutePathAsKey?: boolean;
 	/** Logger instance for logging (default: undefined) */
 	logger?: ILogger;
 	/** Options for the underlying flat cache */
@@ -147,6 +149,7 @@ export class FileEntryCache {
 	private _cwd: string = process.cwd();
 	private _strictPaths = false;
 	private _logger?: ILogger;
+	private _useAbsolutePathAsKey = false;
 
 	/**
 	 * Create a new FileEntryCache instance
@@ -173,6 +176,10 @@ export class FileEntryCache {
 			this._strictPaths = options.strictPaths;
 		}
 
+		if (options?.useAbsolutePathAsKey !== undefined) {
+			this._useAbsolutePathAsKey = options.useAbsolutePathAsKey;
+		}
+
 		if (options?.logger) {
 			this._logger = options.logger;
 		}
@@ -274,6 +281,22 @@ export class FileEntryCache {
 		this._strictPaths = value;
 	}
 
+	/**
+	 * Get whether to use absolute path as cache key
+	 * @returns {boolean} Whether cache keys use absolute paths (default: false)
+	 */
+	public get useAbsolutePathAsKey(): boolean {
+		return this._useAbsolutePathAsKey;
+	}
+
+	/**
+	 * Set whether to use absolute path as cache key
+	 * @param {boolean} value - The value to set
+	 */
+	public set useAbsolutePathAsKey(value: boolean) {
+		this._useAbsolutePathAsKey = value;
+	}
+
 	/**
 	 * Given a buffer, calculate md5 hash of its content.
 	 * @method getHash
@@ -291,7 +314,12 @@ export class FileEntryCache {
 	 * @return {String}
 	 */
 	public createFileKey(filePath: string): string {
-		const result = filePath;
+		let result = filePath;
+
+		if (this._useAbsolutePathAsKey && this.isRelativePath(filePath)) {
+			result = this.getAbsolutePathWithCwd(filePath, this._cwd);
+		}
+
 		return result;
 	}
 

packages/file-entry-cache/test/cwd.test.ts

@@ -60,6 +60,8 @@ describe("cwd functionality", () => {
 			testBaseDir,
 		);
 
+		cache.useAbsolutePathAsKey = false;
+
 		// Get file descriptor using relative path
 		const descriptor = cache.getFileDescriptor("src/index.js");
 

packages/file-entry-cache/test/file-rename.test.ts

@@ -48,6 +48,8 @@ describe("file-rename with cwd", () => {
 			originalPath, // cwd set to the unique folder
 		);
 
+		cache1.useAbsolutePathAsKey = false;
+
 		// Step 3: Get file descriptor using relative path
 		const descriptor1 = cache1.getFileDescriptor(testFileName);
 
@@ -140,6 +142,8 @@ describe("file-rename with cwd", () => {
 			originalPath,
 		);
 
+		cache1.useAbsolutePathAsKey = false;
+
 		// Process all files
 		files.forEach((file) => {
 			const desc = cache1.getFileDescriptor(file.name);
@@ -163,6 +167,8 @@ describe("file-rename with cwd", () => {
 			renamedPath,
 		);
 
+		cache2.useAbsolutePathAsKey = false;
+
 		// Verify all files are still cached and unchanged
 		files.forEach((file) => {
 			const desc = cache2.getFileDescriptor(file.name);

packages/file-entry-cache/test/index.test.ts

@@ -127,6 +127,7 @@ describe("file-entry-cache with options", () => {
 		fs.writeFileSync(testFile, "initial content");
 
 		const fileEntryCache = new FileEntryCache({
+			// @ts-expect-error as test
 			logger,
 			useCheckSum: true,
 		});
@@ -223,6 +224,7 @@ describe("file-entry-cache with options", () => {
 		fs.writeFileSync(testFile, "initial content");
 
 		const fileEntryCache = new FileEntryCache({
+			// @ts-expect-error
 			logger,
 			useCheckSum: false, // Disable checksum to use mtime
 		});
@@ -720,6 +722,7 @@ describe("normalizeEntries()", () => {
 	test("should return all entries", () => {
 		const fileEntryCache = new FileEntryCache({
 			useCheckSum: true,
+			useAbsolutePathAsKey: false,
 		});
 		fileEntryCache.getFileDescriptor(`./${fileCacheName}/test1.txt`);
 		fileEntryCache.getFileDescriptor(`./${fileCacheName}/test2.txt`);
@@ -906,7 +909,9 @@ describe("getUpdatedFiles()", () => {
 	});
 
 	test("should return empty array on get updated files", () => {
-		const fileEntryCache = new FileEntryCache();
+		const fileEntryCache = new FileEntryCache({
+			useAbsolutePathAsKey: false,
+		});
 		const files = [
 			`./${fileCacheName}/test1.txt`,
 			`./${fileCacheName}/test2.txt`,
@@ -920,7 +925,9 @@ describe("getUpdatedFiles()", () => {
 	});
 
 	test("should return updated files if one is updated", () => {
-		const fileEntryCache = new FileEntryCache();
+		const fileEntryCache = new FileEntryCache({
+			useAbsolutePathAsKey: false,
+		});
 		const files = [
 			`./${fileCacheName}/test1.txt`,
 			`./${fileCacheName}/test2.txt`,
@@ -1041,7 +1048,9 @@ describe("getFileDescriptorsByPath()", () => {
 	});
 
 	test("should return an array of file descriptors", () => {
-		const fileEntryCache = new FileEntryCache();
+		const fileEntryCache = new FileEntryCache({
+			useAbsolutePathAsKey: false,
+		});
 		fileEntryCache.getFileDescriptor(`./${fileCacheName}/test1.txt`);
 		fileEntryCache.getFileDescriptor(`./${fileCacheName}/test2.txt`);
 		const fileDescriptors = fileEntryCache.getFileDescriptorsByPath(

packages/file-entry-cache/test/relative-eslint.test.ts

@@ -1,7 +1,10 @@
 import fs from "node:fs";
 import path from "node:path";
 import { describe, expect, test } from "vitest";
-import fileEntryCache from "../src/index.js";
+import fileEntryCache, {
+	FileEntryCache,
+	type FileEntryCacheOptions,
+} from "../src/index.js";
 
 describe("eslint tests scenarios", () => {
 	test("relative pathing works on files and cache", () => {
@@ -18,6 +21,10 @@ describe("eslint tests scenarios", () => {
 			path.resolve("./src"),
 		);
 
+		if (cache.useAbsolutePathAsKey) {
+			cache.useAbsolutePathAsKey = false;
+		}
+
 		const indexDescriptor1 = cache.getFileDescriptor(file);
 
 		expect(indexDescriptor1.changed).toBe(true);
@@ -72,4 +79,36 @@ describe("eslint tests scenarios", () => {
 			force: true,
 		});
 	});
+	test("Need to use the cache directory as the cwd and use absolute path key", () => {
+		const cacheDirectory = "./.cache";
+		const cacheId = ".eslintcache-2020111";
+		const file = "../src/index.ts";
+		const useCheckSum = true;
+		const useAbsolutePathAsKey = true;
+		const cwd = cacheDirectory;
+
+		const options: FileEntryCacheOptions = {
+			useCheckSum,
+			useAbsolutePathAsKey,
+			cwd,
+			cache: {
+				cacheId,
+				cacheDir: cacheDirectory,
+			},
+		};
+
+		const cache = new FileEntryCache(options);
+
+		const fileDescriptor = cache.getFileDescriptor(file);
+
+		expect(fileDescriptor.changed).toBe(true);
+		expect(fileDescriptor.meta.hash).toBeDefined();
+
+		cache.reconcile();
+
+		const fileDescriptor2 = cache.getFileDescriptor(file);
+
+		expect(fileDescriptor2.changed).toBe(false);
+		expect(fileDescriptor2.meta.hash).toBeDefined();
+	});
 });