@exodus/test 1.0.0-rc.33 → 1.0.0-rc.35

package/bin/bundle.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict'
 import { readFile } from 'node:fs/promises'
 import { existsSync } from 'node:fs'
 import { fileURLToPath, pathToFileURL } from 'node:url'
-import { basename, dirname, resolve, join } from 'node:path'
+import { basename, dirname, extname, resolve, join } from 'node:path'
 import { createRequire } from 'node:module'
 import { randomUUID as uuid, randomBytes } from 'node:crypto'
 import * as esbuild from 'esbuild'
@@ -56,8 +56,14 @@ const loadPipeline = [
 
 const options = {}
 
-export const init = async ({ platform, jest, target, jestConfig, outdir }) => {
-  Object.assign(options, { platform, jest, target, jestConfig, outdir })
+export const init = async ({ platform, jest, flow, target, jestConfig, outdir }) => {
+  Object.assign(options, { platform, jest, flow, target, jestConfig, outdir })
+
+  if (options.flow) {
+    const { default: flowRemoveTypes } = await import('flow-remove-types')
+    loadPipeline.unshift((source) => flowRemoveTypes(source, { pretty: true }).toString())
+  }
+
   if (options.platform === 'hermes') {
     const babel = await import('./babel-worker.cjs')
     loadPipeline.push(async (source) => {
@@ -182,10 +188,12 @@ export const build = async (...files) => {
       'process.env.NO_COLOR': stringify('1'),
       'process.env.NODE_ENV': stringify(process.env.NODE_ENV),
       'process.env.EXODUS_TEST_CONTEXT': stringify('pure'),
-      'process.env.EXODUS_TEST_ENVIRONMENT': stringify('bundle'),
-      'process.env.EXODUS_TEST_PLATFORM': stringify(process.env.EXODUS_TEST_PLATFORM),
+      'process.env.EXODUS_TEST_ENVIRONMENT': stringify('bundle'), // always 'bundle'
+      'process.env.EXODUS_TEST_PLATFORM': stringify(process.env.EXODUS_TEST_PLATFORM), // e.g. 'hermes', 'node'
+      'process.env.EXODUS_TEST_ENGINE': stringify(process.env.EXODUS_TEST_ENGINE), // e.g. 'hermes:bundle', 'node:bundle'
       'process.env.EXODUS_TEST_JEST_CONFIG': stringify(JSON.stringify(options.jestConfig)),
       'process.env.EXODUS_TEST_EXECARGV': stringify(process.env.EXODUS_TEST_EXECARGV),
+      'process.env.EXODUS_TEST_ONLY': stringify(process.env.EXODUS_TEST_ONLY),
       'process.env.NODE_DEBUG': stringify(),
       'process.env.DEBUG': stringify(),
       'process.env.READABLE_STREAM': stringify(),
@@ -254,17 +262,19 @@ export const build = async (...files) => {
       {
         name: 'exodus-test.bundle',
         setup({ onLoad }) {
-          onLoad({ filter: /\.[cm]?[jt]s$/, namespace: 'file' }, async (args) => {
+          onLoad({ filter: /\.[cm]?[jt]sx?$/, namespace: 'file' }, async (args) => {
             let filepath = args.path
             // Resolve .native versions
             // TODO: move flag to engine options
             // TODO: maybe follow package.json for this
             if (['jsc', 'hermes'].includes(options.platform)) {
-              const maybeNative = filepath.replace(/(\.[cm]?[jt]s)$/u, '.native$1')
+              const maybeNative = filepath.replace(/(\.[cm]?[jt]sx?)$/u, '.native$1')
               if (existsSync(maybeNative)) filepath = maybeNative
             }
 
-            const loader = /\.[cm]?ts$/.test(filepath) ? 'ts' : 'js'
+            const loader = extname(filepath).replace(/^\.[cm]?/, '') // TODO: a flag to force jsx/tsx perhaps
+            assert(['js', 'ts', 'jsx', 'tx'].includes(loader))
+
             return { contents: await loadSourceFile(filepath), loader }
           })
         },

package/bin/index.js

@@ -38,6 +38,7 @@ function parseOptions() {
   const options = {
     jest: false,
     typescript: false,
+    flow: false,
     esbuild: false,
     babel: false,
     coverage: false,
@@ -47,6 +48,7 @@ function parseOptions() {
     passWithNoTests: false,
     writeSnapshots: false,
     debug: { files: false },
+    dropNetwork: ![undefined, '', '0'].includes(process.env.EXODUS_TEST_DROP_NETWORK),
     ideaCompat: false,
     engine: process.env.EXODUS_TEST_ENGINE ?? 'node:test',
   }
@@ -85,6 +87,9 @@ function parseOptions() {
       case '--typescript':
         options.typescript = true
         break
+      case '--flow':
+        options.flow = true
+        break
       case '--esbuild':
         options.esbuild = true
         break
@@ -100,6 +105,7 @@ function parseOptions() {
       case '--watch':
         options.watch = true
         break
+      case '--test-only':
       case '--only':
         options.only = true
         break
@@ -128,6 +134,9 @@ function parseOptions() {
         process.env.NO_COLOR = '1'
         process.env.NODE_DISABLE_COLORS = '1'
         break
+      case '--drop-network':
+        options.dropNetwork = true
+        break
       case '--idea-compat':
         options.ideaCompat = true
         break
@@ -169,7 +178,6 @@ if (options.pure) {
   assert(!options.writeSnapshots, `Can not use write snapshots with ${options.engine} engine`)
   assert(!options.forceExit, `Can not use --force-exit with ${options.engine} engine yet`) // TODO
   assert(!options.watch, `Can not use --watch with with ${options.engine} engine`)
-  assert(!options.only, `Can not use --only with with ${options.engine} engine yet`) // TODO
 } else if (options.engine === 'node:test') {
   args.push('--test', '--no-warnings=ExperimentalWarning', '--test-reporter=spec')
 
@@ -340,7 +348,9 @@ if (tsTests.length > 0 && !options.esbuild && !options.typescript) {
 }
 
 if (!Object.hasOwn(process.env, 'NODE_ENV')) process.env.NODE_ENV = 'test'
-process.env.EXODUS_TEST_PLATFORM = options.binary
+process.env.EXODUS_TEST_PLATFORM = options.binary // e.g. 'hermes', 'node'
+process.env.EXODUS_TEST_ENGINE = options.engine // e.g. 'hermes:bundle', 'node:bundle', 'node:test', 'node:pure'
+process.env.EXODUS_TEST_ONLY = options.only ? '1' : ''
 
 const c8 = resolveRequire('c8/bin/c8.js')
 if (resolveImport) assert.equal(c8, resolveImport('c8/bin/c8.js'))
@@ -353,7 +363,7 @@ if (options.coverage) {
     args.unshift(options.binary)
     options.binary = c8
     // perhaps use text-summary ?
-    args.unshift('-r', 'text', '-r', 'html', '-r', 'lcov')
+    args.unshift('-r', 'text', '-r', 'html', '-r', 'lcov', '-r', 'json-summary')
   } else {
     throw new Error(`Unknown coverage engine: ${JSON.stringify(options.coverageEngine)}`)
   }
@@ -374,7 +384,32 @@ if (options.bundle) {
   buildFile = (file) => bundle.build(file)
 }
 
-assert(options.binary && ['node', 'bun', 'deno', 'jsc', 'hermes', c8].includes(options.binary))
+if (options.dropNetwork) {
+  console.warn(`--drop-network is experimental and is a test helper, not a security mechanism`)
+}
+
+const execFile = promisify(execFileCallback)
+
+async function launch(binary, args, opts = {}, buffering = false) {
+  assert(binary && ['node', 'bun', 'deno', 'jsc', 'hermes', c8].includes(binary))
+  if (options.dropNetwork) {
+    switch (process.platform) {
+      case 'darwin':
+        ;[binary, args] = ['sandbox-exec', ['-n', 'no-network', binary, ...args]]
+        break
+      case 'linux':
+        ;[binary, args] = ['unshare', ['-n', '-r', binary, ...args]]
+        break
+      default:
+        assert.fail(`--drop-network is not implemented on platform: ${process.platform}`)
+    }
+  }
+
+  if (buffering) return execFile(binary, args, { maxBuffer: 5 * 1024 * 1024, ...opts }) // 5 MiB just in case
+  const child = spawn(binary, args, { stdio: 'inherit', ...opts })
+  const [code] = await once(child, 'close')
+  return { code }
+}
 
 if (options.pure) {
   if (options.binary === 'hermes') {
@@ -405,8 +440,6 @@ if (options.pure) {
   process.env.EXODUS_TEST_CONTEXT = 'pure'
   console.warn(`\n${options.engine} engine is experimental and may not work an expected\n`)
 
-  const execFile = promisify(execFileCallback)
-
   const runOne = async (inputFile) => {
     const bundled = buildFile ? await buildFile(inputFile) : undefined
     if (buildFile) assert(bundled.file)
@@ -414,12 +447,12 @@ if (options.pure) {
     if (bundled?.errors.length > 0) return { ok: false, output: bundled.errors }
 
     const { binaryArgs = [] } = options
-    // 5 MiB just in case, timeout is fallback if timeout in script hangs, 50x as it can be adjusted per-script inside them
+    // Timeout is fallback if timeout in script hangs, 50x as it can be adjusted per-script inside them
     // Do we want to extract timeouts from script code instead? Also, hermes might be slower, so makes sense to increase
-    const execOpts = { maxBuffer: 5 * 1024 * 1024, timeout: (jestConfig?.testTimeout || 5000) * 50 }
+    const timeout = (jestConfig?.testTimeout || 5000) * 50
     try {
       const fullArgs = [...binaryArgs, ...args, file]
-      const { code = 0, stdout, stderr } = await execFile(options.binary, fullArgs, execOpts)
+      const { code = 0, stdout, stderr } = await launch(options.binary, fullArgs, { timeout }, true)
       return { ok: code === 0, output: [stdout, stderr] }
     } catch (err) {
       const { code, stdout = '', stderr = '', signal, killed } = err
@@ -463,6 +496,7 @@ if (options.pure) {
       .replaceAll(/^✔ PASS /gmu, color('✔ PASS ', 'green'))
       .replaceAll(/^⏭ SKIP /gmu, color('⏭ SKIP ', 'dim'))
       .replaceAll(/^✖ FAIL /gmu, color('✖ FAIL ', 'red'))
+      .replaceAll(/^⚠ WARN /gmu, color('⚠ WARN ', 'blue'))
       .replaceAll(/^‼ FATAL /gmu, `${color('‼', 'red')} ${color(' FATAL ', 'bgRed')} `)
   }
 
@@ -498,7 +532,6 @@ if (options.pure) {
   process.env.EXODUS_TEST_CONTEXT = options.engine
   assert(files.length > 0) // otherwise we can run recursively
   assert(!options.binaryArgs)
-  const node = spawn(options.binary, [...args, ...files], { stdio: 'inherit' })
-  const [code] = await once(node, 'close')
+  const { code } = await launch(options.binary, [...args, ...files])
   process.exitCode = code
 }

package/bin/typescript.loader.js

@@ -1,17 +1,13 @@
-import { dirname, resolve as pathResolve } from 'node:path'
-import { createRequire } from 'node:module'
 import { readFile } from 'node:fs/promises'
+import { transformSync } from 'amaro'
 
-const require = createRequire(import.meta.url)
-const amaroDir = dirname(require.resolve('amaro/package.json'))
-const amaro = await import(pathResolve(amaroDir, 'dist/index.js'))
 const extensionsRegex = /\.ts$|\.mts$/
 
 export async function load(url, context, nextLoad) {
   if (extensionsRegex.test(url) && !url.includes('/node_modules/')) {
     const sourceBuf = await readFile(new URL(url))
     const source = sourceBuf.toString('utf8')
-    const transformed = amaro.transformSync(source, { isModule: true }).code
+    const { code: transformed } = transformSync(source, { isModule: true })
     const transformedBuf = Buffer.from(transformed)
     if (sourceBuf.length !== transformed.length) throw new Error('length mismatch')
     // eslint-disable-next-line unicorn/no-for-loop

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/test",
-  "version": "1.0.0-rc.33",
+  "version": "1.0.0-rc.35",
   "author": "Exodus Movement, Inc.",
   "description": "A test suite runner",
   "homepage": "https://github.com/ExodusMovement/test",
@@ -31,7 +31,10 @@
   "exports": {
     "./jest": "./src/jest.js",
     "./node": "./src/node.js",
-    "./tape": "./src/tape.js"
+    "./tape": {
+      "import": "./src/tape.js",
+      "require": "./src/tape.cjs"
+    }
   },
   "prettier": "@exodus/prettier",
   "files": [
@@ -100,7 +103,7 @@
     "@babel/register": "^7.0.0",
     "@chalker/queue": "^1.0.0",
     "@ungap/url-search-params": "^0.2.2",
-    "amaro": "^0.0.4",
+    "amaro": "^0.0.5",
     "assert": "^2.1.0",
     "browserify-zlib": "^0.2.0",
     "buffer": "^6.0.3",
@@ -111,6 +114,7 @@
     "events": "^3.3.0",
     "expect": "^29.7.0",
     "fast-glob": "^3.2.11",
+    "flow-remove-types": "^2.242.0",
     "jest-extended": "^4.0.2",
     "jsdom": "^24.1.0",
     "os-browserify": "^0.3.0",

package/src/engine.pure.cjs

@@ -20,28 +20,37 @@ function parseArgs(args) {
   return { name, options, fn }
 }
 
-function enterContext(name, options = {}) {
-  assert(!running)
-  if (willstart) clearTimeout(willstart) // have to he accurate for engines like Hermes
-  context = {
-    root: context?.root,
-    parent: context,
-    name,
-    options,
-    fullName: context && context !== context.root ? `${context.fullName} > ${name}` : name,
-    assert: { ...assertLoose, snapshot: undefined },
-    hooks: { __proto__: null, before: [], after: [], beforeEach: [], afterEach: [] },
-    test, // todo: bind to context
-    describe, // todo: bind to context
-    children: [],
+class Context {
+  test = test // todo: bind to context
+  describe = describe // todo: bind to context
+  children = []
+  assert = { ...assertLoose, snapshot: undefined }
+  hooks = { __proto__: null, before: [], after: [], beforeEach: [], afterEach: [] }
+
+  constructor(parent, name, options = {}) {
+    Object.assign(this, { root: parent?.root, parent, name, options })
+    this.fullName = parent && parent !== parent.root ? `${parent.fullName} > ${name}` : name
+    if (this.root) {
+      this.parent.children.push(this)
+    } else {
+      assert(this.name === '<root>' && !this.parent)
+      this.root = this
+    }
   }
-  if (context.root) {
-    context.parent.children.push(context)
-  } else {
-    assert((context.name = '<root>'))
-    assert(!context.parent)
-    context.root = context
+
+  get onlySomewhere() {
+    return this.options.only || this.children.some((x) => x.onlySomewhere)
   }
+
+  get only() {
+    return (this.options.only && !this.children.some((x) => x.onlySomewhere)) || this.parent?.only
+  }
+}
+
+function enterContext(name, options) {
+  assert(!running)
+  if (willstart) clearTimeout(willstart) // have to he accurate for engines like Hermes
+  context = new Context(context, name, options)
 }
 
 function exitContext() {
@@ -55,6 +64,8 @@ async function runFunction(fn, context) {
   return new Promise((resolve, reject) => fn(context, (err) => (err ? reject(err) : resolve())))
 }
 
+const runOnly = process.env.EXODUS_TEST_ONLY === '1'
+
 async function runContext(context) {
   const { options, children, hooks, fn } = context
   assert(!context.running, 'Can not run twice')
@@ -63,6 +74,12 @@ async function runContext(context) {
   assert(children.length === 0 || !fn)
   if (options.skip) return console.log('⏭ SKIP', context.fullName)
   if (context.fn) {
+    if (runOnly) {
+      if (!context.only) return console.log('⏭ SKIP', context.fullName)
+    } else if (options.only) {
+      console.log(`⚠ WARN test.only requires the --only command-line option`)
+    }
+
     let error
     const stack = [context]
     while (stack[0].parent) stack.unshift(stack[0].parent)
@@ -93,6 +110,10 @@ async function runContext(context) {
       abstractProcess.exitCode = 1
     }
   } else {
+    if (options.only && !runOnly) {
+      console.log(`⚠ WARN describe.only requires the --only command-line option`)
+    }
+
     // if (context !== context.root) console.log(`▶ ${context.fullName}`)
     // TODO: try/catch for hooks?
     // TODO: flatten recursion before running?
@@ -118,7 +139,6 @@ async function run() {
 async function describe(...args) {
   const { name, options, fn } = parseArgs(args)
   enterContext(name, options)
-  context.options = options
   // todo: callback support?
   if (!options.skip) {
     try {
@@ -140,6 +160,11 @@ describe.skip = (...args) => {
   return describe(name, { ...options, skip: true }, fn)
 }
 
+describe.only = (...args) => {
+  const { name, options, fn } = parseArgs(args)
+  return describe(name, { ...options, only: true }, fn)
+}
+
 function test(...args) {
   const { name, options, fn } = parseArgs(args)
   enterContext(name, options)
@@ -152,6 +177,11 @@ test.skip = (...args) => {
   return test(name, { ...options, skip: true }, fn)
 }
 
+test.only = (...args) => {
+  const { name, options, fn } = parseArgs(args)
+  return test(name, { ...options, only: true }, fn)
+}
+
 class MockTimers {
   #enabled = false
   #base = 0

package/src/jest.js

@@ -89,12 +89,13 @@ const forceExit = execArgv.map((x) => x.replaceAll('_', '-')).includes('--test-f
 const inConcurrent = []
 const inDescribe = []
 const concurrent = []
-const describe = (...args) => {
+
+const describeRaw = (nodeDescribe, ...args) => {
   const fn = args.pop()
   inDescribe.push(fn)
   const optionsConcurrent = args?.at(-1)?.concurrency > 1
   if (optionsConcurrent) inConcurrent.push(fn)
-  const result = node.describe(...args, () => {
+  const result = nodeDescribe(...args, () => {
     const res = fn()
 
     // We do only block-level concurrency, not file-level
@@ -104,7 +105,7 @@ const describe = (...args) => {
     } else if (concurrent.length > 0) {
       const queue = [...concurrent]
       concurrent.length = 0
-      describe('concurrent', { concurrency: defaultConcurrency }, () => {
+      nodeDescribe('concurrent', { concurrency: defaultConcurrency }, () => {
         for (const args of queue) testRaw(...args)
       })
     }
@@ -133,6 +134,9 @@ Also, using expect.assertions() to ensure the planned number of assertions is be
   })
 }
 
+const describe = (...args) => describeRaw(node.describe, ...args)
+describe.only = (...args) => describeRaw(node.describe.only, ...args)
+
 const test = (...args) => testRaw(getCallerLocation(), node.test, ...args)
 test.only = (...args) => testRaw(getCallerLocation(), node.test.only, ...args)
 
@@ -178,10 +182,11 @@ const isBundle = process.env.EXODUS_TEST_ENVIRONMENT === 'bundle' // TODO: impro
 export const jest = {
   exodus: {
     __proto__: null,
+    platform: String(process.env.EXODUS_TEST_PLATFORM), // e.g. 'hermes', 'node'
+    engine: String(process.env.EXODUS_TEST_ENGINE), // e.g. 'hermes:bundle', 'node:bundle', 'node:test', 'node:pure'
+    implementation: String(node.engine), // aka process.env.EXODUS_TEST_CONTEXT, e.g. 'node:test' or 'pure'
     features: {
       __proto__: null,
-      platform: String(process.env.EXODUS_TEST_PLATFORM),
-      engine: String(node.engine),
       timers: Boolean(mock.timers && haveValidTimers),
       esmMocks: Boolean(mock.module && !isBundle), // full support for ESM mocks
       esmInterop: Boolean(insideEsbuild && !isBundle), // loading/using ESM as CJS, ESM mocks creation without a mocker function

package/src/jest.snapshot.js

@@ -10,6 +10,7 @@ import { expect } from 'expect'
 import { format, plugins as builtinPlugins } from 'pretty-format'
 import { jestConfig } from './jest.config.js'
 import { getTestNamePath } from './dark.cjs'
+import { haveSnapshotsReportUnescaped } from './version.js'
 
 const { snapshotFormat, snapshotSerializers } = jestConfig()
 const plugins = Object.values(builtinPlugins)
@@ -160,7 +161,7 @@ const snapOnDisk = (orig, matcher) => {
     wrapContextName(() => getAssert().snapshot(obj))
   } catch (e) {
     if (typeof e.expected === 'string') {
-      const escaped = escape(e.expected)
+      const escaped = haveSnapshotsReportUnescaped ? e.expected : escape(e.expected)
       const final = escaped.includes('\n') ? escaped : `\n${escaped}\n`
       if (final === e.actual) return
     }

package/src/version.js

@@ -12,6 +12,7 @@ export { major, minor, patch }
 
 export const haveModuleMocks = (major === 22 && minor >= 3) || major > 22
 export const haveSnapshots = (major === 22 && minor >= 3) || major > 22
+export const haveSnapshotsReportUnescaped = (major === 22 && minor >= 5) || major > 22
 export const haveForceExit = (major === 20 && minor > 13) || major >= 22
 export const haveValidTimers = (major === 20 && minor >= 11) || major >= 22 // older glitch in various ways / stop executing
 export const haveNoTimerInfiniteLoopBug = (major === 20 && minor >= 11) || major >= 22 // mock.timers.runAll() can get into infinite recursion