GenieFramework/Genie.jl

Choose JSON Renderer due to bug in JSON3/StructTypes

Open

#636 opened on Mar 22, 2023

View on GitHub
 (5 comments) (1 reaction) (1 assignee)Julia (2,408 stars) (186 forks)batch import
enhancementfeature requestgood-first-issuehelp wantednon-breaking

Description

I'm working on an API that needs to serialize a matrix. The JSON.jl package outputs the following

julia> JSON.json(zeros(Float64, 6, 6))
"[[0.0,0.0,0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0,0.0,0.0],[0.0,0.0,0.0,0.0,0.0,0.0]]"

Which are the results I expect. The JSON3.jl package flattens the array without any information about the original dimensions.

julia> JSON3.write(zeros(Float64, 6, 6))
"[0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0]"

Because of #304 the Genie JSON renderer uses JSON3, so I have to make my own renderer. The upstream projects have open issues[1][2] to address this unexpected type behavior but it doesn't look like anyone is working them. It would be nice to perhaps add a keyword argument to the Genie renderer to choose which backing package to use.

[1] https://github.com/quinnj/JSON3.jl/issues/196 [2] https://github.com/JuliaData/StructTypes.jl/issues/14

Contributor guide

Tech stack
None
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JuliaGenie.jlJSON rendering
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the Genie renderer in Genie.jl to understand how it delegates JSON serialization. Look at the existing renderer code (e.g., in src/renderers/) to find where JSON3 is used. Review upstream issues [1](https://github.com/quinnj/JSON3.jl/issues/196) and [2](https://github.com/JuliaData/StructTypes.jl/issues/14) to confirm the bug is unresolved. Then, propose an implementation that adds a keyword argument to the renderer to allow selecting between JSON.jl and JSON3, with JSON.jl as fallback for types like arrays. Test the chosen solution with matrix serialization.