Merge branch 'master' into disable-comp

ZacLN · web-flow · commit 295bc98c571c · 2021-03-21T10:30:15.000Z
diff --git a/src/document.jl b/src/document.jl
@@ -13,6 +13,7 @@ mutable struct Document
     root::Document
     function Document(uri::AbstractString, text::AbstractString, workspace_file::Bool, server=nothing)
         path = something(uri2filepath(uri), "")
+        path == "" || isabspath(path) || throw(LSRelativePath("Relative path `$path` is not valid."))
         cst = CSTParser.parse(text, true)
         doc = new(uri, path, text, nothing, nothing, false, workspace_file, cst, [], 0, server)
         get_line_offsets(doc)
@@ -97,12 +98,13 @@ end
 get_offset(doc, p::Position) = get_offset(doc, p.line, p.character)
 get_offset(doc, r::Range) = get_offset(doc, r.start):get_offset(doc, r.stop)
 
-function get_offset2(doc::Document, line::Integer, character::Integer)
+# 1-based. Basically the index at which (line, character) can be found in the document.
+function get_offset2(doc::Document, line::Integer, character::Integer, forgiving_mode=false)
     line_offsets = get_line_offsets2!(doc)
     text = get_text(doc)
 
     if line >= length(line_offsets)
-        throw(LSOffsetError("get_offset2 crashed. More diagnostics:\nline=$line\nline_offsets='$line_offsets'"))
+        forgiving_mode || throw(LSOffsetError("get_offset2 crashed. More diagnostics:\nline=$line\nline_offsets='$line_offsets'"))
         return nextind(text, lastindex(text))
     elseif line < 0
         throw(LSOffsetError("get_offset2 crashed. More diagnostics:\nline=$line\nline_offsets='$line_offsets'"))
diff --git a/src/languageserverinstance.jl b/src/languageserverinstance.jl
@@ -62,6 +62,8 @@ mutable struct LanguageServerInstance
     clientCapabilities::Union{ClientCapabilities,Missing}
     clientInfo::Union{InfoParams,Missing}
 
+    shutdown_requested::Bool
+
     function LanguageServerInstance(pipe_in, pipe_out, env_path="", depot_path="", err_handler=nothing, symserver_store_path=nothing)
         new(
             JSONRPC.JSONRPCEndpoint(pipe_in, pipe_out, err_handler),
@@ -87,7 +89,8 @@ mutable struct LanguageServerInstance
             false,
             false,
             missing,
-            missing
+            missing,
+            false
         )
     end
 end
@@ -174,16 +177,16 @@ function trigger_symbolstore_reload(server::LanguageServerInstance)
             server.symbol_server,
             server.env_path,
             function (i)
-            if server.clientcapability_window_workdoneprogress && server.current_symserver_progress_token !== nothing
-                JSONRPC.send(
+                if server.clientcapability_window_workdoneprogress && server.current_symserver_progress_token !== nothing
+                    JSONRPC.send(
                         server.jr_endpoint,
                         progress_notification_type,
                         ProgressParams(server.current_symserver_progress_token, WorkDoneProgressReport(missing, "Indexing $i...", missing))
                     )
-            else
-                @info "Indexing $i..."
-            end
-        end,
+                else
+                    @info "Indexing $i..."
+                end
+            end,
             server.err_handler
         )
 
@@ -228,6 +231,21 @@ function trigger_symbolstore_reload(server::LanguageServerInstance)
     end
 end
 
+function request_wrapper(func, server::LanguageServerInstance)
+    return function (conn, params)
+        if server.shutdown_requested
+            # it's fine to always return a value here, even for notifications, because
+            # JSONRPC discards it anyways in that case
+            return JSONRPC.JSONRPCError(
+                -32600,
+                "LS shutdown was requested.",
+                nothing
+            )
+        end
+        func(params, server, conn)
+    end
+end
+
 """
     run(server::LanguageServerInstance)
 
@@ -252,6 +270,9 @@ function Base.run(server::LanguageServerInstance)
         else
             Base.display_error(stderr, err, bt)
         end
+    finally
+        put!(server.combined_msg_queue, (type = :close,))
+        close(server.combined_msg_queue)
     end
 
     @async try
@@ -266,47 +287,53 @@ function Base.run(server::LanguageServerInstance)
         else
             Base.display_error(stderr, err, bt)
         end
+    finally
+        put!(server.combined_msg_queue, (type = :close,))
+        close(server.combined_msg_queue)
     end
 
     msg_dispatcher = JSONRPC.MsgDispatcher()
-    msg_dispatcher[textDocument_codeAction_request_type] = (conn, params) -> textDocument_codeAction_request(params, server, conn)
-    msg_dispatcher[workspace_executeCommand_request_type] = (conn, params) -> workspace_executeCommand_request(params, server, conn)
-    msg_dispatcher[textDocument_completion_request_type] = (conn, params) -> textDocument_completion_request(params, server, conn)
-    msg_dispatcher[textDocument_signatureHelp_request_type] = (conn, params) -> textDocument_signatureHelp_request(params, server, conn)
-    msg_dispatcher[textDocument_definition_request_type] = (conn, params) -> textDocument_definition_request(params, server, conn)
-    msg_dispatcher[textDocument_formatting_request_type] = (conn, params) -> textDocument_formatting_request(params, server, conn)
-    msg_dispatcher[textDocument_references_request_type] = (conn, params) -> textDocument_references_request(params, server, conn)
-    msg_dispatcher[textDocument_rename_request_type] = (conn, params) -> textDocument_rename_request(params, server, conn)
-    msg_dispatcher[textDocument_documentSymbol_request_type] = (conn, params) -> textDocument_documentSymbol_request(params, server, conn)
-    msg_dispatcher[julia_getModuleAt_request_type] = (conn, params) -> julia_getModuleAt_request(params, server, conn)
-    msg_dispatcher[julia_getDocAt_request_type] = (conn, params) -> julia_getDocAt_request(params, server, conn)
-    msg_dispatcher[textDocument_hover_request_type] = (conn, params) -> textDocument_hover_request(params, server, conn)
-    msg_dispatcher[initialize_request_type] = (conn, params) -> initialize_request(params, server, conn)
-    msg_dispatcher[initialized_notification_type] = (conn, params) -> initialized_notification(params, server, conn)
-    msg_dispatcher[shutdown_request_type] = (conn, params) -> shutdown_request(params, server, conn)
-    msg_dispatcher[exit_notification_type] = (conn, params) -> exit_notification(params, server, conn)
-    msg_dispatcher[cancel_notification_type] = (conn, params) -> cancel_notification(params, server, conn)
-    msg_dispatcher[setTrace_notification_type] = (conn, params) -> setTrace_notification(params, server, conn)
-    msg_dispatcher[setTraceNotification_notification_type] = (conn, params) -> setTraceNotification_notification(params, server, conn) # Can we drop this?
-    msg_dispatcher[julia_getCurrentBlockRange_request_type] = (conn, params) -> julia_getCurrentBlockRange_request(params, server, conn)
-    msg_dispatcher[julia_activateenvironment_notification_type] = (conn, params) -> julia_activateenvironment_notification(params, server, conn)
-    msg_dispatcher[textDocument_didOpen_notification_type] = (conn, params) -> textDocument_didOpen_notification(params, server, conn)
-    msg_dispatcher[textDocument_didClose_notification_type] = (conn, params) -> textDocument_didClose_notification(params, server, conn)
-    msg_dispatcher[textDocument_didSave_notification_type] = (conn, params) -> textDocument_didSave_notification(params, server, conn)
-    msg_dispatcher[textDocument_willSave_notification_type] = (conn, params) -> textDocument_willSave_notification(params, server, conn)
-    msg_dispatcher[textDocument_willSaveWaitUntil_request_type] = (conn, params) -> textDocument_willSaveWaitUntil_request(params, server, conn)
-    msg_dispatcher[textDocument_didChange_notification_type] = (conn, params) -> textDocument_didChange_notification(params, server, conn)
-    msg_dispatcher[workspace_didChangeWatchedFiles_notification_type] = (conn, params) -> workspace_didChangeWatchedFiles_notification(params, server, conn)
-    msg_dispatcher[workspace_didChangeConfiguration_notification_type] = (conn, params) -> workspace_didChangeConfiguration_notification(params, server, conn)
-    msg_dispatcher[workspace_didChangeWorkspaceFolders_notification_type] = (conn, params) -> workspace_didChangeWorkspaceFolders_notification(params, server, conn)
-    msg_dispatcher[workspace_symbol_request_type] = (conn, params) -> workspace_symbol_request(params, server, conn)
-    msg_dispatcher[julia_refreshLanguageServer_notification_type] = (conn, params) -> julia_refreshLanguageServer_notification(params, server, conn)
-    msg_dispatcher[julia_getDocFromWord_request_type] = (conn, params) -> julia_getDocFromWord_request(params, server, conn)
+    msg_dispatcher[textDocument_codeAction_request_type] = request_wrapper(textDocument_codeAction_request, server)
+    msg_dispatcher[workspace_executeCommand_request_type] = request_wrapper(workspace_executeCommand_request, server)
+    msg_dispatcher[textDocument_completion_request_type] = request_wrapper(textDocument_completion_request, server)
+    msg_dispatcher[textDocument_signatureHelp_request_type] = request_wrapper(textDocument_signatureHelp_request, server)
+    msg_dispatcher[textDocument_definition_request_type] = request_wrapper(textDocument_definition_request, server)
+    msg_dispatcher[textDocument_formatting_request_type] = request_wrapper(textDocument_formatting_request, server)
+    msg_dispatcher[textDocument_references_request_type] = request_wrapper(textDocument_references_request, server)
+    msg_dispatcher[textDocument_rename_request_type] = request_wrapper(textDocument_rename_request, server)
+    msg_dispatcher[textDocument_documentSymbol_request_type] = request_wrapper(textDocument_documentSymbol_request, server)
+    msg_dispatcher[julia_getModuleAt_request_type] = request_wrapper(julia_getModuleAt_request, server)
+    msg_dispatcher[julia_getDocAt_request_type] = request_wrapper(julia_getDocAt_request, server)
+    msg_dispatcher[textDocument_hover_request_type] = request_wrapper(textDocument_hover_request, server)
+    msg_dispatcher[initialize_request_type] = request_wrapper(initialize_request, server)
+    msg_dispatcher[initialized_notification_type] = request_wrapper(initialized_notification, server)
+    msg_dispatcher[shutdown_request_type] = request_wrapper(shutdown_request, server)
+    msg_dispatcher[exit_notification_type] = request_wrapper(exit_notification, server)
+    msg_dispatcher[cancel_notification_type] = request_wrapper(cancel_notification, server)
+    msg_dispatcher[setTrace_notification_type] = request_wrapper(setTrace_notification, server)
+    msg_dispatcher[setTraceNotification_notification_type] = request_wrapper(setTraceNotification_notification, server)
+    msg_dispatcher[julia_getCurrentBlockRange_request_type] = request_wrapper(julia_getCurrentBlockRange_request, server)
+    msg_dispatcher[julia_activateenvironment_notification_type] = request_wrapper(julia_activateenvironment_notification, server)
+    msg_dispatcher[textDocument_didOpen_notification_type] = request_wrapper(textDocument_didOpen_notification, server)
+    msg_dispatcher[textDocument_didClose_notification_type] = request_wrapper(textDocument_didClose_notification, server)
+    msg_dispatcher[textDocument_didSave_notification_type] = request_wrapper(textDocument_didSave_notification, server)
+    msg_dispatcher[textDocument_willSave_notification_type] = request_wrapper(textDocument_willSave_notification, server)
+    msg_dispatcher[textDocument_willSaveWaitUntil_request_type] = request_wrapper(textDocument_willSaveWaitUntil_request, server)
+    msg_dispatcher[textDocument_didChange_notification_type] = request_wrapper(textDocument_didChange_notification, server)
+    msg_dispatcher[workspace_didChangeWatchedFiles_notification_type] = request_wrapper(workspace_didChangeWatchedFiles_notification, server)
+    msg_dispatcher[workspace_didChangeConfiguration_notification_type] = request_wrapper(workspace_didChangeConfiguration_notification, server)
+    msg_dispatcher[workspace_didChangeWorkspaceFolders_notification_type] = request_wrapper(workspace_didChangeWorkspaceFolders_notification, server)
+    msg_dispatcher[workspace_symbol_request_type] = request_wrapper(workspace_symbol_request, server)
+    msg_dispatcher[julia_refreshLanguageServer_notification_type] = request_wrapper(julia_refreshLanguageServer_notification, server)
+    msg_dispatcher[julia_getDocFromWord_request_type] = request_wrapper(julia_getDocFromWord_request, server)
 
     while true
         message = take!(server.combined_msg_queue)
 
-        if message.type == :clientmsg
+        if message.type == :close
+            @info "Shutting down server instance."
+            return
+        elseif message.type == :clientmsg
             msg = message.msg
 
             JSONRPC.dispatch_msg(server.jr_endpoint, msg_dispatcher, msg)
diff --git a/src/requests/features.jl b/src/requests/features.jl
@@ -25,12 +25,8 @@ end
 
 function get_definitions(x::Union{SymbolServer.FunctionStore,SymbolServer.DataTypeStore}, tls, server, locations)
     StaticLint.iterate_over_ss_methods(x, tls, server, function (m)
-        try
-            if isfile(m.file)
-                push!(locations, Location(filepath2uri(m.file), Range(m.line - 1, 0, m.line - 1, 0)))
-            end
-        catch err
-            isa(err, Base.IOError) || isa(err, Base.SystemError) || rethrow()
+        if safe_isfile(m.file)
+            push!(locations, Location(filepath2uri(m.file), Range(m.line - 1, 0, m.line - 1, 0)))
         end
         return false
     end)
@@ -59,6 +55,16 @@ function get_definitions(x::EXPR, tls::StaticLint.Scope, server, locations)
     end
 end
 
+safe_isfile(s::Symbol) = safe_isfile(string(s))
+function safe_isfile(s::AbstractString)
+    try
+        !occursin("\0", s) && isfile(s)
+    catch err
+        isa(err, Base.IOError) || isa(err, Base.SystemError) || rethrow()
+        false
+    end
+end
+
 function textDocument_definition_request(params::TextDocumentPositionParams, server::LanguageServerInstance, conn)
     locations = Location[]
     doc = getdocument(server, URI2(params.textDocument.uri))
@@ -74,9 +80,9 @@ function textDocument_definition_request(params::TextDocumentPositionParams, ser
         # TODO: move to its own function
         if valof(x) isa String && sizeof(valof(x)) < 256 # AUDIT: OK
             try
-                if isabspath(valof(x)) && isfile(valof(x))
+                if isabspath(valof(x)) && safe_isfile(valof(x))
                     push!(locations, Location(filepath2uri(valof(x)), Range(0, 0, 0, 0)))
-                elseif !isempty(getpath(doc)) && isfile(joinpath(_dirname(getpath(doc)), valof(x)))
+                elseif !isempty(getpath(doc)) && safe_isfile(joinpath(_dirname(getpath(doc)), valof(x)))
                     push!(locations, Location(filepath2uri(joinpath(_dirname(getpath(doc)), valof(x))), Range(0, 0, 0, 0)))
                 end
             catch err
@@ -120,7 +126,8 @@ function find_references(textDocument::TextDocumentIdentifier, position::Positio
     locations = Location[]
     doc = getdocument(server, URI2(textDocument.uri))
     offset = get_offset(doc, position)
-    x = get_expr1(getcst(doc), offset)
+    x = get_identifier(getcst(doc), offset)
+
     if x isa EXPR && StaticLint.hasref(x) && refof(x) isa StaticLint.Binding
         for r in refof(x).refs
             if r isa EXPR
@@ -272,8 +279,8 @@ function julia_getModuleAt_request(params::VersionedTextDocumentPositionParams,
     if hasdocument(server, uri)
         doc = getdocument(server, uri)
         if doc._version == params.version
-            offset = get_offset2(doc, params.position.line, params.position.character)
-            x = get_expr(getcst(doc), offset)
+            offset = get_offset2(doc, params.position.line, params.position.character, true)
+            x = get_expr_or_parent(getcst(doc), offset, 1)
             if x isa EXPR
                 scope = StaticLint.retrieve_scope(x)
                 if scope !== nothing
diff --git a/src/requests/init.jl b/src/requests/init.jl
@@ -188,13 +188,12 @@ function initialized_notification(params::InitializedParams, server::LanguageSer
     end
 end
 
-# TODO provide type for params
-function shutdown_request(params, server::LanguageServerInstance, conn)
+function shutdown_request(params::Nothing, server::LanguageServerInstance, conn)
+    server.shutdown_requested = true
     return nothing
 end
 
-# TODO provide type for params
-function exit_notification(params, server::LanguageServerInstance, conn)
+function exit_notification(params::Nothing, server::LanguageServerInstance, conn)
     server.symbol_server.process isa Base.Process && kill(server.symbol_server.process)
-    exit()
+    exit(server.shutdown_requested ? 0 : 1)
 end
diff --git a/src/staticlint.jl b/src/staticlint.jl
@@ -3,7 +3,7 @@ import StaticLint: getpath, getroot, setroot, getcst, setcst, semantic_pass, get
 hasfile(server::LanguageServerInstance, path::String) = !isempty(path) && hasdocument(server, URI2(filepath2uri(path)))
 function canloadfile(server::LanguageServerInstance, path::String)
     try
-        return !isempty(path) && isfile(path)
+        return !isempty(path) && !safe_isfile(path)
     catch err
         isa(err, Base.IOError) || isa(err, Base.SystemError) || rethrow()
         return false
diff --git a/src/utilities.jl b/src/utilities.jl
@@ -207,6 +207,32 @@ function get_expr(x, offset, pos=0, ignorewhitespace=false)
     end
 end
 
+# like get_expr, but only returns a expr if offset is not on the edge of it's span
+function get_expr_or_parent(x, offset, pos=0)
+    if pos > offset
+        return nothing
+    end
+    if length(x) > 0 && headof(x) !== :NONSTDIDENTIFIER
+        for a in x
+            if pos < offset <= (pos + a.fullspan)
+                if pos < offset < (pos + a.span)
+                    return get_expr_or_parent(a, offset, pos)
+                else
+                    return x
+                end
+            end
+            pos += a.fullspan
+        end
+    elseif pos == 0
+        return x
+    elseif (pos < offset <= (pos + x.fullspan))
+        if pos + x.span < offset
+            return x.parent
+        end
+        return x
+    end
+end
+
 function get_expr(x, offset::UnitRange{Int}, pos=0, ignorewhitespace=false)
     if all(pos .> offset)
         return nothing
