revisiting nvim integration, multiple errors

[ExpandingMan]

After arriving at an auto-complete setup that I'm far more satisfied with, I decided to revisit nvim integration with LanguageServer.jl.

Unfortunately any time I load much more than fairly minimal code I always seem to hit an error at some point.

"MethodError: "
"no method matching "
"LanguageServer.ProgressParams("
"::"
"Nothing, ::LanguageServer.WorkDoneProgressBegin)"
"\nClosest candidates are:\n  LanguageServer.ProgressParams(!Matched::Union{Int64, String}, ::T) where T at /home/expandingman/.julia/packages/LanguageServer/y1ebo/src/protocol/basic.jl:8\nStacktrace:\n"
" [1] "
"create_symserver_progress_ui("
"server::"
"LanguageServerInstance"
")\n   @ "
"LanguageServer ~/.julia/packages/LanguageServer/y1ebo/src/"
"languageserverinstance.jl:"
"143\n [2] initialized_notification(params::LanguageServer.InitializedParams, server::LanguageServerInstance, conn::"
"JSONRPC.JSONRPCEndpoint{Base.PipeEndpoint, Base.PipeEndpoint})\n   @ LanguageServer ~/.julia/packages/LanguageServer/y1ebo/src/requests/init.jl:176\n [3] "
'(::LanguageServer.var"#112#144"{LanguageServerInstance})(conn::'
"JSONRPC.JSONRPCEndpoint{Base.PipeEndpoint, Base.PipeEndpoint}, params::LanguageServer.InitializedParams)\n   @ LanguageServer ~/.julia/packages/LanguageServer/y1ebo/src/languageserverinstance.jl:284\n [4] "
"dispatch_msg(x::JSONRPC.JSONRPCEndpoint{Base.PipeEndpoint, Base.PipeEndpoint}, dispatcher::JSONRPC.MsgDispatcher, msg::"
"Dict{String, Any})\n   @ JSONRPC "
"~/.julia/packages/JSONRPC/xbAlZ/src/typed.jl:66\n [5] run"
"(server::LanguageServerInstance)\n   @ LanguageServer ~/.julia/packages/LanguageServer/y1ebo/src/languageserverinstance.jl:"
"308\n [6] top-level scope\n   @ none:12\n"
"┌ Warning: JuliaInterpreter not stored on disc\n└ @ SymbolServer ~/.julia/packages/SymbolServer/2m6sg/src/SymbolServer.jl:190\n"
"┌ Warning: DocStringExtensions not stored on disc\n└ @ SymbolServer ~/.julia/packages/SymbolServer/2m6sg/src/SymbolServer.jl:190\n"
"┌ Warning: CodeTracking not stored on disc\n└ @ SymbolServer ~/.julia/packages/SymbolServer/2m6sg/src/SymbolServer.jl:190\n"
"ERROR: "
"MethodError: "
"no method matching "
"LanguageServer.ProgressParams("
"::"
"Nothing, ::LanguageServer.WorkDoneProgressBegin"
")"
"\nClosest candidates are:\n  LanguageServer.ProgressParams(!Matched::Union{Int64, String}, ::T) where T at /home/expandingman/.julia/packages/LanguageServer/y1ebo/src/protocol/basic.jl:8\nStacktrace:\n"
" [1] "
"create_symserver_progress_ui("
"server::"
"LanguageServerInstance)\n   @ "
"LanguageServer "
"~/.julia/packages/LanguageServer/y1ebo/src/"
"languageserverinstance.jl:143\n"
" [2] initialized_notification(params::LanguageServer.InitializedParams, server::LanguageServerInstance, conn::"
"JSONRPC.JSONRPCEndpoint{Base.PipeEndpoint, Base.PipeEndpoint})\n   @ LanguageServer ~/.julia/packages/LanguageServer/y1ebo/src/requests/init.jl:"
"176\n [3] "
'(::LanguageServer.var"#112#144"{LanguageServerInstance})(conn::JSONRPC.JSONRPCEndpoint{Base.PipeEndpoint, Base.PipeEndpoint}'
", params::LanguageServer.InitializedParams)\n   @ LanguageServer ~/.julia/packages/LanguageServer/y1ebo/src/languageserverinstance.jl:284\n [4] dispatch_msg("
"x::JSONRPC.JSONRPCEndpoint{Base.PipeEndpoint, Base.PipeEndpoint}, dispatcher::JSONRPC.MsgDispatcher, msg::"
"Dict{String, Any})\n   @ JSONRPC ~/.julia/packages/JSONRPC/xbAlZ/src/typed.jl:66"
"\n [5] run(server::LanguageServerInstance)\n"
"   @ LanguageServer ~/.julia/packages/LanguageServer/y1ebo/src/languageserverinstance.jl:308\n [6]"
" top-level scope\n   @ none:12\n"

I apologize for the awful formatting, it is the fault of the logger. I tried to clean it up a bit.

It seems that some functions, in particular WorkDoneProgressBegin and ProgressParams are getting null values for their first argument where they expect something non-null (I'm guessing probably an empty string).

If I'm right, it suggests we need to either

• Add these fields to whatever JSON dict as empty strings (requires a lot of knowledge of this package and LSP in general)
• Add methods that convert null values to empty strings or whatever they are supposed to be. I'm guessing this is pretty easy, but more likely to cause side effects.

[ExpandingMan]

Another one:

"[ Info: Received new data from Julia Symbol Server.\n"
"ERROR: "
"MethodError: "
"no method matching "
"send("
"::"
"JSONRPC.JSONRPCEndpoint"
"{Base.PipeEndpoint, Base.PipeEndpoint}, ::JSONRPC.NotificationType{LanguageServer.ShowMessageRequestParams}, "
"::LanguageServer.ShowMessageParams)"
"\nClosest candidates are:\n  send(::JSONRPC.JSONRPCEndpoint, !Matched::JSONRPC.RequestType{TPARAM, TR}, ::TPARAM) where {TPARAM, TR} at /home/expandingman/.julia/packages/JSONRPC/xbAlZ/src/typed.jl:22\n  send(::JSONRPC.JSONRPCEndpoint, ::JSONRPC.NotificationType{TPARAM}, !Matched::TPARAM) where TPARAM at /home/expandingman/.julia/packages/JSONRPC/xbAlZ/src/typed.jl:35\nStacktrace:\n [1]"
" "
"textDocument_didSave_notification("
"params::"
"LanguageServer.DidSaveTextDocumentParams, server::LanguageServerInstance, conn::"
"JSONRPC.JSONRPCEndpoint{Base.PipeEndpoint, Base.PipeEndpoint})\n   @ "
"LanguageServer ~/.julia/packages/LanguageServer/y1ebo/src/requests/"
"textdocument.jl:53\n [2] "
'(::LanguageServer.var"#121#153"{LanguageServerInstance})(conn::JSONRPC.JSONRPCEndpoint{Base.PipeEndpoint, Base.PipeEndpoint}'
", params::LanguageServer.DidSaveTextDocumentParams)\n   @ LanguageServer ~/.julia/packages/LanguageServer/y1ebo/src/languageserverinstance.jl:293\n [3] dispatch_msg(x::JSONRPC.JSONRPCEndpoint{Base.PipeEndpoint, Base.PipeEndpoint}, dispatcher::JSONRPC.MsgDispatcher, msg::"
"Dict{String, Any})\n   @ JSONRPC ~/.julia/packages/JSONRPC/xbAlZ/src/typed.jl:66"
"\n [4] run(server::LanguageServerInstance)\n   @ LanguageServer ~/.julia/packages/LanguageServer/y1ebo/src/languageserverinstance.jl:308\n [5] "
"top-level scope\n   @ none:12\n"

[pfitzseb]

I vaguely remember seeing errors like this before and that we fixed them. Can you try LanguageServer.jl master?

[pfitzseb]

Ah, seems like the first one's the client's fault -- the spec only allows integer/string values for the token, not nulls.

[ExpandingMan]

Thanks, when I get a chance to dig into this a little bit more I will open an issue with the client.

[colinxs]

Just as another data point, I'm having 0 issues with nvim-completion + NeoVim's built in LSP + LanguageServer.jl using the following config:

lua <<EOF
local configs = require 'lspconfig/configs'
local util = require 'lspconfig/util'

local old_depot_path = os.getenv("JULIA_DEPOT_PATH") and os.getenv("JULIA_DEPOT_PATH") or ""

local cmd = {
  "julia",
  "--startup-file=no",
  "--history-file=no",
  "--project=/home/colinxs/.local/share/nvim/site/lsp/julia",
  "--depwarn=no",
  "main.jl",
};

local cmd_env = {
  JULIA_LOAD_PATH = ":",
  JULIA_DEPOT_PATH = "/home/colinxs/.local/share/nvim/site/lsp/julia/depot",
}

configs.julials = {
  default_config = {
    cmd = cmd;
    cmd_env = cmd_env;
    on_new_config = function(new_config, _)
      local new_cmd = vim.deepcopy(cmd)
      new_config.cmd = new_cmd
    end,
    filetypes = {'julia'};
    -- TODO
    root_dir = function(fname)
      return util.find_git_ancestor(fname) or vim.fn.getcwd()
    end;
  };
}
EOF

Where main.jl is:

# julia main.jl jlEnvPath --debug=<yes|no> oldDepotPath cacheDir


using Pkg
Pkg.instantiate()

using ArgParse
using Scratch
using LanguageServer
using SymbolServer


struct LSPrecompileFailure <: Exception
    msg::AbstractString
end

function Base.showerror(io::IO, ex::LSPrecompileFailure)
    print(io, ex.msg)
end


if VERSION < v"1.5"
    error("NeoVim julia language server only works with julia 1.5+")
end

ctx = Pkg.Types.Context()
symbol_server_version = ctx.env.manifest[ctx.env.project.deps["SymbolServer"]].version
s = ArgParseSettings()
@add_arg_table s begin
    "env"
        required = false
        default = dirname(something(Base.current_project(pwd()), Base.load_path_expand(LOAD_PATH[2])))
    "--depot"
        arg_type = String
        default = "" 
    "--symserver_store_path"
        arg_type = String
        default = get_scratch!(SymbolServer, "store-$(symbol_server_version.major).$(symbol_server_version.minor)")
    "--debug"
        help = "another option with an argument"
        action = :store_true
end

try
    args = parse_args(ARGS, s)
    @info "ARGS" args

    if args["debug"]
        ENV["JULIA_DEBUG"] = "all"
    end

    mkpath(args["symserver_store_path"])

    server = LanguageServerInstance(
        stdin,
        stdout,
        args["env"],
        args["depot"],
        nothing, # TODO error handler
        args["symserver_store_path"]
    )

    @info "Starting the Julia Language Server"

    run(server)
catch err
    # TODO error handler
    # global_err_handler(err, catch_backtrace(), Base.ARGS[3], "Language Server")
    rethrow()
end

[mjlbach]

This should be mostly resolved now, feel free to file issues with lspconfig if not.

[ExpandingMan]

Yeah, I revisited this a few weeks ago. Can't exactly say that the LSP experience is "good" in nvim right now... in fact it definitely is not, though at this point most of the issues are probably not with this package.

I'll close this issue as I'm pretty sure the specifics given here are resolve as you say. Thanks!

[mjlbach]

Well, I merged three major changes to julia's configuration in the last few weeks, at least, and it seems to robustly detect the correct project.toml, the correct root, is installed within it's own project, so I don't see how the experience could be better.

[ExpandingMan]

Oh, that's more recently than I last played with this, so perhaps I should revisit. Thanks for all the effort on this package, that the experience is lousy on nvim really isn't your fault.

[mjlbach]

It is, given I'm both the nvim-lspconfig maintainer and a neovim maintainer, so I'm one of the few people who can review and merge client changes for neovim 🙃