Update to [email protected], drop old Julia support (#661)

Removes legacy code, updates docs, adds NEWS Co-authored-by: Tim Holy <[email protected]>
timholy · Dec 25, 2021 · e8d8dae · e8d8dae · timholy · Dec 26, 2021
1 parent 5f428c9
commit e8d8dae
Show file tree

Hide file tree

Showing 15 changed files with 83 additions and 510 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -13,8 +13,8 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.0'
-          - '1'
+          - '1.6'     # LTS
+          - '1'       # current stable
           - 'nightly'
         os:
           - ubuntu-latest
@@ -56,7 +56,7 @@ jobs:
         # Tests for when using polling
         julia --project --code-coverage=user -e 'ENV["JULIA_REVISE_POLL"]="1"; using Pkg, Revise; include(joinpath(dirname(pathof(Revise)), "..", "test", "polling.jl"))'
         # The REPL wasn't initialized, so the "Methods at REPL" tests didn't run. Pick those up now.
-        TERM="xterm" julia --project --code-coverage=user -e 'using InteractiveUtils, REPL, Revise; @async(Base.run_main_repl(true, true, false, true, false)); sleep(2); Revise.async_steal_repl_backend(); include(joinpath("test", "runtests.jl")); REPL.eval_user_input(:(exit()), Base.active_repl_backend)' "Methods at REPL"
+        TERM="xterm" julia --project --code-coverage=user -e 'using InteractiveUtils, REPL, Revise; @async(Base.run_main_repl(true, true, false, true, false)); while !isdefined(Base, :active_repl_backend) sleep(0.1) end; pushfirst!(Base.active_repl_backend.ast_transforms, Revise.revise_first); include(joinpath("test", "runtests.jl")); REPL.eval_user_input(:(exit()), Base.active_repl_backend)' "Methods at REPL"
         # Tests for out-of-process updates to manifest
         bash test/envs/use_exputils/setup.sh
         julia --project --code-coverage=user test/envs/use_exputils/switch_version.jl

diff --git a/NEWS.md b/NEWS.md
@@ -3,6 +3,17 @@
 This file describes only major changes, and does not include bug fixes,
 cleanups, or minor enhancements.
 
+## Revise 3.3
+
+* Upgrade to JuliaInterpreter 0.9 and drop support for Julia prior to 1.6 (the new LTS).
+
+## Revise 3.2
+
+* Switch to synchronous processing of new packages and `@require` blocks.
+  This is motivated by changes in Julia designed to make code-loading threadsafe.
+  There are small (100-200ms) increases in latency on first use, but more guarantees that
+  Revise's workqueue will finish before new operations commence.
+
 ## Revise 3.0
 
 * Latencies at startup and upon first subsequent package load are greatly reduced.

diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "Revise"
 uuid = "295af30f-e4ad-537b-8983-00126c2a3abe"
-version = "3.2.1"
+version = "3.3.0"
 
 [deps]
 CodeTracking = "da1fd8a2-8d9e-5ec2-8556-3022fb5608a2"
@@ -18,12 +18,12 @@ Unicode = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
 
 [compat]
 CodeTracking = "1"
-JuliaInterpreter = "0.8.6"
-LoweredCodeUtils = "2.0.0"
+JuliaInterpreter = "0.9"
+LoweredCodeUtils = "2.2"
 OrderedCollections = "1"
 # Exclude Requires-1.1.0 - see https://github.com/JuliaPackaging/Requires.jl/issues/94
 Requires = "~1.0, ^1.1.1"
-julia = "1"
+julia = "1.6"
 
 [extras]
 CatIndices = "aafaddc9-749c-510e-ac4f-586e18779b91"

diff --git a/docs/src/config.md b/docs/src/config.md
@@ -1,22 +1,21 @@
 # Configuration
 
+!!! compat
+    These instructions are applicable only for Julia 1.5 and higher. If you are running an older version of Julia, upgrading to at least 1.6 is recommended. If you cannot upgrade, see the documentation for Revise 3.2.x or earlier.
+
 ## Using Revise by default
 
 If you like Revise, you can ensure that every Julia session uses it by
 launching it from your `~/.julia/config/startup.jl` file.
 Note that using Revise adds a small latency at Julia startup, generally about 0.7s when you first launch Julia and another 0.25s for your first package load.
 Users should weigh this penalty against whatever benefit they may derive from not having to restart their entire session.
 
-### Julia 1.5 and higher
-
-If you're using at least Julia 1.5, this can be as simple as adding
+This can be as simple as adding
 
 ```julia
 using Revise
 ```
-to your `startup.jl`.
-
-or (if you have a Unix terminal available) simply run
+to your `startup.jl`. If you have a Unix terminal available, simply run
 ```bash
 mkdir -p ~/.julia/config/ && echo "using Revise" >> ~/.julia/config/startup.jl
 ```
@@ -33,23 +32,6 @@ end
 
 is recommended instead.
 
-### Earlier Julia versions
-
-If you sometimes use versions of Julia prior to 1.5, instead of the above add
-
-```julia
-atreplinit() do repl
-    try
-        @eval using Revise
-        @async Revise.wait_steal_repl_backend()
-    catch e
-        @warn "Error initializing Revise" exception=(e, catch_backtrace())
-    end
-end
-```
-
-to your `startup.jl`.
-
 ### Using Revise automatically within Jupyter/IJulia
 
 If you want Revise to launch automatically within IJulia, then you should also create a `.julia/config/startup_ijulia.jl` file with the contents
@@ -63,12 +45,12 @@ end
 ```
 or simply run
 ```bash
-mkdir -p ~/.julia/config/ && tee -a  ~/.julia/config/startup_ijulia.jl << END  
+mkdir -p ~/.julia/config/ && tee -a  ~/.julia/config/startup_ijulia.jl << END
 try
     @eval using Revise
 catch e
     @warn "Error initializing Revise" exception=(e, catch_backtrace())
-end  
+end
 END
 ```
 

diff --git a/docs/src/dev_reference.md b/docs/src/dev_reference.md
@@ -56,13 +56,6 @@ MethodSummary
 
 ## Function reference
 
-### Functions called during initialization of Revise
-
-```@docs
-Revise.async_steal_repl_backend
-Revise.steal_repl_backend
-```
-
 ### Functions called when you load a new package
 
 ```@docs

diff --git a/src/Revise.jl b/src/Revise.jl
@@ -1,16 +1,16 @@
 """
-Revise.jl tracks source code changes and incorporates the changes to a running Julia session. 
+Revise.jl tracks source code changes and incorporates the changes to a running Julia session.
 
 Revise.jl works behind-the-scenes. To track a package, e.g. `Example`:
 ```julia
 (@v1.6) pkg> dev Example        # make a development copy of the package
 [...pkg output omitted...]
 
-julia> using Revise             # this must come before the package under development 
+julia> using Revise             # this must come before the package under development
 
-julia> using Example            
+julia> using Example
 
-[...develop the package...]     # Revise.jl will automatically update package functionality to match code changes  
+[...develop the package...]     # Revise.jl will automatically update package functionality to match code changes
 
 ```
 
@@ -39,7 +39,7 @@ using CodeTracking: PkgFiles, basedir, srcfiles, line_is_decl, basepath
 using JuliaInterpreter: whichtt, is_doc_expr, step_expr!, finish_and_return!, get_return,
                         @lookup, moduleof, scopeof, pc_expr, is_quotenode_egal,
                         linetable, codelocs, LineTypes, is_GotoIfNot, isassign, isidentical
-using LoweredCodeUtils: next_or_nothing!, trackedheads, structheads, callee_matches
+using LoweredCodeUtils: next_or_nothing!, trackedheads, callee_matches
 
 include("packagedef.jl")
 

diff --git a/src/legacy_loading.jl b/src/legacy_loading.jl
diff --git a/src/lowered.jl b/src/lowered.jl
@@ -9,11 +9,6 @@ function add_docexpr!(docexprs::AbstractDict{Module,V}, mod::Module, ex) where V
     return docexprs
 end
 
-function lookup_callexpr(frame, stmt)
-    fargs = JuliaInterpreter.collect_args(frame, stmt)
-    return Expr(:call, fargs...)
-end
-
 function assign_this!(frame, value)
     frame.framedata.ssavalues[frame.pc] = value
 end
@@ -187,7 +182,7 @@ function methods_by_execution!(@nospecialize(recurse), methodinfo, docexprs, mod
         mode === :sigs && return nothing, nothing
         return Core.eval(mod, lwr), nothing
     end
-    frame = JuliaInterpreter.Frame(mod, lwr.args[1])
+    frame = JuliaInterpreter.Frame(mod, lwr.args[1]::CodeInfo)
     mode === :eval || LoweredCodeUtils.rename_framemethods!(recurse, frame)
     # Determine whether we need interpreted mode
     isrequired, evalassign = minimal_evaluation!(methodinfo, frame, mode)
@@ -266,12 +261,6 @@ function methods_by_execution!(@nospecialize(recurse), methodinfo, docexprs, fra
                 end
                 isassign(frame, pc) && assign_this!(frame, value)
                 pc = next_or_nothing!(frame)
-            elseif head ∈ structheads
-                if mode !== :sigs
-                    pc = step_expr!(recurse, frame, stmt, true)  # This checks that they are unchanged
-                else
-                    pc = next_or_nothing!(frame)
-                end
             # elseif head === :thunk && isanonymous_typedef(stmt.args[1])
             #     # Anonymous functions should just be defined anew, since there does not seem to be a practical
             #     # way to find them within the already-defined module.
@@ -406,7 +395,7 @@ function methods_by_execution!(@nospecialize(recurse), methodinfo, docexprs, fra
                     assign_this!(frame, nothing)  # FIXME: the file might return something different from `nothing`
                     pc = next_or_nothing!(frame)
                 elseif f === Base.Docs.doc! # && mode !== :eval
-                    fargs = JuliaInterpreter.collect_args(frame, stmt)
+                    fargs = JuliaInterpreter.collect_args(recurse, frame, stmt)
                     popfirst!(fargs)
                     length(fargs) == 3 && push!(fargs, Union{})  # add the default sig
                     dmod::Module, b::Base.Docs.Binding, str::Base.Docs.DocStr, sig = fargs