Fixes #56 removes flat-cache

Author: zachleat

package.json

@@ -45,9 +45,9 @@
 		"prettier": "^3.3.3"
 	},
 	"dependencies": {
+		"@11ty/eleventy-utils": "^2.0.1",
 		"@rgrove/parse-xml": "^4.2.0",
-		"debug": "^4.3.7",
-		"flat-cache": "^6.1.1",
+		"debug": "^4.4.0",
 		"graceful-fs": "^4.2.11",
 		"p-queue": "6.6.2"
 	},

src/AssetCache.js

@@ -1,9 +1,10 @@
 const fs = require("graceful-fs");
 const path = require("path");
-const { create: FlatCacheCreate } = require("flat-cache");
 const { createHash } = require("crypto");
 const debugUtil = require("debug");
+const { DateCompare } = require("@11ty/eleventy-utils");
 
+const FileCache = require("./FileCache.js");
 const Sources = require("./Sources.js");
 const DirectoryManager = require("./DirectoryManager.js");
 
@@ -18,7 +19,7 @@ class AssetCache {
 	#cacheDirectory;
 	#cacheLocationDirty = false;
 	#directoryManager;
-	#rawContents = {}
+	#rawContents = {};
 
 	constructor(source, cacheDirectory, options = {}) {
 		if(!Sources.isValidSource(source)) {
@@ -173,10 +174,11 @@ class AssetCache {
 
 	get cache() {
 		if (!this.#cache || this.#cacheLocationDirty) {
-			let cache = FlatCacheCreate({
-				cacheId: this.cacheFilename,
-				cacheDir: this.rootDir,
+			let cache = new FileCache(this.cacheFilename, {
+				dir: this.rootDir
 			});
+			cache.setDryRun(this.options.dryRun);
+			cache.setDirectoryManager(this.#directoryManager);
 
 			this.#cache = cache;
 			this.#cacheLocationDirty = false;
@@ -185,24 +187,7 @@ class AssetCache {
 	}
 
 	getDurationMs(duration = "0s") {
-		let durationUnits = duration.slice(-1);
-		let durationMultiplier;
-		if (durationUnits === "s") {
-			durationMultiplier = 1;
-		} else if (durationUnits === "m") {
-			durationMultiplier = 60;
-		} else if (durationUnits === "h") {
-			durationMultiplier = 60 * 60;
-		} else if (durationUnits === "d") {
-			durationMultiplier = 60 * 60 * 24;
-		} else if (durationUnits === "w") {
-			durationMultiplier = 60 * 60 * 24 * 7;
-		} else if (durationUnits === "y") {
-			durationMultiplier = 60 * 60 * 24 * 365;
-		}
-
-		let durationValue = parseInt(duration.slice(0, duration.length - 1), 10);
-		return durationValue * durationMultiplier * 1000;
+		return DateCompare.getDurationMs(duration);
 	}
 
 	getCachedContentsPath(type = "buffer") {
@@ -263,8 +248,6 @@ class AssetCache {
 		// the contents must exist before the cache metadata are saved below
 		fs.writeFileSync(contentPath, contents);
 		debug(`Writing ${contentPath}`);
-
-		this.cache.save();
 	}
 
 	async #getCachedContents(type) {
@@ -335,27 +318,7 @@ class AssetCache {
 			return false;
 		}
 
-		// in the cache and no duration
-		if (!duration || duration === "*") {
-			// no duration specified (plugin default is 1d, but if this is falsy assume infinite)
-			// "*" is infinite duration
-			return true;
-		}
-
-		debug("Cache check for: %o %o (duration: %o)", this.hash, this.source, duration);
-		debug("Cache object: %o", this.cachedObject);
-
-		let compareDuration = this.getDurationMs(duration);
-		let expiration = this.cachedObject.cachedAt + compareDuration;
-		let expirationRelative = Math.abs(Date.now() - expiration);
-
-		if (expiration > Date.now()) {
-			debug("Cache okay, expires in %o s (%o)", expirationRelative / 1000, new Date(expiration));
-			return true;
-		}
-
-		debug("Cache expired %o s ago (%o)", expirationRelative / 1000, new Date(expiration));
-		return false;
+		return DateCompare.isTimestampWithinDuration(this.cachedObject.cachedAt, duration);
 	}
 
 	get cachedObject() {

src/DirectoryManager.js

@@ -1,7 +1,5 @@
 const fs = require("node:fs");
-const path = require("node:path");
-const debugUtil = require("debug");
-const debugAssets = debugUtil("Eleventy:Assets");
+const debug = require("debug")("Eleventy:Assets");
 
 class DirectoryManager {
   #dirs = new Set();
@@ -16,7 +14,7 @@ class DirectoryManager {
     }
 
     this.#dirs.add(dir);
-    debugAssets("[11ty/eleventy-fetch] Creating directory %o", dir);
+    debug("Creating directory %o", dir);
     fs.mkdirSync(dir, { recursive: true });
   }
 }

src/ExistsCache.js

@@ -0,0 +1,24 @@
+const fs = require("node:fs");
+// const debug = require("debug")("Eleventy:Assets");
+
+class ExistsCache {
+	#checks = new Map();
+	#count = 0;
+
+	set(target, value) {
+		this.#checks.set(target, Boolean(value));
+	}
+
+	exists(target) {
+		if(this.#checks.has(target)) {
+			return this.#checks.get(target);
+		}
+
+		let exists = fs.existsSync(target);
+		this.#count++;
+		this.#checks.set(target, exists);
+		return exists;
+	}
+}
+
+module.exports = ExistsCache;

src/FileCache.js

@@ -0,0 +1,83 @@
+const fs = require("node:fs");
+const path = require("node:path");
+
+const DirectoryManager = require("./DirectoryManager.js");
+const ExistsCache = require("./ExistsCache.js");
+
+let existsCache = new ExistsCache();
+
+class FileCache {
+	#directoryManager;
+	#data = {};
+	#dryRun = false;
+	#cacheDirectory = ".cache";
+	#counts = {
+		read: 0,
+		write: 0,
+	}
+
+	constructor(cacheId, options = {}) {
+		this.cacheId = cacheId;
+		if(options.dir) {
+			this.#cacheDirectory = options.dir;
+		}
+	}
+
+	setDryRun(val) {
+		this.#dryRun = Boolean(val);
+	}
+
+	setDirectoryManager(manager) {
+		this.#directoryManager = manager;
+	}
+
+	ensureDir() {
+		if (this.#dryRun || existsCache.exists(this.#cacheDirectory)) {
+			return;
+		}
+
+		if(!this.#directoryManager) {
+			// standalone fallback (for tests)
+			this.#directoryManager = new DirectoryManager();
+		}
+
+		this.#directoryManager.create(this.#cacheDirectory);
+	}
+
+	set(id, obj) {
+		if(this.#data[id] !== obj) {
+			this.#data[id] = obj;
+			this.save();
+		}
+	}
+
+	get fsPath() {
+		return path.join(this.#cacheDirectory, this.cacheId);
+	}
+
+	get(id) {
+		if(this.#data[id]) {
+			return this.#data[id];
+		}
+
+		if(!existsCache.exists(this.fsPath)) {
+			return;
+		}
+
+		this.#counts.read++;
+
+		let data = fs.readFileSync(this.fsPath, "utf8");
+		let json = JSON.parse(data);
+		this.#data[id] = json;
+		return json;
+	}
+
+	save() {
+		this.ensureDir(); // doesn’t add to counts (yet?)
+
+		this.#counts.write++;
+		fs.writeFileSync(this.fsPath, JSON.stringify(this.#data), "utf8");
+	}
+}
+
+module.exports = FileCache;