@exodus/test 1.0.0-rc.17 → 1.0.0-rc.19

package/bin/index.js

@@ -6,20 +6,13 @@ import { basename, dirname, resolve } from 'node:path'
 import { createRequire } from 'node:module'
 import assert from 'node:assert/strict'
 import glob from 'fast-glob'
+import { haveModuleMocks, haveSnapshots, haveForceExit } from '../src/version.js'
 
 const bindir = dirname(fileURLToPath(import.meta.url))
 
-const EXTS = `.?([cm])[jt]s?(x)` // we differt from jest, allowing [cm] before everything
+const EXTS = `.?([cm])[jt]s?(x)` // we differ from jest, allowing [cm] before everything
 const DEFAULT_PATTERNS = [`**/__tests__/**/*${EXTS}`, `**/?(*.)+(spec|test)${EXTS}`]
 
-function versionCheck() {
-  const [major, minor, patch] = process.versions.node.split('.').map(Number)
-  assert((major === 18 && minor >= 13) || major >= 20, 'Node.js version too old!')
-  assert(major !== 21, 'Node.js version deprecated!')
-
-  return { major, minor, patch }
-}
-
 function parseOptions() {
   const options = {
     jest: false,
@@ -100,7 +93,6 @@ function parseOptions() {
   return { options, patterns }
 }
 
-const { major, minor } = versionCheck()
 const { options, patterns } = parseOptions()
 
 let program = 'node'
@@ -114,10 +106,7 @@ if (resolveImport) assert.equal(c8, resolveImport('c8/bin/c8.js'))
 
 const args = ['--test', '--no-warnings=ExperimentalWarning']
 
-const haveModuleMocks = major > 22 || (major === 22 && minor >= 3)
 if (haveModuleMocks) args.push('--experimental-test-module-mocks')
-
-const haveSnapshots = major > 22 || (major === 22 && minor >= 3)
 if (haveSnapshots) args.push('--experimental-test-snapshots')
 
 if (options.writeSnapshots) {
@@ -126,14 +115,11 @@ if (options.writeSnapshots) {
 }
 
 if (options.forceExit) {
-  assert((major === 20 && minor > 13) || major >= 22, 'For forceExit, use Node.js >= 20.14.0')
+  assert(haveForceExit, 'For forceExit, use Node.js >= 20.14.0')
   args.push('--test-force-exit')
 }
 
-if (options.watch) {
-  assert((major === 18 && minor > 13) || major >= 20, 'For watch mode, use Node.js >= 18.13.0')
-  args.push('--watch')
-}
+if (options.watch) args.push('--watch')
 
 args.push('--expose-internals') // this is unoptimal and hopefully temporary, see rationale in src/dark.cjs
 
@@ -151,12 +137,8 @@ if (options.coverage) {
 }
 
 if (options.esbuild) {
-  if (major >= 22 || (major === 20 && minor >= 6) || (major === 18 && minor >= 18)) {
-    assert(resolveImport)
-    args.push('--import', resolveImport('tsx'))
-  } else {
-    args.push('-r', resolveRequire('tsx/cjs'))
-  }
+  assert(resolveImport)
+  args.push('--import', resolveImport('tsx'))
 }
 
 if (options.babel) {
@@ -176,11 +158,7 @@ if (process.env.EXODUS_TEST_IGNORE) {
 if (options.jest) {
   const { loadJestConfig } = await import('../src/jest.config.js')
   const config = await loadJestConfig(process.cwd())
-  if (major >= 20 || (major === 18 && minor >= 18)) {
-    args.push('--import', resolve(bindir, 'jest.js'))
-  } else {
-    throw new Error('Option --jest requires Node.js >= v18.18.0')
-  }
+  args.push('--import', resolve(bindir, 'jest.js'))
 
   if (config.testFailureExitCode !== undefined) {
     if (Number(config.testFailureExitCode) === 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/test",
-  "version": "1.0.0-rc.17",
+  "version": "1.0.0-rc.19",
   "author": "Exodus Movement, Inc.",
   "description": "A test suite runner",
   "homepage": "https://github.com/ExodusMovement/test",
@@ -42,6 +42,7 @@
     "src/jest.snapshot.js",
     "src/jest.timers.js",
     "src/tape.js",
+    "src/version.js",
     "!__tests__",
     "CHANGELOG.md"
   ],
@@ -68,6 +69,7 @@
     "@types/jest-when": "^3.5.2",
     "@typescript-eslint/eslint-plugin": "^7.15.0",
     "eslint": "^8.44.0",
+    "jest": "^29.7.0",
     "jest-matcher-utils": "^29.7.0",
     "jest-serializer-ansi-escapes": "^3.0.0",
     "jest-when": "^3.6.0"

package/src/jest.fn.js

@@ -61,7 +61,6 @@ export const jestfn = (baseimpl, parent, property) => {
 
   const queuedMock = (impl) => {
     mockimpl = impl || noop
-    onceStack.length = 0
   }
 
   // getMockImplementation() is undocumented and is changed only in real mockImplementation() call

package/src/jest.js

@@ -7,8 +7,10 @@ import { jestmock, requireActual, requireMock, resetModules } from './jest.mock.
 import * as jestTimers from './jest.timers.js'
 import './jest.snapshot.js'
 import { createCallerLocationHook } from './dark.cjs'
+import './version.js'
 import { expect } from 'expect'
 import matchers from 'jest-extended'
+import { format as prettyFormat } from 'pretty-format'
 
 const { getCallerLocation, installLocationInNextTest } = createCallerLocationHook()
 
@@ -46,8 +48,10 @@ const makeEach =
     // Hack for common testing with simple arrow functions, until we can disable esbuild minification
     const formatArg = (x) => (x && x instanceof Function && `${x}` === '()=>{}' ? '() => {}' : x)
     // better than nothing
-    const protos = new Set([null, Array.prototype, Object.prototype])
-    const printed = (x) => (x && protos.has(Object.getPrototypeOf(x)) ? JSON.stringify(x) : `${x}`)
+    const printed = (x) =>
+      x && [null, Array.prototype, Object.prototype].includes(Object.getPrototypeOf(x))
+        ? prettyFormat(x, { min: true })
+        : `${x}`
 
     const args = parseArgs(list, rest)
     const wrapped = args.every((x) => Array.isArray(x))
@@ -81,9 +85,11 @@ const makeEach =
 const forceExit = process.execArgv.map((x) => x.replaceAll('_', '-')).includes('--test-force-exit')
 
 const inConcurrent = []
+const inDescribe = []
 const concurrent = []
 const describe = (...args) => {
   const fn = args.pop()
+  inDescribe.push(fn)
   const optionsConcurrent = args?.at(-1)?.concurrency > 1
   if (optionsConcurrent) inConcurrent.push(fn)
   const result = nodeDescribe(...args, async () => {
@@ -105,6 +111,7 @@ const describe = (...args) => {
     return res
   })
   if (optionsConcurrent) inConcurrent.pop()
+  inDescribe.pop()
   return result
 }
 
@@ -129,8 +136,12 @@ const test = (...args) => testRaw(getCallerLocation(), ...args)
 
 describe.each = makeEach(describe)
 test.each = makeEach(test)
-test.concurrent = (...args) =>
-  inConcurrent.length > 0 ? test(...args) : concurrent.push([args, getCallerLocation()])
+test.concurrent = (...args) => {
+  assert(inDescribe.length > 0, 'test.concurrent is supported only within a describe block')
+  if (inConcurrent.length > 0) return test(...args)
+  concurrent.push([args, getCallerLocation()])
+}
+
 test.concurrent.each = makeEach(test.concurrent)
 describe.skip = (...args) => nodeDescribe.skip(...args)
 test.skip = (...args) => nodeTest.skip(...args)

package/src/jest.mock.js

@@ -16,6 +16,8 @@ export const relativeRequire = require
 
 export function resolveModule(name) {
   assert(baseUrl || /^[@a-zA-Z]/u.test(name), 'Mocking relative paths is not possible')
+  const unprefixed = name.replace(/^node:/, '')
+  if (builtinModules.includes(unprefixed)) return unprefixed
   return require.resolve(name)
 }
 
@@ -70,7 +72,7 @@ function mockClone(root) {
     if (obj instanceof RegExp) return [new RegExp(), false] // this is what jest does apparently
     if (seen.has(obj)) return [seen.get(obj), !simple.has(obj)]
     if (obj instanceof Function) {
-      seen.set(obj, jestfn(obj))
+      seen.set(obj, jestfn())
       return [seen.get(obj), true]
     }
 
@@ -96,8 +98,6 @@ function mockClone(root) {
 }
 
 export function jestmock(name, mocker) {
-  assert(mock.module, 'ESM module mocks are available only on Node.js >=22.3')
-
   // Loaded ESM: isn't mocked
   // Loaded CJS: mocked via object overriding
   // Loaded built-ins: mocked via object overriding where possible
@@ -119,18 +119,20 @@ export function jestmock(name, mocker) {
   const value = mocker ? { ...mocker() } : mockClone(mapActual.get(resolved))
   mapMocks.set(resolved, value)
 
-  // fall through when e.g. this module doesn't exist or is ESM
   if (Object.hasOwn(require.cache, resolved)) {
     assert.equal(mapActual.get(resolved), require.cache[resolved].exports)
     // If we did't have this prior but have now, it means we just loaded it and there are no leaked instances
     if (havePrior) override(resolved)
     require.cache[resolved].exports = value
-  } else if (builtinModules.includes(resolved.replace(/^node:/, ''))) {
+  } else if (builtinModules.includes(resolved)) {
     override(resolved, true) // Override builtin modules
     syncBuiltinESMExports()
+  } else {
+    // The module doesn't exist or is ESM
+    assert(mock.module, 'ESM module mocks are available only on Node.js >=22.3')
   }
 
-  mock.module(name, { defaultExport: value.default, namedExports: value })
+  mock.module?.(name, { defaultExport: value.default ?? value, namedExports: value })
 
   return this
 }

package/src/jest.snapshot.js

@@ -1,7 +1,7 @@
 import { beforeEach } from 'node:test'
 import { createRequire } from 'node:module'
 import { expect } from 'expect'
-import { format } from 'pretty-format'
+import { format, plugins as builtinPlugins } from 'pretty-format'
 import assert from 'node:assert/strict'
 import { basename, dirname, join, normalize } from 'node:path'
 import { readFileSync } from 'node:fs'
@@ -10,7 +10,7 @@ import { relativeRequire } from './jest.mock.js'
 import { getTestNamePath } from './dark.cjs'
 
 const { snapshotFormat, snapshotSerializers } = jestConfig()
-const plugins = []
+const plugins = Object.values(builtinPlugins)
 const serialize = (val) => format(val, { ...snapshotFormat, plugins }).replaceAll(/\r\n|\r/gu, '\n')
 const resolveSnapshot = (f) => join(dirname(f), '__snapshots__', `${basename(f)}.snap`)
 
@@ -106,7 +106,16 @@ const snapInline = (obj, inline) => {
   getAssert().strictEqual(serialize(obj).trim(), inline.trim())
 }
 
-const snapOnDisk = (obj) => {
+const snapOnDisk = (orig, matcher) => {
+  if (matcher) {
+    expect(orig).toMatchObject(matcher)
+    // If we passed, make appear that the above call never happened
+    const state = expect.getState()
+    state.assertionCalls--
+    state.numPassingAsserts--
+  }
+
+  const obj = matcher ? { ...orig, ...matcher } : orig
   const escape = (str) => str.replaceAll(/([\\`])/gu, '\\$1')
 
   if (!maybeSetupJestSnapshots()) {
@@ -142,16 +151,19 @@ const snapOnDisk = (obj) => {
   try {
     wrapContextName(() => getAssert().snapshot(obj))
   } catch (e) {
-    const escaped = escape(e.expected)
-    const final = escaped.includes('\n') ? escaped : `\n${escaped}\n`
-    if (final === e.actual) return
+    if (typeof e.expected === 'string') {
+      const escaped = escape(e.expected)
+      const final = escaped.includes('\n') ? escaped : `\n${escaped}\n`
+      if (final === e.actual) return
+    }
+
     throw e
   }
 }
 
 expect.extend({
   toMatchInlineSnapshot: (obj, i) => wrap(() => snapInline(obj, i)),
-  toMatchSnapshot: (obj) => wrap(() => snapOnDisk(obj)),
+  toMatchSnapshot: (obj, matcher) => wrap(() => snapOnDisk(obj, matcher)),
   toThrowErrorMatchingInlineSnapshot: (...a) => wrap(() => throws(a, (m) => snapInline(m, a[1]))),
   toThrowErrorMatchingSnapshot: (...a) => wrap(() => throws(a, (m) => snapOnDisk(m))),
 })

package/src/jest.timers.js

@@ -1,18 +1,16 @@
 import assert from 'node:assert/strict'
 import { mock } from 'node:test'
 import { jestConfig } from './jest.config.js'
-
-const [major, minor] = process.versions.node.split('.').map(Number)
+import { haveValidTimers, haveNoTimerInfiniteLoopBug } from './version.js'
 
 const assertHaveTimers = () =>
   assert(mock.timers, 'Timer mocking requires Node.js >=20.4.0 || 18 >=18.19.0')
 
 let timersWarned = false
 const warnOldTimers = () => {
-  if (timersWarned) return
+  if (haveValidTimers || timersWarned) return
   timersWarned = true
-  const ok = major >= 22 || (major === 20 && minor >= 11)
-  if (!ok) console.warn('Warning: timer mocks are known to be glitchy before Node.js >=20.11.0')
+  console.warn('Warning: timer mocks are known to be glitchy before Node.js >=20.11.0')
 }
 
 export function useRealTimers() {
@@ -47,8 +45,7 @@ export function runAllTimers() {
 }
 
 export function runOnlyPendingTimers() {
-  const noInfiniteLoopBug = major >= 22 || (major === 20 && minor >= 11)
-  assert(noInfiniteLoopBug, 'runOnlyPendingTimers requires Node.js >=20.11.0')
+  assert(haveNoTimerInfiniteLoopBug, 'runOnlyPendingTimers requires Node.js >=20.11.0')
   mock.timers.runAll()
   return this
 }

package/src/tape.js

@@ -2,6 +2,7 @@ import assert from 'node:assert/strict'
 import assertLoose from 'node:assert'
 import { test } from 'node:test'
 import { createCallerLocationHook } from './dark.cjs'
+import './version.js'
 
 const knownOptions = new Set(['skip', 'todo', 'concurrency', 'timeout'])
 

package/src/version.js

@@ -0,0 +1,16 @@
+import assert from 'node:assert/strict'
+
+const [major, minor, patch] = process.versions.node.split('.').map(Number)
+assert(major !== 21, 'Node.js 21.x is deprecated!') // reached EOL, no reason to even test
+// older versions are glitchy with before/after on top-level, which is a deal-breaker
+const ok = (major === 18 && minor >= 19) || (major === 20 && minor >= 7) || major >= 22
+assert(ok, 'Node.js version too old or glitchy with node:test, use ^18.19.0 || ^20.7.0 || >=22.0.0')
+assert(major !== 22 || minor !== 3, 'Refusing to run on Node.js 22.3.0 specifically, do not use it') // safe-guard
+
+export { major, minor, patch }
+
+export const haveModuleMocks = (major === 22 && minor >= 3) || major > 22
+export const haveSnapshots = (major === 22 && minor >= 3) || 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