feat(enhance_cache): bring up [locals]

lib/hexo/default_config.js

@@ -68,6 +68,9 @@ module.exports = {
   ignore: [],
 
   // Category & Tag
-  meta_generator: true
+  meta_generator: true,
+
+  // Enhance Cache
+  enhance_cache: false
 };
 

lib/plugins/helper/partial.js

@@ -2,6 +2,9 @@
 
 const { dirname, join } = require('path');
 
+const { createHash } = require('crypto');
+const md5 = (str) => createHash('md5').update(str).digest('hex');
+
 module.exports = ctx => function partial(name, locals, options = {}) {
   if (typeof name !== 'string') throw new TypeError('name must be a string!');
 
@@ -26,10 +29,25 @@ module.exports = ctx => function partial(name, locals, options = {}) {
   viewLocals.layout = false;
 
   if (cache) {
+    // fragment_cache for the partial is enabled no matter if enhance_cache is enabled
+    /*
+     * The specific { cache: true } or { cache: cacheId } should have higher priority.
+     * It means theme developer want to cache this partial even the locals has changed.
+     */
     const cacheId = typeof cache === 'string' ? cache : view.path;
 
+    return this.fragment_cache(cacheId, () => view.renderSync(viewLocals));
+  } else if (ctx.config.enhance_cache && cache !== false) {
+    // enhance_cache is enabled while fragment_cache for the partial is not disabled
+    /*
+     * If a theme developer doesn't want caching, they might use { cache: false }.
+     * We should stick to current behavior even if user has enabled enhance_cache.
+     */
+    const cacheId = typeof cache === 'string' ? cache : [view.path, md5(JSON.stringify(locals))].join('-');
+
     return this.fragment_cache(cacheId, () => view.renderSync(viewLocals));
   }
 
+  // render directly since neither enhance_cache & fragment_cache is enabled.
   return view.renderSync(viewLocals);
 };

test/scripts/helpers/partial.js

@@ -60,13 +60,6 @@ describe('partial', () => {
     partial('test', {foo: 'bar'}).should.eql('bar');
   });
 
-  it('cache', () => {
-    hexo.theme.setView('test.swig', '{{ foo }}');
-
-    partial('test', {foo: 'bar'}, {cache: true}).should.eql('bar');
-    partial('test', {}, {cache: true}).should.eql('bar');
-  });
-
   it('only', () => {
     hexo.theme.setView('test.swig', '{{ foo }}{{ bar }}');
 
@@ -94,4 +87,27 @@ describe('partial', () => {
 
     errorCallback.calledOnce.should.be.true;
   });
+
+  it('cache - default', () => {
+    hexo.theme.setView('test.swig', '{{ foo }}');
+
+    partial('test', {foo: 'bar'}, { cache: true }).should.eql('bar');
+    partial('test', {}, { cache: true }).should.eql('bar');
+    partial('test', {foo: 'bar'}, { cache: 'test-cache-id' }).should.eql('bar');
+    partial('test', {}, { cache: 'test-cache-id' }).should.eql('bar');
+  });
+
+  it('cache - enhance cache', () => {
+    hexo.config.enhance_cache = true;
+    hexo.theme.setView('test.swig', '{{ foo }}');
+
+    // enhance cache should only cache partial when the locals unchanged
+    partial('test', {foo: 'bar'}).should.eql('bar');
+    partial('test', {foo: 'baz'}).should.eql('baz');
+    // when {cache: true} is set, enhance cache should cache the partial even the locals changed
+    partial('test', {foo: 'bar'}, { cache: true }).should.eql('bar');
+    partial('test', {foo: 'baz'}, { cache: true }).should.eql('bar');
+    partial('test', {foo: 'bar'}, { cache: 'test-cache-id' }).should.eql('bar');
+    partial('test', {foo: 'baz'}, { cache: 'test-cache-id' }).should.eql('bar');
+  });
 });