Add simple git support #12817

SihasA · 2025-03-24T21:33:58Z

Closes #12350
We have implemented code here in 3 working packages (denoted 'WP' here).
WP1 - check if a .bib file (used in bibliography management) is inside a Git
repository. If it is, it tags the file as “versioned” and performs a git pull to fetch the latest
updates from the repository.

WP2 - Display the status of synchronisation with the file name.

WP3 - Allow the user to enable an auto push on save functionality via the general preferences as well as enable manual git support for simple git pull/push functionality. With appropriate dialogs for each instance.

The changes we have made on a class by class basis:
GitHandler

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.

…and to pull latest changes if so

Update GitHandler constructor to optionally not create a repository if none exists

…erence exists

…gui.importer.actions

…d-pull' into library-under-version-control-and-pull # Conflicts: # src/test/java/org/jabref/gui/importer/actions/CheckForVersionControlActionTest.java

removed the logic that required the download of additional libraries/dependencies

…into Happy-Days-Git-Integration-WP3

…ion-control-and-pull

…eneral for autopush - to be cleaned up

…d-pull' into library-under-version-control-and-pull # Conflicts: # src/main/java/org/jabref/logic/preferences/CliPreferences.java

…-Git-Integration-WP3

koppor · 2025-03-26T11:00:09Z

where jabref could not parse the file with conflict markers.

You can go to the previous commits. We discussed that shortly in the meeting, but did not have time to dig deeper.

koppor · 2025-03-26T11:04:05Z

In my view, we first have to get #12678 in, then #12773, and then this one?

Yes you are right-

OK, then let's focus on the PRs in that order.

After a PR is squash-merged, you can follow the howto on flupp.de on how to merge main in this PR.

I ask you to work on #12678 to get the unit tests fixed. Our maintainers do all of this in their spare time - and like more to work on pull requests with green tests.

…/jabref into Add-Simple-Git-Support

trag-bot · 2025-03-26T11:21:54Z

src/test/java/org/jabref/gui/importer/actions/CheckForVersionControlActionEndToEndTest.java

+
+        boolean result = action.isActionNecessary(parserResult, dialogService, cliPreferences);
+
+        assertTrue(result);


Assertion statements should not include the message parameter, and the method name should already convey the expected behavior. This violates the guideline for assertion statements.

trag-bot · 2025-03-26T11:21:55Z

src/test/java/org/jabref/gui/importer/actions/CheckForVersionControlActionEndToEndTest.java

+
+        boolean result = action.isActionNecessary(parserResult, dialogService, cliPreferences);
+
+        assertFalse(result);


Assertion statements should not include the message parameter, and the method name should already convey the expected behavior. This violates the guideline for assertion statements.

trag-bot · 2025-03-26T11:22:00Z

src/test/java/org/jabref/gui/importer/actions/CheckForVersionControlActionEndToEndTest.java

+
+        action.isActionNecessary(parserResult, dialogService, cliPreferences);
+
+        assertDoesNotThrow(() -> action.performAction(parserResult, dialogService, cliPreferences));


Assertion statements should not include the message parameter, and the method name should already convey the expected behavior. This violates the guideline for assertion statements.

- Create NotificationService interface in Logic layer - Implement DialogNotificationService adapter in GUI layer - Replace direct DialogService dependency with NotificationService in GitClientHandler - Update all call sites to use the new adapter pattern - Add missing localization keys for Git operations - Remove obsolete localization key This change resolves architectural layering violations while maintaining enhanced error handling and user feedback for Git operations. It properly separates Logic and GUI layers, following the dependency inversion principle.

…og()

…/jabref into Add-Simple-Git-Support

SihasA · 2025-03-26T14:31:52Z

I ask you to work on #12678 to get the unit tests fixed. Our maintainers do all of this in their spare time - and like more to work on pull requests with green tests.

alright! Understood- we are submitting our university project today, will follow up with fixing the unit testing

Merge remote-tracking branch 'origin/Add-Simple-Git-Support' into Add-Simple-Git-Support

trag-bot · 2025-03-26T14:47:04Z

src/main/java/org/jabref/gui/LibraryTab.java

@@ -396,7 +409,8 @@ private boolean isDatabaseReadyForBackup(BibDatabaseContext context) {
     * <p>
     * Example: *jabref-authors.bib – testbib
     */
-    public void updateTabTitle(boolean isChanged) {
+
+    public void updateTabTitle(boolean isModified) {


The method updateTabTitle has been modified but lacks JavaDoc to explain its purpose and behavior, especially after the changes related to Git integration.

trag-bot · 2025-03-26T14:47:40Z

src/main/java/org/jabref/gui/preferences/general/GeneralTab.java

@@ -53,6 +53,9 @@ public class GeneralTab extends AbstractPreferenceTabView<GeneralTabViewModel> i
    @FXML private CheckBox alwaysReformatBib;
    @FXML private CheckBox autosaveLocalLibraries;
    @FXML private Button autosaveLocalLibrariesHelp;
+    @FXML private TextField gitHubUsernameField;


The new UI elements for GitHub integration, such as gitHubUsernameField, should have their labels localized using Localization.lang(). This ensures consistency with other UI elements.

trag-bot · 2025-03-26T14:48:40Z

src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java

@@ -440,4 +451,16 @@ private Optional<Integer> getPortAsInt(String value) {
            return Optional.empty();
        }
    }
+
+    public BooleanProperty autoPushEnabledProperty() {


The method 'autoPushEnabledProperty' returns a BooleanProperty, which can potentially be null. New public methods should not return null and should use java.util.Optional instead.

trag-bot · 2025-03-26T14:48:43Z

src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java

+        return gitPreferences.getAutoPushEnabledProperty();
+    }
+
+    public StringProperty gitHubUsernameProperty() {


The method 'gitHubUsernameProperty' returns a StringProperty, which can potentially be null. New public methods should not return null and should use java.util.Optional instead.

trag-bot · 2025-03-26T14:48:49Z

src/main/java/org/jabref/gui/preferences/general/GeneralTabViewModel.java

+        return gitPreferences.gitHubUsernameProperty();
+    }
+
+    public StringProperty gitHubPasskeyProperty() {


The method 'gitHubPasskeyProperty' returns a StringProperty, which can potentially be null. New public methods should not return null and should use java.util.Optional instead.

…-Simple-Git-Support

trag-bot · 2025-03-26T15:00:03Z

src/main/java/org/jabref/logic/git/GitClientHandler.java

+            try {
+                pushCommitsToRemoteRepository();
+            } catch (IOException e) {
+                LOGGER.error("Failed to push");


The exception is not logged using exception logging capabilities, which would provide more context about the error. It should include the exception object.

trag-bot · 2025-03-26T15:00:13Z

src/main/java/org/jabref/logic/git/GitClientHandler.java

+        } catch (IOException e) {
+            LOGGER.error("Failed to get latest commit");
+        }
+        return null;


Returning null from a method is discouraged. Instead, java.util.Optional should be used to avoid potential NullPointerExceptions.

trag-bot · 2025-03-26T15:00:48Z

src/main/java/org/jabref/logic/git/GitHandler.java

+     * @param repositoryPath The root of the initialized git repository
+     * @param createRepo     If true, initializes a repository if the file path does not contain a repository
+     */
+    public GitHandler(Path repositoryPath, boolean createRepo) {


The constructor has a boolean parameter 'createRepo'. Boolean parameters should be avoided in public methods. Consider creating two distinct methods for clarity.

trag-bot · 2025-03-26T15:00:53Z

src/main/java/org/jabref/logic/git/GitHandler.java

            } catch (GitAPIException e) {
-                LOGGER.info("Failed to push");
+                LOGGER.error("Failed to push: {}", e.getMessage(), e);


The logging statement should use exception logging capabilities directly without concatenating the exception message.

trag-bot · 2025-03-26T15:00:55Z

src/main/java/org/jabref/logic/git/GitHandler.java

            } catch (GitAPIException e) {
-                LOGGER.info("Failed to push");
+                LOGGER.error("Failed to pull", e);


The logging statement should use exception logging capabilities directly without concatenating the exception message.

jabref-machine · 2025-03-26T15:01:57Z

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.

RapidShotzz and others added 30 commits February 26, 2025 13:09

added methods to and boolean to see if file is under version control …

01dec74

…and to pull latest changes if so

Add CheckForVersionControlAction

eb1b9a8

Update GitHandler constructor to optionally not create a repository if none exists

Added unit tests for - CheckForVersionControlAction

c761db5

Added unit tests for - CheckForVersionControlAction

2c9dad4

added functionality for tagging as versioned and pulling only if pref…

ed6eb4a

…erence exists

moved test file and amended shouldAutoPull method to test.org.jabref.…

9cbdd76

…gui.importer.actions

Remove RuntimeException from CheckForVersionControlAction

62defc4

Remove redundant methods from GitHandler

bbc6b38

modified the test cases for CheckForVersionControlAction

69e0f9a

Merge remote-tracking branch 'origin/library-under-version-control-an…

d578bd5

…d-pull' into library-under-version-control-and-pull # Conflicts: # src/test/java/org/jabref/gui/importer/actions/CheckForVersionControlActionTest.java

modified the test cases for CheckForVersionControlAction

cf32088

modified the test cases for CheckForVersionControlAction

c670625

modified the test cases for CheckForVersionControlAction

9026eb9

modified the test cases for CheckForVersionControlAction

40cdd64

removed the logic that required the download of additional libraries/dependencies

Remove preference in CheckForVersionControlAction

8db799c

Add git preferences

af0c3c8

Add GitPreferences to CliPreferences

1f2de0a

added autoPushEnabled attributes and set methods

cfd46db

modified tab view model to handle auto push

6ecf1a8

Add getGitPreferences to JabRefCliPreferences

a0e2dc7

Merge remote-tracking branch 'origin/Happy-Days-Git-Integration-WP3' …

c8be361

…into Happy-Days-Git-Integration-WP3

Merge branch 'Happy-Days-Git-Integration-WP3' into library-under-vers…

5127bca

…ion-control-and-pull

Remove redundant shouldAutoPull from CliPreferences

2bf349d

Added a rudimentary first draft preference selector under Saving in g…

bff9857

…eneral for autopush - to be cleaned up

Merge remote-tracking branch 'origin/library-under-version-control-an…

c197264

…d-pull' into library-under-version-control-and-pull # Conflicts: # src/main/java/org/jabref/logic/preferences/CliPreferences.java

removed duplicate boolean

f7c21c4

Cleaned up UI - "Auto push" Combo Box no longer is in all Caps

980c748

Added "Git" submenu with "Git Pull" and "Git Push" options

caf405b

constructed get git preferences

4ed64cd

Merge branch 'library-under-version-control-and-pull' into Happy-Days…

45c453e

…-Git-Integration-WP3

Merge branch 'Add-Simple-Git-Support' of https://github.com/11raphael…

ddbd137

…/jabref into Add-Simple-Git-Support

trag-bot bot reviewed Mar 26, 2025

View reviewed changes

Jiewu (jack deng) Deng and others added 7 commits March 26, 2025 11:58

fix localisation consistency test

70b84ef

add checknull in gitclienthandler constructor

6968281

fixing openrewrite and checkstyle test, remove no usage showErrorDial…

998fbe9

…og()

removed combo box from auto-push preference and fixed trag-bot comments.

eddc662

add one more error message

7f5f51f

Merge branch 'Add-Simple-Git-Support' of https://github.com/11raphael…

8075d9e

…/jabref into Add-Simple-Git-Support

11raphael added 2 commits March 26, 2025 14:37

Remove rebase logic

6704b94

Remove redundant AutoPushMode logic

91c74db

Merge remote-tracking branch 'origin/Add-Simple-Git-Support' into Add-Simple-Git-Support

trag-bot bot reviewed Mar 26, 2025

View reviewed changes

arp-23 added 2 commits March 26, 2025 14:57

Add localization for GitHub integration UI elements

a56e151

Merge remote-tracking branch 'origin/Add-Simple-Git-Support' into Add…

143969d

…-Simple-Git-Support

trag-bot bot reviewed Mar 26, 2025

View reviewed changes

SihasA closed this Mar 26, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add simple git support #12817

Add simple git support #12817

SihasA commented Mar 24, 2025 •

edited

Loading

koppor commented Mar 26, 2025

koppor commented Mar 26, 2025

trag-bot bot Mar 26, 2025

trag-bot bot Mar 26, 2025

trag-bot bot Mar 26, 2025

SihasA commented Mar 26, 2025

trag-bot bot Mar 26, 2025

trag-bot bot Mar 26, 2025

trag-bot bot Mar 26, 2025

trag-bot bot Mar 26, 2025

trag-bot bot Mar 26, 2025

trag-bot bot Mar 26, 2025

trag-bot bot Mar 26, 2025

trag-bot bot Mar 26, 2025

trag-bot bot Mar 26, 2025

trag-bot bot Mar 26, 2025

jabref-machine commented Mar 26, 2025


		boolean result = action.isActionNecessary(parserResult, dialogService, cliPreferences);

		assertTrue(result);


		boolean result = action.isActionNecessary(parserResult, dialogService, cliPreferences);

		assertFalse(result);


		action.isActionNecessary(parserResult, dialogService, cliPreferences);

		assertDoesNotThrow(() -> action.performAction(parserResult, dialogService, cliPreferences));

Add simple git support #12817

Add simple git support #12817

Conversation

SihasA commented Mar 24, 2025 • edited Loading

Mandatory checks

koppor commented Mar 26, 2025

koppor commented Mar 26, 2025

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

SihasA commented Mar 26, 2025

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

trag-bot bot Mar 26, 2025

Choose a reason for hiding this comment

jabref-machine commented Mar 26, 2025

SihasA commented Mar 24, 2025 •

edited

Loading