Merge pull request #39 from Arkoniak/38-fix-quotes

fix: json quotes (#38)

Author: Arkoniak

Project.toml

@@ -1,7 +1,7 @@
 name = "MiniLoggers"
 uuid = "93f3dd0f-005d-4452-894a-a31841fa4078"
 authors = ["Andrey Oskin and contributors"]
-version = "0.5.0"
+version = "0.5.1"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

src/jsonlogger.jl

@@ -101,30 +101,36 @@ function handle_message(logger::JsonLogger, level, message, _module, group, id,
         elseif val == "id"
             print(iob, "\"", id, "\"")
         elseif val == "message"
-            print(iob, "\"")
-            showmessage(iob, message, logger, logger.mode)
+            mbuf = IOBuffer()
+            miob = IOContext(mbuf, io)
+
+            showmessage(miob, message, logger, logger.mode)
             if length(kwargs) > 0 && !isempty(message)
-                print(iob, " ")
+                print(miob, " ")
             end
 
             iscomma = false
             for (k, v) in kwargs
                 if string(k) == v
-                    print(iob, k)
+                    print(miob, k)
                     iscomma = false
                 else
-                    iscomma && print(iob, ", ")
-                    print(iob, k, " = ")
-                    showvalue(iob, v, logger, logger.mode)
+                    iscomma && print(miob, ", ")
+                    print(miob, k, " = ")
+                    showvalue(miob, v, logger, logger.mode)
                     iscomma = true
                 end
             end
             print(iob, "\"")
+            write(iob, postprocess(JsonSquash(), logger.squash_delimiter, mbuf))
+            print(iob, "\"")
         else
             print(iob, val)
         end
     end
-    write(io, postprocess(logger.mode, logger.squash_delimiter, buf))
+    write(io, take!(buf))
+    write(io, '\n')
+    # write(io, postprocess(logger.mode, logger.squash_delimiter, buf))
 
     if logger.flush
         if logger.flush_threshold <= 0

src/modes.jl

@@ -13,13 +13,13 @@ function squash(msg, logger, mode::Union{Squash, FullSquash})
     smsg = replace(smsg, "\n" => logger.squash_delimiter)
 end
 
-function squash(msg, logger, mode::JsonSquash)
-    smsg = string(msg)
-    # Far from perfect, but should cover most cases. If we run into any issues, we can add more complicated processing
-    smsg = replace(smsg, "\"" => "\\\"")
-    smsg = replace(smsg, "\r" => "")
-    smsg = replace(smsg, "\n" => logger.squash_delimiter)
-end
+# function squash(msg, logger, mode::JsonSquash)
+#     smsg = string(msg)
+#     # Far from perfect, but should cover most cases. If we run into any issues, we can add more complicated processing
+#     smsg = replace(smsg, "\"" => "\\\"")
+#     smsg = replace(smsg, "\r" => "")
+#     smsg = replace(smsg, "\n" => logger.squash_delimiter)
+# end
 
 showvalue(io, msg, logger, mode) = print(io, squash(msg, logger, mode))
 
@@ -48,7 +48,7 @@ function postprocess(mode, delimiter, iobuf)
     take!(iobuf)
 end
 
-function postprocess(mode::Union{FullSquash, JsonSquash}, delimiter, iobuf)
+function postprocess(mode::FullSquash, delimiter, iobuf)
     buf = take!(iobuf)
     delm = Vector{UInt8}(delimiter)
     res = similar(buf)
@@ -80,3 +80,25 @@ function postprocess(mode::Union{FullSquash, JsonSquash}, delimiter, iobuf)
 
     return res
 end
+
+function postprocess(mode::JsonSquash, delimiter, iobuf)
+    buf0 = String(take!(iobuf))
+    buf = IOBuffer()
+    iob = IOContext(buf)
+    @inbounds for c in buf0
+        c == '\r' && continue
+        if c == '\n' 
+            print(iob, delimiter)
+        elseif c == '\\'
+            print(iob, '\\')
+            print(iob, '\\')
+        elseif c == '\"'
+            print(iob, '\\')
+            print(iob, '\"')
+        else
+            print(iob, c)
+        end
+    end
+
+    return take!(buf)
+end

test/test04_jsonlogger.jl

@@ -14,7 +14,6 @@ comptokens(t1, t2) = all(x.val == y for (x, y) in zip(t1, t2))
 
     @testset "comma separated" begin
         res1 = tokenize(JsonLoggerTokenizer(), "x,y")
-        @show res1
         @test comptokens(res1, ["{", "\"x\"", ":", "x", ",", "\"y\"", ":", "y", "}"])
     end
 
@@ -30,22 +29,37 @@ comptokens(t1, t2) = all(x.val == y for (x, y) in zip(t1, t2))
 end
 
 @testset "JsonLogger printing" begin
-    x = 1
-    y = "asd"
-    x1 = 2
-    z = "z"
-
-    d = Dict("asd" => 1, 'a' => 0.34)
-
-    buf = IOBuffer()
-    iob = IOContext(buf, stdout)
-    JsonLogger(io = iob, format = tokenize(JsonLoggerTokenizer(), "severity:level,source:{line:level,level},message"), minlevel = MiniLoggers.Debug) |> global_logger
-    begin
-        @debug "V:" x y
+    @testset "Simple logging" begin
+        x = 1
+        y = "asd"
+        x1 = 2
+        z = "z"
+
+        d = Dict("asd" => 1, 'a' => 0.34)
+
+        buf = IOBuffer()
+        iob = IOContext(buf, stdout)
+        JsonLogger(io = iob, format = tokenize(JsonLoggerTokenizer(), "severity:level,source:{line:level,level},message"), minlevel = MiniLoggers.Debug) |> global_logger
+        begin
+            @debug "V:" x y
+        end
+
+        s = String(take!(buf))
+        @test s == "{\"severity\":\"Debug\",\"source\":{\"line\":\"Debug\",\"level\":\"Debug\"},\"message\":\"V: x = 1, y = asd\"}\n"
     end
 
-    s = String(take!(buf))
-    @test s == "{\"severity\":\"Debug\",\"source\":{\"line\":\"Debug\",\"level\":\"Debug\"},\"message\":\"V: x = 1, y = asd\"}\n"
+    @testset "quotes escape" begin
+        s = "\""
+        buf = IOBuffer()
+        iob = IOContext(buf, stdout)
+        JsonLogger(io = iob, format = tokenize(JsonLoggerTokenizer(), "message"), minlevel = MiniLoggers.Debug) |> global_logger
+        begin
+            @debug "V:" s
+        end
+
+        s1 = String(take!(buf))
+        @test s1 == "{\"message\":\"V: s = \\\"\"}\n"
+    end
 end
 
 end # module