mirror of
https://github.com/discourse/discourse.git
synced 2026-08-07 13:19:19 +08:00
7ecb945ec4## Overview
This PR introduces comprehensive search functionality for chat messages,
enabling users to search through their chat history both globally across
all accessible channels and within specific channels.
### Search Capabilities
**All-Channel Search**: When no channel is specified, users can search
across all channels they have access to. The search respects channel
permissions through `ChannelFetcher.all_secured_channel_ids`, ensuring
users only see results from channels they can view.
**Per-Channel Search**: Users can scope their search to a specific
channel by providing a `channel_id` parameter, useful for finding
messages within a particular conversation context.
**Search Features**:
- Full-text search using PostgreSQL's tsvector/tsquery
- Advanced filters: `@username` to filter by author, `#channel` to
filter by channel slug
- Sort options: relevance (default) or latest
- Pagination support
- Search data weighted by relevance
## Site Setting: `chat_search_enabled`
This feature is gated behind the `chat_search_enabled` site setting,
which is currently:
- **Default**: `false`
- **Hidden**: `true`
- **Client-accessible**: `true`
### Deployment Strategy
Due to the need for chat messages to be indexed before search becomes
useful, we're implementing a two-phase deployment:
**Phase 1 (Initial Merge)**:
- `chat_search_enabled` remains `false` and hidden
- The `register_search_index` uses default (true) instead of `chat_search_enabled` value
- This allows the reindexing infrastructure to begin indexing existing
chat messages even if we don't show the UI yet
**Wait Period**:
- Wait at least one week after Phase 1 deployment
- `Jobs::ReindexSearch` runs every 2 hours and will progressively index
all chat messages
- This ensures most sites have a significant part of their chat history indexed
**Phase 2 (Follow-up Merge)**:
- Set `chat_search_enabled` default to `true` and unhide it
- Update the `register_search_index` enabled proc uses the default
(true) instead of using the `chat_search_enabled` setting
- Users can now access search with pre-indexed data
**Rationale**: Without this phased approach, users would see the search
UI immediately but receive no results until the reindexing job runs,
creating a confusing experience. By pre-indexing while the UI is hidden,
we ensure search works immediately when enabled.
## New Plugin API: `register_search_index`
This PR introduces a new plugin API that allows plugins to register
custom search indexes that integrate seamlessly with Discourse's search
infrastructure.
### API Signature
```ruby
register_search_index(
model_class:, # The ActiveRecord model to index
search_data_class:, # The model for storing search data
index_version:, # Version number for re-indexing
search_data:, # Proc that returns weighted search data
load_unindexed_record_ids:,# Proc that finds records needing indexing
enabled: # Optional proc to enable/disable (default: -> { true })
)
```
### How It Works
**Integration with SearchIndexer**: When `SearchIndexer.index(obj)` is
called, it checks registered search handlers for the object's type. If a
handler matches, it:
1. Calls the `search_data` proc with the object and an `IndexerHelper`
instance
2. Receives weighted search data (`:a_weight`, `:b_weight`, `:c_weight`,
`:d_weight`)
3. Updates the corresponding search data table with PostgreSQL's
tsvector
**Integration with Jobs::ReindexSearch**: The scheduled job (runs every
2 hours) calls `rebuild_registered_search_handlers`, which:
1. Iterates through all registered search handlers
2. Skips handlers where `enabled` proc returns `false`
3. Calls `load_unindexed_record_ids` to find records needing indexing
4. Indexes up to `limit` records per handler (default: 10,000)
### Chat Implementation Example
```ruby
register_search_index(
model_class: Chat::Message,
search_data_class: Chat::MessageSearchData,
index_version: 1,
search_data: proc { |message, indexer_helper|
{
a_weight: message.message,
d_weight: indexer_helper.scrub_html(message.cooked)[0..600_000]
}
},
load_unindexed_record_ids: proc { |limit:, index_version:|
Chat::Message
.joins("LEFT JOIN chat_message_search_data ON chat_message_id = chat_messages.id")
.where(
"chat_message_search_data.locale IS NULL OR
chat_message_search_data.locale != ? OR
chat_message_search_data.version != ?",
SiteSetting.default_locale,
index_version
)
.order("chat_messages.id ASC")
.limit(limit)
.pluck(:id)
}
)
```
Co-authored-by: Martin Brennan <mjrbrennan@gmail.com>
Co-authored-by: Loïc Guitaut <5648+Flink@users.noreply.github.com>
76 lines
2.3 KiB
Ruby
Vendored
76 lines
2.3 KiB
Ruby
Vendored
# frozen_string_literal: true
|
|
|
|
module Chat
|
|
# Service responsible to search messages in channels.
|
|
#
|
|
# @example
|
|
# ::Chat::SearchMessage.call(
|
|
# guardian: guardian,
|
|
# params: {
|
|
# query: "foo",
|
|
# channel_id: 1,
|
|
# sort: "latest",
|
|
# }
|
|
# )
|
|
#
|
|
class SearchMessage
|
|
include Service::Base
|
|
|
|
# @!method self.call(guardian:, params:)
|
|
# @param [Guardian] guardian
|
|
# @param [Hash] params
|
|
# @option params [String] :query The query used to query the results
|
|
# @option params [Integer] :channel_id ID of the channel to scope the search
|
|
# @option params [Integer] :limit Maximum number of results to return (1-40, defaults to 20)
|
|
# @option params [Integer] :offset Number of results to skip for pagination (defaults to 0)
|
|
# @option params [Boolean] :exclude_threads Whether to exclude thread messages (keeps original thread messages)
|
|
# @option params [String] :sort Sort order for results ("relevance" or "latest", defaults to "relevance")
|
|
# @return [Service::Base::Context]
|
|
|
|
params do
|
|
attribute :query, :string
|
|
attribute :channel_id, :integer
|
|
attribute :limit, :integer, default: 20
|
|
attribute :offset, :integer, default: 0
|
|
attribute :exclude_threads, :boolean, default: false
|
|
attribute :sort, :string, default: "relevance"
|
|
|
|
validates :query, presence: true
|
|
validates :limit, numericality: { in: 1..40 }
|
|
validates :offset, numericality: { greater_than_or_equal_to: 0 }
|
|
validates :sort, inclusion: { in: %w[relevance latest] }
|
|
|
|
after_validation { self.query = Search.clean_term(query) }
|
|
end
|
|
|
|
only_if(:provided_channel_id) do
|
|
model :channel
|
|
policy :can_view_channel
|
|
end
|
|
|
|
model :metadata
|
|
model :messages, optional: true
|
|
|
|
private
|
|
|
|
def provided_channel_id(params:)
|
|
params.channel_id.present?
|
|
end
|
|
|
|
def fetch_channel(params:)
|
|
Chat::Channel.find_by(id: params.channel_id)
|
|
end
|
|
|
|
def can_view_channel(guardian:, channel:)
|
|
guardian.can_preview_chat_channel?(channel)
|
|
end
|
|
|
|
def fetch_metadata(params:, guardian:)
|
|
Chat::Action::SearchForMessages.call(params:, guardian:, channel: context[:channel])
|
|
end
|
|
|
|
def fetch_messages(metadata:)
|
|
metadata[:messages]
|
|
end
|
|
end
|
|
end
|
