Merge branch 'main' into chore/dotnet8-support

readmeio · Nov 15, 2024 · 31c6be4 · 31c6be4
2 parents 749b349 + 42a610e
commit 31c6be4
Show file tree

Hide file tree

Showing 11 changed files with 485 additions and 619 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/node/package.json b/packages/node/package.json
@@ -27,7 +27,7 @@
   "dependencies": {
     "content-type": "^1.0.5",
     "find-cache-dir": "^3.3.2",
-    "flat-cache": "^3.0.4",
+    "flat-cache": "^6.1.1",
     "lodash": "^4.17.15",
     "ssri": "^12.0.0",
     "timeout-signal": "^1.1.0",

diff --git a/packages/node/src/lib/get-project-base-url.ts b/packages/node/src/lib/get-project-base-url.ts
@@ -1,14 +1,16 @@
 import crypto from 'crypto';
 
 import findCacheDir from 'find-cache-dir';
-import flatCache from 'flat-cache';
+import { FlatCache } from 'flat-cache';
 import timeoutSignal from 'timeout-signal';
 
 import pkg from '../../package.json';
 import config from '../config';
 
 import { logger } from './logger';
 
+export const cache = new FlatCache();
+
 export function getCache(readmeApiKey: string) {
   const encodedApiKey = Buffer.from(`${readmeApiKey}:`).toString('base64');
   const cacheDir = findCacheDir({ name: pkg.name, create: true });
@@ -18,16 +20,16 @@ export function getCache(readmeApiKey: string) {
   // automatically get refreshed when the package is updated/installed.
   const cacheKey = `${pkg.name}-${pkg.version}-${fsSafeApikey}`;
 
-  return flatCache.load(cacheKey, cacheDir);
+  return cache.load(cacheKey, cacheDir);
 }
 
 export async function getProjectBaseUrl(readmeApiKey: string, requestTimeout = config.timeout): Promise<string> {
   const encodedApiKey = Buffer.from(`${readmeApiKey}:`).toString('base64');
 
-  const cache = getCache(readmeApiKey);
+  getCache(readmeApiKey);
   // Does the cache exist? If it doesn't, let's fill it. If it does, let's see if it's stale. Caches should have a TTL
   // of 1 day.
-  const lastUpdated = cache.getKey('lastUpdated');
+  const lastUpdated = cache.getKey<number>('lastUpdated');
 
   if (
     lastUpdated === undefined ||
@@ -76,7 +78,7 @@ export async function getProjectBaseUrl(readmeApiKey: string, requestTimeout = c
 
     return baseUrl;
   }
-  const cachedBaseUrl = cache.getKey('baseUrl');
+  const cachedBaseUrl = cache.getKey<string>('baseUrl');
   logger.verbose({ message: 'Retrieved baseUrl from cache.', args: { baseUrl: cachedBaseUrl } });
   return cachedBaseUrl;
 }
diff --git a/packages/node/test/index.test.ts b/packages/node/test/index.test.ts
@@ -15,7 +15,7 @@ import { describe, afterAll, beforeEach, afterEach, expect, it } from 'vitest';
 import pkg from '../package.json';
 import * as readmeio from '../src';
 import config from '../src/config';
-import { getCache } from '../src/lib/get-project-base-url';
+import { getCache, cache } from '../src/lib/get-project-base-url';
 import { setBackoff } from '../src/lib/metrics-log';
 
 import getReadMeApiMock from './helpers/getReadMeApiMock';
@@ -60,7 +60,7 @@ function doMetricsHeadersMatch(headers: Headers) {
 describe('#metrics', function () {
   beforeEach(function () {
     server.listen();
-    const cache = getCache(apiKey);
+    getCache(apiKey);
 
     cache.setKey('lastUpdated', Date.now());
     cache.setKey('baseUrl', 'https://docs.example.com');
@@ -69,7 +69,7 @@ describe('#metrics', function () {
 
   afterEach(function () {
     server.resetHandlers();
-    getCache(apiKey).destroy();
+    cache.destroy();
   });
 
   // Close server after all tests
@@ -146,7 +146,7 @@ describe('#metrics', function () {
       app = express();
       app.use((req, res, next) => {
         const logId = readmeio.log(apiKey, req, res, incomingGroup, { logger: mockLogger });
-        res.setHeader('x-log-id', logId);
+        res.setHeader('x-log-id', logId!);
         return next();
       });
       app.get('/test', (req, res) => res.sendStatus(200));
@@ -531,7 +531,7 @@ describe('#metrics', function () {
     it('should fetch the `baseLogUrl` if not passed', function () {
       expect.assertions(1);
       // Invalidating the cache so we do a fetch from the API
-      const cache = getCache(apiKey);
+      getCache(apiKey);
       const lastUpdated = new Date();
       lastUpdated.setDate(lastUpdated.getDate() - 2);
       cache.setKey('lastUpdated', lastUpdated.getTime());

diff --git a/packages/node/test/lib/get-project-base-url.test.ts b/packages/node/test/lib/get-project-base-url.test.ts
@@ -4,7 +4,7 @@ import { describe, beforeAll, afterAll, afterEach, expect, it } from 'vitest';
 
 import { getProjectBaseUrl } from '../../src';
 import config from '../../src/config';
-import { getCache } from '../../src/lib/get-project-base-url';
+import { getCache, cache } from '../../src/lib/get-project-base-url';
 import getReadMeApiMock from '../helpers/getReadMeApiMock';
 
 const apiKey = 'mockReadMeApiKey';
@@ -15,7 +15,7 @@ const restHandlers = [getReadMeApiMock(baseLogUrl)];
 const server = setupServer(...restHandlers);
 
 function hydrateCache(lastUpdated: number) {
-  const cache = getCache(apiKey);
+  getCache(apiKey);
 
   cache.setKey('lastUpdated', lastUpdated);
   cache.setKey('baseUrl', baseLogUrl);
@@ -30,7 +30,8 @@ describe('get-project-base-url', function () {
   afterEach(function () {
     server.resetHandlers();
 
-    getCache(apiKey).destroy();
+    getCache(apiKey);
+    cache.destroy();
   });
 
   //  Close server after all tests
@@ -40,26 +41,26 @@ describe('get-project-base-url', function () {
 
   it('should not call the API for project data if the cache is fresh', async function () {
     await getProjectBaseUrl(apiKey, 2000);
-    expect(getCache(apiKey).getKey('baseUrl')).toStrictEqual(baseLogUrl);
-    const lastUpdated = getCache(apiKey).getKey('lastUpdated');
+    expect(cache.getKey('baseUrl')).toStrictEqual(baseLogUrl);
+    const lastUpdated = cache.getKey('lastUpdated');
     await getProjectBaseUrl(apiKey, 2000);
-    expect(getCache(apiKey).getKey('lastUpdated')).toStrictEqual(lastUpdated);
+    expect(cache.getKey('lastUpdated')).toStrictEqual(lastUpdated);
   });
 
   it('should populate the cache if not present', async function () {
     await getProjectBaseUrl(apiKey, 2000);
-    expect(getCache(apiKey).getKey('baseUrl')).toStrictEqual(baseLogUrl);
+    expect(cache.getKey('baseUrl')).toStrictEqual(baseLogUrl);
   });
 
   it('should refresh the cache if stale', async function () {
     // Hydrate and postdate the cache to two days ago so it'll be seen as stale.
     hydrateCache(Math.round(Date.now() / 1000 - 86400 * 2));
-    expect(getCache(apiKey).getKey('baseUrl')).toStrictEqual(baseLogUrl);
+    expect(cache.getKey('baseUrl')).toStrictEqual(baseLogUrl);
 
-    const lastUpdated = getCache(apiKey).getKey('lastUpdated');
+    const lastUpdated = cache.getKey('lastUpdated');
     await getProjectBaseUrl(apiKey, 2000);
-    expect(getCache(apiKey).getKey('baseUrl')).toStrictEqual(baseLogUrl);
-    expect(getCache(apiKey).getKey('lastUpdated')).not.toStrictEqual(lastUpdated);
+    expect(cache.getKey('baseUrl')).toStrictEqual(baseLogUrl);
+    expect(cache.getKey('lastUpdated')).not.toStrictEqual(lastUpdated);
   });
 
   it('should temporarily set baseUrl to null if the call to the ReadMe API fails for whatever reason', async function () {
@@ -80,6 +81,6 @@ describe('get-project-base-url', function () {
     );
 
     await getProjectBaseUrl(apiKey, 2000);
-    expect(getCache(apiKey).getKey('baseUrl')).toBeNull();
+    expect(cache.getKey('baseUrl')).toBeNull();
   });
 });