Merge pull request #45 from Klafyvel/feat-send-module-info

feat(protocol): Send module information when smuggling errors.

Author: Klafyvel

Project.toml

@@ -1,7 +1,7 @@
 name = "REPLSmuggler"
 uuid = "ad7bff83-59f0-4382-9fe5-c2ac8aa77434"
 authors = ["Hugo Levy-Falk <hugo@klafyvel.me> and contributors"]
-version = "0.5.1"
+version = "0.6.0"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

src/Protocols.jl

@@ -65,7 +65,7 @@ If an error occured, then the error field is a three-elements array structured a
 - `exception::String`: Name of the exception, *e.g.* `"ValueError"`,
 - `exception_text::String`: Text, *e.g.* `"This value cannot be < 0."`,
 - `stacktrace::Vector{Tuple{String, UInt32, String}}`: The stacktrace, with each 
-  row being `(file, line, function)`.
+  row being `(file, line, function, module)`. Module can be `nil`.
 
 ## Notifications by the server.
 
@@ -110,7 +110,7 @@ using ..REPLSmuggler: stringify_error
 "Name of the protocol implementation."
 const PROTOCOL_MAGIC = "REPLSmuggler"
 "Protocol version."
-const PROTOCOL_VERSION = v"0.4"
+const PROTOCOL_VERSION = v"0.5"
 
 "Supported image MIME types."
 const IMAGE_MIME = [
@@ -283,7 +283,7 @@ end
     Error(msgid, error, stackframe)
 """
 function Error(msgid, error::T, stackframe) where {T}
-    frames = [(frame.file, frame.line, frame.func) for frame in stackframe]
+    frames = [(frame.file, frame.line, frame.func, isnothing(frame.parentmodule) ? nothing : string(frame.parentmodule)) for frame in stackframe]
     ErrorResponse(
         msgid,
         string(T), stringify_error(error), frames,

src/eval.jl

@@ -61,6 +61,22 @@ function stripblock(s)
     return String(take!(io))
 end
 
+function scrub_repl_backtrace(backtrace)
+    scrubbed_by_base = Base.scrub_repl_backtrace(backtrace)
+    scrubbed = []
+    for sf in scrubbed_by_base
+        parentmodule = Base.parentmodule(sf)
+        if parentmodule == Base
+            # Taken from Atom.jl: src/utils.jl
+            path = normpath(Sys.BINDIR::String, Base.DATAROOTDIR, "julia", "base", string(sf.file))
+        else
+            path = sf.file
+        end
+        push!(scrubbed, (file = path, line = sf.line, func = string(sf.func), parentmodule = parentmodule))
+    end
+    return scrubbed
+end
+
 """
     evaluate_entry(session, msgid, file, line, value, repl=Base.active_repl))
 
@@ -108,7 +124,8 @@ function evaluate_entry(session, msgid, file, line, value, repl = Base.active_re
         REPL.LineEdit.refresh_line(s)
 
         if !isnothing(error)
-            put!(session.responsechannel, Protocols.Error(msgid, error.exception, error.stack))
+            stack = scrub_repl_backtrace(error.stack)
+            put!(session.responsechannel, Protocols.Error(msgid, error.exception, stack))
         elseif !hide_output && !isnothing(first(repl_response))
             index_mime = session.sessionparams["enableimages"] ? findfirst([Base.invokelatest(showable, mime, first(repl_response)) for mime in Protocols.IMAGE_MIME]) : nothing
             @debug "Show time." index_mime first(repl_response)

test/msgpackserializer.jl

@@ -26,11 +26,11 @@ using MsgPack
 
         msg = Protocols.Error(
             1, ErrorException("Foo"), [
-                (file = "foo.jl", line = 1, func = "foo()"),
-                (file = "bar.jl", line = 2, func = "bar()"),
+                (file = "foo.jl", line = 1, func = "foo()", parentmodule = "Main"),
+                (file = "bar.jl", line = 2, func = "bar()", parentmodule = "Main"),
             ],
         )
-        expected_array = [Protocols.RESPONSE, 0x01, ["ErrorException", "ErrorException: Foo", [("foo.jl", 1, "foo()"), ("bar.jl", 2, "bar()")]], nothing]
+        expected_array = [Protocols.RESPONSE, 0x01, ["ErrorException", "ErrorException: Foo", [("foo.jl", 1, "foo()", "Main"), ("bar.jl", 2, "bar()", "Main")]], nothing]
         @testset "Error" test_msg(msg, expected_array)
 
         msg = Protocols.Result(1, 1, "foo")

test/protocol.jl

@@ -43,8 +43,8 @@ using REPLSmuggler.Protocols
     Protocols.serialize(
         protocol, Protocols.Error(
             1, ErrorException("Foo"), [
-                (file = "foo.jl", line = 1, func = "foo()"),
-                (file = "bar.jl", line = 2, func = "bar()"),
+                (file = "foo.jl", line = 1, func = "foo()", parentmodule = "Main"),
+                (file = "bar.jl", line = 2, func = "bar()", parentmodule = "Main"),
             ],
         ),
     )
@@ -57,8 +57,8 @@ using REPLSmuggler.Protocols
             (
                 "ErrorException", "ErrorException: Foo",
                 [
-                    ("foo.jl", 1, "foo()"),
-                    ("bar.jl", 2, "bar()"),
+                    ("foo.jl", 1, "foo()", "Main"),
+                    ("bar.jl", 2, "bar()", "Main"),
                 ],
             ),
             nothing,