## Description
Implements comprehensive search functionality with advanced filtering
capabilities for Chatwoot (Linear: CW-5956).
This PR adds:
1. **Time-based filtering** for contacts and conversations (SQL-based
search)
2. **Advanced message search** with multiple filters
(OpenSearch/Elasticsearch-based)
- **`from` filter**: Filter messages by sender (format: `contact:42` or
`agent:5`)
- **`inbox_id` filter**: Filter messages by specific inbox
- **Time range filters**: Filter messages using `since` and `until`
parameters (Unix timestamps in seconds)
- **90-day limit enforcement**: Automatically limits searches to the
last 90 days to prevent performance issues
The implementation extends the existing `Enterprise::SearchService`
module for advanced features and adds time filtering to the base
`SearchService` for SQL-based searches.
## API Documentation
### Base URL
All search endpoints follow this pattern:
```
GET /api/v1/accounts/{account_id}/search/{resource}
```
### Authentication
All requests require authentication headers:
```
api_access_token: YOUR_ACCESS_TOKEN
```
---
## 1. Search All Resources
**Endpoint:** `GET /api/v1/accounts/{account_id}/search`
Returns results from all searchable resources (contacts, conversations,
messages, articles).
### Parameters
| Parameter | Type | Description | Required |
|-----------|------|-------------|----------|
| `q` | string | Search query | Yes |
| `page` | integer | Page number (15 items per page) | No |
| `since` | integer | Unix timestamp (contacts/conversations only) | No
|
| `until` | integer | Unix timestamp (contacts/conversations only) | No
|
### Example Request
```bash
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search?q=customer" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
### Example Response
```json
{
"payload": {
"contacts": [...],
"conversations": [...],
"messages": [...],
"articles": [...]
}
}
```
---
## 2. Search Contacts
**Endpoint:** `GET /api/v1/accounts/{account_id}/search/contacts`
Search contacts by name, email, phone number, or identifier with
optional time filtering.
### Parameters
| Parameter | Type | Description | Required |
|-----------|------|-------------|----------|
| `q` | string | Search query | Yes |
| `page` | integer | Page number (15 items per page) | No |
| `since` | integer | Unix timestamp - filter by last_activity_at | No |
| `until` | integer | Unix timestamp - filter by last_activity_at | No |
### Example Requests
**Basic search:**
```bash
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/contacts?q=john" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
**Search contacts active in the last 7 days:**
```bash
SINCE=$(date -v-7d +%s)
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/contacts?q=john&since=${SINCE}" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
**Search contacts active between 30 and 7 days ago:**
```bash
SINCE=$(date -v-30d +%s)
UNTIL=$(date -v-7d +%s)
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/contacts?q=john&since=${SINCE}&until=${UNTIL}" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
### Example Response
```json
{
"payload": {
"contacts": [
{
"id": 42,
"email": "john@example.com",
"name": "John Doe",
"phone_number": "+1234567890",
"identifier": "user_123",
"additional_attributes": {},
"created_at": 1701234567
}
]
}
}
```
---
## 3. Search Conversations
**Endpoint:** `GET /api/v1/accounts/{account_id}/search/conversations`
Search conversations by display ID, contact name, email, phone number,
or identifier with optional time filtering.
### Parameters
| Parameter | Type | Description | Required |
|-----------|------|-------------|----------|
| `q` | string | Search query | Yes |
| `page` | integer | Page number (15 items per page) | No |
| `since` | integer | Unix timestamp - filter by last_activity_at | No |
| `until` | integer | Unix timestamp - filter by last_activity_at | No |
### Example Requests
**Basic search:**
```bash
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/conversations?q=billing" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
**Search conversations active in the last 24 hours:**
```bash
SINCE=$(date -v-1d +%s)
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/conversations?q=billing&since=${SINCE}" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
**Search conversations from last month:**
```bash
SINCE=$(date -v-30d +%s)
UNTIL=$(date +%s)
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/conversations?q=billing&since=${SINCE}&until=${UNTIL}" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
### Example Response
```json
{
"payload": {
"conversations": [
{
"id": 123,
"display_id": 45,
"inbox_id": 1,
"status": "open",
"messages": [...],
"meta": {...}
}
]
}
}
```
---
## 4. Search Messages (Advanced)
**Endpoint:** `GET /api/v1/accounts/{account_id}/search/messages`
Advanced message search with multiple filters powered by
OpenSearch/Elasticsearch.
### Prerequisites
- OpenSearch/Elasticsearch must be running (`OPENSEARCH_URL` env var
configured)
- Account must have `advanced_search` feature flag enabled
- Messages must be indexed in OpenSearch
### Parameters
| Parameter | Type | Description | Required |
|-----------|------|-------------|----------|
| `q` | string | Search query | Yes |
| `page` | integer | Page number (15 items per page) | No |
| `from` | string | Filter by sender: `contact:{id}` or `agent:{id}` |
No |
| `inbox_id` | integer | Filter by specific inbox ID | No |
| `since` | integer | Unix timestamp - searches from this time (max 90
days ago) | No |
| `until` | integer | Unix timestamp - searches until this time | No |
### Important Notes
- **90-Day Limit**: If `since` is not provided, searches default to the
last 90 days
- If `since` exceeds 90 days, returns `422` error: "Search is limited to
the last 90 days"
- All time filters use message `created_at` timestamp
### Example Requests
**Basic message search:**
```bash
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/messages?q=refund" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
**Search messages from a specific contact:**
```bash
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/messages?q=refund&from=contact:42" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
**Search messages from a specific agent:**
```bash
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/messages?q=refund&from=agent:5" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
**Search messages in a specific inbox:**
```bash
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/messages?q=refund&inbox_id=3" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
**Search messages from the last 7 days:**
```bash
SINCE=$(date -v-7d +%s)
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/messages?q=refund&since=${SINCE}" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
**Search messages between specific dates:**
```bash
SINCE=$(date -v-30d +%s)
UNTIL=$(date -v-7d +%s)
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/messages?q=refund&since=${SINCE}&until=${UNTIL}" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
**Combine all filters:**
```bash
SINCE=$(date -v-14d +%s)
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/messages?q=refund&from=contact:42&inbox_id=3&since=${SINCE}" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
**Attempt to search beyond 90 days (returns error):**
```bash
SINCE=$(date -v-120d +%s)
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/messages?q=refund&since=${SINCE}" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
### Example Response (Success)
```json
{
"payload": {
"messages": [
{
"id": 789,
"content": "I need a refund for my purchase",
"message_type": "incoming",
"created_at": 1701234567,
"conversation_id": 123,
"inbox_id": 3,
"sender": {
"id": 42,
"type": "contact"
}
}
]
}
}
```
### Example Response (90-day limit exceeded)
```json
{
"error": "Search is limited to the last 90 days"
}
```
**Status Code:** `422 Unprocessable Entity`
---
## 5. Search Articles
**Endpoint:** `GET /api/v1/accounts/{account_id}/search/articles`
Search help center articles by title or content.
### Parameters
| Parameter | Type | Description | Required |
|-----------|------|-------------|----------|
| `q` | string | Search query | Yes |
| `page` | integer | Page number (15 items per page) | No |
### Example Request
```bash
curl -X GET "https://app.chatwoot.com/api/v1/accounts/1/search/articles?q=installation" \
-H "api_access_token: YOUR_ACCESS_TOKEN"
```
### Example Response
```json
{
"payload": {
"articles": [
{
"id": 456,
"title": "Installation Guide",
"slug": "installation-guide",
"portal_slug": "help",
"account_id": 1,
"category_name": "Getting Started",
"status": "published",
"updated_at": 1701234567
}
]
}
}
```
---
## Technical Implementation
### SQL-Based Search (Contacts, Conversations, Articles)
- Uses PostgreSQL `ILIKE` queries by default
- Optional GIN index support via `search_with_gin` feature flag for
better performance
- Time filtering uses `last_activity_at` for contacts/conversations
- Returns paginated results (15 per page)
### Advanced Search (Messages)
- Powered by OpenSearch/Elasticsearch via Searchkick gem
- Requires `OPENSEARCH_URL` environment variable
- Requires `advanced_search` account feature flag
- Enforces 90-day lookback limit via
`Limits::MESSAGE_SEARCH_TIME_RANGE_LIMIT_DAYS`
- Validates inbox access permissions before filtering
- Returns paginated results (15 per page)
---
## Type of change
- [x] New feature (non-breaking change which adds functionality)
- [x] Enhancement (improves existing functionality)
---
## How Has This Been Tested?
### Unit Tests
- **Contact Search Tests**: 3 new test cases for time filtering
(`since`, `until`, combined)
- **Conversation Search Tests**: 3 new test cases for time filtering
- **Message Search Tests**: 10+ test cases covering:
- Individual filters (`from`, `inbox_id`, time range)
- Combined filters
- Permission validation for inbox access
- Feature flag checks
- 90-day limit enforcement
- Error handling for exceeded time limits
### Test Commands
```bash
# Run all search controller tests
bundle exec rspec spec/controllers/api/v1/accounts/search_controller_spec.rb
# Run search service tests (includes enterprise specs)
bundle exec rspec spec/services/search_service_spec.rb
```
### Manual Testing Setup
A rake task is provided to create 50,000 test messages across multiple
inboxes:
```bash
# 1. Create test data
bundle exec rake search:setup_test_data
# 2. Start OpenSearch
mise elasticsearch-start
# 3. Reindex messages
rails runner "Message.search_index.import Message.all"
# 4. Enable feature flag
rails runner "Account.first.enable_features('advanced_search')"
# 5. Test via API or Rails console
```
---
## Checklist
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my code
- [x] I have commented on my code, particularly in hard-to-understand
areas
- [x] I have made corresponding changes to the documentation (this PR
description)
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream
modules
---
## Additional Notes
### Requirements
- **OpenSearch/Elasticsearch**: Required for advanced message search
- Set `OPENSEARCH_URL` environment variable
- Example: `export OPENSEARCH_URL=http://localhost:9200`
- **Feature Flags**:
- `advanced_search`: Account-level flag for message advanced search
- `search_with_gin` (optional): Account-level flag for GIN-based SQL
search
### Performance Considerations
- 90-day limit prevents expensive long-range queries on large datasets
- GIN indexes recommended for high-volume search on SQL-based resources
- OpenSearch/Elasticsearch provides faster full-text search for messages
### Breaking Changes
- None. All new parameters are optional and backward compatible.
### Frontend Integration
- Frontend PR tracking advanced search UI will consume these endpoints
- Time range pickers should convert JavaScript `Date` to Unix timestamps
(seconds)
- Date conversion: `Math.floor(date.getTime() / 1000)`
### Error Handling
- Invalid `from` parameter format is silently ignored (filter not
applied)
- Time range exceeding 90 days returns `422` with error message
- Missing `q` parameter returns `422` (existing behavior)
- Unauthorized inbox access is filtered out (no error, just excluded
from results)
---------
Co-authored-by: iamsivin <iamsivin@gmail.com>
Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com>
Co-authored-by: Pranav <pranav@chatwoot.com>
Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>
421 lines
20 KiB
Ruby
421 lines
20 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe 'Search', type: :request do
|
|
let(:account) { create(:account) }
|
|
let(:agent) { create(:user, account: account, role: :agent) }
|
|
|
|
before do
|
|
contact = create(:contact, email: 'test@example.com', account: account)
|
|
conversation = create(:conversation, account: account, contact_id: contact.id)
|
|
create(:message, conversation: conversation, account: account, content: 'test1')
|
|
create(:message, conversation: conversation, account: account, content: 'test2')
|
|
create(:contact_inbox, contact_id: contact.id, inbox_id: conversation.inbox.id)
|
|
create(:inbox_member, user: agent, inbox: conversation.inbox)
|
|
|
|
# Create articles for testing
|
|
portal = create(:portal, account: account)
|
|
create(:article, title: 'Test Article Guide', content: 'This is a test article content',
|
|
account: account, portal: portal, author: agent, status: 'published')
|
|
end
|
|
|
|
describe 'GET /api/v1/accounts/{account.id}/search' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
get "/api/v1/accounts/#{account.id}/search", params: { q: 'test' }
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
it 'returns all conversations with messages containing the search query' do
|
|
get "/api/v1/accounts/#{account.id}/search",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
expect(response_data[:payload][:messages].first[:content]).to eq 'test2'
|
|
expect(response_data[:payload].keys).to contain_exactly(:contacts, :conversations, :messages, :articles)
|
|
expect(response_data[:payload][:messages].length).to eq 2
|
|
expect(response_data[:payload][:conversations].length).to eq 1
|
|
expect(response_data[:payload][:contacts].length).to eq 1
|
|
expect(response_data[:payload][:articles].length).to eq 1
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'GET /api/v1/accounts/{account.id}/search/contacts' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
get "/api/v1/accounts/#{account.id}/search/contacts", params: { q: 'test' }
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
it 'returns all conversations with messages containing the search query' do
|
|
get "/api/v1/accounts/#{account.id}/search/contacts",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
expect(response_data[:payload].keys).to contain_exactly(:contacts)
|
|
expect(response_data[:payload][:contacts].length).to eq 1
|
|
end
|
|
|
|
it 'returns last_activity_at in contact search results' do
|
|
contact = create(:contact, email: 'activity@test.com', account: account, last_activity_at: 3.days.ago)
|
|
|
|
get "/api/v1/accounts/#{account.id}/search/contacts",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'activity' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
contact_result = response_data[:payload][:contacts].first
|
|
expect(contact_result[:last_activity_at]).to eq(contact.last_activity_at.to_i)
|
|
expect(contact_result).not_to have_key(:created_at)
|
|
end
|
|
|
|
context 'with advanced_search feature enabled', :opensearch do
|
|
before do
|
|
account.enable_features!('advanced_search')
|
|
end
|
|
|
|
it 'filters contacts by since parameter' do
|
|
create(:contact, email: 'old@test.com', account: account, last_activity_at: 10.days.ago)
|
|
create(:contact, email: 'recent@test.com', account: account, last_activity_at: 2.days.ago)
|
|
|
|
get "/api/v1/accounts/#{account.id}/search/contacts",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test', since: 5.days.ago.to_i },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
contact_emails = response_data[:payload][:contacts].pluck(:email)
|
|
expect(contact_emails).to include('recent@test.com')
|
|
expect(contact_emails).not_to include('old@test.com')
|
|
end
|
|
|
|
it 'filters contacts by until parameter' do
|
|
create(:contact, email: 'old@test.com', account: account, last_activity_at: 10.days.ago)
|
|
create(:contact, email: 'recent@test.com', account: account, last_activity_at: 2.days.ago)
|
|
|
|
get "/api/v1/accounts/#{account.id}/search/contacts",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test', until: 5.days.ago.to_i },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
contact_emails = response_data[:payload][:contacts].pluck(:email)
|
|
expect(contact_emails).to include('old@test.com')
|
|
expect(contact_emails).not_to include('recent@test.com')
|
|
end
|
|
|
|
it 'filters contacts by both since and until parameters' do
|
|
create(:contact, email: 'veryold@test.com', account: account, last_activity_at: 20.days.ago)
|
|
create(:contact, email: 'old@test.com', account: account, last_activity_at: 10.days.ago)
|
|
create(:contact, email: 'recent@test.com', account: account, last_activity_at: 2.days.ago)
|
|
|
|
get "/api/v1/accounts/#{account.id}/search/contacts",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test', since: 15.days.ago.to_i, until: 5.days.ago.to_i },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
contact_emails = response_data[:payload][:contacts].pluck(:email)
|
|
expect(contact_emails).to include('old@test.com')
|
|
expect(contact_emails).not_to include('veryold@test.com', 'recent@test.com')
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'GET /api/v1/accounts/{account.id}/search/conversations' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
get "/api/v1/accounts/#{account.id}/search/conversations", params: { q: 'test' }
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
it 'returns all conversations with messages containing the search query' do
|
|
get "/api/v1/accounts/#{account.id}/search/conversations",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
expect(response_data[:payload].keys).to contain_exactly(:conversations)
|
|
expect(response_data[:payload][:conversations].length).to eq 1
|
|
end
|
|
|
|
context 'with advanced_search feature enabled', :opensearch do
|
|
before do
|
|
account.enable_features!('advanced_search')
|
|
end
|
|
|
|
it 'filters conversations by since parameter' do
|
|
unique_id = SecureRandom.hex(8)
|
|
old_contact = create(:contact, email: "old-#{unique_id}@test.com", account: account)
|
|
recent_contact = create(:contact, email: "recent-#{unique_id}@test.com", account: account)
|
|
old_conversation = create(:conversation, account: account, contact: old_contact)
|
|
recent_conversation = create(:conversation, account: account, contact: recent_contact)
|
|
create(:message, conversation: old_conversation, account: account, content: 'message 1')
|
|
create(:message, conversation: recent_conversation, account: account, content: 'message 2')
|
|
create(:inbox_member, user: agent, inbox: old_conversation.inbox)
|
|
create(:inbox_member, user: agent, inbox: recent_conversation.inbox)
|
|
|
|
# Bypass CURRENT_TIMESTAMP default
|
|
# rubocop:disable Rails/SkipsModelValidations
|
|
Conversation.where(id: old_conversation.id).update_all(last_activity_at: 10.days.ago)
|
|
Conversation.where(id: recent_conversation.id).update_all(last_activity_at: 2.days.ago)
|
|
# rubocop:enable Rails/SkipsModelValidations
|
|
|
|
get "/api/v1/accounts/#{account.id}/search/conversations",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: unique_id, since: 5.days.ago.to_i },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
conversation_display_ids = response_data[:payload][:conversations].pluck(:id)
|
|
expect(conversation_display_ids).to eq([recent_conversation.display_id])
|
|
end
|
|
|
|
it 'filters conversations by until parameter' do
|
|
unique_id = SecureRandom.hex(8)
|
|
old_contact = create(:contact, email: "old-#{unique_id}@test.com", account: account)
|
|
recent_contact = create(:contact, email: "recent-#{unique_id}@test.com", account: account)
|
|
old_conversation = create(:conversation, account: account, contact: old_contact)
|
|
recent_conversation = create(:conversation, account: account, contact: recent_contact)
|
|
create(:message, conversation: old_conversation, account: account, content: 'message 1')
|
|
create(:message, conversation: recent_conversation, account: account, content: 'message 2')
|
|
create(:inbox_member, user: agent, inbox: old_conversation.inbox)
|
|
create(:inbox_member, user: agent, inbox: recent_conversation.inbox)
|
|
|
|
# Bypass CURRENT_TIMESTAMP default
|
|
# rubocop:disable Rails/SkipsModelValidations
|
|
Conversation.where(id: old_conversation.id).update_all(last_activity_at: 10.days.ago)
|
|
Conversation.where(id: recent_conversation.id).update_all(last_activity_at: 2.days.ago)
|
|
# rubocop:enable Rails/SkipsModelValidations
|
|
|
|
get "/api/v1/accounts/#{account.id}/search/conversations",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: unique_id, until: 5.days.ago.to_i },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
conversation_display_ids = response_data[:payload][:conversations].pluck(:id)
|
|
expect(conversation_display_ids).to eq([old_conversation.display_id])
|
|
end
|
|
|
|
it 'filters conversations by both since and until parameters' do
|
|
unique_id = SecureRandom.hex(8)
|
|
very_old_contact = create(:contact, email: "veryold-#{unique_id}@test.com", account: account)
|
|
old_contact = create(:contact, email: "old-#{unique_id}@test.com", account: account)
|
|
recent_contact = create(:contact, email: "recent-#{unique_id}@test.com", account: account)
|
|
very_old_conversation = create(:conversation, account: account, contact: very_old_contact)
|
|
old_conversation = create(:conversation, account: account, contact: old_contact)
|
|
recent_conversation = create(:conversation, account: account, contact: recent_contact)
|
|
create(:message, conversation: very_old_conversation, account: account, content: 'message 1')
|
|
create(:message, conversation: old_conversation, account: account, content: 'message 2')
|
|
create(:message, conversation: recent_conversation, account: account, content: 'message 3')
|
|
create(:inbox_member, user: agent, inbox: very_old_conversation.inbox)
|
|
create(:inbox_member, user: agent, inbox: old_conversation.inbox)
|
|
create(:inbox_member, user: agent, inbox: recent_conversation.inbox)
|
|
|
|
# Bypass CURRENT_TIMESTAMP default
|
|
# rubocop:disable Rails/SkipsModelValidations
|
|
Conversation.where(id: very_old_conversation.id).update_all(last_activity_at: 20.days.ago)
|
|
Conversation.where(id: old_conversation.id).update_all(last_activity_at: 10.days.ago)
|
|
Conversation.where(id: recent_conversation.id).update_all(last_activity_at: 2.days.ago)
|
|
# rubocop:enable Rails/SkipsModelValidations
|
|
|
|
get "/api/v1/accounts/#{account.id}/search/conversations",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: unique_id, since: 15.days.ago.to_i, until: 5.days.ago.to_i },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
conversation_display_ids = response_data[:payload][:conversations].pluck(:id)
|
|
expect(conversation_display_ids).to eq([old_conversation.display_id])
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'GET /api/v1/accounts/{account.id}/search/messages' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
get "/api/v1/accounts/#{account.id}/search/messages", params: { q: 'test' }
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
it 'returns all conversations with messages containing the search query' do
|
|
get "/api/v1/accounts/#{account.id}/search/messages",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
expect(response_data[:payload].keys).to contain_exactly(:messages)
|
|
expect(response_data[:payload][:messages].length).to eq 2
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'GET /api/v1/accounts/{account.id}/search/articles' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
get "/api/v1/accounts/#{account.id}/search/articles", params: { q: 'test' }
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
it 'returns all articles containing the search query' do
|
|
get "/api/v1/accounts/#{account.id}/search/articles",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
expect(response_data[:payload].keys).to contain_exactly(:articles)
|
|
expect(response_data[:payload][:articles].length).to eq 1
|
|
expect(response_data[:payload][:articles].first[:title]).to eq 'Test Article Guide'
|
|
end
|
|
|
|
it 'returns empty results when no articles match the search query' do
|
|
get "/api/v1/accounts/#{account.id}/search/articles",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'nonexistent' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
expect(response_data[:payload].keys).to contain_exactly(:articles)
|
|
expect(response_data[:payload][:articles].length).to eq 0
|
|
end
|
|
|
|
it 'supports pagination' do
|
|
portal = create(:portal, account: account)
|
|
16.times do |i|
|
|
create(:article, title: "Test Article #{i}", account: account, portal: portal, author: agent, status: 'published')
|
|
end
|
|
|
|
get "/api/v1/accounts/#{account.id}/search/articles",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test', page: 1 },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
expect(response_data[:payload][:articles].length).to eq 15 # Default per_page is 15
|
|
end
|
|
|
|
context 'with advanced_search feature enabled', :opensearch do
|
|
before do
|
|
account.enable_features!('advanced_search')
|
|
end
|
|
|
|
it 'filters articles by since parameter' do
|
|
portal = create(:portal, account: account)
|
|
old_article = create(:article, title: 'Old Article test', account: account, portal: portal,
|
|
author: agent, status: 'published', updated_at: 10.days.ago)
|
|
recent_article = create(:article, title: 'Recent Article test', account: account, portal: portal,
|
|
author: agent, status: 'published', updated_at: 2.days.ago)
|
|
|
|
get "/api/v1/accounts/#{account.id}/search/articles",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test', since: 5.days.ago.to_i },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
article_ids = response_data[:payload][:articles].pluck(:id)
|
|
expect(article_ids).to include(recent_article.id)
|
|
expect(article_ids).not_to include(old_article.id)
|
|
end
|
|
|
|
it 'filters articles by until parameter' do
|
|
portal = create(:portal, account: account)
|
|
old_article = create(:article, title: 'Old Article test', account: account, portal: portal,
|
|
author: agent, status: 'published', updated_at: 10.days.ago)
|
|
recent_article = create(:article, title: 'Recent Article test', account: account, portal: portal,
|
|
author: agent, status: 'published', updated_at: 2.days.ago)
|
|
|
|
get "/api/v1/accounts/#{account.id}/search/articles",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test', until: 5.days.ago.to_i },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
article_ids = response_data[:payload][:articles].pluck(:id)
|
|
expect(article_ids).to include(old_article.id)
|
|
expect(article_ids).not_to include(recent_article.id)
|
|
end
|
|
|
|
it 'filters articles by both since and until parameters' do
|
|
portal = create(:portal, account: account)
|
|
very_old_article = create(:article, title: 'Very Old Article test', account: account, portal: portal,
|
|
author: agent, status: 'published', updated_at: 20.days.ago)
|
|
old_article = create(:article, title: 'Old Article test', account: account, portal: portal,
|
|
author: agent, status: 'published', updated_at: 10.days.ago)
|
|
recent_article = create(:article, title: 'Recent Article test', account: account, portal: portal,
|
|
author: agent, status: 'published', updated_at: 2.days.ago)
|
|
|
|
get "/api/v1/accounts/#{account.id}/search/articles",
|
|
headers: agent.create_new_auth_token,
|
|
params: { q: 'test', since: 15.days.ago.to_i, until: 5.days.ago.to_i },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
response_data = JSON.parse(response.body, symbolize_names: true)
|
|
|
|
article_ids = response_data[:payload][:articles].pluck(:id)
|
|
expect(article_ids).to include(old_article.id)
|
|
expect(article_ids).not_to include(very_old_article.id, recent_article.id)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|