Fix using multiple view instances in production mode (#476)

Include the property name in the cache key to avoid clashes when
multiple view instances with different settings and root directories
are registered.

Signed-off-by: Dagfinn Ilmari Mannsåker <[email protected]>

Author: ilmari

index.js

@@ -187,6 +187,10 @@ async function fastifyView (fastify, opts) {
     return result
   }
 
+  function getCacheKey (key) {
+    return [propertyName, key].join('|')
+  }
+
   function getDefaultExtension (type) {
     const mappedExtensions = {
       handlebars: 'hbs',
@@ -223,7 +227,7 @@ async function fastifyView (fastify, opts) {
     if (type === 'handlebars') {
       data = engine.compile(data, globalOptions.compileOptions)
     }
-    fastify[viewCache].set(file, data)
+    fastify[viewCache].set(getCacheKey(file), data)
     return data
   }
 
@@ -238,7 +242,7 @@ async function fastifyView (fastify, opts) {
       isRaw = true
       file = file.raw
     }
-    const data = fastify[viewCache].get(file)
+    const data = fastify[viewCache].get(getCacheKey(file))
     if (data && prod) {
       return data
     }
@@ -270,7 +274,7 @@ async function fastifyView (fastify, opts) {
   }
 
   function getPartialsCacheKey (page, partials, requestedPath) {
-    let cacheKey = page
+    let cacheKey = getCacheKey(page)
 
     for (const key of Object.keys(partials)) {
       cacheKey += `|${key}:${partials[key]}`
@@ -295,7 +299,7 @@ async function fastifyView (fastify, opts) {
 
     const compiledPage = engine.compile(html, localOptions)
 
-    fastify[viewCache].set(page, compiledPage)
+    fastify[viewCache].set(getCacheKey(page), compiledPage)
     return compiledPage
   }
 
@@ -345,7 +349,7 @@ async function fastifyView (fastify, opts) {
       // append view extension
       page = getPage(page, type)
     }
-    const toHtml = fastify[viewCache].get(page)
+    const toHtml = fastify[viewCache].get(getCacheKey(page))
 
     if (toHtml && prod) {
       return toHtml(data)
@@ -376,7 +380,7 @@ async function fastifyView (fastify, opts) {
       // append view extension
       page = getPage(page, type)
     }
-    const toHtml = fastify[viewCache].get(page)
+    const toHtml = fastify[viewCache].get(getCacheKey(page))
 
     if (toHtml && prod) {
       return toHtml(data)
@@ -630,7 +634,7 @@ async function fastifyView (fastify, opts) {
   }
 
   function hasAccessToLayoutFile (fileName, ext) {
-    const layoutKey = `layout-${fileName}-${ext}`
+    const layoutKey = getCacheKey(`layout-${fileName}-${ext}`)
     let result = fastify[viewCache].get(layoutKey)
 
     if (typeof result === 'boolean') {

templates/root-bar/body.hbs

@@ -0,0 +1 @@
+body bar

templates/root-bar/index.hbs

@@ -0,0 +1 @@
+Index bar {{> body}}

templates/root-foo/body.hbs

@@ -0,0 +1 @@
+body foo

templates/root-foo/index.hbs

@@ -0,0 +1 @@
+Index foo {{> body}}

test/test-handlebars.js

@@ -597,10 +597,10 @@ test('reply.view with handlebars engine with partials in production mode should
   const POV = require('..')
   fastify.decorate(POV.fastifyViewCache, {
     get: (key) => {
-      t.assert.strictEqual(key, 'handlebars|body:./templates/body.hbs|null-Partials')
+      t.assert.strictEqual(key, 'view|handlebars|body:./templates/body.hbs|null-Partials')
     },
     set: (key, value) => {
-      t.assert.strictEqual(key, 'handlebars|body:./templates/body.hbs|null-Partials')
+      t.assert.strictEqual(key, 'view|handlebars|body:./templates/body.hbs|null-Partials')
       t.assert.deepStrictEqual(value, { body: fs.readFileSync('./templates/body.hbs', 'utf8') })
     }
   })
@@ -1019,6 +1019,44 @@ test('fastify.view with handlebars engine and callback in production mode and he
   await fastify.close()
 })
 
+test('reply.view with multiple handlebars instances in production mode', async t => {
+  t.plan(8)
+  const fastify = Fastify()
+  const handlebars = require('handlebars')
+
+  const view = require('../index')
+  for (const name of ['foo', 'bar']) {
+    fastify.register(view, {
+      propertyName: name,
+      engine: {
+        handlebars: handlebars.create(),
+      },
+      root: `./templates/root-${name}`,
+      options: {
+        partials: { body: 'body.hbs' },
+      },
+      production: true,
+    })
+
+    fastify.get(`/${name}`, (_req, reply) => {
+      reply.header('Content-Type', 'text/plain')[name]('index.hbs', null)
+    })
+  }
+
+  await fastify.listen({ port: 0 })
+  t.after(() => fastify.close())
+
+  for (const name of ['foo', 'bar']) {
+    const result = await fetch(`http://127.0.0.1:${fastify.server.address().port}/${name}`)
+    const responseContent = await result.text()
+
+    t.assert.strictEqual(result.status, 200)
+    t.assert.strictEqual(result.headers.get('content-length'), '' + responseContent.length)
+    t.assert.strictEqual(result.headers.get('content-type'), 'text/plain')
+    t.assert.strictEqual(responseContent, `Index ${name} body ${name}\n\n`)
+  }
+})
+
 test('fastify.view with handlebars engine and both layout', async t => {
   t.plan(1)
   const fastify = Fastify()