lib: add cache utility

nodejs · joyeecheung · Jun 1, 2018 · Mar 20, 2018 · Jan 30, 2018 · May 31, 2018
commit 3e614effe5e8ace69debcee9c926a4fe317efeaf
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ tmp
 coverage.lcov
 tmp-*
 .eslintcache
+.ncu
diff --git a/lib/cache.js b/lib/cache.js
@@ -0,0 +1,103 @@
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+const { writeJson, readJson, writeFile, readFile } = require('./file');
+
+function isAsync(fn) {
+  return fn[Symbol.toStringTag] === 'AsyncFunction';
+}
+
+class Cache {
+  constructor(dir) {
+    this.dir = dir || path.join(__dirname, '..', '.ncu', 'cache');
+    this.originals = {};
+    this.disabled = true;
+  }
+
+  disable() {
+    this.disabled = true;
+  }
+
+  enable() {
+    this.disabled = false;
+  }
+
+  getFilename(key, ext) {
+    return path.join(this.dir, key) + ext;
+  }
+
+  has(key, ext) {
+    if (this.disabled) {
+      return false;
+    }
+
+    return fs.existsSync(this.getFilename(key, ext));
+  }
+
+  get(key, ext) {
+    if (!this.has(key, ext)) {
+      return undefined;
+    }
+    if (ext === '.json') {
+      return readJson(this.getFilename(key, ext));
+    } else {
+      return readFile(this.getFilename(key, ext));
+    }
+  }
+
+  write(key, ext, content) {
+    if (this.disabled) {
+      return;
+    }
+    const filename = this.getFilename(key, ext);
+    if (ext === '.json') {
+      return writeJson(filename, content);
+    } else {
+      return writeFile(filename, content);
+    }
+  }
+
+  wrapAsync(original, identity) {
+    const cache = this;
+    return async function(...args) {
+      const { key, ext } = identity.call(this, ...args);
+      const cached = cache.get(key, ext);
+      if (cached) {
+        return cached;
+      }
+      const result = await original.call(this, ...args);
+      cache.write(key, ext, result);
+      return result;
+    };
+  }
+
+  wrapNormal(original, identity) {
+    const cache = this;
+    return function(...args) {
+      const { key, ext } = identity.call(this, ...args);
+      const cached = cache.get(key, ext);
+      if (cached) {
+        return cached;
+      }
+      const result = original.call(this, ...args);
+      cache.write(key, ext, result);
+      return result;
+    };
+  }
+
+  wrap(Class, identities) {
+    for (let method of Object.keys(identities)) {
+      const original = Class.prototype[method];
+      const identity = identities[method];
+      this.originals[method] = original;
+      if (isAsync(original)) {
+        Class.prototype[method] = this.wrapAsync(original, identity);
+      } else {
+        Class.prototype[method] = this.wrapNormal(original, identity);
+      }
+    }
+  }
+}
+
+module.exports = Cache;
diff --git a/test/common.js b/test/common.js
@@ -0,0 +1,24 @@
+'use strict';
+
+const path = require('path');
+const rimraf = require('rimraf');
+const mkdirp = require('mkdirp');
+const fs = require('fs');
+
+exports.tmpdir = {
+  get path() {
+    return path.join(__dirname, 'tmp');
+  },
+  refresh() {
+    rimraf.sync(this.path);
+    mkdirp.sync(this.path);
+  }
+};
+
+exports.copyShallow = function(src, dest) {
+  mkdirp.sync(dest);
+  const list = fs.readdirSync(src);
+  for (const file of list) {
+    fs.copyFileSync(path.join(src, file), path.join(dest, file));
+  }
+};
diff --git a/test/unit/cache.test.js b/test/unit/cache.test.js
@@ -0,0 +1,116 @@
+'use strict';
+
+const Cache = require('../../lib/cache');
+const { tmpdir } = require('../common');
+const path = require('path');
+const fs = require('fs');
+const assert = require('assert');
+
+describe('Cache', () => {
+  const syncResult = 'content in sync';
+  const asyncResult = {
+    results: 'content in async.json'
+  };
+
+  class CachedClass {
+    constructor(foo) {
+      this.foo = foo;
+      this.sync = 0;
+      this.async = 0;
+    }
+
+    cachedSyncMethod(...args) {
+      this.sync++;
+      return syncResult;
+    }
+
+    async cachedAsyncMethod(...args) {
+      this.async++;
+      const p = Promise.resolve(asyncResult);
+      const result = await p;  // make sure it's async
+      return result;
+    }
+
+    getCacheKey(prefix, ...args) {
+      return `${prefix}-${args.join('-')}-${this.foo}`;
+    }
+  }
+
+  tmpdir.refresh();
+  const cache = new Cache(tmpdir.path);
+  cache.wrap(CachedClass, {
+    cachedSyncMethod(...args) {
+      return { key: this.getCacheKey('sync', ...args), ext: '.txt' };
+    },
+    cachedAsyncMethod(...args) {
+      return { key: this.getCacheKey('async', ...args), ext: '.json' };
+    }
+  });
+
+  it('should cache sync results', () => {
+    tmpdir.refresh();
+    cache.enable();
+    const expected = syncResult;
+    const instance = new CachedClass('foo');
+    let actual = instance.cachedSyncMethod('test');
+    assert.strictEqual(instance.sync, 1);
+    assert.strictEqual(actual, expected);
+
+    let syncCache = path.join(tmpdir.path, 'sync-test-foo.txt');
+    let cached = fs.readFileSync(syncCache, 'utf8');
+    assert.strictEqual(cached, expected);
+
+    // Call it again
+    actual = instance.cachedSyncMethod('test');
+    assert.strictEqual(instance.sync, 1);
+    assert.strictEqual(actual, expected);
+
+    syncCache = path.join(tmpdir.path, 'sync-test-foo.txt');
+    cached = fs.readFileSync(syncCache, 'utf8');
+    assert.strictEqual(cached, expected);
+  });
+
+  it('should cache async results', async() => {
+    tmpdir.refresh();
+    cache.enable();
+    const expected = Object.assign({}, asyncResult);
+    const instance = new CachedClass('foo');
+    let actual = await instance.cachedAsyncMethod('test');
+    assert.strictEqual(instance.async, 1);
+    assert.deepStrictEqual(actual, expected);
+
+    let asyncCache = path.join(tmpdir.path, 'async-test-foo.json');
+    let cached = JSON.parse(fs.readFileSync(asyncCache, 'utf8'));
+    assert.deepStrictEqual(cached, expected);
+
+    // Call it again
+    actual = await instance.cachedAsyncMethod('test');
+    assert.strictEqual(instance.async, 1);
+    assert.deepStrictEqual(actual, expected);
+
+    asyncCache = path.join(tmpdir.path, 'async-test-foo.json');
+    cached = JSON.parse(fs.readFileSync(asyncCache, 'utf8'));
+    assert.deepStrictEqual(cached, expected);
+  });
+
+  it('should not cache if disabled', async() => {
+    tmpdir.refresh();
+    cache.disable();
+    const expected = Object.assign({}, asyncResult);
+    const instance = new CachedClass('foo');
+    let actual = await instance.cachedAsyncMethod('test');
+    assert.strictEqual(instance.async, 1);
+    assert.deepStrictEqual(actual, expected);
+
+    let list = fs.readdirSync(tmpdir.path);
+    assert.deepStrictEqual(list, []);
+
+    // Call it again
+    actual = await instance.cachedAsyncMethod('test');
+    assert.strictEqual(instance.async, 2);
+    assert.deepStrictEqual(actual, expected);
+
+    list = fs.readdirSync(tmpdir.path);
+    assert.deepStrictEqual(list, []);
+  });
+});
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,3 +6,4 @@ tmp @@
     coverage.lcov
     tmp-*
     .eslintcache
+    .ncu