chore(gatsby): Convert cache.js to TypeScript (#20626)

jest.config.js

@@ -34,8 +34,7 @@ module.exports = {
     `__tests__/fixtures`,
   ],
   transform: {
-    "^.+\\.js$": `<rootDir>/jest-transformer.js`,
-    "^.+\\.tsx?$": `<rootDir>/jest-transformer.js`,
+    "^.+\\.[jt]sx?$": `<rootDir>/jest-transformer.js`,
   },
   moduleNameMapper: {
     "^highlight.js$": `<rootDir>/node_modules/highlight.js/lib/index.js`,

package.json

@@ -5,6 +5,7 @@
     "@babel/plugin-transform-typescript": "^7.7.4",
     "@babel/runtime": "^7.7.7",
     "@lerna/prompt": "3.18.5",
+    "@types/cache-manager": "^2.10.1",
     "@types/express": "^4.17.2",
     "@types/fs-extra": "^8.0.1",
     "@types/got": "^9.6.9",

packages/gatsby/src/utils/__tests__/cache.js → packages/gatsby/src/utils/__tests__/cache.ts

@@ -1,3 +1,7 @@
+import Cache from "../cache"
+import fs from "fs-extra"
+import manager from "cache-manager"
+
 const mockErrorValue = jest.fn()
 const mockResultValue = jest.fn()
 
@@ -6,10 +10,10 @@ jest.mock(`cache-manager`, () => {
     caching: jest.fn(),
     multiCaching: jest.fn(() => {
       return {
-        get: jest.fn((key, callback) => {
+        get: jest.fn((_key, callback) => {
           callback(mockErrorValue(), mockResultValue())
         }),
-        set: jest.fn((key, value, args, callback) => {
+        set: jest.fn((_key, _value, _args, callback) => {
           callback(mockErrorValue())
         }),
       }
@@ -21,16 +25,14 @@ jest.mock(`fs-extra`, () => {
     ensureDirSync: jest.fn(),
   }
 })
-const Cache = require(`../cache`)
-const fs = require(`fs-extra`)
-const manager = require(`cache-manager`)
 
 beforeEach(() => {
-  manager.caching.mockReset()
-  fs.ensureDirSync.mockReset()
+  ;(manager.caching as jest.Mock).mockReset()
+  ;(fs.ensureDirSync as jest.Mock).mockReset()
 })
 
-const getCache = (options = { name: `__test__` }) => new Cache(options).init()
+const getCache = (options = { name: `__test__` }): Cache =>
+  new Cache(options).init()
 
 describe(`cache`, () => {
   it(`it can be instantiated`, () => {
@@ -40,6 +42,8 @@ describe(`cache`, () => {
   it(`it can swap out cache store`, () => {
     const store = {
       custom: true,
+      get: jest.fn(),
+      set: jest.fn(),
     }
 
     new Cache({
@@ -96,14 +100,28 @@ describe(`cache`, () => {
     it(`both are promises`, () => {
       const cache = getCache()
 
-      const containsThenMethod = result =>
+      const containsThenMethod = (result): void =>
         expect(result).toEqual(
           expect.objectContaining({ then: expect.any(Function) })
         )
 
       containsThenMethod(cache.get(`a`))
       containsThenMethod(cache.set(`a`, `b`))
     })
+
+    it(`throws if set is called without initting`, () => {
+      const cache = new Cache({ name: `__test__` })
+      return expect(cache.set(`a`, `b`)).rejects.toThrowError(
+        `Cache wasn't initialised yet, please run the init method first`
+      )
+    })
+
+    it(`throws if get is called without initting`, () => {
+      const cache = new Cache({ name: `__test__` })
+      return expect(cache.get(`a`)).rejects.toThrowError(
+        `Cache wasn't initialised yet, please run the init method first`
+      )
+    })
   })
 
   describe(`set`, () => {
@@ -125,18 +143,17 @@ describe(`cache`, () => {
   describe(`get`, () => {
     it(`resolves to the found value`, () => {
       const cache = getCache()
-
       mockResultValue.mockReturnValueOnce(`result`)
 
-      return expect(cache.get()).resolves.toBe(`result`)
+      return expect(cache.get(``)).resolves.toBe(`result`)
     })
 
     it(`resolves to undefined on caching error`, () => {
       const cache = getCache()
 
       mockErrorValue.mockReturnValueOnce(true)
 
-      return expect(cache.get()).resolves.toBeUndefined()
+      return expect(cache.get(``)).resolves.toBeUndefined()
     })
   })
 })

packages/gatsby/src/utils/cache.ts

@@ -0,0 +1,83 @@
+import manager, { Store, StoreConfig, CachingConfig } from "cache-manager"
+import fs from "fs-extra"
+import fsStore from "cache-manager-fs-hash"
+import path from "path"
+
+const MAX_CACHE_SIZE = 250
+const TTL = Number.MAX_SAFE_INTEGER
+
+interface ICacheProperties {
+  name?: string
+  store?: Store
+}
+
+export default class Cache {
+  public name: string
+  public store: Store
+  public cache?: manager.Cache
+
+  constructor({ name = `db`, store = fsStore }: ICacheProperties = {}) {
+    this.name = name
+    this.store = store
+  }
+
+  get directory(): string {
+    return path.join(process.cwd(), `.cache/caches/${this.name}`)
+  }
+
+  init(): Cache {
+    fs.ensureDirSync(this.directory)
+
+    const configs: StoreConfig[] = [
+      {
+        store: `memory`,
+        max: MAX_CACHE_SIZE,
+        ttl: TTL,
+      },
+      {
+        store: this.store,
+        ttl: TTL,
+        options: {
+          path: this.directory,
+          ttl: TTL,
+        },
+      },
+    ]
+
+    const caches = configs.map(cache => manager.caching(cache))
+
+    this.cache = manager.multiCaching(caches)
+
+    return this
+  }
+
+  get<T = unknown>(key): Promise<T | undefined> {
+    return new Promise(resolve => {
+      if (!this.cache) {
+        throw new Error(
+          `Cache wasn't initialised yet, please run the init method first`
+        )
+      }
+      this.cache.get<T>(key, (err, res) => {
+        resolve(err ? undefined : res)
+      })
+    })
+  }
+
+  set<T>(
+    key: string,
+    value: T,
+    args: CachingConfig = { ttl: TTL }
+  ): Promise<T | undefined> {
+    return new Promise(resolve => {
+      if (!this.cache) {
+        throw new Error(
+          `Cache wasn't initialised yet, please run the init method first`
+        )
+      }
+      this.cache.set(key, value, args, err => {
+        resolve(err ? undefined : value)
+      })
+    })
+  }
+}

packages/gatsby/src/utils/get-cache.js

@@ -1,6 +1,6 @@
-const Cache = require(`./cache`)
+const Cache = require(`./cache`).default
 
-let caches = new Map()
+const caches = new Map()
 
 module.exports = function getCache(name) {
   let cache = caches.get(name)

tsconfig.json

@@ -1,5 +1,7 @@
 {
   "compilerOptions": {
+    "target": "ESNext",
+    "moduleResolution": "node",
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noImplicitReturns": true,

yarn.lock

@@ -3790,6 +3790,11 @@
     "@types/connect" "*"
     "@types/node" "*"
 
+"@types/cache-manager@^2.10.1":
+  version "2.10.1"
+  resolved "https://registry.yarnpkg.com/@types/cache-manager/-/cache-manager-2.10.1.tgz#c7bc354be7988659e139e10fc7bde4b221f7f128"
+  integrity sha512-oJhVIOeC8dX9RZ7OtEZvZ/6cHF5aQWoRcuJ7KwK3Xb69hIIdElpWzfJ35fOXvYOgoyRXA34jFrD8lqEjDWz37w==
+
 "@types/color-name@^1.1.1":
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/@types/color-name/-/color-name-1.1.1.tgz#1c1261bbeaa10a8055bbc5d8ab84b7b2afc846a0"