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

package/lib/worker/render/render.js

@@ -1,209 +1,213 @@
-/*!
- * Copyright(c) 2018 Jan Blaha
- *
- * Orchestration of the rendering process
- */
-const { Readable } = require('stream')
-const extend = require('node.extend.without.arrays')
-const ExecuteEngine = require('./executeEngine')
-const Request = require('../../shared/request')
-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) {
-    if (!request.template) {
-      throw reporter.createError('template property must be defined', {
-        statusCode: 400
-      })
-    }
-
-    await reporter.beforeRenderListeners.fire(request, response)
-    await reporter.validateRenderListeners.fire(request, response)
-  }
-
-  async function invokeRender (reporter, request, response) {
-    if (!request.template.engine) {
-      throw reporter.createError('Engine must be specified', {
-        statusCode: 400
-      })
-    }
-
-    const engine = reporter.extensionsManager.engines.find((e) => e.name === request.template.engine)
-
-    if (!engine) {
-      throw reporter.createError(`Engine '${request.template.engine}' not found. If this is a custom engine make sure it's properly installed from npm`, {
-        statusCode: 400
-      })
-    }
-
-    if (
-      request.data != null &&
-      typeof request.data === 'object' &&
-      Array.isArray(request.data)
-    ) {
-      throw reporter.createError('Request data can not be an array. you should pass an object in request.data input', {
-        statusCode: 400
-      })
-    }
-
-    const engineProfilerEvent = reporter.profiler.emit({
-      type: 'operationStart',
-      subtype: 'engine',
-      name: request.template.engine
-    }, request, response)
-
-    reporter.logger.debug(`Rendering engine ${engine.name}`, request)
-
-    const engineRes = await executeEngine(engine, request)
-
-    response.content = Buffer.from(engineRes.content != null ? engineRes.content : '')
-
-    reporter.profiler.emit({
-      type: 'operationEnd',
-      operationId: engineProfilerEvent.operationId
-    }, request, response)
-
-    await reporter.afterTemplatingEnginesExecutedListeners.fire(request, response)
-
-    if (!request.template.recipe) {
-      throw reporter.createError('Recipe must be specified', {
-        statusCode: 400
-      })
-    }
-
-    const recipe = reporter.extensionsManager.recipes.find((r) => r.name === request.template.recipe)
-
-    if (!recipe) {
-      throw reporter.createError(`Recipe '${request.template.recipe}' not found. If this is a custom recipe make sure it's properly installed from npm.`, {
-        statusCode: 400
-      })
-    }
-
-    const recipeProfilerEvent = reporter.profiler.emit({
-      type: 'operationStart',
-      subtype: 'recipe',
-      name: request.template.recipe
-    }, request, response)
-
-    reporter.logger.debug('Executing recipe ' + request.template.recipe, request)
-
-    await recipe.execute(request, response)
-    reporter.profiler.emit({
-      type: 'operationEnd',
-      operationId: recipeProfilerEvent.operationId
-    }, request, response)
-  }
-
-  async function afterRender (reporter, request, response) {
-    await reporter.afterRenderListeners.fire(request, response)
-
-    response.stream = Readable.from(response.content)
-    response.result = response.stream
-
-    return response
-  }
-
-  return async (req, parentReq) => {
-    const request = Request(req, parentReq)
-    request.context.systemHelpers = ''
-    const response = { meta: {} }
-    let renderStartProfilerEvent
-    try {
-      if (request.context.id == null) {
-        request.context.id = generateRequestId()
-      }
-
-      renderStartProfilerEvent = await reporter.profiler.renderStart(request, parentReq, response)
-      request.data = resolveReferences(request.data) || {}
-
-      if (request.options.reportName) {
-        response.meta.reportName = String(request.options.reportName)
-      } else {
-        response.meta.reportName = 'report'
-      }
-
-      request.context.reportCounter = ++reportCounter
-      request.context.startTimestamp = new Date().getTime()
-
-      reporter.requestModulesCache.set(request.context.id, Object.create(null))
-
-      reporter.logger.info(`Starting rendering request ${request.context.reportCounter} (user: ${(request.context.user ? request.context.user.username : 'null')})`, request)
-
-      // TODO
-      /* if (reporter.entityTypeValidator.getSchema('TemplateType') != null) {
-      const templateValidationResult = reporter.entityTypeValidator.validate('TemplateType', request.template, { rootPrefix: 'template' })
-
-      if (!templateValidationResult.valid) {
-        throw reporter.createError(`template input in request contain values that does not match the defined schema. ${templateValidationResult.fullErrorMessage}`, {
-          statusCode: 400
-        })
-      }
-    } */
-
-      await beforeRender(reporter, request, response)
-      await invokeRender(reporter, request, response)
-      await afterRender(reporter, request, response)
-
-      reporter.logger.info(`Rendering request ${request.context.reportCounter} finished in ${(new Date().getTime() - request.context.startTimestamp)} ms`, request)
-
-      response.meta.logs = request.context.logs
-
-      if (parentReq) {
-        parentReq.context.logs = parentReq.context.logs.concat(request.context.logs)
-        parentReq.context.shared = extend(true, parentReq.context.shared, request.context.shared)
-      }
-
-      await reporter.profiler.renderEnd(renderStartProfilerEvent.operationId, request, response)
-
-      return response
-    } catch (e) {
-      await reporter.renderErrorListeners.fire(request, response, e)
-
-      const logFn = e.weak ? reporter.logger.warn : reporter.logger.error
-
-      logFn(`Error when processing render request ${request.context.reportCounter} ${e.message}${e.stack != null ? ' ' + e.stack : ''}`, request)
-
-      logFn(`Rendering request ${request.context.reportCounter} finished with error in ${(new Date().getTime() - request.context.startTimestamp)} ms`, request)
-
-      if (
-        parentReq &&
-        parentReq.context &&
-        parentReq.context.logs &&
-        request.context &&
-        request.context.logs
-      ) {
-        parentReq.context.logs = parentReq.context.logs.concat(request.context.logs)
-      }
-
-      if (parentReq) {
-        parentReq.context.shared = extend(true, parentReq.context.shared, request.context.shared)
-      }
-
-      e.logged = true
-
-      if (renderStartProfilerEvent) {
-        await reporter.profiler.renderEnd(renderStartProfilerEvent.operationId, request, response, e)
-      }
-
-      throw e
-    } finally {
-      reporter.requestModulesCache.delete(request.context.id)
-    }
-  }
-}
+/*!
+ * Copyright(c) 2018 Jan Blaha
+ *
+ * Orchestration of the rendering process
+ */
+const { Readable } = require('stream')
+const extend = require('node.extend.without.arrays')
+const ExecuteEngine = require('./executeEngine')
+const Request = require('../../shared/request')
+const generateRequestId = require('../../shared/generateRequestId')
+const resolveReferences = require('./resolveReferences.js')
+const moduleHelper = require('./moduleHelper')
+let reportCounter = 0
+
+module.exports = (reporter) => {
+  reporter.addRequestContextMetaConfig('systemHelpers', { sandboxHidden: true })
+
+  moduleHelper(reporter)
+
+  const executeEngine = ExecuteEngine(reporter)
+  async function beforeRender (reporter, request, response) {
+    if (!request.template) {
+      throw reporter.createError('template property must be defined', {
+        statusCode: 400
+      })
+    }
+
+    await reporter.beforeRenderListeners.fire(request, response)
+    await reporter.validateRenderListeners.fire(request, response)
+  }
+
+  async function invokeRender (reporter, request, response) {
+    if (!request.template.engine) {
+      throw reporter.createError('Engine must be specified', {
+        statusCode: 400
+      })
+    }
+
+    const engine = reporter.extensionsManager.engines.find((e) => e.name === request.template.engine)
+
+    if (!engine) {
+      throw reporter.createError(`Engine '${request.template.engine}' not found. If this is a custom engine make sure it's properly installed from npm`, {
+        statusCode: 400
+      })
+    }
+
+    if (
+      request.data != null &&
+      typeof request.data === 'object' &&
+      Array.isArray(request.data)
+    ) {
+      throw reporter.createError('Request data can not be an array. you should pass an object in request.data input', {
+        statusCode: 400
+      })
+    }
+
+    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',
+      name: request.template.engine
+    }, request, response)
+
+    reporter.logger.debug(`Rendering engine ${engine.name}`, request)
+
+    const engineRes = await executeEngine(engine, request)
+
+    response.content = Buffer.from(engineRes.content != null ? engineRes.content : '')
+
+    reporter.profiler.emit({
+      type: 'operationEnd',
+      operationId: engineProfilerEvent.operationId
+    }, request, response)
+
+    await reporter.afterTemplatingEnginesExecutedListeners.fire(request, response)
+
+    if (!request.template.recipe) {
+      throw reporter.createError('Recipe must be specified', {
+        statusCode: 400
+      })
+    }
+
+    const recipe = reporter.extensionsManager.recipes.find((r) => r.name === request.template.recipe)
+
+    if (!recipe) {
+      throw reporter.createError(`Recipe '${request.template.recipe}' not found. If this is a custom recipe make sure it's properly installed from npm.`, {
+        statusCode: 400
+      })
+    }
+
+    const recipeProfilerEvent = reporter.profiler.emit({
+      type: 'operationStart',
+      subtype: 'recipe',
+      name: request.template.recipe
+    }, request, response)
+
+    reporter.logger.debug('Executing recipe ' + request.template.recipe, request)
+
+    await recipe.execute(request, response)
+    reporter.profiler.emit({
+      type: 'operationEnd',
+      operationId: recipeProfilerEvent.operationId
+    }, request, response)
+  }
+
+  async function afterRender (reporter, request, response) {
+    await reporter.afterRenderListeners.fire(request, response)
+
+    response.stream = Readable.from(response.content)
+    response.result = response.stream
+
+    return response
+  }
+
+  return async (req, parentReq) => {
+    const request = Request(req, parentReq)
+    const response = { meta: {} }
+    let renderStartProfilerEvent
+    try {
+      if (request.context.id == null) {
+        request.context.id = generateRequestId()
+      }
+
+      renderStartProfilerEvent = await reporter.profiler.renderStart(request, parentReq, response)
+      request.data = resolveReferences(request.data) || {}
+
+      if (request.options.reportName) {
+        response.meta.reportName = String(request.options.reportName)
+      } else {
+        response.meta.reportName = 'report'
+      }
+
+      request.context.reportCounter = ++reportCounter
+      request.context.startTimestamp = new Date().getTime()
+      request.context.systemHelpers = ''
+
+      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)
+
+      // TODO
+      /* if (reporter.entityTypeValidator.getSchema('TemplateType') != null) {
+      const templateValidationResult = reporter.entityTypeValidator.validate('TemplateType', request.template, { rootPrefix: 'template' })
+
+      if (!templateValidationResult.valid) {
+        throw reporter.createError(`template input in request contain values that does not match the defined schema. ${templateValidationResult.fullErrorMessage}`, {
+          statusCode: 400
+        })
+      }
+    } */
+
+      await beforeRender(reporter, request, response)
+      await invokeRender(reporter, request, response)
+      await afterRender(reporter, request, response)
+
+      reporter.logger.info(`Rendering request ${request.context.reportCounter} finished in ${(new Date().getTime() - request.context.startTimestamp)} ms`, request)
+
+      response.meta.logs = request.context.logs
+
+      if (parentReq) {
+        parentReq.context.logs = parentReq.context.logs.concat(request.context.logs)
+        parentReq.context.shared = extend(true, parentReq.context.shared, request.context.shared)
+      }
+
+      await reporter.profiler.renderEnd(renderStartProfilerEvent.operationId, request, response)
+
+      return response
+    } catch (e) {
+      await reporter.renderErrorListeners.fire(request, response, e)
+
+      const logFn = e.weak ? reporter.logger.warn : reporter.logger.error
+
+      logFn(`Error when processing render request ${request.context.reportCounter} ${e.message}${e.stack != null ? ' ' + e.stack : ''}`, request)
+
+      logFn(`Rendering request ${request.context.reportCounter} finished with error in ${(new Date().getTime() - request.context.startTimestamp)} ms`, request)
+
+      if (
+        parentReq &&
+        parentReq.context &&
+        parentReq.context.logs &&
+        request.context &&
+        request.context.logs
+      ) {
+        parentReq.context.logs = parentReq.context.logs.concat(request.context.logs)
+      }
+
+      if (parentReq) {
+        parentReq.context.shared = extend(true, parentReq.context.shared, request.context.shared)
+      }
+
+      e.logged = true
+
+      if (renderStartProfilerEvent) {
+        await reporter.profiler.renderEnd(renderStartProfilerEvent.operationId, request, response, e)
+      }
+
+      throw e
+    } finally {
+      if (parentReq == null) {
+        reporter.requestModulesCache.delete(request.context.rootId)
+      }
+    }
+  }
+}

package/lib/worker/render/resolveReferences.js

@@ -1,60 +1,60 @@
-// resolve references in json specified by $ref and $id attribute, this is handy when user send cycles in json
-module.exports = function (json) {
-  if (typeof json === 'string') {
-    json = JSON.parse(json)
-  }
-
-  const byid = {} // all objects by id
-  const refs = [] // references to objects that could not be resolved
-  json = (function recurse (obj, prop, parent) {
-    if (typeof obj !== 'object' || !obj) { // a primitive value
-      return obj
-    }
-    if (Object.prototype.toString.call(obj) === '[object Array]') {
-      for (let i = 0; i < obj.length; i++) {
-        if (obj[i] === null) {
-          continue
-        }
-
-        if (Object.prototype.hasOwnProperty.call(obj[i], '$ref')) {
-          obj[i] = recurse(obj[i], i, obj)
-        } else {
-          obj[i] = recurse(obj[i], prop, obj)
-        }
-      }
-      return obj
-    }
-
-    if ('$ref' in obj) { // a reference
-      const ref = obj.$ref
-      if (ref in byid) {
-        return byid[ref]
-      }
-      // else we have to make it lazy:
-      refs.push([parent, prop, ref])
-      return
-    } else if ('$id' in obj) {
-      const id = obj.$id
-      delete obj.$id
-      if ('$values' in obj) { // an array
-        obj = obj.$values.map(recurse)
-      } else { // a plain object
-        for (const p in obj) {
-          if (Object.prototype.hasOwnProperty.call(obj, p)) {
-            obj[p] = recurse(obj[p], p, obj)
-          }
-        }
-      }
-      byid[id] = obj
-    }
-
-    return obj
-  })(json) // run it!
-
-  for (let i = 0; i < refs.length; i++) { // resolve previously unknown references
-    const ref = refs[i]
-    ref[0][ref[1]] = byid[ref[2]]
-    // Notice that this throws if you put in a reference at top-level
-  }
-  return json
-}
+// resolve references in json specified by $ref and $id attribute, this is handy when user send cycles in json
+module.exports = function (json) {
+  if (typeof json === 'string') {
+    json = JSON.parse(json)
+  }
+
+  const byid = {} // all objects by id
+  const refs = [] // references to objects that could not be resolved
+  json = (function recurse (obj, prop, parent) {
+    if (typeof obj !== 'object' || !obj) { // a primitive value
+      return obj
+    }
+    if (Object.prototype.toString.call(obj) === '[object Array]') {
+      for (let i = 0; i < obj.length; i++) {
+        if (obj[i] === null) {
+          continue
+        }
+
+        if (Object.prototype.hasOwnProperty.call(obj[i], '$ref')) {
+          obj[i] = recurse(obj[i], i, obj)
+        } else {
+          obj[i] = recurse(obj[i], prop, obj)
+        }
+      }
+      return obj
+    }
+
+    if ('$ref' in obj) { // a reference
+      const ref = obj.$ref
+      if (ref in byid) {
+        return byid[ref]
+      }
+      // else we have to make it lazy:
+      refs.push([parent, prop, ref])
+      return
+    } else if ('$id' in obj) {
+      const id = obj.$id
+      delete obj.$id
+      if ('$values' in obj) { // an array
+        obj = obj.$values.map(recurse)
+      } else { // a plain object
+        for (const p in obj) {
+          if (Object.prototype.hasOwnProperty.call(obj, p)) {
+            obj[p] = recurse(obj[p], p, obj)
+          }
+        }
+      }
+      byid[id] = obj
+    }
+
+    return obj
+  })(json) // run it!
+
+  for (let i = 0; i < refs.length; i++) { // resolve previously unknown references
+    const ref = refs[i]
+    ref[0][ref[1]] = byid[ref[2]]
+    // Notice that this throws if you put in a reference at top-level
+  }
+  return json
+}