Fix inconsistent search results for date-related queries fixes#12296 (#12724)

* fixed date bug

* Fix inconsistent search results when querying different date fields (date, Date, year)

* Rename functions

* Updated  CHANGELOG.md

* Fix date-related query issues fixes #12296

* Fixes 12296

* Fix for issue 12296

* Added java comments

* Fixed submodules

* Updated dateFields

* Removed unnecessary comment.

* Update src/main/java/org/jabref/logic/search/indexing/BibFieldsIndexer.java

Co-authored-by: Christoph <[email protected]>

* fixed compilation error

* fix npe when switching tabs and entry is null

---------

Co-authored-by: Abdelrahman Mostafa <[email protected]>
Co-authored-by: Christoph <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -101,6 +101,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 - We fixed an issue where JabRef displayed an incorrect deletion notification when canceling entry deletion. [#12645](https://github.com/JabRef/jabref/issues/12645)
 - We fixed an issue where JabRref wrote wrong field names into the PDF. [#12833](https://github.com/JabRef/jabref/pulls/12833)
 - We fixed an issue where an exception would occur when running abbreviate journals for multiple entries. [#12634](https://github.com/JabRef/jabref/issues/12634)
+- We fixed an issue Where JabRef displayed an inconsistent search results for date-related queries[#12296](https://github.com/JabRef/jabref/issues/12296)
 - We fixed an issue where JabRef displayed dropdown triangle in wrong place in "Search for unlinked local files" dialog [#12713](https://github.com/JabRef/jabref/issues/12713)
 - We fixed an issue where JabRef would not open if an invalid external journal abbreviation path was encountered. [#12776](https://github.com/JabRef/jabref/issues/12776)
 - We fixed a bug where LaTeX commands were not removed from filenames generated using the `[bibtexkey] - [fulltitle]` pattern. [#12188](https://github.com/JabRef/jabref/issues/12188)

src/main/java/org/jabref/gui/entryeditor/fileannotationtab/FulltextSearchResultsTab.java

@@ -94,7 +94,7 @@ private void updateSearch() {
         content.getChildren().clear();
         stateManager.activeSearchQuery(SearchType.NORMAL_SEARCH).get().ifPresent(searchQuery -> {
             SearchResults searchResults = searchQuery.getSearchResults();
-            if (searchResults != null) {
+            if (searchResults != null && entry != null) {
                 Map<String, List<SearchResult>> searchResultsForEntry = searchResults.getFileSearchResultsForEntry(entry);
                 if (searchResultsForEntry.isEmpty()) {
                     content.getChildren().add(new Text(Localization.lang("No search matches.")));

src/main/java/org/jabref/logic/search/indexing/BibFieldsIndexer.java

@@ -7,6 +7,7 @@
 import java.util.Collection;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
 import java.util.regex.Pattern;
 
 import org.jabref.logic.l10n.Localization;
@@ -38,6 +39,7 @@ public class BibFieldsIndexer {
     private static final Logger LOGGER = LoggerFactory.getLogger(BibFieldsIndexer.class);
     private static final LatexToUnicodeFormatter LATEX_TO_UNICODE_FORMATTER = new LatexToUnicodeFormatter();
     private static final Pattern GROUPS_SEPARATOR_REGEX = Pattern.compile("\s*,\s*");
+    private static final Set<Field> DATE_FIELDS = Set.of(StandardField.DATE, StandardField.YEAR, StandardField.MONTH, StandardField.DAY);
 
     private final BibDatabaseContext databaseContext;
     private final Connection connection;
@@ -215,10 +217,12 @@ private void addToIndex(BibEntry bibEntry) {
                 // We add a `.orElse("")` only because there could be some flaw in the future in the code - and we want to have search working even if the flaws are present.
                 // To uncover these flaws, we add the "assert" statement.
                 // One potential future flaw is that the bibEntry is modified concurrently and the field being deleted.
-                Optional<String> resolvedFieldLatexFree = bibEntry.getResolvedFieldOrAliasLatexFree(field, this.databaseContext.getDatabase());
-                assert resolvedFieldLatexFree.isPresent();
-                addBatch(preparedStatement, entryId, field, value, resolvedFieldLatexFree.orElse(""));
-
+                // Skip indexing of date-related fields separately to ensure proper handling later in the process.
+                if (!DATE_FIELDS.contains(field)) {
+                    Optional<String> resolvedFieldLatexFree = bibEntry.getResolvedFieldOrAliasLatexFree(field, this.databaseContext.getDatabase());
+                    assert resolvedFieldLatexFree.isPresent();
+                    addBatch(preparedStatement, entryId, field, value, resolvedFieldLatexFree.orElse(""));
+                }
                 // region Handling of known multi-value fields
                 // split and convert to Unicode
                 if (field.getProperties().contains(FieldProperty.PERSON_NAMES)) {
@@ -239,7 +243,11 @@ private void addToIndex(BibEntry bibEntry) {
                 }
                 // endregion
             }
-
+            // ensure all date-related fields are indexed.
+            for (Field dateField : DATE_FIELDS) {
+                Optional<String> resolvedDateValue = bibEntry.getResolvedFieldOrAlias(dateField, this.databaseContext.getDatabase());
+                resolvedDateValue.ifPresent(dateValue -> addBatch(preparedStatement, entryId, dateField, dateValue));
+            }
             // add entry type
             addBatch(preparedStatement, entryId, TYPE_HEADER, bibEntry.getType().getName());
 
@@ -302,16 +310,46 @@ private void insertField(BibEntry entry, Field field) {
                 FIELD_VALUE_LITERAL,
                 FIELD_VALUE_TRANSFORMED);
 
-        try (PreparedStatement preparedStatement = connection.prepareStatement(insertFieldQuery)) {
-            String entryId = entry.getId();
-            String value = entry.getField(field).orElse("");
+        // Inserts or updates date-related fields (e.g., date, year, month, day) into the index.
+        // If a conflict occurs (e.g., the same ENTRY_ID and FIELD_NAME already exist),
+        // the existing values are overwritten with the new ones to ensure the latest data is stored.
+        String insertDateFieldQuery = """
+                INSERT INTO %s ("%s", "%s", "%s", "%s")
+                VALUES (?, ?, ?, ?)
+                ON CONFLICT ("%s", "%s")
+                DO UPDATE SET "%s" = EXCLUDED."%s", "%s" = EXCLUDED."%s"
+                """.formatted(
+                schemaMainTableReference,
+                ENTRY_ID,
+                FIELD_NAME,
+                FIELD_VALUE_LITERAL,
+                FIELD_VALUE_TRANSFORMED,
+                ENTRY_ID, FIELD_NAME,
+                FIELD_VALUE_LITERAL, FIELD_VALUE_LITERAL,
+                FIELD_VALUE_TRANSFORMED, FIELD_VALUE_TRANSFORMED);
+
+        String entryId = entry.getId();
+        if (DATE_FIELDS.contains(field)) {
+            try (PreparedStatement preparedStatement = connection.prepareStatement(insertDateFieldQuery)) {
+                for (Field dateField : DATE_FIELDS) {
+                    Optional<String> resolvedDateValue = entry.getResolvedFieldOrAlias(dateField, this.databaseContext.getDatabase());
+                    resolvedDateValue.ifPresent(dateValue -> addBatch(preparedStatement, entryId, dateField, dateValue));
+                }
+                preparedStatement.executeBatch();
+            } catch (SQLException e) {
+                LOGGER.error("Could not add an entry to the index.", e);
+            }
+        } else {
+            try (PreparedStatement preparedStatement = connection.prepareStatement(insertFieldQuery)) {
+                String value = entry.getField(field).orElse("");
 
-            Optional<String> resolvedFieldLatexFree = entry.getResolvedFieldOrAliasLatexFree(field, this.databaseContext.getDatabase());
-            assert resolvedFieldLatexFree.isPresent();
-            addBatch(preparedStatement, entryId, field, value, resolvedFieldLatexFree.orElse(""));
-            preparedStatement.executeBatch();
-        } catch (SQLException e) {
-            LOGGER.error("Could not add an entry to the index.", e);
+                Optional<String> resolvedFieldLatexFree = entry.getResolvedFieldOrAliasLatexFree(field, this.databaseContext.getDatabase());
+                assert resolvedFieldLatexFree.isPresent();
+                addBatch(preparedStatement, entryId, field, value, resolvedFieldLatexFree.orElse(""));
+                preparedStatement.executeBatch();
+            } catch (SQLException e) {
+                LOGGER.error("Could not add an entry to the index.", e);
+            }
         }
 
         String insertIntoSplitTable = """
@@ -325,7 +363,6 @@ private void insertField(BibEntry entry, Field field) {
                 FIELD_VALUE_TRANSFORMED);
 
         try (PreparedStatement preparedStatement = connection.prepareStatement(insertIntoSplitTable)) {
-            String entryId = entry.getId();
             String value = entry.getField(field).orElse("");
 
             if (field.getProperties().contains(FieldProperty.PERSON_NAMES)) {

src/main/java/org/jabref/model/entry/LinkedFile.java

@@ -3,6 +3,7 @@
 import java.io.IOException;
 import java.io.ObjectInputStream;
 import java.io.ObjectOutputStream;
+import java.io.Serial;
 import java.io.Serializable;
 import java.net.URL;
 import java.nio.file.Files;
@@ -170,6 +171,7 @@ public boolean equals(@Nullable Object o) {
     /**
      * Writes serialized object to ObjectOutputStream, automatically called
      */
+    @Serial
     private void writeObject(ObjectOutputStream out) throws IOException {
         out.writeUTF(getFileType());
         out.writeUTF(getLink());
@@ -181,6 +183,7 @@ private void writeObject(ObjectOutputStream out) throws IOException {
     /**
      * Reads serialized object from {@link ObjectInputStream}, automatically called
      */
+    @Serial
     private void readObject(ObjectInputStream in) throws IOException {
         fileType = new SimpleStringProperty(in.readUTF());
         link = new SimpleStringProperty(in.readUTF());

src/main/java/org/jabref/model/search/PostgreConstants.java

@@ -63,6 +63,10 @@ public static String getMainTableSchemaReference(String mainTable) {
         return BIB_FIELDS_SCHEME + ".\"" + mainTable + "\"";
     }
 
+    /**
+     * Generates the schema reference for the split table, which is used to store multi-value fields (e.g., authors, keywords)
+     * in a normalized form to facilitate efficient querying and indexing of the data.
+     */
     public static String getSplitTableSchemaReference(String mainTable) {
         return BIB_FIELDS_SCHEME + ".\"" + mainTable + SPLIT_TABLE_SUFFIX + "\"";
     }