Track parity of require("util") with node

[soneymathew]

To track parity of bun's util with Node's Util with sufficient tests.

Legend

• API - refers to API in node's util
• Status - Current implementation status in Bun
  • builtin - denotes implementation backed by Zig/C++
  • fallback - denotes implementation backed by Javascript
  • unsupported - Support yet to be added
• Deprecated - denotes if the API is deprecated currently in Node
• Typed - Are the APIs typed and added to [util.d.ts](https://github.com/oven-sh/bun-types/blob/master/util.d.ts)
• ❓ - /to-be-validated
• ❌ - not-done
• ✅ - done

API	Status	Tests	Typed	Deprecated
util.callbackify(original)	builtin	❌	❓	N
util.debuglog(section[, callback])	builtin	❌	❓	N
⮑debuglog().enabled	unsupported	❌	❓	N
util.debug(section)	unsupported	❌	❓	N
util.deprecate(fn, msg[, code])	builtin	❌	❓	N
util.format(format[, ...args])	builtin	❌	❓	N
util.formatWithOptions(inspectOptions, format[, ...args])	unsupported	❌	❓	N
util.getSystemErrorName(err)	unsupported	❌	❓	N
util.getSystemErrorMap()	unsupported	❌	❓	N
util.inherits(constructor, superConstructor)	builtin	❌	❓	N
util.inspect(object[, options])	builtin	❌	❓	N
util.inspect(object[, showHidden[, depth[, colors]]])	builtin	❌	❓	N
⮑Customizing util.inspect colors	unsupported	❌	❓	N
‎↳⟶Modifiers	unsupported	❌	❓	N
⮑⟶Foreground colors	unsupported	❌	❓	N
⮑⟶Background colors	unsupported	❌	❓	N
⮑Custom inspection functions on objects	unsupported	❌	❓	N
⮑util.inspect.custom	unsupported	❌	❓	N
⮑util.inspect.defaultOptions	unsupported	❌	❓	N
util.isDeepStrictEqual(val1, val2)	unsupported	❌	❓	N
util.parseArgs([config])	unsupported	❌	❓	N
util.promisify(original)	builtin	❌	❓	N
⮑Custom promisified functions	unsupported	❌	❓	N
⮑util.promisify.custom	unsupported	❌	❓	N
util.stripVTControlCharacters(str)	unsupported	❌	❓	N
Class: util.TextDecoder	unsupported	❌	❓	N
⮑WHATWG supported encodings	unsupported	❌	❓	N
⮑⟶Encodings supported by default (with full ICU data)	unsupported	❌	❓	N
⮑⟶Encodings supported when Node.js is built with the small-icu option	unsupported	❌	❓	N
⮑⟶Encodings supported when ICU is disabled	unsupported	❌	❓	N
⮑new TextDecoder([encoding[, options]])	unsupported	❌	❓	N
⮑textDecoder.decode([input[, options]])	unsupported	❌	❓	N
⮑textDecoder.encoding	unsupported	❌	❓	N
⮑textDecoder.fatal	unsupported	❌	❓	N
⮑textDecoder.ignoreBOM	unsupported	❌	❓	N
Class: util.TextEncoder	builtin	✅	❓	N
⮑textEncoder.encode([input])	builtin	❌	❓	N
⮑textEncoder.encodeInto(src, dest)	builtin	❌	❓	N
⮑textEncoder.encoding	builtin	❌	❓	N
util.toUSVString(string)	unsupported	❌	❓	N
util.types	builtin	❌	❓	N
⮑util.types.isAnyArrayBuffer(value)	builtin	❌	❓	N
⮑util.types.isArrayBufferView(value)	builtin	❌	❓	N
⮑util.types.isArgumentsObject(value)	builtin	❌	❓	N
⮑util.types.isArrayBuffer(value)	builtin	❌	❓	N
⮑util.types.isAsyncFunction(value)	builtin	❌	❓	N
⮑util.types.isBigInt64Array(value)	builtin	❌	❓	N
⮑util.types.isBigUint64Array(value)	builtin	❌	❓	N
⮑util.types.isBooleanObject(value)	builtin	❌	❓	N
⮑util.types.isBoxedPrimitive(value)	builtin	❌	❓	N
⮑util.types.isCryptoKey(value)	builtin	❌	❓	N
⮑util.types.isDataView(value)	builtin	❌	❓	N
⮑util.types.isDate(value)	builtin	❌	❓	N
⮑util.types.isExternal(value)	builtin	❌	❓	N
⮑util.types.isFloat32Array(value)	builtin	❌	❓	N
⮑util.types.isFloat64Array(value)	builtin	❌	❓	N
⮑util.types.isGeneratorFunction(value)	builtin	❌	❓	N
⮑util.types.isGeneratorObject(value)	builtin	❌	❓	N
⮑util.types.isInt8Array(value)	builtin	❌	❓	N
⮑util.types.isInt16Array(value)	builtin	❌	❓	N
⮑util.types.isInt32Array(value)	builtin	❌	❓	N
⮑util.types.isKeyObject(value)	builtin	❌	❓	N
⮑util.types.isMap(value)	builtin	❌	❓	N
⮑util.types.isMapIterator(value)	builtin	❌	❓	N
⮑util.types.isModuleNamespaceObject(value)	builtin	❌	❓	N
⮑util.types.isNativeError(value)	builtin	❌	❓	N
⮑util.types.isNumberObject(value)	builtin	❌	❓	N
⮑util.types.isPromise(value)	builtin	❌	❓	N
⮑util.types.isProxy(value)	builtin	❌	❓	N
⮑util.types.isRegExp(value)	builtin	❌	❓	N
⮑util.types.isSet(value)	builtin	❌	❓	N
⮑util.types.isSetIterator(value)	builtin	❌	❓	N
⮑util.types.isSharedArrayBuffer(value)	builtin	❌	❓	N
⮑util.types.isStringObject(value)	builtin	❌	❓	N
⮑util.types.isSymbolObject(value)	builtin	❌	❓	N
⮑util.types.isTypedArray(value)	builtin	❌	❓	N
⮑util.types.isUint8Array(value)	builtin	❌	❓	N
⮑util.types.isUint8ClampedArray(value)	builtin	❌	❓	N
⮑util.types.isUint16Array(value)	builtin	❌	❓	N
⮑util.types.isUint32Array(value)	builtin	❌	❓	N
⮑util.types.isWeakMap(value)	builtin	❌	❓	N
⮑util.types.isWeakSet(value)	builtin	❌	❓	N
⮑util.types.isWebAssemblyCompiledModule(value)	builtin	❌	❓	Y
util._extend(target, source)	unsupported	❌	❓	Y
util.isArray(object)	unsupported	❌	❓	Y
util.isBoolean(object)	unsupported	❌	❓	Y
util.isBuffer(object)	unsupported	❌	❓	Y
util.isDate(object)	unsupported	❌	❓	Y
util.isError(object)	unsupported	❌	❓	Y
util.isFunction(object)	unsupported	❌	❓	Y
util.isNull(object)	unsupported	❌	❓	Y
util.isNullOrUndefined(object)	unsupported	❌	❓	Y
util.isNumber(object)	unsupported	❌	❓	Y
util.isObject(object)	unsupported	❌	❓	Y
util.isPrimitive(object)	unsupported	❌	❓	Y
util.isRegExp(object)	unsupported	❌	❓	Y
util.isString(object)	unsupported	❌	❓	Y
util.isSymbol(object)	unsupported	❌	❓	Y
util.isUndefined(object)	unsupported	❌	❓	Y
util.log(string)	unsupported	❌	❓	Y

[albertpurnama]

I'd love to help to tackle these tests.

How big should the PR size be? I'm thinking maybe I can start with testing 1-2 functions (<50 line changes), open PR, then after accepted & merged, move on to more functions per PR.

This is to make sure I'm implementing the tests correctly. What do you think?

[soneymathew]

@albertputrapurnama One suggestion from my side is surface the gaps with node parity first.
In my first iteration I commented out the tests that are not testable until more zig/C++ changes can be made.
PR size can depend on what you are comfortable with 🙏
Consider mapping the file name to follow similar convention as used by node. so that we can review against node's tests to validate parity.

For example: The tests in util.test.js directly maps to test-util.js
perhaps we can move it to a util folder ?
and follow a convention like
test/bun.js/util/test-util.test.js
test/bun.js/util/<filename.in.node.repo>.test.js

[albertpurnama]

I'm not sure what the test convention in Node is, I can see multiple different types of test for util inside the test/parallel directory of node.

I think following test/bun.js/util/<filename-without-test-prefix>.test.js should be ok. I'll try to test https://github.com/nodejs/node/blob/main/test/parallel/test-util-promisify.js using bun, also implement the folder convention as you suggested!

I'll open a PR soon!

[albertpurnama]

#1018 (comment)

@soneymathew Do you know anything about common.mustCall? I tried reading the code on what it does, I'm having a hard time understanding what it does and whether we should implement these common test utilities on bun. Do you have any thoughts/suggestions on this?

[albertpurnama]

util.types tests implemented #1278