isolated-function 0.1.6 → 0.1.8

package/README.md

@@ -22,6 +22,7 @@
   - [Auto install dependencies](#auto-install-dependencies)
   - [Execution profiling](#execution-profiling)
   - [Resource limits](#resource-limits)
+  - [Logging](#logging)
   - [Error handling](#error-handling)
 - [API](#api)
   - [isolatedFunction(code, \[options\])](#isolatedfunctioncode-options)
@@ -30,6 +31,7 @@
       - [memory](#memory)
       - [throwError](#throwerror)
       - [timeout](#timeout)
+      - [tmpdir](#tmpdir)
   - [=\> (fn(\[...args\]), teardown())](#-fnargs-teardown)
     - [fn](#fn)
     - [teardown](#teardown)
@@ -166,6 +168,32 @@ await fn(100)
 // =>  TimeoutError: Execution timed out
 ```
 
+### Logging
+
+The logs are collected into a `logging` object returned after the execution:
+
+```js
+const [fn, teardown] = isolatedFunction(() => {
+  console.log('console.log')
+  console.info('console.info')
+  console.debug('console.debug')
+  console.warn('console.warn')
+  console.error('console.error')
+  return 'done'
+})
+
+const { logging } await fn()
+
+console.log(logging)
+// {
+//   log: ['console.log'],
+//   info: ['console.info'],
+//   debug: ['console.debug'],
+//   warn: ['console.warn'],
+//   error: ['console.error']
+// }
+```
+
 ### Error handling
 
 Any error during **isolated-function** execution will be propagated:
@@ -232,6 +260,13 @@ Default: `Infinity`
 
 Timeout after a specified amount of time, in milliseconds.
 
+##### tmpdir
+
+Type: `function`<br>
+Default: `fs.mkdtemp(path.join(require('os').tmpdir(), 'compile-'))`
+
+The temporal folder to use for installing code dependencies.
+
 ### => (fn([...args]), teardown())
 
 #### fn

package/package.json

@@ -2,7 +2,7 @@
   "name": "isolated-function",
   "description": "Runs untrusted code in a Node.js v8 sandbox.",
   "homepage": "https://github.com/Kikobeats/isolated-function",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "main": "src/index.js",
   "exports": {
     ".": "./src/index.js"

package/src/compile/index.js

@@ -3,7 +3,6 @@
 const { execSync } = require('child_process')
 const esbuild = require('esbuild')
 const fs = require('fs/promises')
-const { tmpdir } = require('os')
 const $ = require('tinyspawn')
 const path = require('path')
 
@@ -22,8 +21,10 @@ const packageManager = (() => {
   }
 })()
 
-const getTmp = async content => {
-  const cwd = await fs.mkdtemp(path.join(tmpdir(), 'compile-'))
+const tmpdirDefault = () => fs.mkdtemp(path.join(require('os').tmpdir(), 'compile-'))
+
+const getTmp = async (content, tmpdir) => {
+  const cwd = await tmpdir()
   await fs.mkdir(cwd, { recursive: true })
 
   const filepath = path.join(cwd, 'index.js')
@@ -33,10 +34,10 @@ const getTmp = async content => {
   return { filepath, cwd, content, cleanup }
 }
 
-module.exports = async snippet => {
+module.exports = async (snippet, tmpdir = tmpdirDefault) => {
   const compiledTemplate = generateTemplate(snippet)
   const dependencies = detectDependencies(compiledTemplate)
-  const tmp = await getTmp(transformDependencies(compiledTemplate))
+  const tmp = await getTmp(transformDependencies(compiledTemplate), tmpdir)
 
   await $(packageManager.init, { cwd: tmp.cwd })
   await $(`${packageManager.install} ${dependencies.join(' ')}`, {
@@ -52,7 +53,7 @@ module.exports = async snippet => {
   })
 
   await tmp.cleanup()
-  return getTmp(result.outputFiles[0].text)
+  return getTmp(result.outputFiles[0].text, tmpdir)
 }
 
 module.exports.detectDependencies = detectDependencies

package/src/compile/transform-dependencies.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const acorn = require('acorn')
 const walk = require('acorn-walk')
+const acorn = require('acorn')
 
 module.exports = code => {
   const ast = acorn.parse(code, { ecmaVersion: 2020, sourceType: 'module' })

package/src/index.js

@@ -15,14 +15,18 @@ const createError = ({ name, message, ...props }) => {
 }
 
 const flags = ({ filename, memory }) => {
-  const flags = ['--experimental-permission', `--allow-fs-read=${filename}`]
+  const flags = [
+    '--disable-warning=ExperimentalWarning',
+    '--experimental-permission',
+    `--allow-fs-read=${filename}`
+  ]
   if (memory) flags.push(`--max-old-space-size=${memory}`)
   return flags.join(' ')
 }
 
-module.exports = (snippet, { timeout, memory, throwError = true } = {}) => {
+module.exports = (snippet, { tmpdir, timeout, memory, throwError = true } = {}) => {
   if (!['function', 'string'].includes(typeof snippet)) throw new TypeError('Expected a function')
-  const compilePromise = compile(snippet)
+  const compilePromise = compile(snippet, tmpdir)
 
   const fn = async (...args) => {
     let duration
@@ -39,11 +43,15 @@ module.exports = (snippet, { timeout, memory, throwError = true } = {}) => {
         timeout,
         killSignal: 'SIGKILL'
       })
-      const { isFulfilled, value, profiling } = JSON.parse(stdout)
+      const { isFulfilled, value, profiling, logging } = JSON.parse(stdout)
       profiling.duration = duration()
-      if (isFulfilled) return { isFulfilled, value, profiling }
-      if (throwError) throw deserializeError(value)
-      return { isFulfilled: false, value: deserializeError(value), profiling }
+      return isFulfilled
+        ? { isFulfilled, value, profiling, logging }
+        : throwError
+          ? (() => {
+              throw deserializeError(value)
+            })()
+          : { isFulfilled: false, value: deserializeError(value), profiling, logging }
     } catch (error) {
       if (error.signalCode === 'SIGTRAP') {
         throw createError({

package/src/template/index.js

@@ -2,10 +2,20 @@
 
 const SERIALIZE_ERROR = require('./serialize-error')
 
-const generateTemplate = snippet => `
+module.exports = snippet => `
   const args = JSON.parse(process.argv[2])
 
-  ;(async () => {
+  const logging = Object.create(null)
+
+  for (const method of ['log', 'info', 'debug', 'warn', 'error']) {
+    console[method] = function (...args) {
+      const input = args.join(' ')
+      logging[method] === undefined ? logging[method] = [input] : logging[method].push(input)
+    }
+  }
+
+  ;(async (send) => {
+    process.stdout.write = function () {}
     let value
     let isFulfilled
 
@@ -16,12 +26,11 @@ const generateTemplate = snippet => `
       value = ${SERIALIZE_ERROR}(error)
       isFulfilled = false
     } finally {
-      console.log(JSON.stringify({
+      send(JSON.stringify({
         isFulfilled,
+        logging,
         value,
         profiling: { memory: process.memoryUsage().rss }
       }))
     }
-  })()`
-
-module.exports = generateTemplate
+  })(process.stdout.write.bind(process.stdout))`