feat(transport): show contents of invalid RPC message in TypeError

[andrewDoing]

related: vscode-neovim/vscode-neovim#2184

[justinmk]

to be safe, let's not involve the logger. this is low-level code and we don't want to get into loops or anything like that.

• instead of printing the type, let's print the actual resolved.value use node.util.inspect.
  • example:

    node-client/packages/neovim/src/utils/logger.ts

    Lines 2 to 21 in b05c7e6

    	import { inspect } from 'node:util';
    	const level = process.env.NVIM_NODE_LOG_LEVEL || 'debug';
    	const loggerKeys = ['info', 'warn', 'error', 'debug', 'level'] as const;
    	export type Logger = Pick<winston.Logger, (typeof loggerKeys)[number]>;
    	function getFormat(colorize: boolean) {
    	return winston.format.combine(
    	winston.format.splat(),
    	winston.format.timestamp({
    	format: 'YYYY-MM-DD HH:mm:ss',
    	}),
    	winston.format.printf(info => {
    	let msg: string;
    	try {
    	msg =
    	typeof info.message === 'object'
    	? inspect(info.message, false, 2, colorize)
    	: info.message;

• to be extra safe, let's wrap the inspect() in a try-catch.

let valstr = '?'
try {
  valstr = inspect(resolved.value, { sorted: true, maxArrayLength: 10, maxStringLength: 500, compact: true, breakLength = 500 })
} catch {}

[andrewDoing]

What do you think now? I put a console.error within the new catch block since I don't like the idea of swallowing the error.

Also do I need to add unit tests to pass CI for this change?

[justinmk]

I put a console.error within the new catch block since I don't like the idea of swallowing the error.

That's usually a good instinct, but in this case the failure will be signaled because we'll show "?" in the thrown error. And this should be rare, so better to wait until it's a problem since this is a low-level codepath.

[justinmk]

will push some updates then merge and release