isolated-function 0.1.14 → 0.1.16

package/README.md

@@ -35,6 +35,9 @@
   - [=\> (fn(\[...args\]), teardown())](#-fnargs-teardown)
     - [fn](#fn)
     - [teardown](#teardown)
+- [Environment Variables](#environment-variables)
+    - [`ISOLATED_FUNCTIONS_MINIFY`](#isolated_functions_minify)
+    - [`DEBUG`](#debug)
 - [License](#license)
 
 ## Install
@@ -262,9 +265,19 @@ 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.
+It setup the temporal folder to be used for installing code dependencies.
+
+The default implementation is:
+
+```js
+const tmpdir = async () => {
+  const cwd = await fs.mkdtemp(path.join(require('os').tmpdir(), 'compile-'))
+  await fs.mkdir(cwd, { recursive: true })
+  const cleanup = () => fs.rm(cwd, { recursive: true, force: true })
+  return { cwd, cleanup }
+}
+```
 
 ### => (fn([...args]), teardown())
 
@@ -280,6 +293,18 @@ Type: `function`
 
 A function to be called to release resources associated with the **isolated-function**.
 
+## Environment Variables
+
+#### `ISOLATED_FUNCTIONS_MINIFY`
+
+Default: `true`
+
+When is `false`, it disabled minify the compiled code.
+
+#### `DEBUG`
+
+Pass `DEBUG=isolated-function` for enabling debug timing output.
+
 ## License
 
 **isolated-function** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/Kikobeats/isolated-function/blob/master/LICENSE.md) License.<br>

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.14",
+  "version": "0.1.16",
   "main": "src/index.js",
   "exports": {
     ".": "./src/index.js"
@@ -36,6 +36,7 @@
     "@kikobeats/time-span": "~1.0.5",
     "acorn": "~8.12.1",
     "acorn-walk": "~8.3.3",
+    "debug-logfmt": "~1.2.3",
     "ensure-error": "~3.0.1",
     "esbuild": "~0.23.1",
     "serialize-error": "8",

package/src/compile/index.js

@@ -9,6 +9,7 @@ const path = require('path')
 const transformDependencies = require('./transform-dependencies')
 const detectDependencies = require('./detect-dependencies')
 const generateTemplate = require('../template')
+const { duration } = require('../debug')
 
 const MINIFY = (() => {
   return process.env.ISOLATED_FUNCTIONS_MINIFY !== 'false'
@@ -20,48 +21,52 @@ const MINIFY = (() => {
       }
 })()
 
-const packageManager = (() => {
+const install = (() => {
   try {
     execSync('which pnpm').toString().trim()
-    return { init: 'pnpm init', install: 'pnpm install' }
+    return 'pnpm install'
   } catch {
-    return { init: 'npm init --yes', install: 'npm install' }
+    return 'npm install'
   }
 })()
 
-const tmpdirDefault = () => fs.mkdtemp(path.join(require('os').tmpdir(), 'compile-'))
-
-const getTmp = async (content, tmpdir) => {
-  const cwd = await tmpdir()
+const tmpdirDefault = async () => {
+  const cwd = await fs.mkdtemp(path.join(require('os').tmpdir(), 'compile-'))
   await fs.mkdir(cwd, { recursive: true })
-
-  const filepath = path.join(cwd, 'index.js')
-  await fs.writeFile(filepath, content)
-
   const cleanup = () => fs.rm(cwd, { recursive: true, force: true })
-  return { filepath, cwd, content, cleanup }
+  return { cwd, cleanup }
 }
 
 module.exports = async (snippet, tmpdir = tmpdirDefault) => {
   const compiledTemplate = generateTemplate(snippet)
   const dependencies = detectDependencies(compiledTemplate)
-  const tmp = await getTmp(transformDependencies(compiledTemplate), tmpdir)
 
-  await $(packageManager.init, { cwd: tmp.cwd })
-  await $(`${packageManager.install} ${dependencies.join(' ')}`, {
-    cwd: tmp.cwd
-  })
+  const content = transformDependencies(compiledTemplate)
+  const tmpDir = await duration('tmpdir', tmpdir)
 
-  const result = await esbuild.build({
-    entryPoints: [tmp.filepath],
-    bundle: true,
-    ...MINIFY,
-    write: false,
-    platform: 'node'
-  })
+  await duration('npm:init', () => fs.writeFile(path.join(tmpDir.cwd, 'package.json'), '{}'))
+  await duration('npm:install', () =>
+    $(`${install} ${dependencies.join(' ')}`, { cwd: tmpDir.cwd })
+  )
 
-  await tmp.cleanup()
-  return getTmp(result.outputFiles[0].text, tmpdir)
+  const result = await duration('esbuild', () =>
+    esbuild.build({
+      stdin: {
+        contents: content,
+        resolveDir: tmpDir.cwd,
+        sourcefile: 'index.js'
+      },
+      bundle: true,
+      ...MINIFY,
+      write: false,
+      platform: 'node'
+    })
+  )
+
+  return {
+    content: result.outputFiles[0].text,
+    cleanupPromise: duration('tmpDir:cleanup', tmpDir.cleanup)
+  }
 }
 
 module.exports.detectDependencies = detectDependencies

package/src/debug.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const debug = require('debug-logfmt')('isolated-function')
+
+const duration = async (name, fn) => {
+  const duration = debug.duration(name)
+
+  return Promise.resolve(fn())
+    .then(result => {
+      duration()
+      return result
+    })
+    .catch(error => {
+      duration.error()
+      throw error
+    })
+}
+
+module.exports = { debug, duration }

package/src/index.js

@@ -2,10 +2,11 @@
 
 const { deserializeError } = require('serialize-error')
 const timeSpan = require('@kikobeats/time-span')()
+const { Readable } = require('node:stream')
 const $ = require('tinyspawn')
-const path = require('path')
 
 const compile = require('./compile')
+const { debug } = require('./debug')
 
 const createError = ({ name, message, ...props }) => {
   const error = new Error(message)
@@ -14,12 +15,8 @@ const createError = ({ name, message, ...props }) => {
   return error
 }
 
-const flags = ({ filename, memory }) => {
-  const flags = [
-    '--disable-warning=ExperimentalWarning',
-    '--experimental-permission',
-    `--allow-fs-read=${filename}`
-  ]
+const flags = ({ memory }) => {
+  const flags = ['--disable-warning=ExperimentalWarning', '--experimental-permission']
   if (memory) flags.push(`--max-old-space-size=${memory}`)
   return flags.join(' ')
 }
@@ -31,22 +28,26 @@ module.exports = (snippet, { tmpdir, timeout, memory, throwError = true } = {})
   const fn = async (...args) => {
     let duration
     try {
-      const { filepath } = await compilePromise
+      const { content, cleanupPromise } = await compilePromise
 
-      const cwd = path.dirname(filepath)
-      const filename = path.basename(filepath)
       duration = timeSpan()
-      const { stdout } = await $('node', [filename, JSON.stringify(args)], {
-        cwd,
+      const subprocess = $('node', ['-', JSON.stringify(args)], {
         env: {
           ...process.env,
-          NODE_OPTIONS: flags({ filename, memory })
+          NODE_OPTIONS: flags({ memory })
         },
         timeout,
         killSignal: 'SIGKILL'
       })
+      Readable.from(content).pipe(subprocess.stdin)
+      const [{ stdout }] = await Promise.all([subprocess, cleanupPromise])
       const { isFulfilled, value, profiling, logging } = JSON.parse(stdout)
       profiling.duration = duration()
+      debug('node', {
+        duration: `${Math.round(profiling.duration / 100)}s`,
+        memory: `${Math.round(profiling.memory / (1024 * 1024))}MiB`
+      })
+
       return isFulfilled
         ? { isFulfilled, value, profiling, logging }
         : throwError