Implementation of walkthrough infrastructure by Yubo-Cao · Pull Request #13182 · JabRef/jabref

Yubo-Cao · 2025-05-29T04:28:22Z

Closes N/A

Initial implementation of the walkthrough feature. See this Google Drive video for demonstration: https://drive.google.com/file/d/19sUz1XoSjP0UkuhUvKQE-MZjmVASy2ot/view?usp=sharing

The completion of the walkthrough is also tracked through modifying the preferences class.

This refs #12664

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (if change is visible to the user)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

Siedlerchr · 2025-05-29T14:52:03Z

So far I like the idea.
Discussion points for Friday would be:

How many steps we want
Going back one step?
content of the steps
Additional steps like adding stuff to groups or creating a new entry or library

koppor · 2025-05-30T15:10:31Z

This refs #12664 somehow :)

calixtus

First half of first iteration through review. More to come on the weekend.

…on of control to the JabRefFrame

Co-authored-by: Subhramit Basu <subhramit.bb@live.in>

subhramit

Just some small nits when reading otherwise lgtm

subhramit · 2025-07-02T18:58:42Z

+        CompletableFuture<Void> timeoutFuture = CompletableFuture.runAsync(() -> {
+            try {
+                Thread.sleep(HANDLER_TIMEOUT_MS);
+            } catch (InterruptedException e) {
+                Thread.currentThread().interrupt();
+            }
+        });


I think this entire class could make use of some more javadoc - I sense high cognitive load on if someone wants to work on this in future. Things like, why we are using a completable future, etc.
But these refinements can be done in future, we can get this in and start focusing on the next steps.

subhramit · 2025-07-02T19:07:22Z

+                     .filter(menuItem -> Optional.ofNullable(menuItem.getGraphic())
+                                                 .map(graphic -> graphic.equals(node)
+                                                         || Stream.iterate(graphic, Objects::nonNull, Node::getParent)
+                                                                  .anyMatch(cm -> cm.equals(node)))


If I am not wrong on the expansion:

Suggested change

.filter(menuItem -> Optional.ofNullable(menuItem.getGraphic())

.map(graphic -> graphic.equals(node)

|| Stream.iterate(graphic, Objects::nonNull, Node::getParent)

.anyMatch(cm -> cm.equals(node)))

.filter(menuItem -> Optional.ofNullable(menuItem.getGraphic())

.map(graphic -> graphic.equals(node)

|| Stream.iterate(graphic, Objects::nonNull, Node::getParent)

.anyMatch(contextMenu -> contextMenu.equals(node)))

calixtus · 2025-07-03T10:45:35Z

@Yubo-Cao please apply suggestions from @subhramit , then we merge.

trag-bot · 2025-07-03T13:02:06Z

@trag-bot didn't find any issues in the code! ✅✨

koppor · 2025-07-03T23:39:32Z

+        event.consume();
+        beforeNavigate.run();
+
+        CompletableFuture<Void> handlerFuture = new CompletableFuture<>();


This variable is never read? -> always handlerFtuure.complete(null) passed. What is the intention?

The intention is that we run onNavigate after the original handler has completed, or a timeout has occurred, or a new window has been created, whichever comes first. To allow for such checking, the handler's future is used more as a signal to indicate that the original handler has finished.

koppor · 2025-07-03T23:39:57Z

+    /// @param event the event to navigate
+    static <T extends Event> void navigate(
+            Runnable beforeNavigate,
+            EventHandler<? super T> originalHandler,


Annotate with @Nullable (the other ones are non-null, aren't they?)

koppor · 2025-07-03T23:40:14Z

+    ///    - The handler has timed out after HANDLER_TIMEOUT_MS milliseconds.
+    ///    - A new window has been opened, or an existing window has been closed.
+    ///
+    ///    Those conditions ensure that we will still navigate if original handler is blocking (e.g., showing a dialog,


"These" conditions

feat: add initial implementation of walkthrough

5babec2