Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reimplement dummy pkg prompt as standard prompt #54674

Merged
merged 1 commit into from
Jun 9, 2024

Conversation

IanButterworth
Copy link
Member

@IanButterworth IanButterworth commented Jun 4, 2024

Follow-up on #54594 based on #54594 (comment) and review below

  • Implements dummy pkg prompt as an actual repl mode
  • Makes premature return execute once loaded
  • Makes history show pkg commands in dummy prompt then load Pkg and run on return
  • Fixes require_stdlib fast path for already loaded exts c653947 (#54674)

Depends on

Closes #51921

@IanButterworth IanButterworth added REPL Julia's REPL (Read Eval Print Loop) backport 1.11 Change should be backported to release-1.11 labels Jun 4, 2024
@IanButterworth IanButterworth changed the title Don't forward return chars during pkg repl switch transition Don't forward return char during pkg repl switch transition Jun 4, 2024
@IanButterworth
Copy link
Member Author

We could also detect that return was pressed before load finished, and tell Pkg to execute the line once loaded.

@christiangnrd
Copy link
Contributor

christiangnrd commented Jun 4, 2024

This PR fixes the issue!

We could also detect that return was pressed before load finished, and tell Pkg to execute the line once loaded.

Personally I would prefer Pkg execute the line once it's loaded like this comment suggests as that's what current 1.10 behaviour is like.

@IanButterworth
Copy link
Member Author

@christiangnrd that's now implemented, can you give it another go. Thanks

@IanButterworth IanButterworth changed the title Don't forward return char during pkg repl switch transition Run entered command after pkg repl switch transition Jun 4, 2024
stdlib/REPL/src/REPL.jl Outdated Show resolved Hide resolved
stdlib/REPL/src/REPL.jl Outdated Show resolved Hide resolved
stdlib/REPL/src/REPL.jl Outdated Show resolved Hide resolved
Copy link
Member

@Keno Keno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NAK, the fake REPL mode should just be an actual REPL mode until Pkg is loaded at which point it's replaced by the real one. The acceptance hook of the fake REPL mode should block until the real mode is available and then just pass it through.

@vtjnash
Copy link
Member

vtjnash commented Jun 5, 2024

Talking about it with Jeff, I think the fake mode will also let us have the ability to render any history entries that are not currently loaded modes, though which error when you hit enter, and print in gray (or, in a few cases, such as Pkg, may load the package on some trigger, such as enter or ^a[)

@IanButterworth
Copy link
Member Author

Yeah I agree #51921 (comment)

@IanButterworth IanButterworth changed the title Run entered command after pkg repl switch transition Reimplement dummy pkg prompt as standard prompt Jun 5, 2024
@IanButterworth
Copy link
Member Author

I've moved to standard tooling and implemented the history lookup as suggested

stdlib/REPL/src/REPL.jl Outdated Show resolved Hide resolved
Copy link
Member

@Keno Keno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much cleaner

@Keno
Copy link
Member

Keno commented Jun 5, 2024

Recording some discussion with @IanButterworth in DM. REPL is not thread safe, so the thread trying to transition the main REPL does not work. I proposed a sketch along the lines of:

diff --git a/stdlib/REPL/src/LineEdit.jl b/stdlib/REPL/src/LineEdit.jl
index 1003dc0e51..b9fd3d9b11 100644
--- a/stdlib/REPL/src/LineEdit.jl
+++ b/stdlib/REPL/src/LineEdit.jl
@@ -2829,7 +2829,14 @@ function prompt!(term::TextTerminal, prompt::ModalInterface, s::MIState = init_s
         old_state = mode(s)
         while true
             kmap = keymap(s, prompt)
-            fcn = match_input(kmap, s)
+            local fcn
+            waitany((
+                @async wait(term),
+                @async (fcn = take!(s.async_channel)),
+            ))
+            if !@isdefined(fcn)
+                fcn = match_input(kmap, s)
+            end
             kdata = keymap_data(s, prompt)
             s.current_action = :unknown # if the to-be-run action doesn't update this field,
                                         # :unknown will be recorded in the last_action field

to allow the REPL state machine to be driven asynchronously.

stdlib/REPL/src/REPL.jl Outdated Show resolved Hide resolved
Copy link
Member

@Keno Keno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice

@christiangnrd
Copy link
Contributor

This PR makes a big difference in how responsive 1.11 will feel. It'll no longer feel like a regression from 1.10 and I'll be able to remove the using Pkg line I had put in my startup file in anticipation for 1.11.

@@ -2829,7 +2830,11 @@ function prompt!(term::TextTerminal, prompt::ModalInterface, s::MIState = init_s
old_state = mode(s)
while true
kmap = keymap(s, prompt)
fcn = match_input(kmap, s)
waitany((
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

waitany() isn't in 1.11 unfortunately, so this can't be easily backported unless #53341 is backported too.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Keno @KristofferC I think it's reasonable to backport waitany so I've added the label.

@IanButterworth
Copy link
Member Author

This is good now, but I've separated out the require_stdlib fixes into #54730 to be merged first. Thanks @Keno for the help figuring it out.

@IanButterworth IanButterworth added the merge me PR is reviewed. Merge when all tests are passing label Jun 9, 2024
@fatteneder fatteneder merged commit 77c28ab into JuliaLang:master Jun 9, 2024
8 checks passed
@fatteneder fatteneder removed the merge me PR is reviewed. Merge when all tests are passing label Jun 9, 2024
@IanButterworth IanButterworth deleted the ib/pkg_switch_tweak branch June 9, 2024 11:31
@KristofferC
Copy link
Member

I wonder if it would be worth to do a little bit of work to get a good guess on the project name for the prompt. The .... switching to the correct one is a bit distracting.

@IanButterworth
Copy link
Member Author

I think we'd either want it to be ... or correct. Maybe the Pkg functions that are used by REPLExt.promptf could be moved to Base?

@vtjnash
Copy link
Member

vtjnash commented Jun 10, 2024

Could we use pkg> as the temporary prompt? I don't mind it being a little bit different, since it behaves a little bit different too, but .. seems a little bit too cryptic

@IanButterworth
Copy link
Member Author

It could be empty instead ( ) pkg>. I just quite like the prompt not moving

@IanButterworth
Copy link
Member Author

IanButterworth commented Jun 10, 2024

Note that originally the ...... was grayed out to make it clearer that it was temporary, but the REPL prompt handling currently doesn't support multi-colored prompts. That would likely be allowed by #51887 which @tecosaur told me has stalled.

@tecosaur
Copy link
Contributor

To make the "unknown" aspect obvious while doing the padding, ( ? ) pkg> maybe?

@KristofferC
Copy link
Member

KristofferC commented Jun 10, 2024

The ..... perfectly shows the unknown aspect, that is not the issue. The problem is that a sudden swap from .... to the environment name is quite jarring and it kind of screams "hey! loading Pkg! heey!" and it is annoying to have that every time. So just using the correct value seems better since it is quite easy to compute.

@IanButterworth
Copy link
Member Author

So we move those Pkg functions to Base? Seems reasonable

@KristofferC
Copy link
Member

KristofferC pushed a commit that referenced this pull request Jun 13, 2024
KristofferC added a commit that referenced this pull request Jun 25, 2024
Backported PRs:
- [x] #54361 <!-- [LBT] Upgrade to v5.9.0 -->
- [x] #54474 <!-- Unalias source from dest in copytrito -->
- [x] #54548 <!-- Fixes for bitcast bugs with LLVM 17 / opaque pointers
-->
- [x] #54191 <!-- make `AbstractPipe` public -->
- [x] #53402 <!-- Add `jl_getaffinity` and `jl_setaffinity` -->
- [x] #53356 <!-- Rename at-scriptdir project argument to at-script and
search upwards for Project.toml -->
- [x] #54545 <!-- typeintersect: fix incorrect innervar handling under
circular env -->
- [x] #54586 <!-- Set storage class of julia globals to dllimport on
windows to avoid auto-import weirdness. Forward port of #54572 -->
- [x] #54587 <!-- Accomodate for rectangular matrices in `copytrito!`
-->
- [x] #54617 <!-- CLI: Use `GetModuleHandleExW` to locate libjulia.dll
-->
- [x] #54605 <!-- Allow libquadmath to also fail as it is not available
on all systems -->
- [x] #54634 <!-- Fix trampoline assembly for build on clang 18 on apple
silicon -->
- [x] #54635 <!-- Aggressive constprop in trevc! to stabilize triangular
eigvec -->
- [x] #54645 <!-- ensure we set the right value to gc_first_tid -->
- [x] #54554 <!-- make elsize public -->
- [x] #54648 <!-- Construct LazyString in error paths for tridiag -->
- [x] #54658 <!-- fix missing uuid check on extension when finding the
location of an extension -->
- [x] #54594 <!-- Switch to Pkg mode prompt immediately and load Pkg in
the background -->
- [x] #54669 <!-- Improve error message in inplace transpose -->
- [x] #54671 <!-- Add boundscheck in bindingkey_eq to avoid OOB access
due to data race -->
- [x] #54672 <!-- make: Fix `sed` command for LLVM libraries with no
symbol versioning -->
- [x] #54624 <!-- more precise aliasing checks for SubArray -->
- [x] #54679 <!-- 🤖 [master] Bump the Distributed stdlib from 6a07d98 to
6c7cdb5 -->
- [x] #54604 <!-- Fix tbaa annotation on union selector bytes inside of
structs -->
- [x] #54690 <!-- Fix assertion/crash when optimizing function with dead
basic block -->
- [x] #54704 <!-- LazyString in reinterpretarray error messages -->
- [x] #54718 <!-- fix prepend StackOverflow issue -->
- [x] #54674 <!-- Reimplement dummy pkg prompt as standard prompt -->
- [x] #54737 <!-- LazyString in interpolated error messages involving
types -->
- [x] #54642 <!-- Document GenericMemory and AtomicMemory -->
- [x] #54713 <!-- make: use `readelf` for LLVM symbol version detection
-->
- [x] #54760 <!-- REPL: improve prompt! async function handler -->
- [x] #54606 <!-- fix double-counting and non-deterministic results in
`summarysize` -->
- [x] #54759 <!-- REPL: Fully populate the dummy Pkg prompt -->
- [x] #54702 <!-- lowering: Recognize argument destructuring inside
macro hygiene -->
- [x] #54678 <!-- Don't let setglobal! implicitly create bindings -->
- [x] #54730 <!-- Fix uuidkey of exts in fast path of `require_stdlib`
-->
- [x] #54765 <!-- Handle no-postdominator case in finalizer pass -->
- [x] #54591 <!-- Don't expose guard pages to malloc_stack API consumers
-->
- [x] #54755 <!-- [TOML] remove Dates hack, replace with explicit usage
-->
- [x] #54721 <!-- add try/catch around scheduler to reset sleep state
-->
- [x] #54631 <!-- Avoid concatenating LazyString in setindex! for
triangular matrices -->
- [x] #54322 <!-- effects: add new `@consistent_overlay` macro -->
- [x] #54785
- [x] #54865
- [x] #54815
- [x] #54795
- [x] #54779
- [x] #54837 

Contains multiple commits, manual intervention needed:
- [ ] #52694 <!-- Reinstate similar for AbstractQ for backward
compatibility -->
- [ ] #54649 <!-- Less restrictive copyto! signature for triangular
matrices -->

Non-merged PRs with backport label:
- [ ] #54779 <!-- make recommendation clearer on manifest version
mismatch -->
- [ ] #54739 <!-- finish implementation of upgradable stdlibs -->
- [ ] #54738 <!-- serialization: fix relocatability bug -->
- [ ] #54574 <!-- Make ScopedValues public -->
- [ ] #54457 <!-- Make `String(::Memory)` copy -->
- [ ] #53957 <!-- tweak how filtering is done for what packages should
be precompiled -->
- [ ] #53452 <!-- RFC: allow Tuple{Union{}}, returning Union{} -->
- [ ] #53286 <!-- Raise an error when using `include_dependency` with
non-existent file or directory -->
- [ ] #51479 <!-- prevent code loading from lookin in the versioned
environment when building Julia -->
@KristofferC KristofferC removed the backport 1.11 Change should be backported to release-1.11 label Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
REPL Julia's REPL (Read Eval Print Loop)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants