bookmark highlighting frontend

Author: R-Sandor

frontend/components/Bookmark/BookmarkCard.tsx

@@ -218,6 +218,7 @@ export default function BookmarkCard({ bookmark }: Readonly<BookmarkProp>) {
     return (
       <CardBody
         bookmark={currentBookmark.current}
+        highlight={bookmark.textHighlight}
         inEditMode={inEditMode}
         edit={edit}
         changeEditMode={changeEditMode}

frontend/components/Bookmark/CardBody.tsx

@@ -6,18 +6,21 @@ import { ScrapableBookmarkToggle } from "./ScrapableToggle";
 
 interface CardBodyProp {
   bookmark: Readonly<Bookmark>;
+  highlight: String | null;
   inEditMode: Readonly<boolean>;
   edit: Readonly<RefObject<Bookmark>>;
   changeEditMode: Readonly<Function>;
 }
 
 export default function CardBody({
   bookmark,
+  highlight,
   inEditMode,
   edit,
   changeEditMode,
 }: Readonly<CardBodyProp>) {
   const [isScrapable, setIsScrapable] = useState(bookmark.scrapable);
+
   return (
     <Card.Body>
       <Card.Title>
@@ -62,6 +65,12 @@ export default function CardBody({
           {bookmark.url}
         </Card.Link>
       )}
+      {highlight ? (
+        <div>
+          <hr />
+          <p dangerouslySetInnerHTML={{ __html: highlight }}></p>
+        </div>
+      ) : null}
     </Card.Body>
   );
 }

frontend/types/Bookmarks/Bookmark.ts

@@ -7,4 +7,5 @@ export default interface Bookmark {
   screenshotUrl: string;
   tags: Tag[];
   scrapable: boolean;
+  textHighlight: string | null;
 }

server/src/main/java/dev/findfirst/core/dto/BookmarkDTO.java

@@ -3,5 +3,33 @@
 import java.util.Date;
 import java.util.List;
 
-public record BookmarkDTO(long id, String title, String url,  String screenshotUrl, boolean scrapable, Date createdDate, Date lastModifiedOn, List<TagOnly> tags) {
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+@Accessors(fluent = true, chain = false)
+@Getter(onMethod = @__(@JsonProperty))
+@Setter
+@AllArgsConstructor
+@NoArgsConstructor
+public class BookmarkDTO {
+
+  private long id;
+  private String title;
+  private String url;
+  private String screenshotUrl;
+  private boolean scrapable;
+  private Date createdDate;
+  private Date lastModifiedOn;
+  private List<TagOnly> tags;
+  private String textHighlight;
+
+  public BookmarkDTO(long id, String title, String url, String screenshotUrl, boolean scrapable,
+      Date createdDate, Date lastModifiedOn, List<TagOnly> tags) {
+    // we don't have any highlighted text.
+    this(id, title, url, screenshotUrl, scrapable, createdDate, lastModifiedOn, tags, null);
+  }
 }

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

@@ -112,6 +112,16 @@ public Optional<BookmarkDTO> getBookmarkDTOById(Long id) {
     }
   }
 
+  public List<BookmarkDTO> convertBookmarkJDBCToDTO(List<BookmarkJDBC> bookmarkEntities,
+      List<String> highlights, int userId) {
+    var bks = convertBookmarkJDBCToDTO(bookmarkEntities, userId);
+
+    for (int i = 0; i < highlights.size() && i < bookmarkEntities.size(); i++) {
+      bks.get(i).textHighlight(highlights.get(i));
+    }
+    return bks;
+  }
+
   public List<BookmarkDTO> convertBookmarkJDBCToDTO(List<BookmarkJDBC> bookmarkEntities,
       int userId) {
 

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

@@ -2,9 +2,11 @@
 
 import java.util.List;
 import java.util.StringJoiner;
+import java.util.stream.Collectors;
 
 import dev.findfirst.core.dto.BookmarkDTO;
 import dev.findfirst.core.repository.jdbc.BookmarkJDBCRepository;
+import dev.findfirst.core.service.TypesenseService.SearchHighlightResult;
 import dev.findfirst.security.userauth.context.UserContext;
 
 import lombok.RequiredArgsConstructor;
@@ -42,11 +44,18 @@ public List<BookmarkDTO> bookmarksByTags(List<String> tags) {
 
   public List<BookmarkDTO> bookmarksByText(String text) {
     var userID = userContext.getUserId();
-      var ids = typesense.search(text).stream()
-              .map(TypesenseService.SearchHighlightResult::id)
-              .toList();
-    var bookmarks = bookmarkRepo.findAllById(ids);
-    return bookmarkService.convertBookmarkJDBCToDTO(bookmarks, userID);
+    List<SearchHighlightResult> searchHighlightResults = typesense.search(text);
+
+    record IdHighlight(List<Long> ids, List<String> hightlights) {
+    }
+
+    IdHighlight ih = searchHighlightResults.stream()
+        .collect(Collectors.teeing(Collectors.mapping(hit -> hit.id(), Collectors.toList()),
+            Collectors.mapping(hit -> hit.highlight(), Collectors.toList()),
+            (ids, highlights) -> new IdHighlight(ids, highlights)));
+
+    var bookmarks = bookmarkRepo.findAllById(ih.ids());
+    return bookmarkService.convertBookmarkJDBCToDTO(bookmarks, ih.hightlights(), userID);
 
   }
 

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

@@ -27,7 +27,9 @@
 @Slf4j
 public class TypesenseService {
 
-    public record SearchHighlightResult(Long id, String highlight) {};
+  public record SearchHighlightResult(Long id, String highlight) {
+  };
+
   private final TypsenseInitializationRepository initRepo;
 
   private final Client client;
@@ -56,8 +58,7 @@ private CollectionSchema createCollectionSchemaSchema() {
 
   private String saveSchema(TypesenseInitRecord initRecord) {
     try {
-      CollectionResponse collectionResponse =
-          client.collections().create(createCollectionSchemaSchema());
+      CollectionResponse collectionResponse = client.collections().create(createCollectionSchemaSchema());
       log.debug(collectionResponse.toString());
       initRecord.setInitialized(true);
       initRepo.save(initRecord);
@@ -88,28 +89,20 @@ public void addText(BookmarkJDBC bookmark, Document retDoc) {
   }
 
   public List<SearchHighlightResult> search(String text) {
-    SearchParameters searchParameters = new SearchParameters()
-            .q(text)
-            .queryBy("text")
-            .highlightFields("text")
-            .highlightStartTag("<mark>")
-            .highlightEndTag("<mark>");
+    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);
+      SearchResult searchResult = client.collections(schemaName).documents().search(searchParameters);
       log.debug(searchResult.toString());
 
-      return searchResult.getHits().stream()
-          .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();
+      return searchResult.getHits().stream().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/model/RobotsTxtResponseTest.java

@@ -9,15 +9,18 @@
 import org.junit.jupiter.api.Test;
 
 class RobotsTxtResponseTest {
-  RobotsTxtResponse response200 = new RobotsFetcher.RobotsTxtResponse(200, "response from server".getBytes(), "json");
-  RobotsTxtResponse response200Same = new RobotsFetcher.RobotsTxtResponse(200, "response from server".getBytes(),
-      "json");
-  RobotsTxtResponse response400 = new RobotsFetcher.RobotsTxtResponse(400, "response from server".getBytes(), "json");
-  RobotsTxtResponse responseContentJson = new RobotsFetcher.RobotsTxtResponse(200, "new message".getBytes(), "json");
-  RobotsTxtResponse responseContentHtml = new RobotsFetcher.RobotsTxtResponse(400, "response from server".getBytes(),
-      "html");
-  RobotsTxtResponse responseContent2 = new RobotsFetcher.RobotsTxtResponse(400, "response from server".getBytes(),
-      null);
+  RobotsTxtResponse response200 =
+      new RobotsFetcher.RobotsTxtResponse(200, "response from server".getBytes(), "json");
+  RobotsTxtResponse response200Same =
+      new RobotsFetcher.RobotsTxtResponse(200, "response from server".getBytes(), "json");
+  RobotsTxtResponse response400 =
+      new RobotsFetcher.RobotsTxtResponse(400, "response from server".getBytes(), "json");
+  RobotsTxtResponse responseContentJson =
+      new RobotsFetcher.RobotsTxtResponse(200, "new message".getBytes(), "json");
+  RobotsTxtResponse responseContentHtml =
+      new RobotsFetcher.RobotsTxtResponse(400, "response from server".getBytes(), "html");
+  RobotsTxtResponse responseContent2 =
+      new RobotsFetcher.RobotsTxtResponse(400, "response from server".getBytes(), null);
 
   @Test
   void robotsTxtResponseEquality() {

server/src/test/java/dev/findfirst/core/model/SearchBkmkByTitleReq.java

@@ -11,24 +11,24 @@ class SearchBkmkByTitleReqTest {
 
   @Test
   void titleRequestsEquality() {
-    assertEquals(new SearchBkmkByTitleReq(new String[] { "java", "spring" }),
-        new SearchBkmkByTitleReq(new String[] { "java", "spring" }));
-    assertNotEquals(new SearchBkmkByTitleReq(new String[] { "java" }),
-        new SearchBkmkByTitleReq(new String[] { "java", "spring" }));
-    assertNotEquals(new SearchBkmkByTitleReq(new String[] { "java", "spring" }), (Object) null);
-    assertNotEquals(new SearchBkmkByTitleReq(new String[] { "java", "spring" }), (Object) "String");
+    assertEquals(new SearchBkmkByTitleReq(new String[] {"java", "spring"}),
+        new SearchBkmkByTitleReq(new String[] {"java", "spring"}));
+    assertNotEquals(new SearchBkmkByTitleReq(new String[] {"java"}),
+        new SearchBkmkByTitleReq(new String[] {"java", "spring"}));
+    assertNotEquals(new SearchBkmkByTitleReq(new String[] {"java", "spring"}), (Object) null);
+    assertNotEquals(new SearchBkmkByTitleReq(new String[] {"java", "spring"}), (Object) "String");
   }
 
   @Test
   void hashCodeTest() {
-    var keywords = new String[] { "java", "spring" };
+    var keywords = new String[] {"java", "spring"};
     var searchReq = new SearchBkmkByTitleReq(keywords);
     assertEquals(Arrays.hashCode(keywords), searchReq.hashCode());
   }
 
   @Test
   void toStringTest() {
-    var keywords = new String[] { "java", "spring" };
+    var keywords = new String[] {"java", "spring"};
     var searchReq = new SearchBkmkByTitleReq(keywords);
     assertEquals(Arrays.toString(keywords), searchReq.toString());
 

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

@@ -4,14 +4,9 @@
 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;
 
@@ -22,7 +17,10 @@
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 import org.typesense.api.Client;
+import org.typesense.api.Collection;
 import org.typesense.api.Collections;
+import org.typesense.api.Documents;
+import org.typesense.model.*;
 
 /**
  * Tests for typsense operations such as intitilization, queries/imports.
@@ -83,41 +81,41 @@ void initializationWasNotFinished() throws Exception {
   @Disabled("Implement test to save storeScrapedText")
   void storeScrapedText() throws Exception {}
 
-    @Test
-    void returnSearchHighlighted() throws Exception {
+  @Test
+  void returnSearchHighlighted() throws Exception {
 
-        String query = "example";
-        Long expectedId = 123L;
-        String expectedSnippet = "<mark>example</mark> text around";
+    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);
+    // 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));
+    // 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 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);
+    // 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);
+    // Act
+    var results = typesense.search(query);
 
-        // Assert
-        assertEquals(1, results.size());
-        assertEquals(expectedId, results.get(0).id());
-        assertEquals(expectedSnippet, results.get(0).highlight());
-    }
+    // Assert
+    assertEquals(1, results.size());
+    assertEquals(expectedId, results.get(0).id());
+    assertEquals(expectedSnippet, results.get(0).highlight());
+  }
 }