Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
koppor merged 15 commits into from
Jan 26, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
0333eda
hide refresh button when citation-related search succeeds
LangInteger Dec 30, 2025
22d8315
search for both cite and cited
LangInteger Dec 30, 2025
f43db11
update changelog
LangInteger Dec 30, 2025
4cfbe14
fix
LangInteger Dec 30, 2025
8e75281
search for both cite and cited when switching fetcher
LangInteger Dec 30, 2025
88417bf
fix changelog
LangInteger Dec 30, 2025
0218475
remove update 2
LangInteger Dec 30, 2025
c635c12
add bypassCache
LangInteger Jan 2, 2026
d532ff1
fix test
LangInteger Jan 2, 2026
5c22d5c
fix changelog
LangInteger Jan 20, 2026
3e7908c
revert
LangInteger Jan 20, 2026
38c94ab
fix
LangInteger Jan 20, 2026
de4f7c2
merge
LangInteger Jan 26, 2026
04609ef
update changelog
LangInteger Jan 26, 2026
6d74464
add comment
LangInteger Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
- We fixed an issue where journal abbreviations chose the wrong abbreviation when fuzzy matching. [#14850](https://github.com/JabRef/jabref/pull/14850)
- We fixed an issue where JaRef would not correctly remember the opened side panels in the preferences [#14818](https://github.com/JabRef/jabref/issues/14818)
- Updates of the pre-selected fetchers are now followed at the Web fetchers. [#14768](https://github.com/JabRef/jabref/pull/14768)
- Restart search button in citation-relation panel now refreshes using external services. [#14757](https://github.com/JabRef/jabref/issues/14757)

### Removed

Expand Down
33 changes: 19 additions & 14 deletions ...ui/src/main/java/org/jabref/gui/entryeditor/citationrelationtab/CitationRelationsTab.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -448,8 +448,9 @@ private SplitPane getPaneAndStartSearch(BibEntry entry) {
importCitedByButton,
citedByProgress);

refreshCitingButton.setOnMouseClicked(_ -> searchForRelations(citingComponents, citedByComponents));
refreshCitedByButton.setOnMouseClicked(_ -> searchForRelations(citedByComponents, citingComponents));
// click refresh button will trigger refresh from the remote
refreshCitingButton.setOnMouseClicked(_ -> searchForRelations(citingComponents, citedByComponents, true));
refreshCitedByButton.setOnMouseClicked(_ -> searchForRelations(citedByComponents, citingComponents, true));

fetcherCombo.getSelectionModel().selectedItemProperty().addListener((_, _, newValue) -> {
if (citingComponents.entry().getDOI().isEmpty()) {
Expand All @@ -464,16 +465,18 @@ private SplitPane getPaneAndStartSearch(BibEntry entry) {
citingTask.cancel();
}
entryEditorPreferences.setCitationFetcherType(newValue);
searchForRelations(citingComponents, citedByComponents);
// switch the fetcher will not trigger refresh from the remote
searchForRelations(citingComponents, citedByComponents, false);
});

// Create SplitPane to hold all nodes above
SplitPane container = new SplitPane(citingVBox, citedByVBox);
styleFetchedListView(citedByListView);
styleFetchedListView(citingListView);

searchForRelations(citingComponents, citedByComponents);
searchForRelations(citedByComponents, citingComponents);
// switch to the tab will not trigger refresh from the remote
searchForRelations(citingComponents, citedByComponents, false);
searchForRelations(citedByComponents, citingComponents, false);

return container;
}
Expand Down Expand Up @@ -660,12 +663,13 @@ protected void bindToEntry(BibEntry entry) {
}

private void searchForRelations(CitationComponents citationComponents,
CitationComponents otherCitationComponents) {
CitationComponents otherCitationComponents,
boolean bypassCache) {
if (citationComponents.entry().getDOI().isEmpty()) {
setUpEmptyPanel(citationComponents, otherCitationComponents);
return;
}
executeSearch(citationComponents);
executeSearch(citationComponents, bypassCache);
}

private void setUpEmptyPanel(CitationComponents citationComponents,
Expand All @@ -689,8 +693,9 @@ private void setUpEmptyPanel(CitationComponents citationComponents,
.onSuccess(identifier -> {
if (identifier.isPresent()) {
citationComponents.entry().setField(StandardField.DOI, identifier.get().asString());
executeSearch(citationComponents);
executeSearch(otherCitationComponents);
// if the DOI is successfully looked up (requested by the user), trigger refresh from the remote
executeSearch(citationComponents, true);
executeSearch(otherCitationComponents, true);
} else {
dialogService.notify(Localization.lang("No DOI found."));
setUpEmptyPanel(citationComponents, otherCitationComponents);
Expand Down Expand Up @@ -719,7 +724,7 @@ private static void setLabelOn(CheckListView<CitationRelationItem> listView, Str
listView.setPlaceholder(lookingUpDoiLabel);
}

private void executeSearch(CitationComponents citationComponents) {
private void executeSearch(CitationComponents citationComponents, boolean bypassCache) {
ObservableList<CitationRelationItem> observableList = FXCollections.observableArrayList();
citationComponents.listView().setItems(observableList);

Expand All @@ -730,7 +735,7 @@ private void executeSearch(CitationComponents citationComponents) {
citedByTask.cancel();
}

this.createBackgroundTask(citationComponents.entry(), citationComponents.searchType())
this.createBackgroundTask(citationComponents.entry(), citationComponents.searchType(), bypassCache)
.consumeOnRunning(task -> prepareToSearchForRelations(citationComponents, task))
.onSuccess(fetchedList -> onSearchForRelationsSucceed(citationComponents,
fetchedList,
Expand All @@ -756,18 +761,18 @@ private void executeSearch(CitationComponents citationComponents) {

/// TODO: Make the method return a callable and let the calling method create the background task.
private BackgroundTask<List<BibEntry>> createBackgroundTask(
BibEntry entry, CitationFetcher.SearchType searchType
BibEntry entry, CitationFetcher.SearchType searchType, boolean bypassCache
) {
return switch (searchType) {
case CitationFetcher.SearchType.CITES -> {
citingTask = BackgroundTask.wrap(
() -> this.searchCitationsRelationsService.searchCites(entry)
() -> this.searchCitationsRelationsService.searchCites(entry, bypassCache)
);
yield citingTask;
}
case CitationFetcher.SearchType.CITED_BY -> {
citedByTask = BackgroundTask.wrap(
() -> this.searchCitationsRelationsService.searchCitedBy(entry)
() -> this.searchCitationsRelationsService.searchCitedBy(entry, bypassCache)
);
yield citedByTask;
}
Expand Down
14 changes: 8 additions & 6 deletions jablib/src/main/java/org/jabref/logic/citation/SearchCitationsRelationsService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,11 @@ public SearchCitationsRelationsService(ImporterPreferences importerPreferences,
this.relationsRepository = repository;
}

public List<BibEntry> searchCites(BibEntry referencing) throws FetcherException {
public List<BibEntry> searchCites(BibEntry referencing, boolean bypassCache) throws FetcherException {
boolean isFetchingAllowed =
!relationsRepository.containsReferences(referencing) ||
relationsRepository.isReferencesUpdatable(referencing);
bypassCache
|| !relationsRepository.containsReferences(referencing)
|| relationsRepository.isReferencesUpdatable(referencing);
if (isFetchingAllowed) {
List<BibEntry> referencedBy = citationFetcher.getReferences(referencing);
relationsRepository.insertReferences(referencing, referencedBy);
Expand All @@ -89,10 +90,11 @@ public List<BibEntry> searchCites(BibEntry referencing) throws FetcherException
/// If the store was empty and nothing was fetch in any case (empty fetch, or error) then yes => empty list
/// If the store was not empty and nothing was fetched after a successful fetch => the store will be erased and the returned collection will be empty
/// If the store was not empty and an error occurs while fetching => will return the content of the store
public List<BibEntry> searchCitedBy(BibEntry cited) throws FetcherException {
public List<BibEntry> searchCitedBy(BibEntry cited, boolean bypassCache) throws FetcherException {
boolean isFetchingAllowed =
!relationsRepository.containsCitations(cited) ||
relationsRepository.isCitationsUpdatable(cited);
bypassCache
|| !relationsRepository.containsCitations(cited)
|| relationsRepository.isCitationsUpdatable(cited);
if (isFetchingAllowed) {
List<BibEntry> citedBy = citationFetcher.getCitations(cited);
relationsRepository.insertCitations(cited, citedBy);
Expand Down
16 changes: 8 additions & 8 deletions jablib/src/test/java/org/jabref/logic/citation/SearchCitationsRelationsServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ void serviceShouldSearchForCitations() throws FetcherException {
SearchCitationsRelationsService searchService = new SearchCitationsRelationsService(null, repository);

// WHEN
List<BibEntry> citations = searchService.searchCitedBy(cited);
List<BibEntry> citations = searchService.searchCitedBy(cited, false);

// THEN
assertEquals(citationsToReturn, citations);
Expand All @@ -92,7 +92,7 @@ void serviceShouldCallTheFetcherForCitationsWhenRepositoryIsUpdatable() throws F
SearchCitationsRelationsService searchService = new SearchCitationsRelationsService(fetcher, repository);

// WHEN
List<BibEntry> citations = searchService.searchCitedBy(cited);
List<BibEntry> citations = searchService.searchCitedBy(cited, false);

// THEN
assertTrue(citationsDatabase.containsKey(cited));
Expand All @@ -111,7 +111,7 @@ void serviceShouldFetchCitationsIfRepositoryIsEmpty() throws FetcherException {
SearchCitationsRelationsService searchService = new SearchCitationsRelationsService(fetcher, repository);

// WHEN
List<BibEntry> citations = searchService.searchCitedBy(cited);
List<BibEntry> citations = searchService.searchCitedBy(cited, false);

// THEN
assertTrue(citationsDatabase.containsKey(cited));
Expand All @@ -128,7 +128,7 @@ void insertingAnEmptyCitationsShouldBePossible() throws FetcherException {
SearchCitationsRelationsService searchService = new SearchCitationsRelationsService(fetcher, repository);

// WHEN
List<BibEntry> citations = searchService.searchCitedBy(cited);
List<BibEntry> citations = searchService.searchCitedBy(cited, false);

// THEN
assertTrue(citations.isEmpty());
Expand All @@ -150,7 +150,7 @@ void serviceShouldSearchForReferences() throws FetcherException {
SearchCitationsRelationsService searchService = new SearchCitationsRelationsService(null, repository);

// WHEN
List<BibEntry> references = searchService.searchCites(referencer);
List<BibEntry> references = searchService.searchCites(referencer, false);

// THEN
assertEquals(referencesToReturn, references);
Expand All @@ -176,7 +176,7 @@ void serviceShouldCallTheFetcherForReferencesWhenRepositoryIsUpdatable() throws
SearchCitationsRelationsService searchService = new SearchCitationsRelationsService(fetcher, repository);

// WHEN
List<BibEntry> references = searchService.searchCites(referencer);
List<BibEntry> references = searchService.searchCites(referencer, false);

// THEN
assertTrue(referencesDatabase.containsKey(referencer));
Expand All @@ -197,7 +197,7 @@ void serviceShouldFetchReferencesIfRepositoryIsEmpty() throws FetcherException {
SearchCitationsRelationsService searchService = new SearchCitationsRelationsService(fetcher, repository);

// WHEN
List<BibEntry> references = searchService.searchCites(reference);
List<BibEntry> references = searchService.searchCites(reference, false);

// THEN
assertTrue(referencesDatabase.containsKey(reference));
Expand All @@ -216,7 +216,7 @@ void insertingAnEmptyReferencesShouldBePossible() throws FetcherException {
SearchCitationsRelationsService searchService = new SearchCitationsRelationsService(fetcher, repository);

// WHEN
List<BibEntry> citations = searchService.searchCites(referencer);
List<BibEntry> citations = searchService.searchCites(referencer, false);

// THEN
assertTrue(citations.isEmpty());
Expand Down