REPL: use an Event to orchestrate prompt entry in precompile script

Author: IanButterworth

stdlib/REPL/src/LineEdit.jl

@@ -85,9 +85,11 @@ mutable struct MIState
     line_modify_lock::Base.ReentrantLock
     hint_generation_lock::Base.ReentrantLock
     n_keys_pressed::Int
+    # Optional event that gets notified each time the prompt is ready for input
+    prompt_ready_event::Union{Nothing, Base.Event}
 end
 
-MIState(i, mod, c, a, m) = MIState(i, mod, mod, c, a, m, String[], 0, Char[], 0, :none, :none, Channel{Function}(), Base.ReentrantLock(), Base.ReentrantLock(), 0)
+MIState(i, mod, c, a, m) = MIState(i, mod, mod, c, a, m, String[], 0, Char[], 0, :none, :none, Channel{Function}(), Base.ReentrantLock(), Base.ReentrantLock(), 0, nothing)
 
 const BufferLike = Union{MIState,ModeState,IOBuffer}
 const State = Union{MIState,ModeState}
@@ -2977,6 +2979,10 @@ function prompt!(term::TextTerminal, prompt::ModalInterface, s::MIState = init_s
     enable_bracketed_paste(term)
     try
         activate(prompt, s, term, term)
+        # Notify that prompt is ready for input
+        if s.prompt_ready_event !== nothing
+            notify(s.prompt_ready_event)
+        end
         old_state = mode(s)
         # spawn this because the main repl task is sticky (due to use of @async and _wait2)
         # and we want to not block typing when the repl task thread is busy

stdlib/REPL/src/REPL.jl

@@ -779,14 +779,18 @@ mutable struct LineEditREPL <: AbstractREPL
     interface::ModalInterface
     backendref::REPLBackendRef
     frontend_task::Task
+    # Optional event to notify when the prompt is ready (used by precompilation)
+    prompt_ready_event::Union{Nothing, Base.Event}
     function LineEditREPL(t,hascolor,prompt_color,input_color,answer_color,shell_color,help_color,pkg_color,history_file,in_shell,in_help,envcolors)
         opts = Options()
         opts.hascolor = hascolor
         if !hascolor
             opts.beep_colors = [""]
         end
-        new(t,hascolor,prompt_color,input_color,answer_color,shell_color,help_color,pkg_color,history_file,in_shell,
+        r = new(t,hascolor,prompt_color,input_color,answer_color,shell_color,help_color,pkg_color,history_file,in_shell,
             in_help,envcolors,false,nothing, opts, nothing, Tuple{String,Int}[])
+        r.prompt_ready_event = nothing
+        r
     end
 end
 outstream(r::LineEditREPL) = (t = r.t; t isa TTYTerminal ? t.out_stream : t)
@@ -1665,6 +1669,10 @@ function run_frontend(repl::LineEditREPL, backend::REPLBackendRef)
     end
     repl.backendref = backend
     repl.mistate = LineEdit.init_state(terminal(repl), interface)
+    # Copy prompt_ready_event from repl to mistate (used by precompilation)
+    if isdefined(repl, :prompt_ready_event) && repl.prompt_ready_event !== nothing
+        repl.mistate.prompt_ready_event = repl.prompt_ready_event
+    end
     run_interface(terminal(repl), interface, repl.mistate)
     # Terminate Backend
     put!(backend.repl_channel, (nothing, -1))

stdlib/REPL/src/precompile.jl

@@ -15,42 +15,55 @@ finally
 end
 
 function repl_workload()
-    # these are intentionally triggered
+    # Capture debug output to show if something goes wrong
+    debug_output = IOBuffer()
+
+    # Errors that are intentionally triggered by the script
     allowed_errors = [
         "BoundsError: attempt to access 0-element Vector{Any} at index [1]",
         "MethodError: no method matching f(::$Int, ::$Int)",
         "Padding of type", # reinterpret docstring has ERROR examples
     ]
-    function check_errors(out)
-        str = String(out)
-        if occursin("ERROR:", str) && !any(occursin(e, str) for e in allowed_errors)
-            @error "Unexpected error (Review REPL precompilation with debug_output on):\n$str" exception=(
-                Base.PrecompilableError(), Base.backtrace())
-            exit(1)
+
+    function check_output()
+        str = String(take!(copy(debug_output)))
+        for line in eachline(IOBuffer(str))
+            if occursin("ERROR:", line) && !any(e -> occursin(e, line), allowed_errors)
+                println(stderr, """
+                ========================================================================
+                ERROR: Unexpected error during REPL precompilation
+                ========================================================================
+                Debug output:
+                ------------------------------------------------------------------------
+                """)
+                println(stderr, str)
+                println(stderr, "========================================================================")
+                error("REPL precompilation encountered unexpected error: $line")
+            end
         end
     end
-    ## Debugging options
-    # View the code sent to the repl by setting this to `stdout`
-    debug_output = devnull # or stdout
 
     CTRL_C = '\x03'
     CTRL_D = '\x04'
     CTRL_R = '\x12'
     UP_ARROW = "\e[A"
     DOWN_ARROW = "\e[B"
 
-    # This is notified as soon as the first prompt appears
-    repl_init_event = Base.Event()
-    repl_init_done_event = Base.Event()
+    # Event that REPL notifies each time it's ready for input (autoreset so each wait blocks until next notify)
+    prompt_ready = Base.Event(true)
+    # Event to signal that REPL.activate has been called
+    activate_done = Base.Event()
 
     atreplinit() do repl
-        # Main is closed so we can't evaluate in it, but atreplinit runs at
-        # a time that repl.mistate === nothing so REPL.activate fails. So do
-        # it async and wait for the first prompt to know its ready.
+        # Set the prompt_ready_event on the repl - run_frontend will copy it to mistate
+        if repl isa REPL.LineEditREPL
+            repl.prompt_ready_event = prompt_ready
+        end
+        # Start async task to wait for first prompt then activate the module
         t = @async begin
-            wait(repl_init_event)
+            wait(prompt_ready)
             REPL.activate(REPL.Precompile; interactive_utils=false)
-            notify(repl_init_done_event)
+            notify(activate_done)
         end
         Base.errormonitor(t)
     end
@@ -83,14 +96,6 @@ function repl_workload()
     println("done")
     """
 
-    JULIA_PROMPT = "julia> "
-    # The help text for `reinterpret` has example `julia>` prompts in it,
-    # so use the longer prompt to avoid desychronization.
-    ACTIVATED_JULIA_PROMPT = "(REPL.Precompile) julia> "
-    PKG_PROMPT = "pkg> "
-    SHELL_PROMPT = "shell> "
-    HELP_PROMPT = "help?> "
-
     tmphistfile = tempname()
     write(tmphistfile, """
     # time: 2020-10-31 13:16:39 AWST
@@ -120,20 +125,16 @@ function repl_workload()
             Base._fd(pts) == rawpts || Base.close_stdio(rawpts)
         end
         # Prepare a background process to copy output from `ptm` until `pts` is closed
-        output_copy = Base.BufferStream()
         tee = @async try
             while !eof(ptm)
                 l = readavailable(ptm)
                 write(debug_output, l)
-                write(output_copy, l)
             end
-            write(debug_output, "\n#### EOF ####\n")
         catch ex
             if !(ex isa Base.IOError && ex.code == Base.UV_EIO)
                 rethrow() # ignore EIO on ptm after pts dies
             end
         finally
-            close(output_copy)
             close(ptm)
         end
         Base.errormonitor(tee)
@@ -159,46 +160,27 @@ function repl_workload()
                 redirect_stderr(isopen(orig_stderr) ? orig_stderr : devnull)
             end
             schedule(repltask)
-            # wait for the definitive prompt before start writing to the TTY
-            check_errors(readuntil(output_copy, JULIA_PROMPT, keep=true))
-
-            # Switch to the activated prompt
-            notify(repl_init_event)
-            wait(repl_init_done_event)
+            # Wait for the first prompt, then for activate to complete
+            wait(activate_done)
+            # Send a newline to get the activated prompt
             write(ptm, "\n")
-            # The prompt prints twice - once for the restatement of the input, once
-            # to indicate ready for the new prompt.
-            check_errors(readuntil(output_copy, ACTIVATED_JULIA_PROMPT, keep=true))
-            check_errors(readuntil(output_copy, ACTIVATED_JULIA_PROMPT, keep=true))
+            # Wait for the new prompt to be ready
+            wait(prompt_ready)
 
-            write(debug_output, "\n#### REPL STARTED ####\n")
             # Input our script
             precompile_lines = split(repl_script::String, '\n'; keepempty=false)
-            curr = 0
             for l in precompile_lines
-                sleep(0.01) # try to let a bit of output accumulate before reading again
-                curr += 1
-                # push our input
-                write(debug_output, "\n#### inputting statement: ####\n$(repr(l))\n####\n")
-                # If the line ends with a CTRL_C, don't write an extra newline, which would
-                # cause a second empty prompt. Our code below expects one new prompt per
-                # input line and can race out of sync with the unexpected second line.
-                endswith(l, CTRL_C) ? write(ptm, l) : write(ptm, l, "\n")
-                check_errors(readuntil(output_copy, "\n"))
-                # wait for the next prompt-like to appear
-                check_errors(readuntil(output_copy, "\n"))
-                strbuf = ""
-                while !eof(output_copy)
-                    strbuf *= String(readavailable(output_copy))
-                    occursin(ACTIVATED_JULIA_PROMPT, strbuf) && break
-                    occursin(PKG_PROMPT, strbuf) && break
-                    occursin(SHELL_PROMPT, strbuf) && break
-                    occursin(HELP_PROMPT, strbuf) && break
-                    sleep(0.01) # try to let a bit of output accumulate before reading again
+                # If the line ends with a CTRL_C, don't write an extra newline
+                # CTRL_C cancels input but doesn't print a new prompt, so don't wait
+                if endswith(l, CTRL_C)
+                    write(ptm, l)
+                    sleep(0.1)  # Brief pause to let CTRL_C be processed
+                else
+                    write(ptm, l, "\n")
+                    # Wait for REPL to signal it's ready for next input
+                    wait(prompt_ready)
                 end
-                check_errors(strbuf)
             end
-            write(debug_output, "\n#### COMPLETED - Closing REPL ####\n")
             write(ptm, "$CTRL_D")
             wait(repltask)
         finally
@@ -208,7 +190,9 @@ function repl_workload()
         end
         wait(tee)
     end
-    write(debug_output, "\n#### FINISHED ####\n")
+    # Check for any unexpected errors in the output
+    check_output()
+    rm(tmphistfile, force=true)
     nothing
 end