@jsreport/jsreport-core 3.0.0 → 3.1.2-test.1

package/lib/worker/render/executeEngine.js

@@ -1,190 +1,227 @@
-/*!
- * Copyright(c) 2018 Jan Blaha
- *
- * Child process script rendering html from template content, helpers and input data.
- * This script runs in the extra process because of multitenancy and security requirements, errors like infinite loop
- * should not affect other reports being rendered at the same time
- */
-const LRU = require('lru-cache')
-const { nanoid } = require('nanoid')
-
-module.exports = (reporter) => {
-  const cache = LRU(reporter.options.sandbox.cache || { max: 100 })
-  reporter.templatingEngines = { cache }
-
-  return async (engine, req) => {
-    const executionFnParsedParamsMap = new Map()
-
-    reporter.extendProxy((proxy, req, {
-      runInSandbox,
-      context,
-      getTopLevelFunctions
-    }) => {
-      proxy.templatingEngines = {
-        evaluate: async ({ engine, content, helpers, data }, { entity, entitySet }) => {
-          const engineImpl = reporter.extensionsManager.engines.find((e) => e.name === engine)
-
-          if (!engine) {
-            throw reporter.createError(`Engine '${engine}' not found. If this is a custom engine make sure it's properly installed from npm`, {
-              statusCode: 400
-            })
-          }
-
-          const res = await executeEngine({
-            engine: engineImpl,
-            content,
-            helpers,
-            systemHelpers: req.context.systemHelpers,
-            data
-          }, { executionFnParsedParamsMap, handleErrors: false, entity, entitySet }, req)
-          return res.content
-        }
-      }
-    })
-
-    req.data.__appDirectory = reporter.options.appDirectory
-    req.data.__rootDirectory = reporter.options.rootDirectory
-    req.data.__parentModuleDirectory = reporter.options.parentModuleDirectory
-
-    return executeEngine({
-      engine,
-      content: req.template.content,
-      helpers: req.template.helpers,
-      systemHelpers: req.context.systemHelpers,
-      data: req.data
-    }, {
-      executionFnParsedParamsMap,
-      handleErrors: true,
-      entity: req.template,
-      entitySet: 'templates'
-    }, req)
-  }
-
-  async function executeEngine ({ engine, content, helpers, systemHelpers, data }, { executionFnParsedParamsMap, handleErrors, entity, entitySet }, req) {
-    const joinedHelpers = systemHelpers + '\n' + helpers
-    const executionFnParsedParamsKey = `entity:${entity.shortid || 'anonymous'}:helpers:${joinedHelpers}`
-
-    const executionFn = async ({ require, console, topLevelFunctions }) => {
-      if (entitySet !== 'templates') {
-        const jsreport = require('jsreport-proxy')
-        const entityPath = await jsreport.folders.resolveEntityPath(entity, entitySet)
-        jsreport.currentPath = entityPath.substring(0, entityPath.lastIndexOf('/'))
-      }
-
-      const asyncResultMap = new Map()
-      executionFnParsedParamsMap.set(executionFnParsedParamsKey, { require, console, topLevelFunctions })
-
-      const key = `template:${content}:${engine.name}`
-
-      if (!cache.has(key)) {
-        try {
-          cache.set(key, engine.compile(content, { require }))
-        } catch (e) {
-          e.property = 'content'
-          throw e
-        }
-      }
-
-      const compiledTemplate = cache.get(key)
-
-      const wrappedTopLevelFunctions = {}
-
-      for (const h of Object.keys(topLevelFunctions)) {
-        wrappedTopLevelFunctions[h] = wrapHelperForAsyncSupport(topLevelFunctions[h], asyncResultMap)
-      }
-
-      let contentResult = await engine.execute(compiledTemplate, wrappedTopLevelFunctions, data, { require })
-      const resolvedResultsMap = new Map()
-      while (asyncResultMap.size > 0) {
-        await Promise.all([...asyncResultMap.keys()].map(async (k) => {
-          resolvedResultsMap.set(k, `${await asyncResultMap.get(k)}`)
-          asyncResultMap.delete(k)
-        }))
-      }
-
-      while (contentResult.includes('{#asyncHelperResult')) {
-        contentResult = contentResult.replace(/{#asyncHelperResult ([^{}]+)}/g, (str, p1) => {
-          const asyncResultId = p1
-          return `${resolvedResultsMap.get(asyncResultId)}`
-        })
-      }
-
-      return {
-        content: contentResult
-      }
-    }
-
-    if (executionFnParsedParamsMap.has(executionFnParsedParamsKey)) {
-      const { require, console, topLevelFunctions } = executionFnParsedParamsMap.get(executionFnParsedParamsKey)
-
-      return executionFn({ require, console, topLevelFunctions })
-    }
-
-    if (reporter.options.sandbox.cache && reporter.options.sandbox.cache.enabled === false) {
-      cache.reset()
-    }
-
-    try {
-      return await reporter.runInSandbox({
-        context: {
-          ...(engine.createContext ? engine.createContext() : {})
-        },
-        userCode: joinedHelpers,
-        executionFn,
-        errorLineNumberOffset: systemHelpers.split('\n').length,
-        onRequire: (moduleName, { context }) => {
-          if (engine.onRequire) {
-            return engine.onRequire(moduleName, { context })
-          }
-        }
-      }, req)
-    } catch (e) {
-      if (!handleErrors) {
-        throw e
-      }
-
-      const nestedErrorWithEntity = e.entity != null
-
-      const templatePath = req.template._id ? await reporter.folders.resolveEntityPath(req.template, 'templates', req) : 'anonymous'
-      if (templatePath !== 'anonymous' && !nestedErrorWithEntity) {
-        const templateFound = await reporter.folders.resolveEntityFromPath(templatePath, 'templates', req)
-        if (templateFound != null) {
-          e.entity = {
-            shortid: templateFound.entity.shortid,
-            name: templateFound.entity.name,
-            content
-          }
-        }
-      }
-
-      e.message = `Error when evaluating engine ${engine.name} for template ${templatePath}\n` + e.message
-
-      if (!nestedErrorWithEntity && e.property !== 'content') {
-        e.property = 'helpers'
-      }
-
-      if (nestedErrorWithEntity) {
-        // errors from nested assets evals needs an unwrap for some reason
-        e.entity = { ...e.entity }
-      }
-
-      throw e
-    }
-  }
-
-  function wrapHelperForAsyncSupport (fn, asyncResultMap) {
-    return function (...args) {
-    // important to call the helper with the current this to preserve the same behaviour
-      const fnResult = fn.call(this, ...args)
-
-      if (fnResult == null || typeof fnResult.then !== 'function') {
-        return fnResult
-      }
-
-      const asyncResultId = nanoid(7)
-      asyncResultMap.set(asyncResultId, fnResult)
-
-      return `{#asyncHelperResult ${asyncResultId}}`
-    }
-  }
-}
+/*!
+ * Copyright(c) 2018 Jan Blaha
+ *
+ * Child process script rendering html from template content, helpers and input data.
+ * This script runs in the extra process because of multitenancy and security requirements, errors like infinite loop
+ * should not affect other reports being rendered at the same time
+ */
+const LRU = require('lru-cache')
+const { nanoid } = require('nanoid')
+
+module.exports = (reporter) => {
+  const cache = LRU(reporter.options.sandbox.cache || { max: 100 })
+
+  reporter.templatingEngines = { cache }
+
+  const executionFnParsedParamsMap = new Map()
+
+  const templatingEnginesEvaluate = async (mainCall, { engine, content, helpers, data }, { entity, entitySet }, req) => {
+    const engineImpl = reporter.extensionsManager.engines.find((e) => e.name === engine)
+
+    if (!engine) {
+      throw reporter.createError(`Engine '${engine}' not found. If this is a custom engine make sure it's properly installed from npm`, {
+        statusCode: 400
+      })
+    }
+
+    if (mainCall) {
+      executionFnParsedParamsMap.set(req.context.id, new Map())
+    }
+
+    try {
+      const res = await executeEngine({
+        engine: engineImpl,
+        content,
+        helpers,
+        systemHelpers: req.context.systemHelpers,
+        data
+      }, { handleErrors: false, entity, entitySet }, req)
+
+      return res.content
+    } finally {
+      if (mainCall) {
+        executionFnParsedParamsMap.delete(req.context.id)
+      }
+    }
+  }
+
+  reporter.templatingEngines.evaluate = (executionInfo, entityInfo, req) => templatingEnginesEvaluate(true, executionInfo, entityInfo, req)
+
+  reporter.extendProxy((proxy, req, {
+    runInSandbox,
+    context,
+    getTopLevelFunctions
+  }) => {
+    proxy.templatingEngines = {
+      evaluate: async (executionInfo, entityInfo) => {
+        return templatingEnginesEvaluate(false, executionInfo, entityInfo, req)
+      }
+    }
+  })
+
+  return async (engine, req) => {
+    executionFnParsedParamsMap.set(req.context.id, new Map())
+    req.data.__appDirectory = reporter.options.appDirectory
+    req.data.__rootDirectory = reporter.options.rootDirectory
+    req.data.__parentModuleDirectory = reporter.options.parentModuleDirectory
+
+    try {
+      return await executeEngine({
+        engine,
+        content: req.template.content,
+        helpers: req.template.helpers,
+        systemHelpers: req.context.systemHelpers,
+        data: req.data
+      }, {
+        handleErrors: true,
+        entity: req.template,
+        entitySet: 'templates'
+      }, req)
+    } finally {
+      executionFnParsedParamsMap.delete(req.context.id)
+    }
+  }
+
+  async function executeEngine ({ engine, content, helpers, systemHelpers, data }, { handleErrors, entity, entitySet }, req) {
+    let entityPath
+
+    if (entity._id) {
+      entityPath = await reporter.folders.resolveEntityPath(entity, entitySet, req)
+      entityPath = entityPath.substring(0, entityPath.lastIndexOf('/'))
+    }
+
+    const joinedHelpers = systemHelpers + '\n' + (helpers || '')
+    const executionFnParsedParamsKey = `entity:${entity.shortid || 'anonymous'}:helpers:${joinedHelpers}`
+
+    const executionFn = async ({ require, console, topLevelFunctions }) => {
+      // cached components dont call runInSandbox but share the proxy, we get to it here
+      if (entitySet !== 'templates') {
+        const jsreport = require('jsreport-proxy')
+        jsreport.currentPath = entityPath
+      }
+
+      const asyncResultMap = new Map()
+      executionFnParsedParamsMap.get(req.context.id).get(executionFnParsedParamsKey).resolve({ require, console, topLevelFunctions })
+      const key = `template:${content}:${engine.name}`
+
+      if (!cache.has(key)) {
+        try {
+          cache.set(key, engine.compile(content, { require }))
+        } catch (e) {
+          e.property = 'content'
+          throw e
+        }
+      }
+
+      const compiledTemplate = cache.get(key)
+
+      const wrappedTopLevelFunctions = {}
+
+      for (const h of Object.keys(topLevelFunctions)) {
+        wrappedTopLevelFunctions[h] = wrapHelperForAsyncSupport(topLevelFunctions[h], asyncResultMap)
+      }
+
+      let contentResult = await engine.execute(compiledTemplate, wrappedTopLevelFunctions, data, { require })
+      const resolvedResultsMap = new Map()
+      while (asyncResultMap.size > 0) {
+        await Promise.all([...asyncResultMap.keys()].map(async (k) => {
+          resolvedResultsMap.set(k, `${await asyncResultMap.get(k)}`)
+          asyncResultMap.delete(k)
+        }))
+      }
+
+      while (contentResult.includes('{#asyncHelperResult')) {
+        contentResult = contentResult.replace(/{#asyncHelperResult ([^{}]+)}/g, (str, p1) => {
+          const asyncResultId = p1
+          return `${resolvedResultsMap.get(asyncResultId)}`
+        })
+      }
+
+      return {
+        content: contentResult
+      }
+    }
+
+    // executionFnParsedParamsMap is there to cache parsed components helpers to speed up longer loops
+    // we store there for the particular request and component a promise and only the first component gets compiled
+    if (executionFnParsedParamsMap.get(req.context.id).has(executionFnParsedParamsKey)) {
+      const { require, console, topLevelFunctions } = await (executionFnParsedParamsMap.get(req.context.id).get(executionFnParsedParamsKey).promise)
+
+      return executionFn({ require, console, topLevelFunctions })
+    } else {
+      const awaiter = {}
+      awaiter.promise = new Promise((resolve) => {
+        awaiter.resolve = resolve
+      })
+      executionFnParsedParamsMap.get(req.context.id).set(executionFnParsedParamsKey, awaiter)
+    }
+
+    if (reporter.options.sandbox.cache && reporter.options.sandbox.cache.enabled === false) {
+      cache.reset()
+    }
+
+    try {
+      return await reporter.runInSandbox({
+        context: {
+          ...(engine.createContext ? engine.createContext() : {})
+        },
+        userCode: joinedHelpers,
+        executionFn,
+        currentPath: entityPath,
+        errorLineNumberOffset: systemHelpers.split('\n').length,
+        onRequire: (moduleName, { context }) => {
+          if (engine.onRequire) {
+            return engine.onRequire(moduleName, { context })
+          }
+        }
+      }, req)
+    } catch (e) {
+      if (!handleErrors) {
+        throw e
+      }
+
+      const nestedErrorWithEntity = e.entity != null
+
+      const templatePath = req.template._id ? await reporter.folders.resolveEntityPath(req.template, 'templates', req) : 'anonymous'
+      if (templatePath !== 'anonymous' && !nestedErrorWithEntity) {
+        const templateFound = await reporter.folders.resolveEntityFromPath(templatePath, 'templates', req)
+        if (templateFound != null) {
+          e.entity = {
+            shortid: templateFound.entity.shortid,
+            name: templateFound.entity.name,
+            content
+          }
+        }
+      }
+
+      e.message = `Error when evaluating engine ${engine.name} for template ${templatePath}\n` + e.message
+
+      if (!nestedErrorWithEntity && e.property !== 'content') {
+        e.property = 'helpers'
+      }
+
+      if (nestedErrorWithEntity) {
+        // errors from nested assets evals needs an unwrap for some reason
+        e.entity = { ...e.entity }
+      }
+
+      throw e
+    }
+  }
+
+  function wrapHelperForAsyncSupport (fn, asyncResultMap) {
+    return function (...args) {
+    // important to call the helper with the current this to preserve the same behaviour
+      const fnResult = fn.call(this, ...args)
+
+      if (fnResult == null || typeof fnResult.then !== 'function') {
+        return fnResult
+      }
+
+      const asyncResultId = nanoid(7)
+      asyncResultMap.set(asyncResultId, fnResult)
+
+      return `{#asyncHelperResult ${asyncResultId}}`
+    }
+  }
+}

package/lib/worker/render/htmlRecipe.js

@@ -1,10 +1,10 @@
-/*!
- * Copyright(c) 2016 Jan Blaha
- *
- * Recipe running no document transformations. Just adds html response headers
- */
-
-module.exports = function (req, res) {
-  res.meta.contentType = 'text/html'
-  res.meta.fileExtension = 'html'
-}
+/*!
+ * Copyright(c) 2016 Jan Blaha
+ *
+ * Recipe running no document transformations. Just adds html response headers
+ */
+
+module.exports = function (req, res) {
+  res.meta.contentType = 'text/html'
+  res.meta.fileExtension = 'html'
+}

package/lib/worker/render/moduleHelper.js

@@ -1,43 +1,45 @@
-const fs = require('fs').promises
-const path = require('path')
-
-module.exports = (reporter) => {
-  let helpersScript
-  reporter.beforeRenderListeners.add('core-helpers', async (req) => {
-    if (!helpersScript) {
-      helpersScript = await fs.readFile(path.join(__dirname, '../../static/helpers.js'), 'utf8')
-    }
-    req.context.systemHelpers += helpersScript + '\n'
-  })
-
-  reporter.extendProxy((proxy, req, { safeRequire }) => {
-    proxy.module = async (module) => {
-      if (!reporter.options.allowLocalFilesAccess && reporter.options.sandbox.allowedModules !== '*') {
-        if (reporter.options.sandbox.allowedModules.indexOf(module) === -1) {
-          throw reporter.createError(`require of module ${module} was rejected. Either set allowLocalFilesAccess=true or sandbox.allowLocalModules='*' or sandbox.allowLocalModules=['${module}'] `, { status: 400 })
-        }
-      }
-
-      const resolve = require('enhanced-resolve')
-
-      const moduleResolve = resolve.create({
-        extensions: ['.js', '.json']
-      })
-
-      const modulePath = await new Promise((resolve, reject) => {
-        moduleResolve(reporter.options.rootDirectory, module, (err, result) => {
-          if (err) {
-            err.message = `module read error. ${err.message}`
-            return reject(err)
-          }
-
-          resolve(result)
-        })
-      })
-
-      const buf = await fs.readFile(modulePath)
-
-      return buf.toString()
-    }
-  })
-}
+const fs = require('fs').promises
+const path = require('path')
+
+module.exports = (reporter) => {
+  let helpersScript
+
+  reporter.registerHelpersListeners.add('core-helpers', (req) => {
+    return helpersScript
+  })
+
+  reporter.initializeListeners.add('core-helpers', async () => {
+    helpersScript = await fs.readFile(path.join(__dirname, '../../static/helpers.js'), 'utf8')
+  })
+
+  reporter.extendProxy((proxy, req, { safeRequire }) => {
+    proxy.module = async (module) => {
+      if (!reporter.options.allowLocalFilesAccess && reporter.options.sandbox.allowedModules !== '*') {
+        if (reporter.options.sandbox.allowedModules.indexOf(module) === -1) {
+          throw reporter.createError(`require of module ${module} was rejected. Either set allowLocalFilesAccess=true or sandbox.allowLocalModules='*' or sandbox.allowLocalModules=['${module}'] `, { status: 400 })
+        }
+      }
+
+      const resolve = require('enhanced-resolve')
+
+      const moduleResolve = resolve.create({
+        extensions: ['.js', '.json']
+      })
+
+      const modulePath = await new Promise((resolve, reject) => {
+        moduleResolve(reporter.options.rootDirectory, module, (err, result) => {
+          if (err) {
+            err.message = `module read error. ${err.message}`
+            return reject(err)
+          }
+
+          resolve(result)
+        })
+      })
+
+      const buf = await fs.readFile(modulePath)
+
+      return buf.toString()
+    }
+  })
+}

package/lib/worker/render/noneEngine.js

@@ -1,12 +1,12 @@
-/*!
- * Copyright(c) 2018 Jan Blaha
- *
- * Engine running not templating engine compilation or rendering. Just return input html
- */
-
-module.exports = () => {
-  return {
-    compile: (html) => html,
-    execute: (html) => html
-  }
-}
+/*!
+ * Copyright(c) 2018 Jan Blaha
+ *
+ * Engine running not templating engine compilation or rendering. Just return input html
+ */
+
+module.exports = () => {
+  return {
+    compile: (html) => html,
+    execute: (html) => html
+  }
+}