@jsreport/jsreport-core 3.1.1 → 3.3.0

package/lib/shared/listenerCollection.js

@@ -1,169 +1,169 @@
-
-module.exports = function createListenerCollection (_name) {
-  const name = _name != null ? `${_name}` : 'Anonymous'
-  return new ListenerCollection(name)
-}
-
-class ListenerCollection {
-  constructor (name) {
-    this._name = name
-    this._listeners = []
-    this._pre = []
-    this._post = []
-    this._postFail = []
-  }
-
-  /**
-   * Add listener cb at the end of the current chain.
-   * @param {String} key
-   * @param {Object|Function} context
-   * @param {Function} listener
-   */
-  add (key, context, listener) {
-    const fn = listener || context
-    const _context = listener === null ? this : context
-
-    this._listeners.push({
-      key: key,
-      fn,
-      context: _context
-    })
-  }
-
-  /**
-   * Add the listener callback to the particular position in the chain.
-   * The position is specified by the index in the array or a condition
-   * Example
-   * listeners.insert({ pre: "another", post: "another2" }, "foo", this, function() {... });
-   *
-   * @param {Number|Object} indexOrCondition
-   * @param {String} key
-   * @param {Object} context
-   * @param {Function} listener
-   */
-  insert (indexOrCondition, key, context, listener) {
-    const listenerOpts = {
-      key: key,
-      fn: listener || context,
-      context: listener === null ? this : context
-    }
-
-    if (!isNaN(indexOrCondition)) {
-      return this._listeners.splice(indexOrCondition, 0, listenerOpts)
-    }
-
-    let afterInsertIndex = null
-    let beforeInsertIndex = null
-
-    for (let i = 0; i < this._listeners.length; i++) {
-      if (this._listeners[i].key === indexOrCondition.after) {
-        afterInsertIndex = i + 1
-      }
-
-      if (this._listeners[i].key === indexOrCondition.before) {
-        beforeInsertIndex = i
-      }
-    }
-
-    const index = afterInsertIndex !== null
-      ? afterInsertIndex
-      : (beforeInsertIndex !== null ? beforeInsertIndex : this._listeners.length)
-
-    this._listeners.splice(index, 0, listenerOpts)
-  }
-
-  /**
-   * Remove the listener specified by its key from the collection
-   * @param {String} key
-   */
-  remove (key) {
-    this._listeners = this._listeners.filter((l) => {
-      return l.key !== key
-    })
-  }
-
-  /* Add hook that will be executed before actual listener */
-  pre (fn) {
-    this._pre.push(fn)
-  }
-
-  /* Add hook that will be executed after actual listener */
-  post (fn) {
-    this._post.push(fn)
-  }
-
-  /* Add hook that will be executed after actual listener when execution will fail */
-  postFail (fn) {
-    this._postFail.push(fn)
-  }
-
-  /**
-   * Fires listeners and returns value composed from all boolean results into the single bool
-   * @returns {Promise<Boolean>}
-   */
-  async fireAndJoinResults (...args) {
-    const results = await this.fire(...args)
-
-    const successes = results.filter((r) => {
-      return r === true
-    })
-
-    const failures = results.filter((r) => {
-      return r === false
-    })
-
-    const dontCares = results.filter((r) => {
-      return r === null || r === undefined
-    })
-
-    if (successes.length && (successes.length + dontCares.length === results.length)) {
-      // override pass
-      return true
-    }
-
-    if (failures.length && (failures.length + dontCares.length === results.length)) {
-      return false
-    }
-
-    if (dontCares.length === results.length) {
-      return null
-    }
-
-    return true
-  }
-
-  /**
-   * Fire registered listeners in sequence and returns a promise containing wrapping an array of all
-   * individual results.
-   * The parameters passed to the fire are forwarded in the same order to the listeners.
-   * @returns {Promise<U>}
-   */
-  async fire (...args) {
-    const self = this
-
-    const applyHook = function applyHook (l, hookArrayName, outerArgs) {
-      self[hookArrayName].forEach((p) => {
-        p.apply(l, outerArgs)
-      })
-    }
-
-    const results = []
-
-    for (const l of this._listeners) {
-      const currentArgs = [...args]
-      applyHook(l, '_pre', currentArgs)
-
-      try {
-        const val = await l.fn.apply(l.context, currentArgs)
-        applyHook(l, '_post', currentArgs)
-        results.push(val)
-      } catch (e) {
-        currentArgs.unshift(e)
-        applyHook(l, '_postFail', currentArgs)
-        throw e
-      }
-    }
-
-    return results
-  }
-}
+
+module.exports = function createListenerCollection (_name) {
+  const name = _name != null ? `${_name}` : 'Anonymous'
+  return new ListenerCollection(name)
+}
+
+class ListenerCollection {
+  constructor (name) {
+    this._name = name
+    this._listeners = []
+    this._pre = []
+    this._post = []
+    this._postFail = []
+  }
+
+  /**
+   * Add listener cb at the end of the current chain.
+   * @param {String} key
+   * @param {Object|Function} context
+   * @param {Function} listener
+   */
+  add (key, context, listener) {
+    const fn = listener || context
+    const _context = listener === null ? this : context
+
+    this._listeners.push({
+      key: key,
+      fn,
+      context: _context
+    })
+  }
+
+  /**
+   * Add the listener callback to the particular position in the chain.
+   * The position is specified by the index in the array or a condition
+   * Example
+   * listeners.insert({ pre: "another", post: "another2" }, "foo", this, function() {... });
+   *
+   * @param {Number|Object} indexOrCondition
+   * @param {String} key
+   * @param {Object} context
+   * @param {Function} listener
+   */
+  insert (indexOrCondition, key, context, listener) {
+    const listenerOpts = {
+      key: key,
+      fn: listener || context,
+      context: listener === null ? this : context
+    }
+
+    if (!isNaN(indexOrCondition)) {
+      return this._listeners.splice(indexOrCondition, 0, listenerOpts)
+    }
+
+    let afterInsertIndex = null
+    let beforeInsertIndex = null
+
+    for (let i = 0; i < this._listeners.length; i++) {
+      if (this._listeners[i].key === indexOrCondition.after) {
+        afterInsertIndex = i + 1
+      }
+
+      if (this._listeners[i].key === indexOrCondition.before) {
+        beforeInsertIndex = i
+      }
+    }
+
+    const index = afterInsertIndex !== null
+      ? afterInsertIndex
+      : (beforeInsertIndex !== null ? beforeInsertIndex : this._listeners.length)
+
+    this._listeners.splice(index, 0, listenerOpts)
+  }
+
+  /**
+   * Remove the listener specified by its key from the collection
+   * @param {String} key
+   */
+  remove (key) {
+    this._listeners = this._listeners.filter((l) => {
+      return l.key !== key
+    })
+  }
+
+  /* Add hook that will be executed before actual listener */
+  pre (fn) {
+    this._pre.push(fn)
+  }
+
+  /* Add hook that will be executed after actual listener */
+  post (fn) {
+    this._post.push(fn)
+  }
+
+  /* Add hook that will be executed after actual listener when execution will fail */
+  postFail (fn) {
+    this._postFail.push(fn)
+  }
+
+  /**
+   * Fires listeners and returns value composed from all boolean results into the single bool
+   * @returns {Promise<Boolean>}
+   */
+  async fireAndJoinResults (...args) {
+    const results = await this.fire(...args)
+
+    const successes = results.filter((r) => {
+      return r === true
+    })
+
+    const failures = results.filter((r) => {
+      return r === false
+    })
+
+    const dontCares = results.filter((r) => {
+      return r === null || r === undefined
+    })
+
+    if (successes.length && (successes.length + dontCares.length === results.length)) {
+      // override pass
+      return true
+    }
+
+    if (failures.length && (failures.length + dontCares.length === results.length)) {
+      return false
+    }
+
+    if (dontCares.length === results.length) {
+      return null
+    }
+
+    return true
+  }
+
+  /**
+   * Fire registered listeners in sequence and returns a promise containing wrapping an array of all
+   * individual results.
+   * The parameters passed to the fire are forwarded in the same order to the listeners.
+   * @returns {Promise<U>}
+   */
+  async fire (...args) {
+    const self = this
+
+    const applyHook = function applyHook (l, hookArrayName, outerArgs) {
+      self[hookArrayName].forEach((p) => {
+        p.apply(l, outerArgs)
+      })
+    }
+
+    const results = []
+
+    for (const l of this._listeners) {
+      const currentArgs = [...args]
+      applyHook(l, '_pre', currentArgs)
+
+      try {
+        const val = await l.fn.apply(l.context, currentArgs)
+        applyHook(l, '_post', currentArgs)
+        results.push(val)
+      } catch (e) {
+        currentArgs.unshift(e)
+        applyHook(l, '_postFail', currentArgs)
+        throw e
+      }
+    }
+
+    return results
+  }
+}

package/lib/shared/normalizeMetaFromLogs.js

@@ -1,30 +1,30 @@
-const omit = require('lodash.omit')
-
-module.exports = (level, msg, meta) => {
-  // detecting if meta is jsreport request object
-  if (meta != null && meta.context) {
-    meta.context.logs = meta.context.logs || []
-
-    meta.context.logs.push({
-      level: level,
-      message: msg,
-      timestamp: meta.timestamp || new Date().getTime()
-    })
-
-    // TODO adding cancel looks bad, its before script is adding req.cancel()
-    // excluding non relevant properties for the log
-    const newMeta = Object.assign({}, omit(meta, ['template', 'options', 'data', 'context', 'timestamp', 'cancel']))
-
-    if (newMeta.rootId == null && meta.context.rootId != null) {
-      newMeta.rootId = meta.context.rootId
-    }
-
-    if (newMeta.id == null && meta.context.id != null) {
-      newMeta.id = meta.context.id
-    }
-
-    return newMeta
-  }
-
-  return meta
-}
+const omit = require('lodash.omit')
+
+module.exports = (level, msg, meta) => {
+  // detecting if meta is jsreport request object
+  if (meta != null && meta.context) {
+    meta.context.logs = meta.context.logs || []
+
+    meta.context.logs.push({
+      level: level,
+      message: msg,
+      timestamp: meta.timestamp || new Date().getTime()
+    })
+
+    // TODO adding cancel looks bad, its before script is adding req.cancel()
+    // excluding non relevant properties for the log
+    const newMeta = Object.assign({}, omit(meta, ['template', 'options', 'data', 'context', 'timestamp', 'cancel']))
+
+    if (newMeta.rootId == null && meta.context.rootId != null) {
+      newMeta.rootId = meta.context.rootId
+    }
+
+    if (newMeta.id == null && meta.context.id != null) {
+      newMeta.id = meta.context.id
+    }
+
+    return newMeta
+  }
+
+  return meta
+}

package/lib/shared/reporter.js

@@ -1,123 +1,128 @@
-const EventEmitter = require('events')
-const createListenerCollection = require('./listenerCollection')
-const Request = require('./request')
-const Templates = require('./templates')
-const Folders = require('./folders')
-const createOrExtendError = require('./createError')
-const tempFilesHandler = require('./tempFilesHandler')
-const encryption = require('./encryption')
-
-class Reporter extends EventEmitter {
-  constructor (options) {
-    super()
-
-    this.options = options || {}
-    this.Request = Request
-
-    // since `reporter` instance will be used for other extensions,
-    // it will quickly reach the limit of `10` listeners,
-    // we increase the limit to Infinity for now,
-    // later we should probably design
-    // a way to detect possible memory leaks from extensions
-    this.setMaxListeners(Infinity)
-
-    const coreVersion = require('../../package.json').version
-
-    this.version = coreVersion
-    this.coreVersion = coreVersion
-
-    this.initializeListeners = this.createListenerCollection('initialize')
-    this.afterRenderListeners = this.createListenerCollection('afterRender')
-    this.renderErrorListeners = this.createListenerCollection('renderError')
-    this.beforeRenderListeners = this.createListenerCollection('beforeRender')
-    this.closeListeners = this.createListenerCollection('close')
-  }
-
-  createListenerCollection (name) {
-    return createListenerCollection(name)
-  }
-
-  /**
-   *  Creates a custom error or extends an existing one
-   *
-   * @public
-   */
-  createError (message, options = {}) {
-    return createOrExtendError(message, options)
-  }
-
-  /**
-   * Ensures that the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory) exists by doing a mkdir call
-   *
-   * @public
-   */
-  async ensureTempDirectoryExists () {
-    if (this.options.tempAutoCleanupDirectory == null) {
-      throw new Error('Can not use ensureTempDirectoryExists when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
-    }
-
-    return tempFilesHandler.ensureTempDirectoryExists(this.options.tempAutoCleanupDirectory)
-  }
-
-  /**
-   * Reads a file from the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
-   *
-   * @public
-   */
-  async readTempFile (filename, opts) {
-    if (this.options.tempAutoCleanupDirectory == null) {
-      throw new Error('Can not use readTempFile when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
-    }
-
-    return tempFilesHandler.readTempFile(this.options.tempAutoCleanupDirectory, filename, opts)
-  }
-
-  /**
-   * Creates a file into the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
-   * ensuring that the directory always exists
-   *
-   * @public
-   */
-  async writeTempFile (filenameFn, content, opts) {
-    if (this.options.tempAutoCleanupDirectory == null) {
-      throw new Error('Can not use writeTempFile when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
-    }
-
-    return tempFilesHandler.writeTempFile(this.options.tempAutoCleanupDirectory, filenameFn, content, opts)
-  }
-
-  /**
-   * Reads a file as stream from the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
-   *
-   * @public
-   */
-  async readTempFileStream (filename, opts) {
-    if (this.options.tempAutoCleanupDirectory == null) {
-      throw new Error('Can not use readTempFileStream when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
-    }
-
-    return tempFilesHandler.readTempFileStream(this.options.tempAutoCleanupDirectory, filename, opts)
-  }
-
-  /**
-   * Creates a file as stream into the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
-   * ensuring that the directory always exists
-   *
-   * @public
-   */
-  async writeTempFileStream (filenameFn, opts) {
-    if (this.options.tempAutoCleanupDirectory == null) {
-      throw new Error('Can not use writeTempFileStream when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
-    }
-
-    return tempFilesHandler.writeTempFileStream(this.options.tempAutoCleanupDirectory, filenameFn, opts)
-  }
-
-  async init () {
-    this.templates = Templates(this)
-    this.folders = Folders(this)
-    this.encryption = encryption(this)
-  }
-}
-
-module.exports = Reporter
+const EventEmitter = require('events')
+const createListenerCollection = require('./listenerCollection')
+const Request = require('./request')
+const Templates = require('./templates')
+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) {
+    super()
+
+    this.options = options || {}
+    this.Request = Request
+
+    // since `reporter` instance will be used for other extensions,
+    // it will quickly reach the limit of `10` listeners,
+    // we increase the limit to Infinity for now,
+    // later we should probably design
+    // a way to detect possible memory leaks from extensions
+    this.setMaxListeners(Infinity)
+
+    const coreVersion = require('../../package.json').version
+
+    this.version = coreVersion
+    this.coreVersion = coreVersion
+
+    this.initializeListeners = this.createListenerCollection('initialize')
+    this.afterRenderListeners = this.createListenerCollection('afterRender')
+    this.renderErrorListeners = this.createListenerCollection('renderError')
+    this.beforeRenderListeners = this.createListenerCollection('beforeRender')
+    this.closeListeners = this.createListenerCollection('close')
+  }
+
+  createListenerCollection (name) {
+    return createListenerCollection(name)
+  }
+
+  /**
+   *  Creates a custom error or extends an existing one
+   *
+   * @public
+   */
+  createError (message, options = {}) {
+    return createOrExtendError(message, options)
+  }
+
+  generateRequestId () {
+    return generateRequestId()
+  }
+
+  /**
+   * Ensures that the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory) exists by doing a mkdir call
+   *
+   * @public
+   */
+  async ensureTempDirectoryExists () {
+    if (this.options.tempAutoCleanupDirectory == null) {
+      throw new Error('Can not use ensureTempDirectoryExists when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
+    }
+
+    return tempFilesHandler.ensureTempDirectoryExists(this.options.tempAutoCleanupDirectory)
+  }
+
+  /**
+   * Reads a file from the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
+   *
+   * @public
+   */
+  async readTempFile (filename, opts) {
+    if (this.options.tempAutoCleanupDirectory == null) {
+      throw new Error('Can not use readTempFile when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
+    }
+
+    return tempFilesHandler.readTempFile(this.options.tempAutoCleanupDirectory, filename, opts)
+  }
+
+  /**
+   * Creates a file into the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
+   * ensuring that the directory always exists
+   *
+   * @public
+   */
+  async writeTempFile (filenameFn, content, opts) {
+    if (this.options.tempAutoCleanupDirectory == null) {
+      throw new Error('Can not use writeTempFile when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
+    }
+
+    return tempFilesHandler.writeTempFile(this.options.tempAutoCleanupDirectory, filenameFn, content, opts)
+  }
+
+  /**
+   * Reads a file as stream from the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
+   *
+   * @public
+   */
+  async readTempFileStream (filename, opts) {
+    if (this.options.tempAutoCleanupDirectory == null) {
+      throw new Error('Can not use readTempFileStream when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
+    }
+
+    return tempFilesHandler.readTempFileStream(this.options.tempAutoCleanupDirectory, filename, opts)
+  }
+
+  /**
+   * Creates a file as stream into the jsreport auto-cleanup temp directory (options.tempAutoCleanupDirectory)
+   * ensuring that the directory always exists
+   *
+   * @public
+   */
+  async writeTempFileStream (filenameFn, opts) {
+    if (this.options.tempAutoCleanupDirectory == null) {
+      throw new Error('Can not use writeTempFileStream when tempAutoCleanupDirectory option is not initialized, make sure to initialize jsreport first using jsreport.init()')
+    }
+
+    return tempFilesHandler.writeTempFileStream(this.options.tempAutoCleanupDirectory, filenameFn, opts)
+  }
+
+  async init () {
+    this.templates = Templates(this)
+    this.folders = Folders(this)
+    this.encryption = encryption(this)
+  }
+}
+
+module.exports = Reporter