feat: implement caching results feature (#75)

* feat: implement caching results feature

* test: add cache tests

Author: lightnet328

package.json

@@ -20,7 +20,9 @@
     "prepublish": "npm run build",
     "build": "tsc",
     "lint": "eslint src/**/*.ts --fix --cache",
-    "test": "jest"
+    "pretest": "rimraf .test-cache",
+    "test": "jest",
+    "posttest": "rimraf .test-cache"
   },
   "bin": {
     "extract-react-intl-messages": "dist/cli.js",
@@ -41,6 +43,7 @@
   "dependencies": {
     "@babel/core": "^7.9.0",
     "babel-plugin-react-intl": "^7.0.0",
+    "file-entry-cache": "^5.0.1",
     "flat": "^5.0.0",
     "glob": "^7.1.6",
     "js-yaml": "^3.13.1",
@@ -61,6 +64,7 @@
     "@babel/preset-env": "^7.9.0",
     "@babel/preset-flow": "^7.9.0",
     "@babel/preset-react": "^7.9.1",
+    "@types/file-entry-cache": "^5.0.0",
     "@types/flat": "^5.0.0",
     "@types/glob": "^7.1.1",
     "@types/jest": "^25.1.4",
@@ -81,6 +85,7 @@
     "prettier": "^2.0.2",
     "react": "^16.13.1",
     "react-intl": "^4.2.2",
+    "rimraf": "^3.0.2",
     "temp-write": "^4.0.0",
     "tempy": "^0.5.0",
     "ts-jest": "^25.2.1",

src/cli.ts

@@ -15,6 +15,8 @@ const cli = meow(
   -d, --default-locale    default locale
   --overwriteDefault      [default: true]
   --flat                  json [default: true] | yaml [default: false]
+  --cache                 [default: false]
+  --cacheLocation         [default: .extract-react-intl-messages-cache]
 
   Example
   $ extract-messages --locales=ja,en --output app/translations 'app/**/*.js'

src/extract-react-intl/index.ts

@@ -11,6 +11,7 @@ import {
 } from '@babel/core'
 import readBabelrcUp from 'read-babelrc-up'
 import babelPluginReactIntl from 'babel-plugin-react-intl'
+import fileEntryCache, { FileDescriptor } from 'file-entry-cache'
 
 type LocaleMap = Record<string, Record<string, {}>>
 
@@ -67,6 +68,8 @@ type Options = {
   [key: string]: unknown
   defaultLocale?: string
   cwd?: string
+  cache?: boolean
+  cacheLocation?: string
   withDescriptions?: boolean
 }
 
@@ -76,6 +79,17 @@ type Message = {
   description: string
 }
 
+type CacheData = {
+  defaultLocale: string
+  localeMap: LocaleMap
+}
+
+type File = FileDescriptor & {
+  meta: {
+    data: CacheData
+  }
+}
+
 // eslint-disable-next-line max-lines-per-function
 export default async (
   locales: string[],
@@ -84,6 +98,8 @@ export default async (
     defaultLocale = 'en',
     withDescriptions = false,
     cwd = process.cwd(),
+    cache: cacheEnabled = false,
+    cacheLocation = '.extract-react-intl-messages-cache',
     ...pluginOptions
   }: Options = {}
 ) => {
@@ -122,6 +138,19 @@ export default async (
     })
   }
 
+  const files: string[] = await pify(glob)(pattern)
+  if (files.length === 0) {
+    throw new Error(`File not found (${pattern})`)
+  }
+
+  const cachePath = path.resolve(cacheLocation)
+  const cacheDirname = path.dirname(cachePath)
+  const cacheBasename = path.basename(cachePath)
+
+  const cache = cacheEnabled
+    ? fileEntryCache.create(cacheBasename, cacheDirname)
+    : null
+
   const extractFromFile = async (file: string) => {
     const babelOpts = {
       presets: resolvePresets(presets, babelrcDir),
@@ -131,7 +160,6 @@ export default async (
     const localeObj = localeMap(locales)
     const result = metadata['react-intl'].messages as Message[]
     for (const { id, defaultMessage, description } of result) {
-      // eslint-disable-next-line no-unused-vars
       for (const locale of locales) {
         const message = defaultLocale === locale ? defaultMessage : ''
         localeObj[locale][id] = withDescriptions
@@ -142,10 +170,36 @@ export default async (
     return localeObj
   }
 
-  const files: string[] = await pify(glob)(pattern)
-  if (files.length === 0) {
-    throw new Error(`File not found (${pattern})`)
+  const extractFromCache = async (file: string) => {
+    if (cache === null) {
+      return extractFromFile(file)
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+    const cachedLocaleObj = cache?.getFileDescriptor(file) as File | undefined
+    const changed = cachedLocaleObj?.changed
+    const data = cachedLocaleObj?.meta.data
+
+    if (changed === false && data?.defaultLocale === defaultLocale) {
+      return data.localeMap
+    }
+
+    const localeObj = await extractFromFile(file)
+
+    if (cachedLocaleObj) {
+      cachedLocaleObj.meta.data = { defaultLocale, localeMap: localeObj }
+    }
+
+    return localeObj
   }
-  const arr = await Promise.all(files.map(extractFromFile))
+
+  const extract = cacheEnabled ? extractFromCache : extractFromFile
+
+  const arr = await Promise.all(files.map(extract))
+
+  if (cache) {
+    cache.reconcile()
+  }
+
   return arr.reduce((h, obj) => merge(h, obj), localeMap(locales))
 }

src/extract-react-intl/test/__snapshots__/test.ts.snap

@@ -31,6 +31,52 @@ Object {
 }
 `;
 
+exports[`extract from file by enabling cache and extract from cache 1`] = `
+Object {
+  "en": Object {
+    "components.App.1248161314": "Submit button",
+    "components.App.hello": "hello",
+    "components.App.world": "world",
+    "components/Greeting/welcome": "
+    Welcome {name}, you have received {unreadCount, plural,
+      =0 {no new messages}
+      one {{formattedUnreadCount} new message}
+      other {{formattedUnreadCount} new messages}
+    } since {formattedLastLoginTime}.
+    ",
+  },
+  "ja": Object {
+    "components.App.1248161314": "",
+    "components.App.hello": "",
+    "components.App.world": "",
+    "components/Greeting/welcome": "",
+  },
+}
+`;
+
+exports[`extract from file by enabling cache and extract from cache 2`] = `
+Object {
+  "en": Object {
+    "components.App.1248161314": "Submit button",
+    "components.App.hello": "hello",
+    "components.App.world": "world",
+    "components/Greeting/welcome": "
+    Welcome {name}, you have received {unreadCount, plural,
+      =0 {no new messages}
+      one {{formattedUnreadCount} new message}
+      other {{formattedUnreadCount} new messages}
+    } since {formattedLastLoginTime}.
+    ",
+  },
+  "ja": Object {
+    "components.App.1248161314": "",
+    "components.App.hello": "",
+    "components.App.world": "",
+    "components/Greeting/welcome": "",
+  },
+}
+`;
+
 exports[`extract from file with descriptions 1`] = `
 Object {
   "en": Object {

src/extract-react-intl/test/test.ts

@@ -13,6 +13,27 @@ test('extract from file', async () => {
   expect(x).toMatchSnapshot()
 })
 
+test('extract from file by enabling cache and extract from cache', async () => {
+  process.env.BABEL_ENV = 'react-intl'
+  const x = await m(locales, pattern, {
+    defaultLocale: 'en',
+    cwd: `${__dirname}/fixtures`,
+    extractFromFormatMessageCall: true,
+    cache: true,
+    cacheLocation: '.test-cache'
+  })
+  expect(x).toMatchSnapshot()
+
+  const y = await m(locales, pattern, {
+    defaultLocale: 'en',
+    cwd: `${__dirname}/fixtures`,
+    extractFromFormatMessageCall: true,
+    cache: true,
+    cacheLocation: '.test-cache'
+  })
+  expect(y).toMatchSnapshot()
+})
+
 // TODO: fix
 test.skip('babelrc path resolution', async () => {
   const x = await m(['en'], './extract-react-intl/test/resolution/**/*.js', {

yarn.lock

@@ -1165,6 +1165,13 @@
   resolved "https://registry.yarnpkg.com/@types/events/-/events-3.0.0.tgz#2862f3f58a9a7f7c3e78d79f130dd4d71c25c2a7"
   integrity sha512-EaObqwIvayI5a8dCzhFrjKzVwKLxjoG9T6Ppd5CEo07LRKfQ8Yokw54r5+Wq7FaBQ+yXRvQAYPrHwya1/UFt9g==
 
+"@types/file-entry-cache@^5.0.0":
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/@types/file-entry-cache/-/file-entry-cache-5.0.0.tgz#84dced293b3b80485afd454696eb4c420c7591ae"
+  integrity sha512-K1Q4O4PwDaMG3hOfvnWNtmjbUHHRkxeYfMlUCoT1abxeaYM0H8aDLE5wFcI29PNWhBdcES9VtACAMnAM8IerOQ==
+  dependencies:
+    "@types/node" "*"
+
 "@types/flat@^5.0.0":
   version "5.0.0"
   resolved "https://registry.yarnpkg.com/@types/flat/-/flat-5.0.0.tgz#de18742aea57ce3dd2c093c7d2ba8fd3a4135b53"
@@ -5262,7 +5269,7 @@ rimraf@2.6.3:
   dependencies:
     glob "^7.1.3"
 
-rimraf@^3.0.0:
+rimraf@^3.0.0, rimraf@^3.0.2:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a"
   integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==