wip: migrate to JSON.jl v1

Author: aviatesk

JSONRPC/Project.toml

@@ -4,7 +4,7 @@ version = "0.1.0"
 authors = ["Shuhei Kadowaki <[email protected]>"]
 
 [deps]
-JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
+JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
 
 [compat]
-JSON3 = "1.14.3"
+JSON = "1.2.1"

JSONRPC/src/JSONRPC.jl

@@ -2,7 +2,7 @@ module JSONRPC
 
 export Endpoint, send
 
-using JSON3
+using JSON
 
 mutable struct Endpoint
     in_msg_queue::Channel{Any}
@@ -55,12 +55,9 @@ function Endpoint(in::IO, out::IO, method_dispatcher)
     end
 end
 
-const Parsed = @NamedTuple{method::Union{Nothing,String}}
-
 function readmsg(io::IO, method_dispatcher)
     msg_str = @something read_transport_layer(io) return nothing
-    parsed = JSON3.read(msg_str, Parsed)
-    return reparse_msg_str(parsed, msg_str, method_dispatcher)
+    return reparse_msg_str(JSON.lazy(msg_str), method_dispatcher)
 end
 
 function read_transport_layer(io::IO)
@@ -81,20 +78,19 @@ function read_transport_layer(io::IO)
     return String(read(io, message_length))
 end
 
-function reparse_msg_str(parsed::Parsed, msg_str::String, method_dispatcher)
-    parsed_method = parsed.method
-    if parsed_method !== nothing
-        if haskey(method_dispatcher, parsed_method)
-            return JSON3.read(msg_str, method_dispatcher[parsed_method])
+function reparse_msg_str(lazyjson::JSON.LazyValue, method_dispatcher)
+    if hasproperty(lazyjson, :method)
+        if haskey(method_dispatcher, lazyjson.method)
+            return JSON.parse(lazyjson, method_dispatcher[parsed_method])
         end
-        return JSON3.read(msg_str, Dict{Symbol,Any})
+        return JSON.parse(lazyjson, Dict{Symbol,Any})
     else # TODO parse to ResponseMessage?
-        return JSON3.read(msg_str, Dict{Symbol,Any})
+        return JSON.parse(lazyjson, Dict{Symbol,Any})
     end
 end
 
 function writemsg(io::IO, @nospecialize msg)
-    msg_str = JSON3.write(msg)
+    msg_str = JSON.json(msg)
     write_transport_layer(io, msg_str)
 end
 

LSP/Project.toml

@@ -4,7 +4,7 @@ version = "0.1.0"
 authors = ["Shuhei Kadowaki <[email protected]>"]
 
 [deps]
-StructTypes = "856f2bd8-1eba-4b0a-8007-ebc267875bd4"
+StructUtils = "ec057cc2-7a8d-4b58-b3b3-92acb9f63b42"
 
 [compat]
-StructTypes = "1.11.0"
+StructUtils = "2.6.0"

LSP/README.md

@@ -12,7 +12,7 @@ to faithfully translate the TypeScript LSP specification into idiomatic Julia co
   - Uses `Union{Nothing, Type} = nothing` field to represent TypeScript's optional properties (`field?: Type`)
   - Supports inheritance through `@extends` to compose interfaces (similar to TypeScript's `extends`)
   - Enables anonymous interface definitions within `Union` types for inline type specifications
-  - Automatically configures `StructTypes.omitempties()` to omit optional fields during JSON serialization
+  - Integrates with JSON.jl v1 and StructUtils.jl for JSON serialization/deserialization
   - Creates method dispatchers for `RequestMessage` and `NotificationMessage` types to enable LSP message routing
 
 - **`@namespace` macro**: Creates Julia modules containing typed constants that correspond to TypeScript `namespace`s:

LSP/src/LSP.jl

@@ -1,6 +1,6 @@
 module LSP
 
-using StructTypes: StructTypes
+using StructUtils: StructUtils
 
 include("URIs2/URIs2.jl")
 using ..URIs2: URI

LSP/src/URIs2/URIs2.jl

@@ -7,7 +7,7 @@ module URIs2
 
 export URI, uri2filename, uri2filepath, filename2uri, filepath2uri, @uri_str
 
-using StructTypes: StructTypes
+using StructUtils: StructUtils
 
 include("vendored_from_uris.jl")
 
@@ -22,7 +22,7 @@ Details of a Unified Resource Identifier.
  - query::Union{Nothing, String}
  - fragment::Union{Nothing, String}
 """
-struct URI
+StructUtils.@nonstruct struct URI
     scheme::Union{String,Nothing}
     authority::Union{String,Nothing}
     path::String
@@ -72,10 +72,9 @@ else
     end
 end
 
-Base.convert(::Type{URI}, s::AbstractString) = URI(s)
-
-# This overload requires `URI(::AbstractString)` as well, which is defined later
-StructTypes.StructType(::Type{URI}) = StructTypes.StringType()
+# Tell StructUtils how to serialize/deserialize URI as a string
+StructUtils.lower(uri::URI) = string(uri)
+StructUtils.lift(::Type{URI}, s::String) = URI(s)
 
 function percent_decode(str::AbstractString)
     return unescapeuri(str)

LSP/src/base-protocol.jl

@@ -3,14 +3,13 @@
 
 """
 A special object representing `null` value.
-When used as a field specified as `StructTypes.omitempties`, the key-value pair is not
-omitted in the serialized JSON but instead appears as `null`.
+When used as a field that might be omitted in the serialized JSON, the key-value pair
+appears as `null` instead of being omitted.
 This special object is specifically intended for use in `ResponseMessage`.
 """
 struct Null end
 const null = Null()
-StructTypes.StructType(::Type{Null}) = StructTypes.CustomStruct()
-StructTypes.lower(::Null) = nothing
+StructUtils.lower(::Null) = nothing
 push!(exports, :Null, :null)
 
 const boolean = Bool

LSP/src/utils/interface.jl

@@ -33,22 +33,19 @@ macro interface(exs...)
 
     is_method_dispatchable = false
     structbody = Expr(:block, __source__)
-    omittable_fields = Set{Symbol}()
     extended_fields = Dict{Symbol,Vector{Int}}()
     duplicated_fields = Int[]
     if extends !== nothing
         for extend in extends
             is_method_dispatchable |= extend === :RequestMessage || extend === :NotificationMessage
             add_extended_interface!(toplevelblk, structbody,
-                                    omittable_fields,
                                     extended_fields,
                                     duplicated_fields,
                                     extend,
                                     __source__)
         end
     end
     _, method = process_interface_def!(toplevelblk, structbody,
-                                       omittable_fields,
                                        extended_fields,
                                        duplicated_fields,
                                        defex,
@@ -68,35 +65,22 @@ macro interface(exs...)
 end
 
 function process_interface_def!(toplevelblk::Expr, structbody::Expr,
-                                omittable_fields::Set{Symbol},
                                 extended_fields::Dict{Symbol,Vector{Int}},
                                 duplicated_fields::Vector{Int},
                                 defex::Expr,
                                 __source__::LineNumberNode,
                                 Name::Union{Symbol,Nothing})
-    method = _process_interface_def!(toplevelblk, structbody, omittable_fields, extended_fields, duplicated_fields, defex, __source__)
+    method = _process_interface_def!(toplevelblk, structbody, extended_fields, duplicated_fields, defex, __source__)
     deleteat!(structbody.args, duplicated_fields)
     is_anon = Name === nothing
     if is_anon
         # Name = Symbol("AnonymousInterface", string(__source__)) # XXX this doesn't work probably due to Julia internal bug
         Name = Symbol("AnonymousInterface", gensym())
     end
     structdef = Expr(:struct, false, Name, structbody)
+    # TODO Use `StructUtils.@defaults` here?
     kwdef = Expr(:macrocall, GlobalRef(Base, Symbol("@kwdef")), __source__, structdef) # `@kwdef` will attach `Core.__doc__` automatically
     push!(toplevelblk.args, kwdef)
-    if !isempty(omittable_fields)
-        omitempties = Tuple(omittable_fields)
-        if Name === :InitializeParams
-            # HACK: In the write->read roundtrip of `InitializationRequest` in the
-            # `withserver` test, empty `workspaceFolders` needs to be serialized without
-            # being omitted. So override the `omitempties` for `InitializeParams`.
-            # In the normal lifecycle of a language server, `InitializeParams` is never
-            # serialized, so adding this hack doesn't affect the language server's behavior
-            # (except in the tests)
-            omitempties = ()
-        end
-        push!(toplevelblk.args, :(StructTypes.omitempties(::Type{$Name}) = $omitempties))
-    end
     if is_anon
         push!(toplevelblk.args, :(Base.convert(::Type{$Name}, nt::NamedTuple) = $Name(; nt...)))
     end
@@ -107,13 +91,11 @@ function process_interface_def!(toplevelblk::Expr, structbody::Expr,
 end
 
 function add_extended_interface!(toplevelblk::Expr, structbody::Expr,
-                                 omittable_fields::Set{Symbol},
                                  extended_fields::Dict{Symbol,Vector{Int}},
                                  duplicated_fields::Vector{Int},
                                  extend::Symbol,
                                 __source__::LineNumberNode)
     return _process_interface_def!(toplevelblk, structbody,
-                                   omittable_fields,
                                    extended_fields,
                                    duplicated_fields,
                                    _INTERFACE_DEFS[extend],
@@ -122,7 +104,6 @@ function add_extended_interface!(toplevelblk::Expr, structbody::Expr,
 end
 
 function _process_interface_def!(toplevelblk::Expr, structbody::Expr,
-                                 omittable_fields::Set{Symbol},
                                  extended_fields::Dict{Symbol,Vector{Int}},
                                  duplicated_fields::Vector{Int},
                                  defex::Expr,
@@ -157,7 +138,6 @@ function _process_interface_def!(toplevelblk::Expr, structbody::Expr,
                 error("Unsupported syntax found in `@interface`: ", defex)
             end
         end
-        omittable = false
         if Meta.isexpr(fieldline, :(=))
             fielddecl, default = fieldline.args
             if Meta.isexpr(fielddecl, :(::))
@@ -177,14 +157,6 @@ function _process_interface_def!(toplevelblk::Expr, structbody::Expr,
         if Meta.isexpr(fielddecl, :(::))
             fieldname = fielddecl.args[1]
             fieldtype = fielddecl.args[2]
-            if Meta.isexpr(fieldtype, :curly) && fieldtype.args[1] === :Union
-                for i = 2:length(fieldtype.args)
-                    ufty = fieldtype.args[i]
-                    if ufty === :Nothing
-                        omittable = true
-                    end
-                end
-            end
             if Meta.isexpr(fieldtype, :curly)
                 for i = 1:length(fieldtype.args)
                     ufty = fieldtype.args[i]
@@ -203,12 +175,8 @@ function _process_interface_def!(toplevelblk::Expr, structbody::Expr,
             fieldname = fielddecl
         end
         fieldname isa Symbol || error("Invalid `@interface` syntax: ", defex)
-        if omittable
-            push!(omittable_fields, fieldname)
-        end
         if haskey(extended_fields, fieldname)
             append!(duplicated_fields, extended_fields[fieldname])
-            omittable || delete!(omittable_fields, fieldname)
         end
         push!(structbody.args, fieldline)
         if extending
@@ -221,11 +189,10 @@ function _process_interface_def!(toplevelblk::Expr, structbody::Expr,
 end
 
 function process_anon_interface_def!(toplevelblk::Expr, defex::Expr, __source__::LineNumberNode) # Anonymous @interface
-    omittable_fields = Set{Symbol}()
     extended_fields = Dict{Symbol,Vector{Int}}()
     duplicated_fields = Int[]
     res, _ = process_interface_def!(toplevelblk, Expr(:block),
-        omittable_fields, extended_fields, duplicated_fields, defex, __source__, #=Name=#nothing)
+        extended_fields, duplicated_fields, defex, __source__, #=Name=#nothing)
     if !(isempty(extended_fields) && isempty(duplicated_fields))
         error("`Anonymous @interface` does not support extension", defex)
     end