@jsreport/jsreport-cli 3.0.0-beta.2 → 3.1.1

package/lib/{errorUtils.js → utils/error.js}

@@ -1,127 +1,149 @@
-'use strict'
-
-function formatError (err) {
-  return err.message || ''
-}
-
-function addStack (err, stack, { stackPrefix = '', stripMessage = false } = {}) {
-  if (stack != null && stack !== '') {
-    let newStack = stack
-    let originalStack = ''
-
-    if (err.stack != null && err.stack !== '') {
-      originalStack = `${err.stack}\n`
-    }
-
-    if (stripMessage) {
-      // to avoid duplicating message we strip the message
-      // from the stack if it is equals to the message of error
-      newStack = newStack.replace(/(\S+:) (.+)(\r?\n)/, (match, gLabel, gMessage, gRest) => {
-        if (err.message === gMessage) {
-          return `${gLabel}${gRest}`
-        }
-
-        return match
-      })
-    }
-
-    err.stack = `${originalStack}${stackPrefix}${newStack}`
-  }
-}
-
-function getErrors (err) {
-  let parent = err
-  const errors = []
-
-  while (parent != null) {
-    const customProps = Object.assign({}, parent)
-    let currentStack = parent.stack || ''
-    let cleanState = false
-
-    if (parent.cleanState === true) {
-      cleanState = true
-    }
-
-    // making sure custom props like "originalError", "cleanState" are not part of meta
-    delete customProps.originalError
-    delete customProps.disableExit
-    delete customProps.cleanState
-
-    const fakeE = { message: parent.message, stack: '' }
-
-    addStack(fakeE, parent.stack || '', {
-      stripMessage: true
-    })
-
-    currentStack = fakeE.stack
-
-    errors.push({
-      message: parent.message,
-      stack: currentStack || '',
-      meta: Object.keys(customProps).length > 0 ? customProps : undefined,
-      cleanState
-    })
-
-    parent = parent.originalError
-  }
-
-  return errors
-}
-
-function getErrorMessages (err) {
-  const errors = getErrors(err)
-  let count = errors.length
-  let cleanState = false
-  const messages = []
-  const stacks = []
-
-  errors.forEach((error) => {
-    let customProps = error.meta || {}
-    const currentStack = error.stack
-
-    if (!cleanState && error.cleanState === true) {
-      cleanState = true
-    }
-
-    customProps = JSON.stringify(customProps)
-
-    if (cleanState) {
-      messages.push(`${formatError(error)}`)
-    } else {
-      messages.push(`${formatError(error)} (${count})`)
-    }
-
-    if (customProps === '{}') {
-      customProps = ''
-    }
-
-    if (currentStack !== '') {
-      const causedBy = `caused by error (${count}):`
-
-      if (customProps !== '') {
-        stacks.push(`${causedBy}\n-> meta = ${customProps}\n-> stack\n${currentStack}`)
-      } else {
-        stacks.push(`${causedBy}\n-> stack\n${currentStack}`)
-      }
-    }
-
-    count--
-  })
-
-  if (!cleanState && stacks.length > 0) {
-    messages.push(`\n${stacks.join('\n')}`)
-  }
-
-  return messages
-}
-
-function printError (err, logger) {
-  const messages = getErrorMessages(err)
-
-  logger.error(messages.join('. '))
-}
-
-module.exports.printError = printError
-module.exports.getErrors = getErrors
-module.exports.getErrorMessages = getErrorMessages
-module.exports.addStack = addStack
+'use strict'
+
+function formatError (err) {
+  return err.message || ''
+}
+
+function addStack (err, stack, { stackPrefix = '', stripMessage = false } = {}) {
+  if (stack != null && stack !== '') {
+    let newStack = stack
+    let originalStack = ''
+
+    if (err.stack != null && err.stack !== '') {
+      originalStack = `${err.stack}\n`
+    }
+
+    if (stripMessage) {
+      // to avoid duplicating message we strip the message
+      // from the stack if it is equals to the message of error
+      newStack = newStack.replace(/(\S+:) (.+)(\r?\n)/, (match, gLabel, gMessage, gRest) => {
+        if (err.message === gMessage) {
+          return `${gLabel}${gRest}`
+        }
+
+        return match
+      })
+    }
+
+    err.stack = `${originalStack}${stackPrefix}${newStack}`
+  }
+}
+
+function getErrors (err) {
+  let parent = err
+  const errors = []
+
+  while (parent != null) {
+    const customProps = Object.assign({}, parent)
+    let currentStack = parent.stack || ''
+    let cleanState = false
+
+    if (parent.cleanState === true) {
+      cleanState = true
+    }
+
+    // making sure custom props like "originalError", "cleanState" are not part of meta
+    delete customProps.originalError
+    delete customProps.disableExit
+    delete customProps.cleanState
+
+    const fakeE = { message: parent.message, stack: '' }
+
+    addStack(fakeE, parent.stack || '', {
+      stripMessage: true
+    })
+
+    currentStack = fakeE.stack
+
+    errors.push({
+      message: parent.message,
+      stack: currentStack || '',
+      meta: Object.keys(customProps).length > 0 ? getSimpleProperties(customProps) : undefined,
+      cleanState
+    })
+
+    parent = parent.originalError
+  }
+
+  return errors
+}
+
+function getErrorMessages (err) {
+  const errors = getErrors(err)
+  let count = errors.length
+  let cleanState = false
+  const messages = []
+  const stacks = []
+
+  errors.forEach((error) => {
+    let customProps = error.meta || {}
+    const currentStack = error.stack
+
+    if (!cleanState && error.cleanState === true) {
+      cleanState = true
+    }
+
+    customProps = JSON.stringify(customProps)
+
+    if (cleanState) {
+      messages.push(`${formatError(error)}`)
+    } else {
+      messages.push(`${formatError(error)} (${count})`)
+    }
+
+    if (customProps === '{}') {
+      customProps = ''
+    }
+
+    if (currentStack !== '') {
+      const causedBy = `caused by error (${count}):`
+
+      if (customProps !== '') {
+        stacks.push(`${causedBy}\n-> meta = ${customProps}\n-> stack\n${currentStack}`)
+      } else {
+        stacks.push(`${causedBy}\n-> stack\n${currentStack}`)
+      }
+    }
+
+    count--
+  })
+
+  if (!cleanState && stacks.length > 0) {
+    messages.push(`\n${stacks.join('\n')}`)
+  }
+
+  return messages
+}
+
+function getSimpleProperties (obj) {
+  const newObj = {}
+
+  for (const [key, value] of Object.entries(obj)) {
+    if (
+      value == null ||
+      typeof value === 'string' ||
+      typeof value === 'number' ||
+      typeof value === 'boolean' ||
+      typeof value === 'bigint'
+    ) {
+      newObj[key] = value
+    }
+  }
+
+  if (Object.keys(newObj).length === 0) {
+    return undefined
+  }
+
+  return newObj
+}
+
+function printError (err, logger) {
+  const messages = getErrorMessages(err)
+
+  logger.error(messages.join('. '))
+}
+
+module.exports.printError = printError
+module.exports.getErrors = getErrors
+module.exports.getErrorMessages = getErrorMessages
+module.exports.addStack = addStack

package/lib/{getTempPaths.js → utils/getTempPaths.js}

@@ -1,39 +1,39 @@
-const path = require('path')
-const fs = require('fs')
-const os = require('os')
-
-module.exports = () => {
-  const useCustomTempDirectory = process.env.cli_tempDirectory != null
-  const useCustomSocketDirectory = process.env.cli_socketsDirectory != null
-  const ROOT_PATH = !useCustomTempDirectory ? path.join(os.tmpdir(), 'jsreport') : process.env.cli_tempDirectory
-  const CLI_PATH = path.join(ROOT_PATH, 'cli')
-  const MAIN_SOCK_PATH = !useCustomSocketDirectory ? path.join(CLI_PATH, 'sock') : process.env.cli_socketsDirectory
-  const WORKER_SOCK_PATH = path.join(path.dirname(MAIN_SOCK_PATH), 'wSock')
-
-  return {
-    useCustomSocketDirectory,
-    rootPath: ROOT_PATH,
-    cliPath: CLI_PATH,
-    mainSockPath: MAIN_SOCK_PATH,
-    workerSockPath: WORKER_SOCK_PATH,
-    createPaths: () => {
-      if (!useCustomSocketDirectory) {
-        tryCreate(ROOT_PATH)
-        tryCreate(CLI_PATH)
-      }
-
-      tryCreate(MAIN_SOCK_PATH)
-      tryCreate(WORKER_SOCK_PATH)
-    }
-  }
-}
-
-function tryCreate (dir) {
-  try {
-    fs.mkdirSync(dir, '0755')
-  } catch (err) {
-    if (err.code !== 'EEXIST') {
-      throw err
-    }
-  }
-}
+const path = require('path')
+const fs = require('fs')
+const os = require('os')
+
+module.exports = () => {
+  const useCustomTempDirectory = process.env.cli_tempDirectory != null
+  const useCustomSocketDirectory = process.env.cli_socketsDirectory != null
+  const ROOT_PATH = !useCustomTempDirectory ? path.join(os.tmpdir(), 'jsreport') : process.env.cli_tempDirectory
+  const CLI_PATH = path.join(ROOT_PATH, 'cli')
+  const MAIN_SOCK_PATH = !useCustomSocketDirectory ? path.join(CLI_PATH, 'sock') : process.env.cli_socketsDirectory
+  const WORKER_SOCK_PATH = path.join(path.dirname(MAIN_SOCK_PATH), 'wSock')
+
+  return {
+    useCustomSocketDirectory,
+    rootPath: ROOT_PATH,
+    cliPath: CLI_PATH,
+    mainSockPath: MAIN_SOCK_PATH,
+    workerSockPath: WORKER_SOCK_PATH,
+    createPaths: () => {
+      if (!useCustomSocketDirectory) {
+        tryCreate(ROOT_PATH)
+        tryCreate(CLI_PATH)
+      }
+
+      tryCreate(MAIN_SOCK_PATH)
+      tryCreate(WORKER_SOCK_PATH)
+    }
+  }
+}
+
+function tryCreate (dir) {
+  try {
+    fs.mkdirSync(dir, '0755')
+  } catch (err) {
+    if (err.code !== 'EEXIST') {
+      throw err
+    }
+  }
+}

package/lib/{normalizePathOptionOrArg.js → utils/normalizePathOptionOrArg.js}

@@ -1,41 +1,41 @@
-const path = require('path')
-const fs = require('fs')
-
-module.exports = function normalizePathOption (cwd, optionOrArgName, value, options = {}) {
-  const type = options.type ? options.type : 'option'
-
-  if (typeof value === 'string') {
-    const pathVal = path.resolve(cwd, value)
-
-    if (options.strict) {
-      if (!path.isAbsolute(pathVal)) {
-        throw new Error(`${optionOrArgName} ${type} must be a valid file path`)
-      }
-    }
-
-    const read = options.read != null ? options.read : true
-    if (!read) {
-      return pathVal
-    }
-
-    try {
-      if (options.json) {
-        return JSON.parse(fs.readFileSync(pathVal).toString())
-      } else {
-        return fs.readFileSync(pathVal).toString()
-      }
-    } catch (e) {
-      if (e.code !== 'ENOENT' && options.json) {
-        throw new Error(`${optionOrArgName} ${type} error: file in ${pathVal} doesn't have a valid JSON content`)
-      }
-
-      throw new Error(`${optionOrArgName} ${type} error: can't read file in ${pathVal}`)
-    }
-  }
-
-  if (options.strict) {
-    throw new Error(`${optionOrArgName} ${type} must be a file path`)
-  }
-
-  return value
-}
+const path = require('path')
+const fs = require('fs')
+
+module.exports = function normalizePathOption (cwd, optionOrArgName, value, options = {}) {
+  const type = options.type ? options.type : 'option'
+
+  if (typeof value === 'string') {
+    const pathVal = path.resolve(cwd, value)
+
+    if (options.strict) {
+      if (!path.isAbsolute(pathVal)) {
+        throw new Error(`${optionOrArgName} ${type} must be a valid file path`)
+      }
+    }
+
+    const read = options.read != null ? options.read : true
+    if (!read) {
+      return pathVal
+    }
+
+    try {
+      if (options.json) {
+        return JSON.parse(fs.readFileSync(pathVal).toString())
+      } else {
+        return fs.readFileSync(pathVal).toString()
+      }
+    } catch (e) {
+      if (e.code !== 'ENOENT' && options.json) {
+        throw new Error(`${optionOrArgName} ${type} error: file in ${pathVal} doesn't have a valid JSON content`)
+      }
+
+      throw new Error(`${optionOrArgName} ${type} error: can't read file in ${pathVal}`)
+    }
+  }
+
+  if (options.strict) {
+    throw new Error(`${optionOrArgName} ${type} must be a file path`)
+  }
+
+  return value
+}

package/lib/{normalizeSocketPath.js → utils/normalizeSocketPath.js}

@@ -1,9 +1,9 @@
-'use strict'
-
-module.exports = function normalizeSocketPath (socketPath) {
-  if (process.platform === 'win32') {
-    socketPath = '\\\\.\\pipe\\' + socketPath
-  }
-
-  return socketPath
-}
+'use strict'
+
+module.exports = function normalizeSocketPath (socketPath) {
+  if (process.platform === 'win32') {
+    socketPath = '\\\\.\\pipe\\' + socketPath
+  }
+
+  return socketPath
+}

package/lib/{startSocketServer.js → utils/startSocketServer.js}

@@ -1,53 +1,53 @@
-'use strict'
-
-const path = require('path')
-const fs = require('fs')
-const nanoid = require('nanoid')
-const nssocket = require('nssocket')
-const normalizeSocketPath = require('./normalizeSocketPath')
-
-/**
- * Starts a server using a socket file randomly generated
- * and resolves when it is ready to listen connections
- */
-module.exports = function startSocketServer (options, cb) {
-  const socketPath = options.socketPath
-  const socketPrefix = options.socketPrefix || ''
-  const createSymbolicForSocket = options.createSymbolicForSocket
-  const protocol = options.protocol
-  const uid = nanoid(7)
-  const server = nssocket.createServer(protocol)
-
-  const socketFile = path.join(socketPath, [
-    socketPrefix,
-    uid,
-    'sock'
-  ].join('.'))
-
-  if (createSymbolicForSocket) {
-    fs.openSync(socketFile, 'w')
-  }
-
-  const normalizedSocketFile = normalizeSocketPath(socketFile)
-
-  server.on('listening', () => {
-    cb(null, {
-      uid: uid,
-      socketFile: socketFile,
-      normalizedSocketFile: normalizedSocketFile,
-      server: server
-    })
-  })
-
-  server.on('error', (err) => {
-    if (err.code === 'EADDRINUSE') {
-      return startSocketServer(options, cb)
-    } else {
-      cb(err)
-    }
-  })
-
-  server.listen(normalizedSocketFile)
-
-  return server
-}
+'use strict'
+
+const path = require('path')
+const fs = require('fs')
+const { nanoid } = require('nanoid')
+const nssocket = require('nssocket')
+const normalizeSocketPath = require('./normalizeSocketPath')
+
+/**
+ * Starts a server using a socket file randomly generated
+ * and resolves when it is ready to listen connections
+ */
+module.exports = function startSocketServer (options, cb) {
+  const socketPath = options.socketPath
+  const socketPrefix = options.socketPrefix || ''
+  const createSymbolicForSocket = options.createSymbolicForSocket
+  const protocol = options.protocol
+  const uid = nanoid(7)
+  const server = nssocket.createServer(protocol)
+
+  const socketFile = path.join(socketPath, [
+    socketPrefix,
+    uid,
+    'sock'
+  ].join('.'))
+
+  if (createSymbolicForSocket) {
+    fs.openSync(socketFile, 'w')
+  }
+
+  const normalizedSocketFile = normalizeSocketPath(socketFile)
+
+  server.on('listening', () => {
+    cb(null, {
+      uid: uid,
+      socketFile: socketFile,
+      normalizedSocketFile: normalizedSocketFile,
+      server: server
+    })
+  })
+
+  server.on('error', (err) => {
+    if (err.code === 'EADDRINUSE') {
+      return startSocketServer(options, cb)
+    } else {
+      cb(err)
+    }
+  })
+
+  server.listen(normalizedSocketFile)
+
+  return server
+}