Show a welcome screen if no database is open #12461

oops-shlok · 2025-02-04T10:27:39Z

Mandatory checks

I own the copyright of the code submitted and I licence 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 (for UI changes)
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.

Screen.Recording.2025-02-04.at.3.49.55.PM.mov

github-actions

Your code currently does not meet JabRef's code guidelines.
We use OpenRewrite to ensure "modern" Java coding practices.
The issues found can be automatically fixed.
Please execute the gradle task rewriteRun, check the results, commit, and push.

You can check the detailed error output by navigating to your pull request, selecting the tab "Checks", section "Tests" (on the left), subsection "OpenRewrite".

github-actions

JUnit tests are failing. In the area "Some checks were not successful", locate "Tests / Unit tests (pull_request)" and click on "Details". This brings you to the test output.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

calixtus

Just a quick review from my cellphone. A more deeper look will follow.

src/main/java/org/jabref/gui/Base.css

src/main/java/org/jabref/gui/frame/JabRefFrame.java

src/main/java/org/jabref/gui/util/WelcomePage.java

oops-shlok · 2025-02-04T21:42:42Z

Hi @calixtus! Saw all the comments with respect to the PR. Will resolve them asap. Thanks for the review!

…issue-JabRef#12272

github-actions

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

In case of issues with the import order, double check that you activated Auto Import.
You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

subhramit

Hey @oops-shlok, thanks for your contribution!
Please revert the submodule changes (steps linked below).

Also, please don't resolve conversations from your end until the reviewer who asked for the change is satisfied and does that - otherwise each comment has to be manually expanded when trying to gather context on the changes asked (when re-reviewing) or to read your replies and carry the discussion forward.
For very trivial comments (for example, these ones below), you can mark resolved once done.

subhramit · 2025-02-05T21:21:47Z

buildres/abbrv.jabref.org

Undo the changes to submodules. Follow the alternative method in https://devdocs.jabref.org/code-howtos/faq.html#submodules

Noted. Will do this from now. Reverted the changes to submodules.

subhramit · 2025-02-05T21:22:11Z

src/main/resources/csl-styles

Same as above

Reverted the changes to submodules

koppor · 2025-02-06T12:41:34Z

src/main/java/org/jabref/gui/exporter/ExportCommand.java

+                                })),
+                                Duration.seconds(5));
+                    } else {
+                        LOGGER.warn("Library Tab is null as Welcome Tab is open");


This is not a warning.

Please store tabSupplier.get() in a variable. You can use the refacroing functionality of IntelliJ for that ("extract variable)

Just add a comment above the if to say that the tab is null in case of the welcome page.

koppor · 2025-02-06T12:45:05Z

src/main/java/org/jabref/gui/exporter/SaveDatabaseAction.java

+        if (libraryTab == null) {
+            return false;
+        }


This reads like a code smell...

The action has to be disabled if no tab is opened. -- work on the bindings.

executable.bind(needsDatabase(stateManager)); is the code search hint.

See other fixes for other cases: #12199

Maybe there is somewhere an instanceOf check missing where SaveDatabaseAction#save is called?

calixtus · 2025-02-06T19:32:55Z

src/main/java/org/jabref/gui/importer/actions/OpenDatabaseAction.java

        if (tabContainer.getLibraryTabs().isEmpty()) {
            return preferences.getFilePreferences().getWorkingDirectory();
-        } else {
-            Optional<Path> databasePath = tabContainer.getCurrentLibraryTab().getBibDatabaseContext().getDatabasePath();
-            return databasePath.map(Path::getParent).orElse(preferences.getFilePreferences().getWorkingDirectory());
        }
+
+        LibraryTab currentTab = tabContainer.getCurrentLibraryTab();
+        if (currentTab == null) {
+            return preferences.getFilePreferences().getWorkingDirectory();
+        }
+
+        Optional<Path> databasePath = currentTab.getBibDatabaseContext().getDatabasePath();
+        return databasePath.map(Path::getParent).orElse(preferences.getFilePreferences().getWorkingDirectory());


getLibraryTabs is not empty, but getCurrentLibraryTab could be null?

calixtus · 2025-02-06T19:33:18Z

src/main/java/org/jabref/gui/frame/JabRefFrame.java

+            fileHistory.setDisable(!hasRecentFiles);
+        });
+
+        this.welcomePage = new WelcomePage(


Why do you initialize this here? Just put all the WelcomePage stuff into the tab. You do not reuse the WelcomePage in JabRefFrame.

calixtus · 2025-02-06T19:36:50Z

src/main/java/org/jabref/gui/util/WelcomePage.java

+    private final TaskExecutor taskExecutor;
+    private final FileHistoryMenu fileHistoryMenu;
+
+    public WelcomePage(JabRefFrame frame,


Always use the smalles possible scope to avoid unneccessary dependencies.

Suggested change

public WelcomePage(JabRefFrame frame,

public WelcomePage(LibraryTabContainer tabContainer,

calixtus · 2025-02-06T19:38:16Z

src/main/java/org/jabref/gui/util/WelcomePage.java

+import org.jabref.model.entry.BibEntryTypesManager;
+import org.jabref.model.util.FileUpdateMonitor;
+
+public class WelcomePage {


Integrate into WelcomeTab

calixtus · 2025-02-06T19:40:45Z

src/main/java/org/jabref/gui/exporter/SaveDatabaseAction.java

+        if (libraryTab == null) {
+            return false;
+        }


Maybe there is somewhere an instanceOf check missing where SaveDatabaseAction#save is called?

Fix JabRef#12272 - Show a welcome screen if no database is open

08ec5d8

github-actions bot reviewed Feb 4, 2025

View reviewed changes

Fix JabRef#12272 - Fix missing localisation keys for WelcomePage

684f7df

github-actions bot reviewed Feb 4, 2025

View reviewed changes

Fix JabRef#12272 - Fix missing localisation keys for WelcomePage

3759e24

calixtus requested changes Feb 4, 2025

View reviewed changes

subhramit changed the title ~~Fix #12272 - Show a welcome screen if no database is open~~ Show a welcome screen if no database is open Feb 5, 2025

oops-shlok added 3 commits February 6, 2025 01:26

Merge branch 'main' of https://github.com/JabRef/jabref into fix-for-…

9fc595d

…issue-JabRef#12272

Fix JabRef#12272 - Addressed 1st Review Changes

4e576e9

Fix JabRef#12272 - Checkstyle issue fix in ExportCommand file

52409bd

github-actions bot reviewed Feb 5, 2025

View reviewed changes

oops-shlok requested a review from calixtus February 5, 2025 20:21

subhramit requested changes Feb 5, 2025

View reviewed changes

oops-shlok added 2 commits February 6, 2025 03:33

Reverted csl-styles submodule changes

f130244

Reverted abbrv.jabref.org submodule changes

2559f22

oops-shlok requested a review from subhramit February 5, 2025 22:09

koppor requested changes Feb 6, 2025

View reviewed changes

calixtus requested changes Feb 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show a welcome screen if no database is open #12461

Show a welcome screen if no database is open #12461

oops-shlok commented Feb 4, 2025 •

edited by subhramit

Loading

github-actions bot left a comment

github-actions bot left a comment

calixtus left a comment

oops-shlok commented Feb 4, 2025

github-actions bot left a comment

subhramit left a comment

subhramit Feb 5, 2025

oops-shlok Feb 5, 2025

subhramit Feb 5, 2025

oops-shlok Feb 5, 2025

koppor Feb 6, 2025

koppor Feb 6, 2025

calixtus Feb 6, 2025

calixtus Feb 6, 2025

calixtus Feb 6, 2025

calixtus Feb 6, 2025

calixtus Feb 6, 2025

calixtus Feb 6, 2025

	public WelcomePage(JabRefFrame frame,
	public WelcomePage(LibraryTabContainer tabContainer,

Show a welcome screen if no database is open #12461

Are you sure you want to change the base?

Show a welcome screen if no database is open #12461

Conversation

oops-shlok commented Feb 4, 2025 • edited by subhramit Loading

Mandatory checks

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

calixtus left a comment

Choose a reason for hiding this comment

oops-shlok commented Feb 4, 2025

github-actions bot left a comment

Choose a reason for hiding this comment

subhramit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oops-shlok commented Feb 4, 2025 •

edited by subhramit

Loading