// The constants module is part of the mutation suite. These literals live in the test, not in src/, so a mutant // that changes a definition fails here even when no parser happens to branch on that name. import { test } from 'vitest'; import assert from 'node:assert/strict'; import * as fmt from '../src/format.js'; test('format facts match the specs they cite', () => { assert.deepEqual({ OID_BYTES: fmt.OID_BYTES, OID_HEX_CHARS: fmt.OID_HEX_CHARS, HEX_DIGIT_MIN: fmt.HEX_DIGIT_MIN, HEX_DIGIT_MAX: fmt.HEX_DIGIT_MAX, HEX_LOWER_MIN: fmt.HEX_LOWER_MIN, HEX_LOWER_MAX: fmt.HEX_LOWER_MAX, ZERO_OID: fmt.ZERO_OID, SHA256_HEX_CHARS: fmt.SHA256_HEX_CHARS, BYTE_VALUES: fmt.BYTE_VALUES, BYTE_MASK: fmt.BYTE_MASK, BE32_SHIFTS: [...fmt.BE32_SHIFTS], UINT32_BYTES: fmt.UINT32_BYTES, TREE_MODE_SEP: fmt.TREE_MODE_SEP, TREE_NUL: fmt.TREE_NUL, MODE_BLOB: fmt.MODE_BLOB, MODE_EXEC: fmt.MODE_EXEC, MODE_LINK: fmt.MODE_LINK, MODE_TREE: fmt.MODE_TREE, MODE_COMMIT: fmt.MODE_COMMIT, BLOB_MODES: [...fmt.BLOB_MODES], MODE_S_IFMT: fmt.MODE_S_IFMT, MODE_S_IFDIR: fmt.MODE_S_IFDIR, MODE_BITS: fmt.MODE_BITS, MODE_LOW_DIGITS: fmt.MODE_LOW_DIGITS, TREE_SORT_SLASH: fmt.TREE_SORT_SLASH, TREE_MODE_MIN_DIGITS: fmt.TREE_MODE_MIN_DIGITS, TREE_NAME_MIN_BYTES: fmt.TREE_NAME_MIN_BYTES, TREE_ENTRY_OVERHEAD: fmt.TREE_ENTRY_OVERHEAD, TREE_ENTRY_MIN: fmt.TREE_ENTRY_MIN, PKT_LEN_HEX: fmt.PKT_LEN_HEX, PKT_HEX_BASE: fmt.PKT_HEX_BASE, PKT_FLUSH: fmt.PKT_FLUSH, PKT_DELIM: fmt.PKT_DELIM, PKT_RESPONSE_END: fmt.PKT_RESPONSE_END, PKT_LEN_INVALID: fmt.PKT_LEN_INVALID, PKT_DATA_MIN: fmt.PKT_DATA_MIN, PKT_MAX_SIZE: fmt.PKT_MAX_SIZE, PKT_MAX_PAYLOAD: fmt.PKT_MAX_PAYLOAD, PKT_READ_MAX_PAYLOAD: fmt.PKT_READ_MAX_PAYLOAD, NIBBLE_BITS: fmt.NIBBLE_BITS, PKT_LEN_SHIFTS: [...fmt.PKT_LEN_SHIFTS], PACK_SIGNATURE: [...fmt.PACK_SIGNATURE], PACK_VERSION: fmt.PACK_VERSION, PACK_HEADER_BYTES: fmt.PACK_HEADER_BYTES, PACK_TRAILER_BYTES: fmt.PACK_TRAILER_BYTES, OBJ_COMMIT: fmt.OBJ_COMMIT, OBJ_TREE: fmt.OBJ_TREE, OBJ_BLOB: fmt.OBJ_BLOB, OBJ_TAG: fmt.OBJ_TAG, OBJ_OFS_DELTA: fmt.OBJ_OFS_DELTA, OBJ_REF_DELTA: fmt.OBJ_REF_DELTA, OBJ_TYPE_SHIFT: fmt.OBJ_TYPE_SHIFT, OBJ_TYPE_MASK: fmt.OBJ_TYPE_MASK, OBJ_SIZE_FIRST_MASK: fmt.OBJ_SIZE_FIRST_MASK, OBJ_SIZE_NEXT_MASK: fmt.OBJ_SIZE_NEXT_MASK, OBJ_CONTINUE: fmt.OBJ_CONTINUE, OBJ_SIZE_FIRST_BASE: fmt.OBJ_SIZE_FIRST_BASE, OBJ_SIZE_NEXT_BASE: fmt.OBJ_SIZE_NEXT_BASE, VARINT_BITS: fmt.VARINT_BITS, DELTA_SIZE_MIN: fmt.DELTA_SIZE_MIN, DELTA_COPY: fmt.DELTA_COPY, DELTA_INSERT_MAX: fmt.DELTA_INSERT_MAX, DELTA_COPY_MAX: fmt.DELTA_COPY_MAX, DELTA_COPY_OFF1: fmt.DELTA_COPY_OFF1, DELTA_COPY_OFF2: fmt.DELTA_COPY_OFF2, DELTA_COPY_OFF3: fmt.DELTA_COPY_OFF3, DELTA_COPY_OFF4: fmt.DELTA_COPY_OFF4, DELTA_COPY_LEN1: fmt.DELTA_COPY_LEN1, DELTA_COPY_LEN2: fmt.DELTA_COPY_LEN2, DELTA_COPY_LEN3: fmt.DELTA_COPY_LEN3, BYTE_SHIFT: fmt.BYTE_SHIFT, DELTA_OFF_SHIFT: fmt.DELTA_OFF_SHIFT, DELTA_BYTE2_SHIFT: fmt.DELTA_BYTE2_SHIFT, DELTA_OFF4_FACTOR: fmt.DELTA_OFF4_FACTOR, SIDEBAND_PACK: fmt.SIDEBAND_PACK, SIDEBAND_PROGRESS: fmt.SIDEBAND_PROGRESS, SIDEBAND_ERROR: fmt.SIDEBAND_ERROR, SIDEBAND_CHANNEL_BYTES: fmt.SIDEBAND_CHANNEL_BYTES, PROTOCOL_V2: fmt.PROTOCOL_V2, IDENT_TZ_DIGITS: fmt.IDENT_TZ_DIGITS, IDENT_TIMESTAMP_MAX: fmt.IDENT_TIMESTAMP_MAX, IDENT_TZ_HOUR_MIN: fmt.IDENT_TZ_HOUR_MIN, IDENT_TZ_HOUR_MAX: fmt.IDENT_TZ_HOUR_MAX, IDENT_TZ_MINUTE_MAX: fmt.IDENT_TZ_MINUTE_MAX, COMMIT_HEADER_TREE: fmt.COMMIT_HEADER_TREE, COMMIT_HEADER_PARENT: fmt.COMMIT_HEADER_PARENT, COMMIT_HEADER_AUTHOR: fmt.COMMIT_HEADER_AUTHOR, COMMIT_HEADER_COMMITTER: fmt.COMMIT_HEADER_COMMITTER, COMMIT_HEADER_ENCODING: fmt.COMMIT_HEADER_ENCODING, TAG_HEADER_OBJECT: fmt.TAG_HEADER_OBJECT, TAG_HEADER_TYPE: fmt.TAG_HEADER_TYPE, TAG_HEADER_TAG: fmt.TAG_HEADER_TAG, TAG_HEADER_TAGGER: fmt.TAG_HEADER_TAGGER, ZLIB_HEADER_BYTES: fmt.ZLIB_HEADER_BYTES, ZLIB_CM_DEFLATE: fmt.ZLIB_CM_DEFLATE, ZLIB_CM_MASK: fmt.ZLIB_CM_MASK, ZLIB_FDICT: fmt.ZLIB_FDICT, ZLIB_HEADER_MOD: fmt.ZLIB_HEADER_MOD, ADLER_BYTES: fmt.ADLER_BYTES, ADLER_MOD: fmt.ADLER_MOD, ADLER_SHIFT: fmt.ADLER_SHIFT, DEFLATE_BFINAL_BITS: fmt.DEFLATE_BFINAL_BITS, DEFLATE_BTYPE_BITS: fmt.DEFLATE_BTYPE_BITS, DEFLATE_STORED: fmt.DEFLATE_STORED, DEFLATE_FIXED: fmt.DEFLATE_FIXED, DEFLATE_DYNAMIC: fmt.DEFLATE_DYNAMIC, DEFLATE_STORED_HEADER_BYTES: fmt.DEFLATE_STORED_HEADER_BYTES, DEFLATE_STORED_LEN_MASK: fmt.DEFLATE_STORED_LEN_MASK, DEFLATE_MAX_BITS: fmt.DEFLATE_MAX_BITS, DEFLATE_BIT_TABLE: fmt.DEFLATE_BIT_TABLE, DEFLATE_LITERALS: fmt.DEFLATE_LITERALS, DEFLATE_EOB: fmt.DEFLATE_EOB, DEFLATE_LENGTH_BASE: fmt.DEFLATE_LENGTH_BASE, DEFLATE_LENGTH_CODES: fmt.DEFLATE_LENGTH_CODES, DEFLATE_HLIT_BASE: fmt.DEFLATE_HLIT_BASE, DEFLATE_HLIT_BITS: fmt.DEFLATE_HLIT_BITS, DEFLATE_HDIST_BASE: fmt.DEFLATE_HDIST_BASE, DEFLATE_HDIST_BITS: fmt.DEFLATE_HDIST_BITS, DEFLATE_HCLEN_BASE: fmt.DEFLATE_HCLEN_BASE, DEFLATE_HCLEN_BITS: fmt.DEFLATE_HCLEN_BITS, DEFLATE_HLIT_MAX: fmt.DEFLATE_HLIT_MAX, DEFLATE_HDIST_MAX: fmt.DEFLATE_HDIST_MAX, DEFLATE_CODELEN_CODES: fmt.DEFLATE_CODELEN_CODES, DEFLATE_CODELEN_BITS: fmt.DEFLATE_CODELEN_BITS, DEFLATE_REPEAT_PREV: fmt.DEFLATE_REPEAT_PREV, DEFLATE_REPEAT_ZERO3: fmt.DEFLATE_REPEAT_ZERO3, DEFLATE_REPEAT_ZERO11: fmt.DEFLATE_REPEAT_ZERO11, DEFLATE_REPEAT16_BASE: fmt.DEFLATE_REPEAT16_BASE, DEFLATE_REPEAT16_BITS: fmt.DEFLATE_REPEAT16_BITS, DEFLATE_REPEAT17_BASE: fmt.DEFLATE_REPEAT17_BASE, DEFLATE_REPEAT17_BITS: fmt.DEFLATE_REPEAT17_BITS, DEFLATE_REPEAT18_BASE: fmt.DEFLATE_REPEAT18_BASE, DEFLATE_REPEAT18_BITS: fmt.DEFLATE_REPEAT18_BITS, ZLIB_BOUND_LITERAL_DIV: fmt.ZLIB_BOUND_LITERAL_DIV, ZLIB_BOUND_BLOCK_DIV: fmt.ZLIB_BOUND_BLOCK_DIV, ZLIB_BOUND_SLACK: fmt.ZLIB_BOUND_SLACK, }, { OID_BYTES: 20, OID_HEX_CHARS: 40, HEX_DIGIT_MIN: 0x30, HEX_DIGIT_MAX: 0x39, HEX_LOWER_MIN: 0x61, HEX_LOWER_MAX: 0x66, ZERO_OID: '0'.repeat(40), SHA256_HEX_CHARS: 64, BYTE_VALUES: 256, BYTE_MASK: 255, BE32_SHIFTS: [24, 16, 8, 0], UINT32_BYTES: 4, TREE_MODE_SEP: 0x20, TREE_NUL: 0, MODE_BLOB: '100644', MODE_EXEC: '100755', MODE_LINK: '120000', MODE_TREE: '40000', MODE_COMMIT: '160000', BLOB_MODES: ['100644', '100755', '120000'], MODE_S_IFMT: 0o170000, MODE_S_IFDIR: 0o040000, MODE_BITS: 0xffff, MODE_LOW_DIGITS: 6, TREE_SORT_SLASH: 0x2f, TREE_MODE_MIN_DIGITS: 1, TREE_NAME_MIN_BYTES: 1, TREE_ENTRY_OVERHEAD: 4, TREE_ENTRY_MIN: 24, PKT_LEN_HEX: 4, PKT_HEX_BASE: 16, PKT_FLUSH: 0, PKT_DELIM: 1, PKT_RESPONSE_END: 2, PKT_LEN_INVALID: 3, PKT_DATA_MIN: 4, PKT_MAX_SIZE: 65520, PKT_MAX_PAYLOAD: 65516, PKT_READ_MAX_PAYLOAD: 65519, NIBBLE_BITS: 4, PKT_LEN_SHIFTS: [12, 8, 4, 0], PACK_SIGNATURE: [0x50, 0x41, 0x43, 0x4b], PACK_VERSION: 2, PACK_HEADER_BYTES: 12, PACK_TRAILER_BYTES: 20, OBJ_COMMIT: 1, OBJ_TREE: 2, OBJ_BLOB: 3, OBJ_TAG: 4, OBJ_OFS_DELTA: 6, OBJ_REF_DELTA: 7, OBJ_TYPE_SHIFT: 4, OBJ_TYPE_MASK: 7, OBJ_SIZE_FIRST_MASK: 0x0f, OBJ_SIZE_NEXT_MASK: 0x7f, OBJ_CONTINUE: 0x80, OBJ_SIZE_FIRST_BASE: 16, OBJ_SIZE_NEXT_BASE: 128, VARINT_BITS: 7, DELTA_SIZE_MIN: 4, DELTA_COPY: 0x80, DELTA_INSERT_MAX: 127, DELTA_COPY_MAX: 0x10000, DELTA_COPY_OFF1: 0x01, DELTA_COPY_OFF2: 0x02, DELTA_COPY_OFF3: 0x04, DELTA_COPY_OFF4: 0x08, DELTA_COPY_LEN1: 0x10, DELTA_COPY_LEN2: 0x20, DELTA_COPY_LEN3: 0x40, BYTE_SHIFT: 8, DELTA_OFF_SHIFT: 8, DELTA_BYTE2_SHIFT: 16, DELTA_OFF4_FACTOR: 0x1000000, SIDEBAND_PACK: 1, SIDEBAND_PROGRESS: 2, SIDEBAND_ERROR: 3, SIDEBAND_CHANNEL_BYTES: 1, PROTOCOL_V2: 2, IDENT_TZ_DIGITS: 4, IDENT_TIMESTAMP_MAX: 9223372036854775807n, IDENT_TZ_HOUR_MIN: -12, IDENT_TZ_HOUR_MAX: 14, IDENT_TZ_MINUTE_MAX: 59, COMMIT_HEADER_TREE: 'tree', COMMIT_HEADER_PARENT: 'parent', COMMIT_HEADER_AUTHOR: 'author', COMMIT_HEADER_COMMITTER: 'committer', COMMIT_HEADER_ENCODING: 'encoding', TAG_HEADER_OBJECT: 'object', TAG_HEADER_TYPE: 'type', TAG_HEADER_TAG: 'tag', TAG_HEADER_TAGGER: 'tagger', ZLIB_HEADER_BYTES: 2, ZLIB_CM_DEFLATE: 8, ZLIB_CM_MASK: 0x0f, ZLIB_FDICT: 0x20, ZLIB_HEADER_MOD: 31, ADLER_BYTES: 4, ADLER_MOD: 65521, ADLER_SHIFT: 16, DEFLATE_BFINAL_BITS: 1, DEFLATE_BTYPE_BITS: 2, DEFLATE_STORED: 0, DEFLATE_FIXED: 1, DEFLATE_DYNAMIC: 2, DEFLATE_STORED_HEADER_BYTES: 4, DEFLATE_STORED_LEN_MASK: 0xffff, DEFLATE_MAX_BITS: 15, DEFLATE_BIT_TABLE: 16, DEFLATE_LITERALS: 256, DEFLATE_EOB: 256, DEFLATE_LENGTH_BASE: 257, DEFLATE_LENGTH_CODES: 29, DEFLATE_HLIT_BASE: 257, DEFLATE_HLIT_BITS: 5, DEFLATE_HDIST_BASE: 1, DEFLATE_HDIST_BITS: 5, DEFLATE_HCLEN_BASE: 4, DEFLATE_HCLEN_BITS: 4, DEFLATE_HLIT_MAX: 286, DEFLATE_HDIST_MAX: 30, DEFLATE_CODELEN_CODES: 19, DEFLATE_CODELEN_BITS: 3, DEFLATE_REPEAT_PREV: 16, DEFLATE_REPEAT_ZERO3: 17, DEFLATE_REPEAT_ZERO11: 18, DEFLATE_REPEAT16_BASE: 3, DEFLATE_REPEAT16_BITS: 2, DEFLATE_REPEAT17_BASE: 3, DEFLATE_REPEAT17_BITS: 3, DEFLATE_REPEAT18_BASE: 11, DEFLATE_REPEAT18_BITS: 7, ZLIB_BOUND_LITERAL_DIV: 8, ZLIB_BOUND_BLOCK_DIV: 64, ZLIB_BOUND_SLACK: 13, }); assert.equal(Object.isFrozen(fmt.BLOB_MODES), true); assert.equal(fmt.varintScale(0), 1); assert.equal(fmt.varintScale(4), 16); assert.equal(fmt.varintScale(7), 128); }); // zlibBound(S) = S + ⌈S/8⌉ + ⌈S/64⌉ + 13: the longest zlib stream accepted for an object declared S bytes. The S/8 and S/64 // terms are zlib's conservative deflateBound ("complen", deflate.c ≤ 1.2.13: sourceLen + ((sourceLen + 7) >> 3) + // ((sourceLen + 63) >> 6) + 5 — 9-bit literals in fixed blocks plus per-block overhead); 13 is compressBound's constant // (compress.c: the 6-byte zlib wrapper + 7). The function dominates every value deflateBound returns for a zlib-wrapped // stream without a dictionary — complen + 6, and the fixedlen (+4) and storelen (+7) forms zlib 1.3 switched to for // memLevel 2 and 1 — at every size, which the inequalities below check; the empirical half (node:zlib at every level, // strategy, memLevel and windowBits never exceeds it) is in mutant-kill.test.js. test('zlibBound: the pinned values, and it dominates every form of zlib deflateBound for a zlib-wrapped stream', () => { const { zlibBound } = fmt; assert.deepEqual([0, 1, 2, 7, 8, 9, 10, 63, 64, 65, 1000, 65535, 65536, 1 << 20, 64 << 20].map(zlibBound), [13, 16, 17, 22, 23, 25, 26, 85, 86, 89, 1154, 74764, 74765, 1196045, 76546061]); assert.equal(zlibBound(64 << 20), (64 << 20) + (8 << 20) + (1 << 20) + 13); const wrap = 6; // 2-byte header + 4-byte Adler-32 const complen = s => s + ((s + 7) >> 3) + ((s + 63) >> 6) + 5 + wrap; // deflate.c (≤ 1.2.13) deflateBound, non-default parameters const fixedlen = s => s + (s >> 3) + (s >> 8) + (s >> 9) + 4 + wrap; // deflate.c (1.3) fixed blocks, 9-bit literals, memLevel 2 const storelen = s => s + (s >> 5) + (s >> 7) + (s >> 11) + 7 + wrap; // deflate.c (1.3) stored blocks of 127 bytes, memLevel 1 const tight = s => s + (s >> 12) + (s >> 14) + (s >> 25) + 13; // compress.c compressBound: default windowBits/memLevel const stored = s => s + 5 * Math.max(1, Math.ceil(s / 65535)) + wrap; // 65535-byte stored blocks, the layout a level-0 encoder emits for (let s = 0; s <= 200_000; s++) { const b = zlibBound(s); assert.ok(b >= complen(s) && b >= fixedlen(s) && b >= storelen(s) && b >= tight(s) && b >= stored(s), `zlibBound(${s}) = ${b}`); } for (const s of [1 << 20, 16 << 20, 64 << 20, 2 ** 31 - 1]) { const b = zlibBound(s); assert.ok(b >= complen(s) && b >= fixedlen(s) && b >= storelen(s) && b >= tight(s) && b >= stored(s), `zlibBound(${s}) = ${b}`); } // a size the 10-byte varint can declare (readObjHeader: up to ~2^70) stays finite; the object-size cap refuses it anyway assert.ok(Number.isFinite(zlibBound(2 ** 69))); });