Improve library loading UX by HoussemNasri · Pull Request #7119 · JabRef/jabref

HoussemNasri · 2020-11-23T15:57:54Z

When JabRef opens a library, it opens a file, runs the database parser, and after everything is done, creates a new tab in the frame with the contents of the open database.

An improvement would be to first create a tab in the frame, display a loading animation, and after the parser has finished, display all entries (or display every entry as soon as it is parsed).

there is a bug that I couldn't fix, even after data is loaded the group pane will keep showing 0 entry, you need to navigate away from the tab and back to get the real number of entries

about applying the improvement on startup, I think having a splash screen will look better something like a blocking dialog that displays a ProgressIndicator

Closes #6417

Change in CHANGELOG.md described (if applicable)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

…data when it's available

Siedlerchr · 2020-11-23T18:48:36Z

+    }
+
+    public void onDatabaseLoadingFailed(LibraryTab libraryTab, Exception ex) {
+        dialogService.showErrorDialogAndWait(Localization.lang("Connection error"),


It would be cook if you could pass the exception as paramter to the error dialog as well, it's just one addtional paramter

Siedlerchr · 2020-11-23T18:51:03Z

Wohoo! Thanks for your work, I just tested it with a huge library, it's really cool and looks really nice!
Codewise lgtm as well

calixtus · 2020-11-23T19:34:24Z

I'll take a look into it the next days, im just a bit busy this week, I hope you don't mind.
About the bug: Maybe there is some var that should be a property. I'll check that.
Thank you for this huge work. I guess, it wasn't just a 'good first issue' but a big improvement!

HoussemNasri · 2020-11-23T19:52:41Z

I'll take a look into it the next days, im just a bit busy this week, I hope you don't mind.

Don't worry I'm not in a hurry, take your time

tobiasdiez

Thanks also from my side. Some initial suggestions:

tobiasdiez · 2020-11-23T20:42:20Z

    }
+
+    /* The layout to display in the tab when it's loading*/
+    public Node createLoadingLayout() {


I would let the LibraryTab handle the progress indicator. This could be done for example by setting the placeholder to the progress indicator. https://docs.oracle.com/javase/8/javafx/api/javafx/scene/control/TableView.html#placeholderProperty

There was a bug when I close a loading tab before it finishes, the tab next to it TableView would shrink but it seems using placeholder fixed it, Thank you

tobiasdiez · 2020-11-23T20:44:52Z

+        BibDatabaseContext context = result.getDatabaseContext();
+        libraryTab.feedData(context);
+
+        OpenDatabaseAction.performPostOpenActions(libraryTab, result);


I would put this before the feedData call. Some of the post actions change a lot of entries, which would result in unnecessary updates of the ui.

tobiasdiez · 2020-11-23T20:47:22Z

+                context.getDatabasePath().isPresent();
+    }
+
+    private void trackOpenNewDatabase(LibraryTab libraryTab) {


I think this should be in the opendatabaseaction class (as it's not really connected to the library tab)

and by this, you mean trackOpenNewDatabase(), right?

Siedlerchr · 2020-11-27T08:56:16Z

+    }
+
+    public BackgroundTask<?> getDataLoadingTask() {
+        if (dataLoadingTask == null) {


This condition/if is uncessary as you either return null or the dataLoadingTask.

Siedlerchr

codewise lgtm so far

DominikVoigt

Great work!
I did not test the changes, but the code looks fine to me :)!

calixtus · 2020-12-03T17:28:29Z

I will fix some line breaks and merge tonight. Sorry for delay.

…ned method name

Siedlerchr · 2020-12-06T17:48:28Z

Thanks again for your contribution!

* upstream/master: Improve library loading UX (#7119) remove jython (#7157) Add missing authors Remove obsolete hint Fixed issue in PreviewView for number textfield (#7158) Fix for issue 6959 (#7151) Revert "remove jython (#7155)" (#7156) remove jython (#7155) Fix remembering password for sql db (#7154) Update to libre office 7.0.3 (#7150) Add IdBasedSearchFetcher to jstor (#7145) Squashed 'src/main/resources/csl-styles/' changes from 55200d0..a20406d Bump antlr4-runtime from 4.8-1 to 4.9 (#7136)

HoussemNasri added 3 commits November 23, 2020 16:07

refactoring LibraryTab to be able to create an empty tab and feed it …

5ec4027

…data when it's available

applying the improvement when opening database using action

e1af860

checkstyle

5f2d7ea

Siedlerchr reviewed Nov 23, 2020

View reviewed changes

Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Nov 23, 2020

add exception parameter to error dialog

a1ee474

HoussemNasri added 3 commits November 24, 2020 11:30

Adding DataLoadingTask to LibraryTab

1ca8616

Add getter for dataLoadingTask

8c0fd83

Fixing memory leak by canceling dataLoadingTask when tab is closed

f43c2ff

tobiasdiez requested changes Nov 24, 2020

View reviewed changes

HoussemNasri added 4 commits November 24, 2020 14:41

Relocate LibraryTab method trackOpenNewDatabase() to OpenDatabaseAction

ef088af

Refactor LibraryTab to handle dataLoadingTask callbacks

77061c8

Put performPostOpenActions() before feedData() for performance reasons

b7ca2d3

Fix groups pane not updating bug

2e71e7a

Siedlerchr reviewed Nov 27, 2020

View reviewed changes

Siedlerchr approved these changes Nov 27, 2020

View reviewed changes

Cleanup code

5783b30

Siedlerchr approved these changes Nov 30, 2020

View reviewed changes

DominikVoigt approved these changes Dec 3, 2020

View reviewed changes

calixtus and others added 3 commits December 5, 2020 19:41

Merge branch 'master' into improve-database-loading-ux

be3c2bf

Extracted JabRefPreferences, fixed imports

6c3149c

Extracted JabRefPreferences, fixed imports, removed dead code, shorte…

8b32c09

…ned method name

Siedlerchr approved these changes Dec 6, 2020

View reviewed changes

Siedlerchr merged commit 33b9315 into JabRef:master Dec 6, 2020

Uh oh!

Conversation

HoussemNasri commented Nov 23, 2020 • edited by calixtus Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Siedlerchr commented Nov 23, 2020

Uh oh!

calixtus commented Nov 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

HoussemNasri commented Nov 23, 2020

Uh oh!

tobiasdiez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Siedlerchr left a comment

Choose a reason for hiding this comment

Uh oh!

DominikVoigt left a comment

Choose a reason for hiding this comment

Uh oh!

calixtus commented Dec 3, 2020

Uh oh!

Siedlerchr commented Dec 6, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

HoussemNasri commented Nov 23, 2020 •

edited by calixtus

Loading

calixtus commented Nov 23, 2020 •

edited

Loading