WIP: eliminate "host" concept

Problem:
The "remote plugin" concept is too complicated. neovim/neovim#27949

Solution:
- Let the "client" also be the "host". Eliminate the separate "host"
  concept and related modules.
- Let any node module be a "host". Any node module that imports the
  "neovim" package and defines method handler(s) is a "remote module".
  It is loaded by Nvim same as any "node client".

Old architecture:

    nvim rplugin framework ->
      node: cli.js ->
        starts the "plugin Host"
          attaches itself to current node process
            searches for plugins and tries to load them in the node process (MULTI-TENANCY)
              -> plugin1
              -> plugin2
              -> ...

New architecture:

    nvim vim.rplugin('node', '…/plugin1.js') ->
      node: neovim.cli()
    nvim vim.rplugin('node', '…/plugin2.js') ->
      node: neovim.cli()

1. A Lua plugin calls `vim.rplugin('node', '/path/to/plugin.js')`.
2. Each call to `vim.rplugin()` starts a new node process (no "multi-tenancy").
3. plugin.js is just a normal javascript file that imports the `neovim` package.
4. plugin.js provides a "main" function. It can simply import the `neovim.cli()` util function, which handles attaching/setup.

TEST CASE / DEMO:

    const found = findNvim({ orderBy: 'desc', minVersion: '0.9.0' })
    const nvim_proc = child_process.spawn(found.matches[0].path, ['--clean', '--embed'], {});
    const nvim = attach({ proc: nvim_proc });
    nvim.setHandler('foo', (ev, args) => {
      nvim.logger.info('handled from remote module: "%s": args:%O', ev.name, args);
    });
    nvim.callFunction('rpcrequest', [(await nvim.channelId), 'foo', [42, true, 'bar']]);

    2024-03-26 16:47:35 INF handleRequest: foo
    2024-03-26 16:47:35 DBG request received: foo
    2024-03-26 16:47:35 INF handled from remote module: "foo": args:[ [ 42, true, 'bar' ] ]

Author: justinmk

packages/example-plugin2/fixture.js

@@ -0,0 +1 @@
+module.exports = 'you bet!';

packages/example-plugin2/index.js

@@ -0,0 +1,30 @@
+const required = require('./fixture');
+const neovim = require('neovim');
+
+let nvim;
+
+function hostTest(args, range) {
+  if (args[0] === 'canhazresponse?') {
+    throw new Error('no >:(');
+  }
+
+  nvim.setLine('A line, for your troubles');
+
+  return 'called hostTest';
+}
+
+function onBufEnter(filename) {
+  return new Promise((resolve, reject) => {
+    console.log('This is an annoying function ' + filename);
+    resolve(filename);
+  });
+}
+
+function main() {
+  nvim = neovim.cli();
+  // Now that we successfully started, we can remove the default listener.
+  //nvim.removeAllListeners('request');
+  nvim.setHandler('testMethod1', hostTest);
+}
+
+main();

packages/example-plugin2/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@neovim/example-plugin2",
+  "private": true,
+  "version": "1.0.0",
+  "description": "Test fixture for new rplugin design",
+  "main": "index.js",
+  "license": "MIT",
+  "devDependencies": {}
+}

packages/integration-tests/__tests__/integration.test.ts

@@ -4,9 +4,16 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as http from 'http';
 
+//
+//
+// TODO: The old rplugin design is deprecated and NOT supported.
+//       This file will be deleted.
+//
+//
+
 import { NeovimClient, attach, findNvim } from 'neovim';
 
-describe('Node host', () => {
+describe.skip('Node host (OLD, DELETE ME)', () => {
   const testdir = process.cwd();
   let proc: cp.ChildProcessWithoutNullStreams;
   let args;

packages/integration-tests/__tests__/rplugin2.test.ts

@@ -0,0 +1,128 @@
+/* eslint-env jest */
+import * as cp from 'child_process';
+import * as fs from 'fs';
+import * as path from 'path';
+
+import { NeovimClient, attach, findNvim } from 'neovim';
+
+/**
+ * Runs a program and returns its output.
+ */
+async function run(cmd: string, args: string[]) {
+  return new Promise<{ proc: ReturnType<typeof cp.spawn>, stdout: string, stderr: string}>((resolve, reject) => {
+    const proc = cp.spawn(cmd, args, { shell: false });
+    const rv = {
+      proc: proc,
+      stdout: '',
+      stderr: '',
+    }
+
+    proc.stdout.on('data', (data) => {
+      rv.stdout += data.toString();
+    });
+
+    proc.stderr.on('data', (data) => {
+      rv.stderr += data.toString();
+    });
+
+    proc.on('exit', (code_) => {
+      resolve(rv);
+    });
+
+    proc.on('error', (e) => {
+      reject(e);
+    });
+  });
+}
+
+describe('Node host2', () => {
+  const thisDir = path.resolve(__dirname);
+  const pluginDir = path.resolve(thisDir, '../../example-plugin2/');
+  const pluginMain = path.resolve(pluginDir, 'index.js');
+
+  const testdir = process.cwd();
+  let nvimProc: ReturnType<typeof cp.spawn>;
+  let nvim: NeovimClient;
+
+  beforeAll(async () => {
+    const minVersion = '0.9.5'
+    const nvimInfo = findNvim({ minVersion: minVersion });
+    const nvimPath = nvimInfo.matches[0]?.path;
+    if (!nvimPath) {
+      throw new Error(`nvim ${minVersion} not found`)
+    }
+
+    nvimProc = cp.spawn(nvimPath, ['--clean', '-n', '--headless', '--embed'], {});
+    nvim = attach({ proc: nvimProc });
+  });
+
+  afterAll(() => {
+    process.chdir(testdir);
+    nvim.quit();
+    if (nvimProc && nvimProc.connected) {
+      nvimProc.disconnect();
+    }
+  });
+
+  beforeEach(() => {});
+
+  afterEach(() => {});
+
+
+  /**
+   * From the Nvim process, starts a new "node …/plugin/index.js" RPC job (that
+   * is, a node "plugin host", aka an Nvim node client).
+   */
+  async function newPluginChan() {
+    const luacode = `
+      -- "node …/plugin/index.js"
+      local argv = {'${process.argv0}', '${pluginMain}'}
+      local chan = vim.fn.jobstart(argv, { rpc = true, stderr_buffered = true })
+      return chan
+    `
+    return await nvim.lua(luacode);
+  }
+
+  it('`node plugin.js --version` prints node-client version', async () => {
+    //process.chdir(thisDir);
+    const proc = await run(process.argv0, [pluginMain, '--version']);
+    // "5.1.1-dev.0\n"
+    expect(proc.stdout).toMatch(/\d+\.\d+\.\d+/);
+
+    proc.proc.kill('SIGKILL');
+  });
+
+  it('responds to "poll" with "ok"', async () => {
+    // See also the old provider#Poll() function.
+
+    // From Nvim, start an "node …/plugin/index.js" RPC job.
+    // Then use that channel to call methods on the remote plugin.
+    const chan = await newPluginChan();
+    const rv = await nvim.lua(`return vim.rpcrequest(..., 'poll')`, [ chan ]);
+
+    expect(rv).toEqual('ok');
+  });
+
+  //it('responds to "nvim_xx" methods', async () => {
+  //  // This is just a happy accident of the fact that Nvim plugin host === client.
+  //  const chan = await newPluginChan();
+  //  const rv = await nvim.lua(`return vim.rpcrequest(..., 'nvim_eval', '1 + 3')`, [ chan ]);
+  //  expect(rv).toEqual(3);
+  //});
+
+  it('responds to custom, plugin-defined methods', async () => {
+    // The "foo" method is defined in …/example-plugin2/index.js.
+
+    const chan = await newPluginChan();
+    const rv = await nvim.lua(`return vim.rpcrequest(..., 'testMethod1', {})`, [ chan ]);
+
+    expect(rv).toEqual('called hostTest');
+  });
+
+  // TODO
+  //it('Lua plugin can define autocmds/functions that call the remote plugin', async () => {
+  //  // JSHostTestCmd
+  //  // BufEnter
+  //});
+});
+

packages/neovim/src/api/client.ts

@@ -9,15 +9,32 @@ import { Buffer } from './Buffer';
 
 const REGEX_BUF_EVENT = /nvim_buf_(.*)_event/;
 
+export interface Response {
+  send(resp: any, isError?: boolean): void;
+}
+
 export class NeovimClient extends Neovim {
   protected requestQueue: any[];
 
+  /**
+   * Handlers for custom (non "nvim_") methods registered by the remote module.
+   * These handle requests from the Nvim peer.
+   */
+  public handlers: { [index: string]: (args: any[], event: { name: string }) => any } = {};
+
   private transportAttached: boolean;
 
   private _channelId?: number;
 
   private attachedBuffers: Map<string, Map<string, Function[]>> = new Map();
 
+  /**
+   * Defines a handler for incoming RPC request method/notification.
+   */
+  setHandler(method: string, fn: (args: any[], event: { name: string }) => any) {
+    this.handlers[method] = fn;
+  }
+
   constructor(options: { transport?: Transport; logger?: Logger } = {}) {
     // Neovim has no `data` or `metadata`
     super({
@@ -44,6 +61,41 @@ export class NeovimClient extends Neovim {
     this.setupTransport();
   }
 
+  /**
+   * The "client" is also the "host". https://github.com/neovim/neovim/issues/27949
+   */
+  async handleRequest2(method: string, args: any[], res: Response) {
+    this.logger.debug('request received: %s', method);
+    // 'poll' and 'specs' are requests from Nvim internals. Else we dispatch to registered remote module methods (if any).
+    if (method === 'poll') {
+      // Handshake for Nvim.
+      res.send('ok');
+    //} else if (method.startsWith('nvim_')) {
+    //  // Let base class handle it.
+    //  this.request(method, args);
+    } else {
+      const handler = this.handlers[method];
+      if (!handler) {
+        const msg = `node-client: missing handler for "${method}"`;
+        this.logger.error(msg);
+        res.send(msg, true);
+      }
+
+      try {
+        this.logger.debug('found handler: %s: %O', method, handler);
+        const plugResult = await handler(args, { name: method });
+        res.send(
+          !plugResult || typeof plugResult === 'undefined' ? null : plugResult
+        );
+      } catch (e) {
+        const err = e as Error;
+        const msg = `node-client: failed to handle request: "${method}": ${err.message}`;
+        this.logger.error(msg);
+        res.send(err.toString(), true);
+      }
+    }
+  }
+
   get isApiReady(): boolean {
     return this.transportAttached && this._channelId !== undefined;
   }
@@ -188,6 +240,9 @@ export class NeovimClient extends Neovim {
 
         this._channelId = channelId;
 
+        // XXX
+        this.on('request', this.handleRequest2);
+
         // register the non-queueing handlers
         // dequeue any pending RPCs
         this.requestQueue.forEach(pending => {

packages/neovim/src/cli.ts

@@ -0,0 +1,60 @@
+import { spawnSync } from 'child_process';
+import { attach } from './attach';
+
+// node <current script> <rest of args>
+const [, , ...args] = process.argv;
+
+if (args[0] === '--version') {
+  // eslint-disable-next-line global-require
+  const pkg = require('../package.json');
+  // eslint-disable-next-line no-console
+  console.log(pkg.version);
+  process.exit(0);
+}
+
+// "21.6.1" => "21"
+const nodeMajorVersionStr = process.versions.node.replace(/\..*/, '')
+const nodeMajorVersion = Number.parseInt(nodeMajorVersionStr ?? '0')
+
+if (
+  process.env.NVIM_NODE_HOST_DEBUG &&
+  nodeMajorVersion >= 8 &&
+  process.execArgv.every(token => token !== '--inspect-brk')
+) {
+  const childHost = spawnSync(
+    process.execPath,
+    process.execArgv.concat(['--inspect-brk']).concat(process.argv.slice(1)),
+    { stdio: 'inherit' }
+  );
+  process.exit(childHost.status ?? undefined);
+}
+
+export interface Response {
+  send(resp: any, isError?: boolean): void;
+}
+
+process.on('unhandledRejection', (reason, p) => {
+  process.stderr.write(`Unhandled Rejection at: ${p} reason: ${reason}\n`);
+});
+
+// "The client *is* the host... The client *is* the host..."
+//
+// "Main" entrypoint for any Nvim remote plugin. It implements the Nvim remote
+// plugin specification:
+// - Attaches self to incoming RPC channel.
+// - Responds to "poll" with "ok".
+// - TODO: "specs"?
+export function cli() {
+  try {
+    // Reverse stdio because it's from the perspective of Nvim.
+    const nvim = attach({ reader: process.stdin, writer: process.stdout });
+    nvim.logger.debug('host.start');
+
+    return nvim;
+  } catch (e) {
+    const err = e as Error;
+    process.stderr.write(`failed to start Nvim plugin host: ${err.name}: ${err.message}\n`);
+
+    return undefined;
+  }
+}

packages/neovim/src/host/index.ts

@@ -6,6 +6,9 @@ export interface Response {
   send(resp: any, isError?: boolean): void;
 }
 
+/**
+ * @deprecated Eliminate the "host" concept. https://github.com/neovim/neovim/issues/27949
+ */
 export class Host {
   public loaded: { [index: string]: NvimPlugin };
 

packages/neovim/src/index.ts

@@ -1,4 +1,5 @@
 export { attach } from './attach';
+export { cli } from './cli';
 export { Neovim, NeovimClient, Buffer, Tabpage, Window } from './api/index';
 export { Plugin, Function, Autocmd, Command } from './plugin';
 export { NvimPlugin } from './host/NvimPlugin';

test.lua

@@ -0,0 +1,12 @@
+
+-- See also the old provider#Poll() function.
+local function doit()
+  local job = {rpc = true, stderr_buffered =true}
+  local argv = {'node', 'packages/example-plugin2/index.js'}
+  local chan = vim.fn.jobstart(argv, job)
+  local pollresult = vim.rpcrequest(chan, 'poll')
+  -- assert(pollresult == 'ok')
+  vim.print(pollresult)
+end
+
+doit()