Highlight matched search terms

tramlinehq · Jan 24, 2025 · 3d9a7d5 · 3d9a7d5
1 parent 70ec40d
commit 3d9a7d5
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 5 deletions.
diff --git a/app/components/all_releases_table_component.html.erb b/app/components/all_releases_table_component.html.erb
@@ -47,10 +47,10 @@
             <div class="text-left">
               <ul class="list-disc list-inside">
                 <% release.pull_requests.each do |pr| %>
-                  <li><a href="<%= pr[:url] %>"><%= pr[:message] %></a></li>
+                  <li><a href="<%= pr[:url] %>"><%= pr[:message].html_safe %></a></li>
                 <% end %>
                 <% release.commits.each do |commit| %>
-                  <li><a href="<%= commit[:url] %>"><%= commit[:message] %></a></li>
+                  <li><a href="<%= commit[:url] %>"><%= commit[:message].html_safe %></a></li>
                 <% end %>
 
               </ul>

diff --git a/app/libs/queries/releases.rb b/app/libs/queries/releases.rb
@@ -72,6 +72,7 @@ def selected_records
               "relevant_releases.slug", "relevant_releases.status", "relevant_releases.created_at")
       .joins("JOIN (#{relevant_releases.to_sql}) AS relevant_releases ON commits.release_id = relevant_releases.id")
       .search_by_message(params.search_query)
+      .with_pg_search_highlight
 
 
     filtered_pull_requests = PullRequest
@@ -80,6 +81,7 @@ def selected_records
               "relevant_releases.slug", "relevant_releases.status", "relevant_releases.created_at")
       .joins("JOIN (#{relevant_releases.to_sql}) AS relevant_releases ON pull_requests.release_id = relevant_releases.id")
       .search_by_title(params.search_query)
+      .with_pg_search_highlight
 
     # Final query with CTEs
     Release
@@ -92,7 +94,7 @@ def selected_records
       .from("filtered_commits_and_pull_requests")
       .select(:release_id,
         "array_agg(type) as types",
-        "array_agg(matched_message) as matched_messages",
+        "array_agg(pg_search_highlight) as matched_messages",
         "array_agg(url) as urls",
         :slug, 
         :status, 

diff --git a/app/models/commit.rb b/app/models/commit.rb
@@ -48,7 +48,17 @@ class Commit < ApplicationRecord
     using: {
       tsearch: {
         prefix: true,
-        any_word: true
+        any_word: true,
+        highlight: {
+          StartSel: '<b>',
+          StopSel: '</b>',
+          MinWords: 123,
+          MaxWords: 456,
+          ShortWord: 4,
+          HighlightAll: true,
+          MaxFragments: 3,
+          FragmentDelimiter: '&hellip;'
+        }
       }
     }
 

diff --git a/app/models/pull_request.rb b/app/models/pull_request.rb
@@ -56,7 +56,17 @@ class UnsupportedPullRequestSource < StandardError; end
     using: {
       tsearch: {
         prefix: true,
-        any_word: true
+        any_word: true,
+        highlight: {
+          StartSel: '<b>',
+          StopSel: '</b>',
+          MinWords: 123,
+          MaxWords: 456,
+          ShortWord: 4,
+          HighlightAll: true,
+          MaxFragments: 3,
+          FragmentDelimiter: '&hellip;'
+        }
       }
     }
   # rubocop:disable Rails/SkipsModelValidations