server: introduce --listen, deprecate $NVIM_LISTEN_ADDRESS #8247

justinmk · 2018-04-08T17:52:09Z

$NVIM_LISTEN_ADDRESS is awkward/ambiguous because it does multiple things: it sets the listen address, but also is used to detect a parent nvim.

This PR introduces the --listen option and deprecates $NVIM_LISTEN_ADDRESS.

A followup PR will introduce $NVIM env var which is like $TMUX, it will be an opaque map for used by nested nvim instances.

todo

tests
initialize v:servername with a new address if $NVIM_LISTEN_ADDRESS is invalid.
implement helper.matches()

future

do not pass $NVIM_LISTEN_ADDRESS to :terminal environment
~~should $NVIM_LISTEN_ADDRESS actually be deprecated? It's still useful for the example give at :help rpc-connecting~~

bfredl · 2018-04-08T18:21:25Z

Maybe it should be deprecated for setting the server address, but still be set in subprocesses and recommended for clients?

mrbiggfoot · 2018-04-08T21:45:10Z

@justinmk with this PR, how a script inside a neovim terminal is supposed to communicate with the parent neovim instance? I mean, if there's no $NVIM_LISTEN_ADDRESS.

Usage of this script was removed 0c2ec77.

justinmk · 2018-04-10T23:08:11Z

@mrbiggfoot I will introduce a new env var $NVIM which will be set only in :terminal and will not be passed down to grandchildren. I'm thinking it should be a JSON map, something like:

$NVIM={"server":"/tmp/nvimfoo","buf":42}

Maybe it should be deprecated for setting the server address, but still be set in subprocesses and recommended for clients?

@bfredl The new $NVIM env var will also contain the :terminal buffer-number, so that would be the preferred way for nested nvim to communicate with the parent. Then the only use-case remaining for $NVIM_LISTEN_ADDRESS is to set the server address.

Before this change, if $NVIM_LISTEN_ADDRESS was invalid, v:servername was left empty.

bfredl · 2018-04-11T07:06:30Z

Sounds good. Not sure I understand the " will not be passed down to grandchildren" part, but I suppose it will make sense when we see the next PR :)

mhinz · 2018-04-11T07:46:27Z

I'm thinking it should be a JSON map, something like:

$NVIM={"server":"/tmp/nvimfoo","buf":42}

Is this better than simply adding multiple env variables? This means that all programs relying on $NVIM need to be able to parse JSON. E.g. for nvr I'd need to import yet another package for this.

IMHO, using JSON in an env variable is rather uncommon and makes it harder to use. :)

justinmk · 2018-04-11T08:26:45Z

Is this better than simply adding multiple env variables? This means that all programs relying on $NVIM need to be able to parse JSON.

It's meant to be opaque. If there is some program that can't parse the (simple, non-nested) JSON we can revisit, but it doesn't require a JSON library.

Not to mention, nvim is capable of parsing JSON, so one can always shell out ...

Also $NVIM_LISTEN_ADDRESS still exists for back-compat.

using JSON in an env variable is rather uncommon

Compare $TMUX, which is comma-delimited. The reason for JSON is for convenience and standards. Maybe comma-delimited is better though.

This reverts commit f96d99a, reversing changes made to 84bac9f.

FEATURES: 3cc7ebf #7234 built-in VimL expression parser 6a7c904 #4419 implement <Cmd> key to invoke command in any mode b836328 #7679 'startup: treat stdin as text instead of commands' 58b210e :digraphs : highlight with hl-SpecialKey #2690 7a13611 #8276 'startup: Let `-s -` read from stdin' 1e71978 events: VimSuspend, VimResume #8280 1e7d5e8 #6272 'stdpath()' f96d99a #8247 server: introduce --listen e8c39f7 #8226 insert-mode: interpret unmapped META as ESC 98e7112 msg: do not scroll entire screen (#8088) f72630b #8055 let negative 'writedelay' show all redraws 5d2dd2e win: has("wsl") on Windows Subsystem for Linux #7330 a4f6cec cmdline: CmdlineEnter and CmdlineLeave autocommands (#7422) 207b7ca #6844 channels: support buffered output and bytes sockets/stdio API: f85cbea #7917 API: buffer updates 418abfc #6743 API: list information about all channels/jobs. 36b2e3f #8375 API: nvim_get_commands 273d2cd #8329 API: Make nvim_set_option() update `:verbose set …` 8d40b36 #8371 API: more reliable/descriptive VimL errors ebb1acb #8353 API: nvim_call_dict_function 9f994bb #8004 API: nvim_list_uis 3405704 #7520 API/UI: forward option updates to UIs 911b1e4 #7821 API: improve nvim_command_output WINDOWS OS: 9cefd83 #8084, #8516 build/win: support MSVC ee4e1fd win: Fix reading content from stdin (#8267) TUI: ffb8904 #8309 TUI: add support for mouse release events in urxvt 8d5a46e #8081 TUI: implement "standout" attribute 6071637 TUI: support TERM=konsole-256color 67848c0 #7653 TUI: report TUI info with -V3 ('verbose' >= 3) 3d0ee17 TUI/rxvt: enable focus-reporting d109f56 #7640 TUI: 'term' option: reflect effective terminal behavior FIXES: ed6a113 #8273 'job-control: avoid kill-timer race' 4e02f1a #8107 'jobs: separate process-group' 451c48a terminal: flush vterm output buffer on pty output #8486 5d6732f :checkhealth fixes #8335 53f11dc #8218 'Fix errors reported by PVS' d05712f inccommand: pause :terminal redraws (#8307) 51af911 inccommand: do not execute trailing commands #8256 84359a4 terminal: resize to the max dimensions (#8249) d49c1dd #8228 Make vim_fgets() return the same values as in Vim 60e96a4 screen: winhl=Normal:Background should not override syntax (#8093) 0c59ac1 #5908 'shada: Also save numbered marks' ba87a2c cscope: ignore EINTR while reading the prompt (#8079) b1412dc #7971 ':terminal Enter/Leave should not increment jumplist' 3a5721e TUI: libtermkey: force CSI driver for mouse input #7948 6ff13d7 #7720 TUI: faster startup 1c6e956 #7862 TUI: fix resize-related segfaults a58c909 #7676 TUI: always hide cursor when flushing, never flush buffers during unibilium output 303e1df #7624 TUI: disable BCE almost always 249bdb0 #7761 mark: Make sure that jumplist item will not have zero lnum 6f41ce0 #7704 macOS: Set $LANG based on the system locale a043899 #7633 'Retry fgets on EINTR' CHANGES: ad60927 #8304 default to 'nofsync' f3f1970 #8035 defaults: 'fillchars' a6052c7 #7984 defaults: sidescroll=1 b69fa86 #7888 defaults: enable cscopeverbose 7c4bb23 defaults: do :filetype stuff unless explicitly "off" 2aa308c #5658 'Apply :lmap in macros' 8ce6393 terminal: Leave 'relativenumber' alone (#8360) e46534b #4486 refactor: Remove maxmem, maxmemtot options 131aad9 win: defaults: 'shellcmdflag', 'shellxquote' #7343 c57d315 #8031 jobwait(): return -2 on interrupt also with timeout 6452831 clipboard: macOS: fallback to tmux if pbcopy is broken #7940 300d365 #7919 Make 'langnoremap' apply directly after a map ada1956 #7880 'lua/executor: Remove lightuserdata' INTERNAL: de0a954 #7806 internal statistics for list impl dee78a4 #7708 rewrite internal list impl

PROBLEM ------------------------------------------------------------------------ $NVIM_LISTEN_ADDRESS has conflicting purposes as both a parameter ("the current process should listen on this address") and a descriptor ("the current process is a child of this address"). This contradiction means the presence of NVIM_LISTEN_ADDRESS is ambiguous, so child Nvim always tries to listen on its _parent's_ socket. This is the cause of lots of "Failed to start server" spam in our test/CI logs: WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-4480-0 WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-2168-0 SOLUTION ------------------------------------------------------------------------ 1. Set $NVIM to v:servername, *only* in child processes. - Now the correct way to detect a "host" or "parent" Nvim is to check for $NVIM env var. 2. Do NOT set $NVIM_LISTEN_ADDRESS child processes. 3. On startup if $NVIM_LISTEN_ADDRESS exists, unset it immediately after server init. 4. Open a channel to parent automatically, expose it as v:parent. This also fixes the "Failed to start server" spam in our test/CI logs: WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-4480-0 WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-2168-0 Fixes neovim#3118 Fixes neovim#6764 Fixes neovim#9336 Ref neovim#8247 (comment) Ref neovim#8696

PROBLEM ------------------------------------------------------------------------ $NVIM_LISTEN_ADDRESS has conflicting purposes as both a parameter ("the current process should listen on this address") and a descriptor ("the current process is a child of this address"). This contradiction means the presence of NVIM_LISTEN_ADDRESS is ambiguous, so child Nvim always tries to listen on its _parent's_ socket. This is the cause of lots of "Failed to start server" spam in our test/CI logs: WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-4480-0 WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-2168-0 SOLUTION ------------------------------------------------------------------------ 1. Set $NVIM to v:servername, *only* in child processes. - Now the correct way to detect a "host" or "parent" Nvim is to check for $NVIM env var. 2. Do NOT set $NVIM_LISTEN_ADDRESS child processes. 3. On startup if $NVIM_LISTEN_ADDRESS exists, unset it immediately after server init. 4. Open a channel to parent automatically, expose it as v:parent. Fixes neovim#3118 Fixes neovim#6764 Fixes neovim#9336 Ref neovim#8247 (comment) Ref neovim#8696

PROBLEM ------------------------------------------------------------------------ $NVIM_LISTEN_ADDRESS has conflicting purposes as both a parameter ("the current process should listen on this address") and a descriptor ("the current process is a child of this address"). This contradiction means the presence of NVIM_LISTEN_ADDRESS is ambiguous, so child Nvim always tries to listen on its _parent's_ socket. This is the cause of lots of "Failed to start server" spam in our test/CI logs: WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-4480-0 WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-2168-0 SOLUTION ------------------------------------------------------------------------ 1. Set $NVIM to the parent v:servername, *only* in child processes. - Now the correct way to detect a "parent" Nvim is to check for $NVIM. 2. Do NOT set $NVIM_LISTEN_ADDRESS in child processes. 3. On startup if $NVIM_LISTEN_ADDRESS exists, unset it immediately after server init. 4. Open a channel to parent automatically, expose it as v:parent. Fixes neovim#3118 Fixes neovim#6764 Fixes neovim#9336 Ref neovim#8247 (comment) Ref neovim#8696

PROBLEM ------------------------------------------------------------------------ $NVIM_LISTEN_ADDRESS has conflicting purposes as both a parameter ("the current process should listen on this address") and a descriptor ("the current process is a child of this address"). This contradiction means the presence of NVIM_LISTEN_ADDRESS is ambiguous, so child Nvim always tries to listen on its _parent's_ socket. This is the cause of lots of "Failed to start server" spam in our test/CI logs: WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-4480-0 WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-2168-0 SOLUTION ------------------------------------------------------------------------ 1. Set $NVIM to the parent v:servername, *only* in child processes. - Now the correct way to detect a "parent" Nvim is to check for $NVIM. 2. Do NOT set $NVIM_LISTEN_ADDRESS in child processes. 3. On startup if $NVIM_LISTEN_ADDRESS exists, unset it immediately after server init. 4. Open a channel to parent automatically, expose it as v:parent. Fixes #3118 Fixes #6764 Fixes #9336 Ref #8247 (comment) Ref #8696

PROBLEM ------------------------------------------------------------------------ $NVIM_LISTEN_ADDRESS has conflicting purposes as both a parameter ("the current process should listen on this address") and a descriptor ("the current process is a child of this address"). This contradiction means the presence of NVIM_LISTEN_ADDRESS is ambiguous, so child Nvim always tries to listen on its _parent's_ socket. This is the cause of lots of "Failed to start server" spam in our test/CI logs: WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-4480-0 WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-2168-0 SOLUTION ------------------------------------------------------------------------ 1. Set $NVIM to the parent v:servername, *only* in child processes. - Now the correct way to detect a "parent" Nvim is to check for $NVIM. 2. Do NOT set $NVIM_LISTEN_ADDRESS in child processes. 3. On startup if $NVIM_LISTEN_ADDRESS exists, unset it immediately after server init. 4. Open a channel to parent automatically, expose it as v:parent. Fixes neovim#3118 Fixes neovim#6764 Fixes neovim#9336 Ref neovim#8247 (comment) Ref neovim#8696

PROBLEM ------------------------------------------------------------------------ $NVIM_LISTEN_ADDRESS has conflicting purposes as both a parameter ("the current process should listen on this address") and a descriptor ("the current process is a child of this address"). This contradiction means the presence of NVIM_LISTEN_ADDRESS is ambiguous, so child Nvim always tries to listen on its _parent's_ socket. This is the cause of lots of "Failed to start server" spam in our test/CI logs: WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-4480-0 WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-2168-0 SOLUTION ------------------------------------------------------------------------ 1. Set $NVIM to the parent v:servername, *only* in child processes. - Now the correct way to detect a "parent" Nvim is to check for $NVIM. 2. Do NOT set $NVIM_LISTEN_ADDRESS in child processes. 3. On startup if $NVIM_LISTEN_ADDRESS exists, unset it immediately after server init. 4. Open a channel to parent automatically, expose it as v:parent. Fixes #3118 Fixes #6764 Fixes #9336 Ref #8247 (comment) Ref #8696 (cherry picked from commit b9d97f5)

…18986) feat(server): introduce $NVIM PROBLEM ------------------------------------------------------------------------ $NVIM_LISTEN_ADDRESS has conflicting purposes as both a parameter ("the current process should listen on this address") and a descriptor ("the current process is a child of this address"). This contradiction means the presence of NVIM_LISTEN_ADDRESS is ambiguous, so child Nvim always tries to listen on its _parent's_ socket. This is the cause of lots of "Failed to start server" spam in our test/CI logs: WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-4480-0 WARN 2022-04-30… server_start:154: Failed to start server: address already in use: \\.\pipe\nvim-2168-0 SOLUTION ------------------------------------------------------------------------ 1. Set $NVIM to the parent v:servername, *only* in child processes. - Now the correct way to detect a "parent" Nvim is to check for $NVIM. 2. Do NOT set $NVIM_LISTEN_ADDRESS in child processes. 3. On startup if $NVIM_LISTEN_ADDRESS exists, unset it immediately after server init. 4. Open a channel to parent automatically, expose it as v:parent. Fixes #3118 Fixes #6764 Fixes #9336 Ref #8247 (comment) Ref #8696 (cherry picked from commit b9d97f5) Co-authored-by: Justin M. Keyes <justinkz@gmail.com>

mrbiggfoot mentioned this pull request Apr 8, 2018

Incorrect fixed-height window behavior #8096

Closed

remove scripts/run-api-tests.exp

f19db1b

Usage of this script was removed 0c2ec77.

justinmk force-pushed the startup-listen branch from c4a35ba to fb100a2 Compare April 10, 2018 22:57

justinmk added 3 commits April 11, 2018 01:58

test/util: matches()

b11b681

serverstop(): return FALSE for invalid address

9f598e5

cleanup: remove main_start_gui()

7362ca4

justinmk force-pushed the startup-listen branch 2 times, most recently from 990f9b3 to cfa0aa8 Compare April 11, 2018 00:32

justinmk added 3 commits April 11, 2018 02:41

server: introduce --listen, deprecate $NVIM_LISTEN_ADDRESS

507bda1

server: init v:servername if $NVIM_LISTEN_ADDRESS is invalid

704ba41

Before this change, if $NVIM_LISTEN_ADDRESS was invalid, v:servername was left empty.

lint

777d34e

justinmk force-pushed the startup-listen branch from cfa0aa8 to 777d34e Compare April 11, 2018 00:41

justinmk merged commit f96d99a into neovim:master Apr 11, 2018

justinmk deleted the startup-listen branch April 11, 2018 01:29

justinmk added a commit to justinmk/neovim that referenced this pull request May 6, 2018

Revert "Merge neovim#8247 'server: introduce --listen'"

fd4d691

This reverts commit f96d99a, reversing changes made to 84bac9f.

baodrate mentioned this pull request Nov 26, 2018

Is neovim-remote compatible with --listen option? mhinz/neovim-remote#91

Closed

justinmk added channels-rpc channels, RPC, msgpack server labels Dec 9, 2018

justinmk mentioned this pull request Dec 9, 2018

Exit nested nvim instance would break channel attached by using socket address #9336

Closed

justinmk mentioned this pull request Sep 13, 2019

introduce $NVIM, unset $NVIM_LISTEN_ADDRESS #11009

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

server: introduce --listen, deprecate $NVIM_LISTEN_ADDRESS #8247

server: introduce --listen, deprecate $NVIM_LISTEN_ADDRESS #8247

justinmk commented Apr 8, 2018 •

edited

Loading

bfredl commented Apr 8, 2018

mrbiggfoot commented Apr 8, 2018 •

edited

Loading

justinmk commented Apr 10, 2018 •

edited

Loading

bfredl commented Apr 11, 2018

mhinz commented Apr 11, 2018

justinmk commented Apr 11, 2018 •

edited

Loading

server: introduce --listen, deprecate $NVIM_LISTEN_ADDRESS #8247

server: introduce --listen, deprecate $NVIM_LISTEN_ADDRESS #8247

Conversation

justinmk commented Apr 8, 2018 • edited Loading

bfredl commented Apr 8, 2018

mrbiggfoot commented Apr 8, 2018 • edited Loading

justinmk commented Apr 10, 2018 • edited Loading

bfredl commented Apr 11, 2018

mhinz commented Apr 11, 2018

justinmk commented Apr 11, 2018 • edited Loading

justinmk commented Apr 8, 2018 •

edited

Loading

mrbiggfoot commented Apr 8, 2018 •

edited

Loading

justinmk commented Apr 10, 2018 •

edited

Loading

justinmk commented Apr 11, 2018 •

edited

Loading