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

package/lib/main/defaults.js

@@ -6,7 +6,7 @@ exports.getDefaultTempDirectory = () => {
 }
 
 exports.getDefaultRootDirectory = () => {
-  return path.join(__dirname, '../../../../')
+  return path.join(__dirname, '../../../../../')
 }
 
 exports.getDefaultLoadConfig = () => {

package/lib/main/reporter.js

@@ -435,10 +435,6 @@ class MainReporter extends Reporter {
     }
   }
 
-  generateRequestId () {
-    return generateRequestId()
-  }
-
   registerWorkersManagerFactory (workersManagerFactory) {
     this._workersManagerFactory = workersManagerFactory
   }
@@ -459,12 +455,12 @@ class MainReporter extends Reporter {
       clearInterval(this._reaperTimerRef)
     }
 
+    await this.closeListeners.fire()
+
     if (this._workersManager) {
       await this._workersManager.close()
     }
 
-    await this.closeListeners.fire()
-
     if (this.documentStore) {
       await this.documentStore.close()
     }

package/lib/shared/reporter.js

@@ -6,6 +6,7 @@ const Folders = require('./folders')
 const createOrExtendError = require('./createError')
 const tempFilesHandler = require('./tempFilesHandler')
 const encryption = require('./encryption')
+const generateRequestId = require('../shared/generateRequestId')
 
 class Reporter extends EventEmitter {
   constructor (options) {
@@ -46,6 +47,10 @@ class Reporter extends EventEmitter {
     return createOrExtendError(message, options)
   }
 
+  generateRequestId () {
+    return generateRequestId()
+  }
+
   /**
    * Ensures that the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory) exists by doing a mkdir call
    *

package/lib/worker/render/executeEngine.js

@@ -10,32 +10,51 @@ 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 ({ 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
-        }, { handleErrors: false, entity, entitySet }, req)
-        return res.content
+      evaluate: async (executionInfo, entityInfo) => {
+        return templatingEnginesEvaluate(false, executionInfo, entityInfo, req)
       }
     }
   })
@@ -65,12 +84,13 @@ module.exports = (reporter) => {
 
   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 joinedHelpers = systemHelpers + '\n' + (helpers || '')
     const executionFnParsedParamsKey = `entity:${entity.shortid || 'anonymous'}:helpers:${joinedHelpers}`
 
     const executionFn = async ({ require, console, topLevelFunctions }) => {

package/lib/worker/render/moduleHelper.js

@@ -3,11 +3,13 @@ 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.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 }) => {

package/lib/worker/render/render.js

@@ -54,6 +54,14 @@ module.exports = (reporter) => {
       })
     }
 
+    let helpersResults = await reporter.registerHelpersListeners.fire(request)
+
+    helpersResults = helpersResults.filter((result) => {
+      return result != null
+    })
+
+    request.context.systemHelpers = helpersResults.join('\n')
+
     const engineProfilerEvent = reporter.profiler.emit({
       type: 'operationStart',
       subtype: 'engine',
@@ -113,7 +121,6 @@ module.exports = (reporter) => {
 
   return async (req, parentReq) => {
     const request = Request(req, parentReq)
-    request.context.systemHelpers = ''
     const response = { meta: {} }
     let renderStartProfilerEvent
     try {
@@ -132,8 +139,11 @@ module.exports = (reporter) => {
 
       request.context.reportCounter = ++reportCounter
       request.context.startTimestamp = new Date().getTime()
+      request.context.systemHelpers = ''
 
-      reporter.requestModulesCache.set(request.context.id, Object.create(null))
+      if (parentReq == null) {
+        reporter.requestModulesCache.set(request.context.rootId, Object.create(null))
+      }
 
       reporter.logger.info(`Starting rendering request ${request.context.reportCounter} (user: ${(request.context.user ? request.context.user.username : 'null')})`, request)
 
@@ -195,7 +205,9 @@ module.exports = (reporter) => {
 
       throw e
     } finally {
-      reporter.requestModulesCache.delete(request.context.id)
+      if (parentReq == null) {
+        reporter.requestModulesCache.delete(request.context.rootId)
+      }
     }
   }
 }

package/lib/worker/reporter.js

@@ -26,6 +26,7 @@ class WorkerReporter extends Reporter {
     this._workerActions = new Map()
     this._registerRenderAction()
 
+    this.registerHelpersListeners = this.createListenerCollection('registerHelpers')
     this.afterTemplatingEnginesExecutedListeners = this.createListenerCollection('afterTemplatingEnginesExecuted')
     this.validateRenderListeners = this.createListenerCollection('validateRender')
 

package/lib/worker/sandbox/runInSandbox.js

@@ -34,7 +34,7 @@ module.exports = (reporter) => {
       formatError: (error, moduleName) => {
         error.message += ` To be able to require custom modules you need to add to configuration { "allowLocalFilesAccess": true } or enable just specific module using { sandbox: { allowedModules": ["${moduleName}"] }`
       },
-      modulesCache: reporter.requestModulesCache.get(req.context.id),
+      modulesCache: reporter.requestModulesCache.get(req.context.rootId),
       globalModules: reporter.options.sandbox.nativeModules || [],
       allowedModules: reporter.options.sandbox.allowedModules,
       propertiesConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsreport/jsreport-core",
-  "version": "3.1.1",
+  "version": "3.1.2-test.1",
   "description": "javascript based business reporting",
   "keywords": [
     "report",