feat(core): ✨ add setting to cache rendered HTML

This close #713.
barbajs · Aug 1, 2023 · 7075b1f · 7075b1f
2 parents 4c97b59 + b745e97
commit 7075b1f
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 4 deletions.
diff --git a/packages/core/__tests__/core/core.init.test.ts b/packages/core/__tests__/core/core.init.test.ts
@@ -122,3 +122,11 @@ it('has other options', () => {
   expect(requestError()).toBeFalsy();
   expect(barba.wrapper).toBe(wrapper);
 });
+
+it('cache the first rendered page', () => {
+  barba.init({
+    cacheFirstPage: true,
+  });
+
+  expect(barba.cache.has('http://localhost/')).toBeTruthy();
+});
diff --git a/packages/core/src/core.ts b/packages/core/src/core.ts
@@ -74,6 +74,7 @@ export class Core {
    */
   public timeout: number;
   public cacheIgnore: IgnoreOption;
+  public cacheFirstPage: boolean;
   public prefetchIgnore: IgnoreOption;
   public preventRunning: boolean;
   /**
@@ -140,6 +141,7 @@ export class Core {
    * - schema: [[SchemaAttribute]]
    * - timeout: `2e3`
    * - cacheIgnore: `false`
+   * - cacheFirstPage: `false`
    * - prefetchIgnore: `false`
    * - preventRunning: `false`
    * - prevent: `null`,
@@ -154,6 +156,7 @@ export class Core {
       requestError,
       timeout = 2e3,
       cacheIgnore = false,
+      cacheFirstPage = false,
       prefetchIgnore = false,
       /* istanbul ignore next */
       preventRunning = false,
@@ -178,6 +181,7 @@ export class Core {
     this._requestCustomError = requestError;
     this.timeout = timeout;
     this.cacheIgnore = cacheIgnore;
+    this.cacheFirstPage = cacheFirstPage;
     this.prefetchIgnore = prefetchIgnore;
     this.preventRunning = preventRunning;
 
@@ -216,10 +220,12 @@ export class Core {
     this.history.init(current.url.href, current.namespace);
 
     // 6. Add to cache
-    this.cache.set(current.url.href, Promise.resolve({
-      html: current.html,
-      url: current.url,
-    }), 'init', 'fulfilled');
+    if (cacheFirstPage) {
+      this.cache.set(current.url.href, Promise.resolve({
+        html: current.html,
+        url: current.url,
+      }), 'init', 'fulfilled');
+    }
 
     // 7. Bind context
     this._onLinkEnter = this._onLinkEnter.bind(this);

diff --git a/packages/core/src/defs/barba.ts b/packages/core/src/defs/barba.ts
@@ -27,6 +27,8 @@ export interface IBarbaOptions {
   requestError?: RequestCustomError | undefined;
   /** Disable cache or ignore some routes. */
   cacheIgnore?: IgnoreOption;
+  /** Disable cache on the first rendered page. */
+  cacheFirstPage?: boolean;
   /** Disable prefetch or ignore routes. */
   prefetchIgnore?: IgnoreOption;
   /** Custom prevent check. */