v8r 4.2.0 → 4.2.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 📦 [4.2.1](https://www.npmjs.com/package/v8r/v/4.2.1) - 2024-12-14
+
+* Upgrade to flat-cache 6.
+  This release revamps how cache is stored and invalidated internally
+  but should have no user-visible impact
+
 ## 📦 [4.2.0](https://www.npmjs.com/package/v8r/v/4.2.0) - 2024-10-24
 
 * Add `V8R_CONFIG_FILE` environment variable.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "v8r",
-  "version": "4.2.0",
+  "version": "4.2.1",
   "description": "A command-line JSON, YAML and TOML validator that's on your wavelength",
   "scripts": {
     "test": "V8R_CACHE_NAME=v8r-test c8 --reporter=text mocha \"src/**/*.spec.js\"",
@@ -33,7 +33,7 @@
     "chalk": "^5.0.0",
     "cosmiconfig": "^9.0.0",
     "decamelize": "^6.0.0",
-    "flat-cache": "^5.0.0",
+    "flat-cache": "^6.1.4",
     "glob": "^10.1.0",
     "global-agent": "^3.0.0",
     "got": "^13.0.0",
@@ -51,7 +51,7 @@
     "eslint-plugin-jsdoc": "^50.2.2",
     "eslint-plugin-mocha": "^10.0.3",
     "eslint-plugin-prettier": "^5.0.0",
-    "mocha": "^10.7.3",
+    "mocha": "^11.0.1",
     "mock-cwd": "^1.0.0",
     "nock": "^13.0.4",
     "prettier": "^3.0.0",

package/src/cache.js

@@ -3,28 +3,13 @@ import logger from "./logger.js";
 import { parseSchema } from "./parser.js";
 
 class Cache {
-  constructor(flatCache, ttl) {
+  constructor(flatCache) {
     this.cache = flatCache;
-    this.ttl = ttl;
+    this.ttl = this.cache._cache.ttl || 0;
     this.callCounter = {};
     this.callLimit = 10;
   }
 
-  expire() {
-    Object.entries(this.cache.all()).forEach(
-      function ([url, cachedResponse]) {
-        if (!("timestamp" in cachedResponse) || !("body" in cachedResponse)) {
-          logger.debug(`Cache error: deleting malformed response`);
-          this.cache.removeKey(url);
-        } else if (Date.now() > cachedResponse.timestamp + this.ttl) {
-          logger.debug(`Cache stale: deleting cached response from ${url}`);
-          this.cache.removeKey(url);
-        }
-        this.cache.save(true);
-      }.bind(this),
-    );
-  }
-
   limitDepth(url) {
     /*
     It is possible to create cyclic dependencies with external references
@@ -51,7 +36,6 @@ class Cache {
 
   async fetch(url) {
     this.limitDepth(url);
-    this.expire();
     const cachedResponse = this.cache.getKey(url);
     if (cachedResponse !== undefined) {
       logger.debug(`Cache hit: using cached response from ${url}`);
@@ -63,7 +47,7 @@ class Cache {
       const resp = await got(url);
       const parsedBody = parseSchema(resp.body, url);
       if (this.ttl > 0) {
-        this.cache.setKey(url, { timestamp: Date.now(), body: parsedBody });
+        this.cache.setKey(url, { body: parsedBody });
         this.cache.save(true);
       }
       return parsedBody;

package/src/cli.js

@@ -1,7 +1,7 @@
 import fs from "node:fs";
 import os from "node:os";
 import path from "node:path";
-import flatCache from "flat-cache";
+import { FlatCache } from "flat-cache";
 import isUrl from "is-url";
 import { validate } from "./ajv.js";
 import { bootstrap } from "./bootstrap.js";
@@ -27,11 +27,15 @@ function secondsToMilliseconds(seconds) {
   return seconds * 1000;
 }
 
-function getFlatCache() {
+function getFlatCache(ttl) {
+  let cache;
   if (process.env.V8R_CACHE_NAME) {
-    return flatCache.load(process.env.V8R_CACHE_NAME);
+    cache = new FlatCache({ cacheId: process.env.V8R_CACHE_NAME, ttl: ttl });
+  } else {
+    cache = new FlatCache({ cacheId: "v8rv2", cacheDir: CACHE_DIR, ttl: ttl });
   }
-  return flatCache.load("v8r", CACHE_DIR);
+  cache.load();
+  return cache;
 }
 
 async function validateDocument(
@@ -180,7 +184,7 @@ function Validator() {
     filenames.sort((a, b) => a.localeCompare(b));
 
     const ttl = secondsToMilliseconds(config.cacheTtl || 0);
-    const cache = new Cache(getFlatCache(), ttl);
+    const cache = new Cache(getFlatCache(ttl));
 
     let results = [];
     for (const filename of filenames) {

package/src/test-helpers.js

@@ -1,4 +1,4 @@
-import flatCache from "flat-cache";
+import { clearCacheById } from "flat-cache";
 import logger from "./logger.js";
 
 const origWriteOut = logger.writeOut;
@@ -7,7 +7,7 @@ const testCacheName = process.env.V8R_CACHE_NAME;
 const env = process.env;
 
 function setUp() {
-  flatCache.clearCacheById(testCacheName);
+  clearCacheById(testCacheName);
   logger.resetStdout();
   logger.resetStderr();
   logger.writeOut = function () {};
@@ -16,7 +16,7 @@ function setUp() {
 }
 
 function tearDown() {
-  flatCache.clearCacheById(testCacheName);
+  clearCacheById(testCacheName);
   logger.resetStdout();
   logger.resetStderr();
   logger.writeOut = origWriteOut;