Merge branch 'master' into return-type-check

Author: davidanthoff

.github/pull_request_template.md

@@ -0,0 +1,5 @@
+Fixes #.
+
+For every PR, please check the following:
+- [ ] End-user documentation check. If this PR requires end-user documentation in the Julia VS Code extension docs, please add that at https://github.com/julia-vscode/docs.
+- [ ] Changelog mention. If this PR should be mentioned in the CHANGELOG for the Julia VS Code extension, please open a PR against https://github.com/julia-vscode/julia-vscode/blob/master/CHANGELOG.md with those changes.

.github/workflows/jlpkgbutler-ci-master-workflow.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        julia-version: ['1.0', '1.1', '1.2', '1.3', '1.4']
+        julia-version: ['1.0', '1.1', '1.2', '1.3', '1.4', '1.5']
         julia-arch: [x64, x86]
         os: [ubuntu-latest, windows-latest, macOS-latest]
         exclude:

.github/workflows/jlpkgbutler-ci-pr-workflow.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        julia-version: ['1.0', '1.1', '1.2', '1.3', '1.4']
+        julia-version: ['1.0', '1.1', '1.2', '1.3', '1.4', '1.5']
         julia-arch: [x64, x86]
         os: [ubuntu-latest, windows-latest, macOS-latest]
         exclude:

Project.toml

@@ -1,7 +1,7 @@
 name = "JSONRPC"
 uuid = "b9b8584e-8fd3-41f9-ad0c-7255d428e418"
 authors = ["David Anthoff <anthoff@berkeley.edu>"]
-version = "1.1.1-DEV"
+version = "1.3.1-DEV"
 
 [deps]
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"

src/core.jl

@@ -41,9 +41,9 @@ function Base.showerror(io::IO, ex::JSONRPCError)
     end
 end
 
-mutable struct JSONRPCEndpoint
-    pipe_in
-    pipe_out
+mutable struct JSONRPCEndpoint{IOIn <: IO,IOOut <: IO}
+    pipe_in::IOIn
+    pipe_out::IOOut
 
     out_msg_queue::Channel{Any}
     in_msg_queue::Channel{Any}
@@ -56,12 +56,11 @@ mutable struct JSONRPCEndpoint
 
     read_task::Union{Nothing,Task}
     write_task::Union{Nothing,Task}
-
-    function JSONRPCEndpoint(pipe_in, pipe_out, err_handler = nothing)
-        return new(pipe_in, pipe_out, Channel{Any}(Inf), Channel{Any}(Inf), Dict{String,Channel{Any}}(), err_handler, :idle, nothing, nothing)
-    end
 end
 
+JSONRPCEndpoint(pipe_in, pipe_out, err_handler = nothing) =
+    JSONRPCEndpoint(pipe_in, pipe_out, Channel{Any}(Inf), Channel{Any}(Inf), Dict{String,Channel{Any}}(), err_handler, :idle, nothing, nothing)
+
 function write_transport_layer(stream, response)
     response_utf8 = transcode(UInt8, response)
     n = length(response_utf8)
@@ -86,12 +85,19 @@ function read_transport_layer(stream)
     return message_str
 end
 
+Base.isopen(x::JSONRPCEndpoint) = x.status != :closed && isopen(x.pipe_in) && isopen(x.pipe_out)
+
 function Base.run(x::JSONRPCEndpoint)
     x.status == :idle || error("Endpoint is not idle.")
 
     x.write_task = @async try
         for msg in x.out_msg_queue
-            write_transport_layer(x.pipe_out, msg)
+            if isopen(x.pipe_out)
+                write_transport_layer(x.pipe_out, msg)
+            else
+                # TODO Reconsider at some point whether this should be treated as an error.
+                break
+            end
         end
     catch err
         bt = catch_backtrace()
@@ -143,7 +149,7 @@ function Base.run(x::JSONRPCEndpoint)
 end
 
 function send_notification(x::JSONRPCEndpoint, method::AbstractString, params)
-    x.status == :running || error("Endpoint is not running.")
+    check_dead_endpoint!(x)
 
     message = Dict("jsonrpc" => "2.0", "method" => method, "params" => params)
 
@@ -155,7 +161,7 @@ function send_notification(x::JSONRPCEndpoint, method::AbstractString, params)
 end
 
 function send_request(x::JSONRPCEndpoint, method::AbstractString, params)
-    x.status == :running || error("Endpoint is not running.")
+    check_dead_endpoint!(x)
 
     id = string(UUIDs.uuid4())
     message = Dict("jsonrpc" => "2.0", "method" => method, "params" => params, "id" => id)
@@ -182,15 +188,15 @@ function send_request(x::JSONRPCEndpoint, method::AbstractString, params)
 end
 
 function get_next_message(endpoint::JSONRPCEndpoint)
-    endpoint.status == :running || error("Endpoint is not running.")
+    check_dead_endpoint!(endpoint)
 
     msg = take!(endpoint.in_msg_queue)
 
     return msg
 end
 
 function Base.iterate(endpoint::JSONRPCEndpoint, state = nothing)
-    endpoint.status == :running || error("Endpoint is not running.")
+    check_dead_endpoint!(endpoint)
 
     try
         return take!(endpoint.in_msg_queue), nothing
@@ -204,7 +210,7 @@ function Base.iterate(endpoint::JSONRPCEndpoint, state = nothing)
 end
 
 function send_success_response(endpoint, original_request, result)
-    endpoint.status == :running || error("Endpoint is not running.")
+    check_dead_endpoint!(endpoint)
 
     response = Dict("jsonrpc" => "2.0", "id" => original_request["id"], "result" => result)
 
@@ -214,7 +220,7 @@ function send_success_response(endpoint, original_request, result)
 end
 
 function send_error_response(endpoint, original_request, code, message, data)
-    endpoint.status == :running || error("Endpoint is not running.")
+    check_dead_endpoint!(endpoint)
 
     response = Dict("jsonrpc" => "2.0", "id" => original_request["id"], "error" => Dict("code" => code, "message" => message, "data" => data))
 
@@ -224,11 +230,7 @@ function send_error_response(endpoint, original_request, code, message, data)
 end
 
 function Base.close(endpoint::JSONRPCEndpoint)
-    endpoint.status == :running || error("Endpoint is not running.")
-
-    while isready(endpoint.out_msg_queue)
-        yield()
-    end
+    flush(endpoint)
 
     endpoint.status = :closed
     close(endpoint.in_msg_queue)
@@ -240,3 +242,17 @@ function Base.close(endpoint::JSONRPCEndpoint)
     # the socket, which we don't want to do
     # fetch(endpoint.read_task)
 end
+
+function Base.flush(endpoint::JSONRPCEndpoint)
+    check_dead_endpoint!(endpoint)
+
+    while isready(endpoint.out_msg_queue)
+        yield()
+    end
+end
+
+function check_dead_endpoint!(endpoint)
+    status = endpoint.status
+    status === :running && return
+    error("Endpoint is not running, the current state is $(status).")
+end

src/interface_def.jl

@@ -16,7 +16,7 @@ end
 function field_allows_missing(field::Expr)
     field.head == :(::) && field.args[2] isa Expr &&
     field.args[2].head == :curly && field.args[2].args[1] == :Union &&
-    any(i->i == :Missing, field.args[2].args)
+    any(i -> i == :Missing, field.args[2].args)
 end
 
 function field_type(field::Expr, typename::String)
@@ -42,7 +42,7 @@ end
 
 macro dict_readable(arg)
     tname = arg.args[2] isa Expr ? arg.args[2].args[1] : arg.args[2]
-    count_real_fields = count(field->!(field isa LineNumberNode), arg.args[3].args)
+    count_real_fields = count(field -> !(field isa LineNumberNode), arg.args[3].args)
     ex = quote
         $((arg))
 

src/typed.jl

@@ -62,7 +62,7 @@ function dispatch_msg(x::JSONRPCEndpoint, dispatcher::MsgDispatcher, msg)
         handler = get(dispatcher._handlers, method_name, nothing)
         if handler !== nothing
             param_type = get_param_type(handler.message_type)
-            params = param_type === Nothing ? nothing : param_type(msg["params"])
+            params = param_type === Nothing ? nothing : param_type <: NamedTuple ? convert(param_type,(;(Symbol(i[1])=>i[2] for i in msg["params"])...)) : param_type(msg["params"])
 
             res = handler.func(x, params)
 

test/test_interface_def.jl

@@ -2,14 +2,14 @@
 
     @test_throws ErrorException Foo()
 
-    a = Foo(fieldA = 1, fieldB = "A")
+    a = Foo(fieldA=1, fieldB="A")
 
     @test a.fieldA == 1
     @test a.fieldB == "A"
     @test a.fieldC === missing
     @test a.fieldD === missing
 
-    b = Foo(fieldA = 1, fieldB = "A", fieldC = "B", fieldD = "C")
+    b = Foo(fieldA=1, fieldB="A", fieldC="B", fieldD="C")
 
     @test b.fieldA == 1
     @test b.fieldB == "A"
@@ -19,13 +19,13 @@
     @test Foo(JSON.parse(JSON.json(a))) == a
     @test Foo(JSON.parse(JSON.json(b))) == b
 
-    c = Foo2(fieldA = nothing, fieldB = [1,2])
+    c = Foo2(fieldA=nothing, fieldB=[1,2])
 
     @test c.fieldA === nothing
     @test c.fieldB == [1,2]
     @test Foo2(JSON.parse(JSON.json(c))) == c
 
-    d = Foo2(fieldA = 3, fieldB = [1,2])
+    d = Foo2(fieldA=3, fieldB=[1,2])
     @test d.fieldA === 3
     @test d.fieldB == [1,2]
     @test Foo2(JSON.parse(JSON.json(d))) == d

test/test_typed.jl

@@ -23,12 +23,12 @@
         global conn = JSONRPC.JSONRPCEndpoint(sock, sock)
         global msg_dispatcher = JSONRPC.MsgDispatcher()
 
-        msg_dispatcher[request1_type] = (conn, params)->begin
+        msg_dispatcher[request1_type] = (conn, params) -> begin
             @test JSONRPC.is_currently_handling_msg(msg_dispatcher)
             params.fieldA == 1 ? "YES" : "NO"
         end
-        msg_dispatcher[request2_type] = (conn, params)->JSONRPC.JSONRPCError(-32600, "Our message", nothing)
-        msg_dispatcher[notify1_type] = (conn, params)->g_var = params
+        msg_dispatcher[request2_type] = (conn, params) -> JSONRPC.JSONRPCError(-32600, "Our message", nothing)
+        msg_dispatcher[notify1_type] = (conn, params) -> g_var = params
 
         run(conn)
 
@@ -46,7 +46,7 @@
 
     JSONRPC.send(conn2, notify1_type, "TEST")
 
-    res = JSONRPC.send(conn2, request1_type, Foo(fieldA = 1, fieldB = "FOO"))
+    res = JSONRPC.send(conn2, request1_type, Foo(fieldA=1, fieldB="FOO"))
 
     @test res == "YES"
     @test g_var == "TEST"