wip(msgpack): handle Nil strings by gigamaax · Pull Request #184 · neovim/go-client

gigamaax · 2025-03-31T02:39:14Z

I made another change that I'm worried might not be the right direction:

Here
https://github.com/neovim/go-client/pull/184/files#diff-4686cdf50ccf547850a2e89191f11c343519caef6fd7718fd73b7a1480606bd0L3843

I moved away from using the color map based on https://neovim.io/doc/user/syntax.html#ctermbg. I'm not sure if the ctermbg / ctermfg are expected to work with the RGB colors that are in the color map, or if maybe the color map has been enhanced since v0.9? I'm not sure if I'm avoiding the issue with this fix.

for nvim minor verion 9, no commands are returned for nvim minor version 10, three are returned currently, for nightly builds, four are returend

neovim ships with default keybindings that may change per verison. the tests, prior to this change, included these default key mappings which make the tests fragile with each release. keeping a list of default commands should be outside the scope of this library. this change removes assertions against the entire set of keymaps returned by `nvim_get_keymap` and only verifies the desired keymap has been added and then removed.

using the colors described here rather than the color map https://neovim.io/doc/user/syntax.html#ctermbg

v0.11 changed the way that messages are broadcast from only to those who are subscribed, to all channels. this test, as it's written, doesn't make sense in that scenario. snippet from release notes: > vim.rpcnotify(0) and rpcnotify(0) broadcast to ALL channels. Previously > they would "multicast" only to subscribed channels (controlled by > nvim_subscribe()). Plugins and clients that want "multicast" behavior > must now maintain their own list of channels.

codecov · 2025-03-31T03:23:27Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.1%. Comparing base (dd77a91) to head (af022d4).
Report is 9 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##            main    #184     +/-   ##
=======================================
- Coverage   83.3%   83.1%   -0.2%     
=======================================
  Files         14      14             
  Lines       3132    3134      +2     
=======================================
- Hits        2610    2607      -3     
- Misses       522     527      +5

Flag	Coverage Δ
linux-1.18-nightly	`?`
linux-1.18-stable	`?`
linux-1.19-nightly	`?`
linux-1.19-stable	`?`
linux-1.20-nightly	`?`
linux-1.20-stable	`?`
linux-1.22-nightly	`82.8% <100.0%> (?)`
linux-1.22-stable	`83.1% <100.0%> (?)`
linux-1.23-nightly	`82.8% <100.0%> (?)`
linux-1.23-stable	`83.1% <100.0%> (?)`
linux-1.24-nightly	`82.8% <100.0%> (?)`
linux-1.24-stable	`83.1% <100.0%> (?)`
macos-1.18-nightly	`?`
macos-1.18-stable	`?`
macos-1.19-nightly	`?`
macos-1.19-stable	`?`
macos-1.20-nightly	`?`
macos-1.20-stable	`?`
macos-1.22-nightly	`82.8% <100.0%> (?)`
macos-1.22-stable	`83.1% <100.0%> (?)`
macos-1.23-nightly	`82.8% <100.0%> (?)`
macos-1.23-stable	`83.1% <100.0%> (?)`
macos-1.24-nightly	`82.8% <100.0%> (?)`
macos-1.24-stable	`83.1% <100.0%> (?)`
windows-1.18-nightly	`?`
windows-1.18-stable	`?`
windows-1.19-nightly	`?`
windows-1.19-stable	`?`
windows-1.20-nightly	`?`
windows-1.20-stable	`?`
windows-1.22-nightly	`82.0% <100.0%> (?)`
windows-1.22-stable	`82.3% <100.0%> (?)`
windows-1.23-nightly	`82.0% <100.0%> (?)`
windows-1.23-stable	`82.3% <100.0%> (?)`
windows-1.24-nightly	`82.0% <100.0%> (?)`
windows-1.24-stable	`82.3% <100.0%> (?)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

all of the listed go versions prior to this change are no longer supported. this bumps to more recent versions.

justinmk · 2025-04-01T12:36:19Z

@zchee @glepnir

brianhuster · 2026-01-14T02:24:42Z

Is this still WIP?

gigamaax · 2026-01-29T20:11:55Z

I forgot about this. after looking at this again with fresh eyes and a little bit more of a desire to figure it out (rather than just fix) I think I can say that the concern I described in the initial description is not an issue.

for context, I was worried that dropping the colormap wasn't really fixing the failing test but just making it not visible. I now think that the test set up was incorrectly to begin with.

This was the original error:

    --- FAIL: TestAPI/Highlight (0.00s)
        --- FAIL: TestAPI/Highlight/Nvim (0.00s)
            api_test.go:3865: got cterm foreground is 0 but want 16711680
        --- FAIL: TestAPI/Highlight/Batch (0.00s)
            api_test.go:3946: got cterm foreground is 0 but want 16711680
FAIL

the nvim_set_hl api is being called with CtermForegroud and CtermBackground, which take the the cterm colors, not the color map. in order to use the color map, I think we should have been calling with Foreground and Background instead. I haven't gone back to make that change mainly because aside from being able to see "Red" or whatever color, there's not a whole lot of value since we're just checking what was set was actually set.

as for how it ended up as 0, I think nvim_set_hl overflows during the cast to an int16_t -- I didn't see any validation, but I might have just missed it.

anyway, I think this is ready for a review if @zchee or @justinmk would like to take a look. if you don't agree with my analysis, I'm happy to make any changes or look at it some more. some of the tests cold probably get some more love.

codecov-commenter · 2026-04-01T06:52:13Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.1%. Comparing base (dd77a91) to head (af022d4).
⚠️ Report is 9 commits behind head on main.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff           @@
##            main    #184     +/-   ##
=======================================
- Coverage   83.3%   83.1%   -0.2%     
=======================================
  Files         14      14             
  Lines       3132    3134      +2     
=======================================
- Hits        2610    2607      -3     
- Misses       522     527      +5

Flag	Coverage Δ
linux-1.18-nightly	`?`
linux-1.18-stable	`?`
linux-1.19-nightly	`?`
linux-1.19-stable	`?`
linux-1.20-nightly	`?`
linux-1.20-stable	`?`
linux-1.22-nightly	`82.8% <100.0%> (?)`
linux-1.22-stable	`83.1% <100.0%> (?)`
linux-1.23-nightly	`82.8% <100.0%> (?)`
linux-1.23-stable	`83.1% <100.0%> (?)`
linux-1.24-nightly	`82.8% <100.0%> (?)`
linux-1.24-stable	`83.1% <100.0%> (?)`
macos-1.18-nightly	`?`
macos-1.18-stable	`?`
macos-1.19-nightly	`?`
macos-1.19-stable	`?`
macos-1.20-nightly	`?`
macos-1.20-stable	`?`
macos-1.22-nightly	`82.8% <100.0%> (?)`
macos-1.22-stable	`83.1% <100.0%> (?)`
macos-1.23-nightly	`82.8% <100.0%> (?)`
macos-1.23-stable	`83.1% <100.0%> (?)`
macos-1.24-nightly	`82.8% <100.0%> (?)`
macos-1.24-stable	`83.1% <100.0%> (?)`
windows-1.18-nightly	`?`
windows-1.18-stable	`?`
windows-1.19-nightly	`?`
windows-1.19-stable	`?`
windows-1.20-nightly	`?`
windows-1.20-stable	`?`
windows-1.22-nightly	`82.0% <100.0%> (?)`
windows-1.22-stable	`82.3% <100.0%> (?)`
windows-1.23-nightly	`82.0% <100.0%> (?)`
windows-1.23-stable	`82.3% <100.0%> (?)`
windows-1.24-nightly	`82.0% <100.0%> (?)`
windows-1.24-stable	`82.3% <100.0%> (?)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

gigamaax and others added 5 commits March 29, 2025 16:15

wip(msgpack): handle Nil strings

f45ea35

fix(nvim): expect commands based on nvim version

96d7cca

for nvim minor verion 9, no commands are returned for nvim minor version 10, three are returned currently, for nightly builds, four are returend

msgpack: add string decode test for Nil

0ea75ee

fix(nvim): set cterm colors

07fd8cc

using the colors described here rather than the color map https://neovim.io/doc/user/syntax.html#ctermbg

github-actions Bot added area/nvim area/msgpack labels Mar 31, 2025

gigamaax added 2 commits March 30, 2025 20:02

update codecov action

bd08023

github-actions Bot added the area/ci label Mar 31, 2025

gigamaax and others added 4 commits March 30, 2025 20:25

fix(build): rename file to files for codecov action

88285ee

chore: update go versions

d2312de

all of the listed go versions prior to this change are no longer supported. this bumps to more recent versions.

chore: add specific neovim versions for testing

fbd7e11

chore: bump actions and runners versions

b8dd2bd

gigamaax marked this pull request as ready for review March 31, 2025 17:36

chore: add concurrency check to actions workflow

af022d4

zchee self-requested a review April 1, 2025 18:20

gigamaax mentioned this pull request Jun 8, 2025

Update api #185

Open

Navigation Menu

Uh oh!

wip(msgpack): handle Nil strings - #184

wip(msgpack): handle Nil strings#184
gigamaax wants to merge 12 commits into
neovim:mainfrom
gigamaax:fix-tests

gigamaax commented Mar 31, 2025 •

edited

Loading

Uh oh!

codecov Bot commented Mar 31, 2025 •

edited

Loading

Uh oh!

justinmk commented Apr 1, 2025

Uh oh!

brianhuster commented Jan 14, 2026

Uh oh!

gigamaax commented Jan 29, 2026

Uh oh!

codecov-commenter commented Apr 1, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

gigamaax commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

justinmk commented Apr 1, 2025

Uh oh!

brianhuster commented Jan 14, 2026

Uh oh!

gigamaax commented Jan 29, 2026

Uh oh!

codecov-commenter commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gigamaax commented Mar 31, 2025 •

edited

Loading

codecov Bot commented Mar 31, 2025 •

edited

Loading

codecov-commenter commented Apr 1, 2026 •

edited

Loading