Add Node.js 26 support; drop 25 (#3450)

* Sanitize line numbers for lib/ files in reporter logs

* Remove v25 snapshots

* Test with Node.js 26

External assertion snapshot cannot be updated, since AVA 8 emits corrupt snapshots with Node.js 26.

* Update support statement now that odd-numbered Node.js releases will become LTS

* Upgrade to cbor2 for Node.js 26 snapshot compatibility

* Skip tests failing due to Node.js 26 bug

Author: novemberborn

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [^22.20, ^24.12, ^25]
+        node-version: [^22.20, ^24.12, ^26]
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
       - uses: actions/checkout@v6

docs/support-statement.md

@@ -8,8 +8,6 @@ AVA supports the latest release of any major version that [is supported by Node.
 
 When we drop support for an LTS-covered major version we will bump AVA's major version number.
 
-We will drop support for odd-numbered Node.js versions (e.g. `21` or `23`) *without* bumping AVA's major version number.
-
 We try to avoid *accidentally* dropping support for non-latest Node.js releases. If such breakage does occur we'll accept pull requests to restore functionality. We might decide to deprecate the offending AVA release and bump AVA's major version number instead.
 
 Whenever we bump AVA's major version number, we *will* explicitly drop support for non-latest Node.js releases. This ensures we can rely on backported APIs or the availability of newer V8 releases in later Node.js versions, either in AVA itself or one of our dependencies.

lib/snapshot-manager.js

@@ -6,7 +6,9 @@ import path from 'node:path';
 import {fileURLToPath} from 'node:url';
 import zlib from 'node:zlib';
 
-import cbor from 'cbor';
+import {decode as decodeCbor, encode as encodeCbor, TypeEncoderMap} from 'cbor2';
+import {writeArray, writeUint8Array} from 'cbor2/encoder';
+import {sortLengthFirstDeterministic} from 'cbor2/sorts';
 import concordance from 'concordance';
 import indentString from 'indent-string';
 import memoize from 'memoize';
@@ -92,7 +94,7 @@ function formatEntry(snapshot, index) {
 	} = snapshot;
 
 	const description = data
-		? concordance.formatDescriptor(concordance.deserialize(data), concordanceOptions)
+		? concordance.formatDescriptor(concordance.deserialize(Buffer.from(data.buffer, data.byteOffset, data.byteLength)), concordanceOptions)
 		: '<No Data>';
 
 	const blockquote = label.split(/\n/).map(line => '> ' + line).join('\n');
@@ -180,10 +182,36 @@ function sortBlocks(blocksByTitle, blockIndices) {
 	});
 }
 
-async function encodeSnapshots(snapshotData) {
-	const encoded = await cbor.encodeAsync(snapshotData, {
-		omitUndefinedProperties: true,
-		canonical: true,
+function normalizeBeforeEncoding(value) {
+	if (Array.isArray(value)) {
+		return value.map(v => normalizeBeforeEncoding(v));
+	}
+
+	// FIXME: The decode code path unexpectedly returns Buffers not Uint8Arrays.
+	if (Buffer.isBuffer(value)) {
+		return new Uint8Array(value.buffer, value.byteOffset, value.byteLength);
+	}
+
+	if (value !== null && typeof value === 'object' && !(value instanceof Uint8Array)) {
+		return Object.fromEntries(Object.entries(value)
+			.filter(([, v]) => v !== undefined)
+			.map(([k, v]) => [k, normalizeBeforeEncoding(v)]));
+	}
+
+	return value;
+}
+
+// FIXME: This seems to be a bug in cbor2, ignoreGlobalTags shouldn't break (Uint8)Array encoding.
+const types = new TypeEncoderMap();
+types.registerEncoder(Array, writeArray);
+types.registerEncoder(Uint8Array, writeUint8Array);
+
+function encodeSnapshots(snapshotData) {
+	const encoded = encodeCbor(normalizeBeforeEncoding(snapshotData), {
+		ignoreGlobalTags: true,
+		rejectUndefined: true,
+		sortKeys: sortLengthFirstDeterministic,
+		types,
 	});
 	const compressed = zlib.gzipSync(encoded);
 	compressed[9] = 0x03; // Override the GZip header containing the OS to always be Linux
@@ -233,7 +261,9 @@ function decodeSnapshots(buffer, snapPath) {
 	}
 
 	const decompressed = zlib.gunzipSync(compressed);
-	return cbor.decode(decompressed);
+	return decodeCbor(decompressed, {
+		ignoreGlobalTags: true,
+	});
 }
 
 class Manager {
@@ -282,7 +312,7 @@ class Manager {
 			return {pass: true};
 		}
 
-		const actual = concordance.deserialize(data, concordanceOptions);
+		const actual = concordance.deserialize(Buffer.from(data.buffer, data.byteOffset, data.byteLength), concordanceOptions);
 		const expected = concordance.describe(options.expected, concordanceOptions);
 		const pass = concordance.compareDescriptors(actual, expected);
 
@@ -311,7 +341,8 @@ class Manager {
 	deferRecord(options) {
 		const {expected, belongsTo, label, index} = options;
 		const descriptor = concordance.describe(expected, concordanceOptions);
-		const data = concordance.serialize(descriptor);
+		const buffer = concordance.serialize(descriptor);
+		const data = new Uint8Array(buffer.buffer, buffer.byteOffset, buffer.byteLength);
 
 		return () => { // Must be called in order!
 			this.hasChanges = true;
@@ -369,7 +400,7 @@ class Manager {
 			blocks: sortBlocks(this.newBlocksByTitle, this.blockIndices).map(([title, block]) => ({title, ...block})),
 		};
 
-		const buffer = await encodeSnapshots(snapshots);
+		const buffer = encodeSnapshots(snapshots);
 		const reportBuffer = generateReport(relFile, snapFile, snapshots);
 
 		await fs.promises.mkdir(dir, {recursive: true});

package-lock.json

@@ -27,7 +27,7 @@
 	},
 	"type": "module",
 	"engines": {
-		"node": "^22.20 || ^24.12 || >=25"
+		"node": "^22.20 || ^24.12 || >=26"
 	},
 	"scripts": {
 		"test": "./scripts/test.sh"
@@ -81,7 +81,7 @@
 		"arrgv": "^1.0.2",
 		"arrify": "^3.0.0",
 		"callsites": "^4.2.0",
-		"cbor": "^10.0.12",
+		"cbor2": "^2.3.0",
 		"chalk": "^5.6.2",
 		"chunkd": "^2.0.1",
 		"ci-info": "^4.4.0",

package.json

@@ -45,7 +45,8 @@ exports.sanitizers = {
 	esmLoader: string => string.split('\n').filter(line => !line.includes('› async node:internal/modules/esm/loader:')).join('\n'),
 	experimentalWarning: string => string.replaceAll(/^\(node:\d+\) ExperimentalWarning.+\n/g, ''),
 	lineEndings: string => string.replaceAll('\r\n', '\n'),
-	// The following are invjected by tap@18.
+	libLineNumbers: string => string.replaceAll(/\((\/lib\/.+\.js):\d+:\d+\)/g, '($1)'),
+	// The following are injected by tap@18.
 	posix: string => string.replaceAll('\\', '/'),
 	tapLoaders: string => string.replaceAll(/.+(Module\._compile|node_modules.pirates|require\.extensions).+\r?\n/g, ''),
 	timers: string => string.replaceAll(/timers\.js:\d+:\d+/g, 'timers.js'),

test-tap/helper/report.js

@@ -23,6 +23,7 @@ test(async t => {
 				report.sanitizers.cwd,
 				report.sanitizers.esmLoader,
 				report.sanitizers.experimentalWarning,
+				report.sanitizers.libLineNumbers,
 				report.sanitizers.posix,
 				report.sanitizers.tapLoaders,
 				report.sanitizers.timers,