fix(logger): console.assert() throws exception #395

Problem:
Exception when calling `console.assert()`.
Example from vscode-neovim/vscode-neovim#2242 :

    {"tag":"dap.send","timestamp":1726115647837,"metadata":{"connectionId":3,"message":{"seq":1,"type":"response","request_seq":1,"command":"initialize","success":false,"body":{"error":{"id":9221,"format":
    "Error processing initialize: TypeError: Cannot read properties of undefined (reading 'apply')
    at console.<computed> [as assert] (/home/vscode/.vscode-server/extensions/asvetliakov.vscode-neovim-1.18.11/node_modules/neovim/lib/utils/logger.js:72:46)
    at r.onInitialize (/vscode/vscode-server/…/extensions/ms-vscode.js-debug/src/extension.js:120:345)
    at /vscode/vscode-server/…/extensions/ms-vscode.js-debug/src/extension.js:119:1632
    at zc._onMessage (/vscode/vscode-server/…/extensions/ms-vscode.js-debug/src/extension.js:34:4948)
    at /vscode/vscode-server/…/extensions/ms-vscode.js-debug/src/extension.js:34:3426
    at D.fire (/vscode/vscode-server/…/extensions/ms-vscode.js-debug/src/extension.js:30:10962)
    at Socket._handleData (/vscode/vscode-server/…/extensions/ms-vscode.js-debug/src/extension.js:116:688)
    at Socket.emit (node:events:519:28)
    at addChunk (node:internal/streams/readable:559:12)
    at readableAddChunkPushByteMode (node:internal/streams/readable:510:3)
    at Socket.Readable.push (node:internal/streams/readable:390:5)
    at Pipe.onStreamRead (node:internal/stream_base_commons:191:23)","showUser":false,"sendTelemetry":false}}}},"level":0}

9a2cf4c restored "console.x monkey-patching", but the logic was
sloppy: it replaces every console.x function instead of only the ones
that our logger actually supports.

Solution:
- Only patch `console.x` functions we can actually support.
- Special-case `console.assert`.

Author: justinmk

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## [5.3.0](https://github.com/neovim/node-client/compare/v5.2.0...v5.3.0)
 
-- TBD
+- fix(logger): console.assert() throws exception
 
 ## [5.2.0](https://github.com/neovim/node-client/compare/v5.1.0...v5.2.0)
 

packages/neovim/src/attach/attach.test.ts

@@ -47,6 +47,17 @@ describe('Nvim API', () => {
     expect(await nvim.eval('1+1')).toEqual(2);
   });
 
+  it('console.assert is monkey-patched', async () => {
+    const spy = jest.spyOn(nvim.logger, 'error');
+    // eslint-disable-next-line no-console
+    console.assert(false, 'foo', 42, { x: [1, 2] });
+    expect(spy).toHaveBeenCalledWith('assertion failed', 'foo', 42, {
+      x: [1, 2],
+    });
+    // Still alive?
+    expect(await nvim.eval('1+1')).toEqual(2);
+  });
+
   it('console.log NOT monkey-patched if custom logger passed to attach()', async () => {
     const [proc2] = testUtil.startNvim(false);
     const logged: string[] = [];

packages/neovim/src/utils/logger.ts

@@ -3,10 +3,8 @@ import { inspect } from 'node:util';
 
 const level = process.env.NVIM_NODE_LOG_LEVEL || 'debug';
 
-export type Logger = Pick<
-  winston.Logger,
-  'info' | 'warn' | 'error' | 'debug' | 'level'
->;
+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(
@@ -61,10 +59,24 @@ function setupWinstonLogger(): Logger {
 
   // Monkey-patch `console` so that it does not write to the RPC (stdio) channel.
   Object.keys(console).forEach((k: string) => {
-    (console as any)[k] = function () {
-      // eslint-disable-next-line prefer-rest-params
-      (logger as any)[k === 'log' ? 'info' : k].apply(logger, arguments);
-    };
+    const loggerKey = k === 'log' ? 'info' : k;
+    if (k === 'assert') {
+      // XXX: support console.assert() even though our logger doesn't define it.
+      // eslint-disable-next-line no-console
+      console.assert = function (
+        condition?: boolean | undefined,
+        ...data: any[]
+      ) {
+        if (!condition) {
+          logger.error('assertion failed', ...data);
+        }
+      };
+    } else if (loggerKeys.includes(loggerKey as any)) {
+      (console as any)[k] = function (...args: any[]) {
+        const loggerFn = (logger as any)[loggerKey];
+        loggerFn.apply(logger, args);
+      };
+    }
   });
 
   return logger;