[Server] Add support for highlight text preview (#399)

* feat(typesense): add support for highlighted search results

* fix: correct highlightFields usage in SearchParameters for Typesense search

* test: add unit test for TypesenseService search with highlights

Author: jessica-ortiz-c

server/src/main/java/dev/findfirst/core/service/SearchService.java

@@ -42,7 +42,10 @@ public List<BookmarkDTO> bookmarksByTags(List<String> tags) {
 
   public List<BookmarkDTO> bookmarksByText(String text) {
     var userID = userContext.getUserId();
-    var bookmarks = bookmarkRepo.findAllById(typesense.search(text));
+      var ids = typesense.search(text).stream()
+              .map(TypesenseService.SearchHighlightResult::id)
+              .toList();
+    var bookmarks = bookmarkRepo.findAllById(ids);
     return bookmarkService.convertBookmarkJDBCToDTO(bookmarks, userID);
 
   }

server/src/main/java/dev/findfirst/core/service/TypesenseService.java

@@ -27,6 +27,7 @@
 @Slf4j
 public class TypesenseService {
 
+    public record SearchHighlightResult(Long id, String highlight) {};
   private final TypsenseInitializationRepository initRepo;
 
   private final Client client;
@@ -86,16 +87,29 @@ public void addText(BookmarkJDBC bookmark, Document retDoc) {
     }
   }
 
-  public List<Long> search(String text) {
-    SearchParameters searchParameters = new SearchParameters().q(text).queryBy("text");
+  public List<SearchHighlightResult> search(String text) {
+    SearchParameters searchParameters = new SearchParameters()
+            .q(text)
+            .queryBy("text")
+            .highlightFields("text")
+            .highlightStartTag("<mark>")
+            .highlightEndTag("<mark>");
     try {
       log.debug("searching");
       SearchResult searchResult =
           client.collections(schemaName).documents().search(searchParameters);
       log.debug(searchResult.toString());
 
       return searchResult.getHits().stream()
-          .map(h -> Long.parseLong(h.getDocument().get("id").toString())).toList();
+          .map(hit -> {
+                  Long id = Long.parseLong(hit.getDocument().get("id").toString());
+                  String highlight = hit.getHighlights().stream()
+                          .filter(h -> "text".equals(h.getField()))
+                          .map(h-> h.getSnippet())
+                          .findFirst()
+                          .orElse("");
+                  return new SearchHighlightResult(id, highlight);
+          }).toList();
     } catch (Exception e) {
       log.error(e.toString());
     }

server/src/test/java/dev/findfirst/core/service/TypesenseServiceTest.java

@@ -1,10 +1,16 @@
 package dev.findfirst.core.service;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.mockito.Mockito.any;
-import static org.mockito.Mockito.when;
+import static org.mockito.Mockito.*;
 
 import java.util.Date;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.typesense.model.*;
+import org.typesense.api.Documents;
+import org.typesense.api.Collection;
 
 import dev.findfirst.core.model.jdbc.TypesenseInitRecord;
 import dev.findfirst.core.repository.jdbc.TypsenseInitializationRepository;
@@ -17,8 +23,6 @@
 import org.mockito.junit.jupiter.MockitoExtension;
 import org.typesense.api.Client;
 import org.typesense.api.Collections;
-import org.typesense.model.CollectionResponse;
-import org.typesense.model.CollectionSchema;
 
 /**
  * Tests for typsense operations such as intitilization, queries/imports.
@@ -78,4 +82,42 @@ void initializationWasNotFinished() throws Exception {
   @Test
   @Disabled("Implement test to save storeScrapedText")
   void storeScrapedText() throws Exception {}
+
+    @Test
+    void returnSearchHighlighted() throws Exception {
+
+        String query = "example";
+        Long expectedId = 123L;
+        String expectedSnippet = "<mark>example</mark> text around";
+
+        // Mock highlight
+        SearchHighlight highlight = mock(SearchHighlight.class);
+        when(highlight.getField()).thenReturn("text");
+        when(highlight.getSnippet()).thenReturn(expectedSnippet);
+
+        // Simula un hit como Map
+        SearchResultHit hit = mock(SearchResultHit.class);
+        when(hit.getDocument()).thenReturn(Map.of("id", expectedId.toString()));
+        when(hit.getHighlights()).thenReturn(List.of(highlight));
+
+        // Mock search result
+        SearchResult searchResult = new SearchResult();
+        searchResult.setHits(List.of(hit));
+
+
+        // Mock client behavior
+        var documents = mock(Documents.class);
+        var collection = mock(Collection.class);
+        when(client.collections("bookmark")).thenReturn(collection);
+        when(collection.documents()).thenReturn(documents);
+        when(documents.search(any(SearchParameters.class))).thenReturn(searchResult);
+
+        // Act
+        var results = typesense.search(query);
+
+        // Assert
+        assertEquals(1, results.size());
+        assertEquals(expectedId, results.get(0).id());
+        assertEquals(expectedSnippet, results.get(0).highlight());
+    }
 }