@jsreport/jsreport-core 3.1.0 → 3.2.0

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

@@ -385,8 +385,8 @@ class MainReporter extends Reporter {
 
       if (
         this.options.enableRequestReportTimeout &&
-      req.options &&
-      req.options.timeout != null
+        req.options &&
+        req.options.timeout != null
       ) {
         reportTimeout = req
       }
@@ -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()
     }
@@ -515,7 +511,6 @@ class MainReporter extends Reporter {
           options: req.options
         }
       }, {
-      // TODO add worker timeout
         timeout,
         timeoutErrorMessage: options.timeoutErrorMessage || ('Timeout during worker action ' + actionName),
         executeMain: async (data) => {

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/shared/request.js

@@ -18,7 +18,7 @@ module.exports = (obj, parent) => {
   request.template = extend(true, {}, obj.template)
 
   if (parent) {
-    request.context = Object.assign({}, request.context, omit(parent.context, ['id', 'logs', 'systemHelpers']))
+    request.context = Object.assign({}, request.context, omit(parent.context, ['id', 'logs']))
     request.context.isChildRequest = true
     request.options = Object.assign({}, request.options, parent.options)
 

package/lib/worker/render/executeEngine.js

@@ -10,32 +10,50 @@ 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,
+        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)
       }
     }
   })
@@ -51,7 +69,6 @@ module.exports = (reporter) => {
         engine,
         content: req.template.content,
         helpers: req.template.helpers,
-        systemHelpers: req.context.systemHelpers,
         data: req.data
       }, {
         handleErrors: true,
@@ -63,14 +80,29 @@ module.exports = (reporter) => {
     }
   }
 
-  async function executeEngine ({ engine, content, helpers, systemHelpers, data }, { handleErrors, entity, entitySet }, req) {
+  async function executeEngine ({ engine, content, helpers, 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 registerResults = await reporter.registerHelpersListeners.fire(req)
+    const systemHelpers = []
+
+    for (const result of registerResults) {
+      if (result == null) {
+        continue
+      }
+
+      if (typeof result === 'string') {
+        systemHelpers.push(result)
+      }
+    }
+
+    const systemHelpersStr = systemHelpers.join('\n')
+    const joinedHelpers = systemHelpersStr + '\n' + (helpers || '')
     const executionFnParsedParamsKey = `entity:${entity.shortid || 'anonymous'}:helpers:${joinedHelpers}`
 
     const executionFn = async ({ require, console, topLevelFunctions }) => {
@@ -148,7 +180,7 @@ module.exports = (reporter) => {
         userCode: joinedHelpers,
         executionFn,
         currentPath: entityPath,
-        errorLineNumberOffset: systemHelpers.split('\n').length,
+        errorLineNumberOffset: systemHelpersStr.split('\n').length,
         onRequire: (moduleName, { context }) => {
           if (engine.onRequire) {
             return engine.onRequire(moduleName, { context })
@@ -191,7 +223,7 @@ module.exports = (reporter) => {
 
   function wrapHelperForAsyncSupport (fn, asyncResultMap) {
     return function (...args) {
-    // important to call the helper with the current this to preserve the same behaviour
+    // important to call the helper with the current this to preserve the same behavior
       const fnResult = fn.call(this, ...args)
 
       if (fnResult == null || typeof fnResult.then !== 'function') {

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

@@ -11,19 +11,9 @@ const generateRequestId = require('../../shared/generateRequestId')
 const resolveReferences = require('./resolveReferences.js')
 const moduleHelper = require('./moduleHelper')
 let reportCounter = 0
-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'
-  })
   moduleHelper(reporter)
-  reporter.addRequestContextMetaConfig('systemHelpers', { sandboxHidden: true })
 
   const executeEngine = ExecuteEngine(reporter)
   async function beforeRender (reporter, request, response) {
@@ -121,7 +111,6 @@ module.exports = (reporter) => {
 
   return async (req, parentReq) => {
     const request = Request(req, parentReq)
-    request.context.systemHelpers = ''
     const response = { meta: {} }
     let renderStartProfilerEvent
     try {
@@ -141,7 +130,9 @@ module.exports = (reporter) => {
       request.context.reportCounter = ++reportCounter
       request.context.startTimestamp = new Date().getTime()
 
-      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)
 
@@ -203,7 +194,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,
@@ -75,15 +75,22 @@ module.exports = (reporter) => {
     const functionNames = getTopLevelFunctions(userCode)
     const functionsCode = `return {${functionNames.map(h => `"${h}": ${h}`).join(',')}}`
     const executionCode = `;(async () => { ${userCode}; ${functionsCode} })()
-        .then((topLevelFunctions) => ${executionFnName}({
-            topLevelFunctions: {
-                ...topLevelFunctions,
-                ...__topLevelFunctions
-            },
-            require,
-            console,
-            context: this
-        })).catch(__handleError);`
+        .then((topLevelFunctions) => {
+          const mergedTopLevelFunctions = { ...topLevelFunctions, ...__topLevelFunctions }
+
+          // expose top level functions to the sandbox context
+          // so helpers can call other helpers (from shared asset helpers, or .registerHelpers call from proxy)
+          for (const [topLevelFnName, topLevelFn] of Object.entries(mergedTopLevelFunctions)) {
+            this[topLevelFnName] = topLevelFn
+          }
+
+          return ${executionFnName}({
+              topLevelFunctions: mergedTopLevelFunctions,
+              require,
+              console,
+              context: this
+          })
+        }).catch(__handleError);`
 
     return run(executionCode, {
       filename: 'sandbox.js',

package/lib/worker/templates.js

@@ -1,4 +1,5 @@
 const extend = require('node.extend.without.arrays')
+const omit = require('lodash.omit')
 
 module.exports = (reporter) => {
   reporter.addRequestContextMetaConfig('currentFolderPath', { sandboxReadOnly: true })
@@ -35,8 +36,9 @@ module.exports = (reporter) => {
       })
     }
 
-    // store a copy to prevent side-effects
-    req.template = template ? extend(true, {}, template, req.template) : req.template
+    // store a copy to prevent side-effects, we ignore name from the req.template because it can be path "/path/to/template"
+    // and we want that req.template.name be always the real template name
+    req.template = template ? extend(true, {}, template, omit(req.template, ['name'])) : req.template
     req.template.content = req.template.content || ''
 
     reporter.logger.info(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsreport/jsreport-core",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "javascript based business reporting",
   "keywords": [
     "report",
@@ -32,7 +32,7 @@
     "@babel/code-frame": "7.12.13",
     "@babel/parser": "7.14.4",
     "@babel/traverse": "7.12.9",
-    "@jsreport/advanced-workers": "1.1.0",
+    "@jsreport/advanced-workers": "1.2.0",
     "@jsreport/mingo": "2.4.1",
     "ajv": "6.12.6",
     "app-root-path": "2.0.1",
@@ -71,7 +71,7 @@
   "devDependencies": {
     "mocha": "8.2.1",
     "should": "13.2.3",
-    "standard": "16.0.3",
+    "standard": "16.0.4",
     "std-mocks": "1.0.1",
     "winston-loggly-bulk": "3.2.1"
   },