Restart search button in citation-relation panel should bypass the cache #14764

LangInteger · 2025-12-30T10:52:24Z

User description

Closes #14757

I have made one change:
~~- 1. Only show the "Restart search" button when the fetch failed~~

1. Let the “Restart search” button to bypass the cache

Steps to test

1. start -> New empty library
1. add example entry
1. only the only newly added entry
1. check DOI exists in the General panel
1. switch to Citations panel
- both the "cite" and "cited by" have a restart search button
- click the button, the search will start with bypassing local cache

Please refer to the video below:

test2.mov

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
I manually tested my changes in running JabRef (always required)
[/] I added JUnit tests for changes (if applicable)
I added screenshots in the PR description (if change is visible to the user)
I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
[/] I checked the user 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 updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

PR Type

Bug fix

Description

Only show restart search button when citation fetch fails
Trigger searches for both cite and cited sides when switching fetchers
Hide refresh button on successful search completion

Diagram Walkthrough

flowchart LR
  A["Fetcher Changed"] --> B["Search Both Sides"]
  B --> C["Cite Search"]
  B --> D["Cited By Search"]
  C --> E{Success?}
  D --> E
  E -->|Yes| F["Hide Refresh Button"]
  E -->|No| G["Show Refresh Button"]
  F --> H["Show Import Button"]
  G --> H

File Walkthrough

Relevant files

Bug fix

CitationRelationsTab.java `Fix dual-side search and refresh button visibility` jabgui/src/main/java/org/jabref/gui/entryeditor/citationrelationtab/CitationRelationsTab.java Added second `searchForRelations` call to trigger searches for both cite and cited sides when fetcher changes Modified `onSearchForRelationsSucceed` to hide refresh button on successful search completion Removed refresh button from being shown after successful search results	+3/-2

Documentation

CHANGELOG.md `Document citation-relation panel fixes` CHANGELOG.md Added bullet point formatting to existing fix entry Added new changelog entry documenting the citation-relation panel fix for issue "Restart search" should restart search #14757	+2/-1

qodo-free-for-open-source-projects · 2025-12-30T11:17:19Z

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance

🟢

No security concerns identified

No security vulnerabilities detected by AI analysis. Human verification advised for critical code.

Ticket Compliance

🟡

🎫 #13109

🔴	Add pseudonymization functionality to the CLI
	Make org.jabref.logic.pseudonymization.Pseudonymization available on the command line interface
	Implement similar CLI experience as the consistency check
	Follow the implementation pattern of org.jabref.cli.CheckConsistency class

Codebase Duplication Compliance

⚪

Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance

🟢

Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

qodo-free-for-open-source-projects · 2025-12-30T11:18:10Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Cancel both background search tasks Cancel the `citedByTask` in addition to the `citingTask` when the citation fetcher changes. This prevents potential race conditions and unnecessary background processing. jabgui/src/main/java/org/jabref/gui/entryeditor/citationrelationtab/CitationRelationsTab.java [467-473] // Cancel any running searches so they don't continue with the old fetcher if (citingTask != null && !citingTask.isCancelled()) { citingTask.cancel(); +} +if (citedByTask != null && !citedByTask.isCancelled()) { + citedByTask.cancel(); } entryEditorPreferences.setCitationFetcherType(newValue); searchForRelations(citingComponents, citedByComponents); searchForRelations(citedByComponents, citingComponents); `[To ensure code accuracy, apply this suggestion manually]` Suggestion importance[1-10]: 8 __ Why: The suggestion correctly identifies that when the fetcher is changed, the `citedByTask` is not cancelled, unlike the `citingTask`. This could lead to unnecessary resource usage and potential race conditions, as both tasks are re-triggered by the PR's changes.	Medium
Update

calixtus · 2025-12-30T19:25:39Z

I think this PR does not closes the issue. The issue description states:

This PR disables the restart button after the citations have been fetched.

LangInteger · 2025-12-30T22:05:16Z

@calixtus

The issue states that after citations are successfully fetched, there is no real possibility to “Restart” the search, and the button becomes misleading.

Since a restart is not supported in that state, this PR hides/disables the button once the fetch succeeds and only shows it when an error occurs during the fetch process.

I’m happy to consider alternative approaches if you have a different suggestion in mind.

calixtus · 2025-12-31T07:34:31Z

I see. What if the user selects the other provider to search for citations?

LangInteger · 2025-12-31T07:40:55Z

Screen.Recording.2025-12-31.at.01.37.26.mov

The left citation side will be refreshed, and the restart button may appear again if that refresh fails.
Check the above video for this scenario.

calixtus · 2025-12-31T07:58:29Z

@koppor is this the behavior you desire? I think it's ok, since the result of a search for citations probably won't change that quickly

calixtus · 2025-12-31T09:06:28Z

Btw the title of the issue was " 'Restart search" should restart search"

github-actions · 2026-01-01T03:40:02Z

Your pull request conflicts with the target branch.

Please merge with your code. For a step-by-step guide to resolve merge conflicts, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.

LangInteger · 2026-01-02T00:35:55Z

jabgui/src/main/java/org/jabref/gui/entryeditor/citationrelationtab/CitationRelationsTab.java

+        searchForRelations(citingComponents, citedByComponents, false);
+        searchForRelations(citedByComponents, citingComponents, false);


switch to the tab will not trigger refresh from the remote

LangInteger · 2026-01-02T00:36:20Z

jabgui/src/main/java/org/jabref/gui/entryeditor/citationrelationtab/CitationRelationsTab.java

            }
            entryEditorPreferences.setCitationFetcherType(newValue);
-            searchForRelations(citingComponents, citedByComponents);
+            searchForRelations(citingComponents, citedByComponents, true);


switch the fetcher will not trigger refresh from the remote

the last parameter has been updated to false

LangInteger · 2026-01-02T00:36:41Z

jabgui/src/main/java/org/jabref/gui/entryeditor/citationrelationtab/CitationRelationsTab.java

+        refreshCitingButton.setOnMouseClicked(_ -> searchForRelations(citingComponents, citedByComponents, true));
+        refreshCitedByButton.setOnMouseClicked(_ -> searchForRelations(citedByComponents, citingComponents, true));


click refresh button will trigger refresh from the remote

LangInteger · 2026-01-02T00:38:27Z

jabgui/src/main/java/org/jabref/gui/entryeditor/citationrelationtab/CitationRelationsTab.java

+                                  executeSearch(citationComponents, true);
+                                  executeSearch(otherCitationComponents, true);


if the DOI is successfully looked up (requested by the user), trigger refresh from the remote

subhramit · 2026-01-07T08:27:50Z

Hey @LangInteger !
is this PR ready for review?

LangInteger · 2026-01-07T09:04:42Z

@subhramit Hi, yes this PR is ready for review. As mentioned in the introduction, it does two things:

1. Only show the "Restart search" button when the fetch failed
1. Let the “Restart search” button to bypass the cache

However, I do want to confirm with @koppor , do you want both changes, or the second one is enough?

koppor · 2026-01-20T19:16:26Z

Only this, because the user might want to see if there are new cites.

LangInteger · 2026-01-20T22:32:24Z

@koppor Ok. I have removed changes for 1.
The change is not unit-test friendly. So I did not add any test cases. Is that ok?

github-actions bot added good second issue Issues that involve a tour of two or three interweaved components in JabRef status: changes-required Pull requests that are not yet complete labels Dec 30, 2025

LangInteger marked this pull request as ready for review December 30, 2025 11:16

qodo-free-for-open-source-projects bot added the Review effort 2/5 label Dec 30, 2025

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Dec 30, 2025

calixtus added component: entry-editor component: citation-relations labels Dec 31, 2025

github-actions bot added the status: changes-required Pull requests that are not yet complete label Jan 1, 2026

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Jan 1, 2026

LangInteger commented Jan 2, 2026

View reviewed changes

LangInteger changed the title ~~Only show restart search button in citation-relation panel when the fetch failed~~ Only show restart search button in citation-relation panel when the fetch failed and make it to bypass the cache Jan 2, 2026

github-actions bot added the status: changes-required Pull requests that are not yet complete label Jan 4, 2026

LangInteger mentioned this pull request Jan 14, 2026

Update DOI in general tab should trigger a refresh after switching to citations tab #14769

Open

LangInteger changed the title ~~Only show restart search button in citation-relation panel when the fetch failed and make it to bypass the cache~~ Restart search button in citation-relation panel should bypass the cache Jan 20, 2026

hide refresh button when citation-related search succeeds

0333eda

LangInteger added 8 commits January 20, 2026 15:54

search for both cite and cited

22d8315

update changelog

f43db11

fix

4cfbe14

search for both cite and cited when switching fetcher

8e75281

fix changelog

88417bf

remove update 2

0218475

add bypassCache

c635c12

fix test

d532ff1

LangInteger force-pushed the fix-issue-14757 branch from 5881cfb to d532ff1 Compare January 20, 2026 21:54

LangInteger added 2 commits January 20, 2026 15:58

fix changelog

5c22d5c

revert

3e7908c

github-actions bot removed the status: changes-required Pull requests that are not yet complete label Jan 20, 2026

fix

38c94ab

		searchForRelations(citingComponents, citedByComponents, false);
		searchForRelations(citedByComponents, citingComponents, false);

		refreshCitingButton.setOnMouseClicked(_ -> searchForRelations(citingComponents, citedByComponents, true));
		refreshCitedByButton.setOnMouseClicked(_ -> searchForRelations(citedByComponents, citingComponents, true));

		executeSearch(citationComponents, true);
		executeSearch(otherCitationComponents, true);

Uh oh!

Restart search button in citation-relation panel should bypass the cache #14764

Are you sure you want to change the base?

Restart search button in citation-relation panel should bypass the cache #14764

Conversation

LangInteger commented Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User description

Steps to test

Mandatory checks

PR Type

Description

Diagram Walkthrough

File Walkthrough

Uh oh!

qodo-free-for-open-source-projects bot commented Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Compliance Guide 🔍

Uh oh!

qodo-free-for-open-source-projects bot commented Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Code Suggestions ✨

Uh oh!

calixtus commented Dec 30, 2025

Uh oh!

LangInteger commented Dec 30, 2025

Uh oh!

calixtus commented Dec 31, 2025

Uh oh!

LangInteger commented Dec 31, 2025

Uh oh!

calixtus commented Dec 31, 2025

Uh oh!

calixtus commented Dec 31, 2025

Uh oh!

github-actions bot commented Jan 1, 2026

Uh oh!

LangInteger Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

LangInteger Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LangInteger Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

LangInteger Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

LangInteger Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

subhramit commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LangInteger commented Jan 7, 2026

Uh oh!

koppor commented Jan 20, 2026

Uh oh!

LangInteger commented Jan 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

LangInteger commented Dec 30, 2025 •

edited

Loading

qodo-free-for-open-source-projects bot commented Dec 30, 2025 •

edited

Loading

qodo-free-for-open-source-projects bot commented Dec 30, 2025 •

edited

Loading

LangInteger Jan 2, 2026 •

edited

Loading

subhramit commented Jan 7, 2026 •

edited

Loading