## 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>
272 lines
7.4 KiB
Vue
272 lines
7.4 KiB
Vue
<script setup>
|
|
import { computed, ref, defineModel } from 'vue';
|
|
import { useToggle } from '@vueuse/core';
|
|
import { useI18n } from 'vue-i18n';
|
|
import { vOnClickOutside } from '@vueuse/components';
|
|
import {
|
|
subDays,
|
|
subMonths,
|
|
subYears,
|
|
startOfDay,
|
|
endOfDay,
|
|
format,
|
|
getUnixTime,
|
|
fromUnixTime,
|
|
} from 'date-fns';
|
|
import { DATE_RANGE_TYPES } from '../helpers/searchHelper';
|
|
|
|
import Button from 'dashboard/components-next/button/Button.vue';
|
|
import DropdownMenu from 'dashboard/components-next/dropdown-menu/DropdownMenu.vue';
|
|
|
|
const emit = defineEmits(['change']);
|
|
const modelValue = defineModel({
|
|
type: Object,
|
|
default: () => ({ type: null, from: null, to: null }),
|
|
});
|
|
|
|
const { t } = useI18n();
|
|
const [showDropdown, toggleDropdown] = useToggle();
|
|
|
|
const customFrom = ref('');
|
|
const customTo = ref('');
|
|
const rangeType = ref(DATE_RANGE_TYPES.BETWEEN);
|
|
|
|
// Calculate min date (90 days ago) for date inputs
|
|
const minDate = computed(() => format(subDays(new Date(), 90), 'yyyy-MM-dd'));
|
|
const maxDate = computed(() => format(new Date(), 'yyyy-MM-dd'));
|
|
|
|
// Check if both custom date inputs have values
|
|
const hasCustomDates = computed(() => customFrom.value && customTo.value);
|
|
|
|
const DATE_FILTER_ACTIONS = {
|
|
PRESET: 'preset',
|
|
SELECT: 'select',
|
|
};
|
|
|
|
const PRESET_RANGES = computed(() => [
|
|
{
|
|
label: t('SEARCH.DATE_RANGE.LAST_7_DAYS'),
|
|
value: DATE_RANGE_TYPES.LAST_7_DAYS,
|
|
days: 7,
|
|
},
|
|
{
|
|
label: t('SEARCH.DATE_RANGE.LAST_30_DAYS'),
|
|
value: DATE_RANGE_TYPES.LAST_30_DAYS,
|
|
days: 30,
|
|
},
|
|
{
|
|
label: t('SEARCH.DATE_RANGE.LAST_60_DAYS'),
|
|
value: DATE_RANGE_TYPES.LAST_60_DAYS,
|
|
days: 60,
|
|
},
|
|
{
|
|
label: t('SEARCH.DATE_RANGE.LAST_90_DAYS'),
|
|
value: DATE_RANGE_TYPES.LAST_90_DAYS,
|
|
days: 90,
|
|
},
|
|
]);
|
|
|
|
const computeDateRange = config => {
|
|
const end = endOfDay(new Date());
|
|
let start;
|
|
|
|
if (config.days) {
|
|
start = startOfDay(subDays(end, config.days));
|
|
} else if (config.months) {
|
|
start = startOfDay(subMonths(end, config.months));
|
|
} else {
|
|
start = startOfDay(subYears(end, config.years));
|
|
}
|
|
|
|
return { type: config.value, from: getUnixTime(start), to: getUnixTime(end) };
|
|
};
|
|
|
|
const selectedValue = computed(() => {
|
|
const { from, to, type } = modelValue.value || {};
|
|
if (!from && !to && !type) return '';
|
|
return type || DATE_RANGE_TYPES.CUSTOM;
|
|
});
|
|
|
|
const menuItems = computed(() =>
|
|
PRESET_RANGES.value.map(item => ({
|
|
...item,
|
|
action: DATE_FILTER_ACTIONS.PRESET,
|
|
isSelected: selectedValue.value === item.value,
|
|
}))
|
|
);
|
|
|
|
const applySelection = ({ type, from, to }) => {
|
|
const newValue = { type, from, to };
|
|
modelValue.value = newValue;
|
|
emit('change', newValue);
|
|
};
|
|
|
|
const clearFilter = () => {
|
|
applySelection({ type: null, from: null, to: null });
|
|
customFrom.value = '';
|
|
customTo.value = '';
|
|
toggleDropdown(false);
|
|
};
|
|
|
|
const handlePresetAction = item => {
|
|
if (selectedValue.value === item.value) {
|
|
clearFilter();
|
|
return;
|
|
}
|
|
customFrom.value = '';
|
|
customTo.value = '';
|
|
applySelection(computeDateRange(item));
|
|
toggleDropdown(false);
|
|
};
|
|
|
|
const applyCustomRange = () => {
|
|
const customFromDate = customFrom.value
|
|
? startOfDay(new Date(customFrom.value))
|
|
: null;
|
|
const customToDate = customTo.value
|
|
? endOfDay(new Date(customTo.value))
|
|
: null;
|
|
|
|
// Only BETWEEN mode - require both dates
|
|
if (customFromDate && customToDate) {
|
|
applySelection({
|
|
type: DATE_RANGE_TYPES.BETWEEN,
|
|
from: getUnixTime(customFromDate),
|
|
to: getUnixTime(customToDate),
|
|
});
|
|
toggleDropdown(false);
|
|
}
|
|
};
|
|
|
|
const clearCustomRange = () => {
|
|
customFrom.value = '';
|
|
customTo.value = '';
|
|
};
|
|
|
|
const formatDate = timestamp => format(fromUnixTime(timestamp), 'MMM d, yyyy'); // (e.g., "Jan 15, 2024")
|
|
|
|
const selectedLabel = computed(() => {
|
|
const prefix = t('SEARCH.DATE_RANGE.TIME_RANGE');
|
|
if (!selectedValue.value) return prefix;
|
|
|
|
// Check if it's a preset
|
|
const preset = PRESET_RANGES.value.find(p => p.value === selectedValue.value);
|
|
if (preset) return `${prefix}: ${preset.label}`;
|
|
|
|
// Custom range - only BETWEEN mode with both dates
|
|
const { from, to } = modelValue.value;
|
|
if (from && to) return `${prefix}: ${formatDate(from)} - ${formatDate(to)}`;
|
|
|
|
return `${prefix}: ${t('SEARCH.DATE_RANGE.CUSTOM_RANGE')}`;
|
|
});
|
|
|
|
const CUSTOM_RANGE_TYPES = [DATE_RANGE_TYPES.BETWEEN, DATE_RANGE_TYPES.CUSTOM];
|
|
|
|
const onToggleDropdown = () => {
|
|
if (!showDropdown.value) {
|
|
const { type, from, to } = modelValue.value || {};
|
|
|
|
rangeType.value = CUSTOM_RANGE_TYPES.includes(type)
|
|
? type
|
|
: DATE_RANGE_TYPES.BETWEEN;
|
|
|
|
if (CUSTOM_RANGE_TYPES.includes(type)) {
|
|
try {
|
|
customFrom.value = from ? format(fromUnixTime(from), 'yyyy-MM-dd') : '';
|
|
customTo.value = to ? format(fromUnixTime(to), 'yyyy-MM-dd') : '';
|
|
} catch {
|
|
customFrom.value = '';
|
|
customTo.value = '';
|
|
}
|
|
} else {
|
|
customFrom.value = '';
|
|
customTo.value = '';
|
|
}
|
|
}
|
|
toggleDropdown();
|
|
};
|
|
</script>
|
|
|
|
<template>
|
|
<div
|
|
v-on-click-outside="() => toggleDropdown(false)"
|
|
class="relative flex items-center group min-w-0 max-w-full"
|
|
>
|
|
<Button
|
|
sm
|
|
slate
|
|
:variant="showDropdown ? 'faded' : 'solid'"
|
|
:label="selectedLabel"
|
|
class="group-hover:bg-n-alpha-2 max-w-full"
|
|
trailing-icon
|
|
icon="i-lucide-chevron-down"
|
|
@click="onToggleDropdown()"
|
|
/>
|
|
<DropdownMenu
|
|
v-if="showDropdown"
|
|
:menu-items="menuItems"
|
|
class="mt-1 ltr:left-0 rtl:right-0 top-full w-64"
|
|
@action="handlePresetAction"
|
|
>
|
|
<template #footer>
|
|
<div class="h-px bg-n-strong" />
|
|
<div class="flex flex-col gap-2">
|
|
<div class="flex items-center justify-between gap-2 px-1 h-9">
|
|
<span class="text-sm text-n-slate-11">
|
|
{{ t('SEARCH.DATE_RANGE.CUSTOM_RANGE') }}
|
|
</span>
|
|
<span class="text-sm text-n-slate-12">
|
|
{{ t('SEARCH.DATE_RANGE.CREATED_BETWEEN') }}
|
|
</span>
|
|
</div>
|
|
|
|
<input
|
|
v-model="customFrom"
|
|
type="date"
|
|
:min="minDate"
|
|
:max="customTo || maxDate"
|
|
class="!w-full !mb-0 !rounded-lg !bg-n-alpha-black2 !outline-n-strong -outline-offset-1 !px-3 !py-2 !text-sm text-n-slate-12 !h-8"
|
|
/>
|
|
|
|
<div class="flex items-center gap-3 h-5 px-1">
|
|
<div class="flex-1 h-px bg-n-weak" />
|
|
<span class="text-sm text-n-slate-11">
|
|
{{ t('SEARCH.DATE_RANGE.AND') }}
|
|
</span>
|
|
<div class="flex-1 h-px bg-n-weak" />
|
|
</div>
|
|
|
|
<input
|
|
v-model="customTo"
|
|
type="date"
|
|
:min="customFrom || minDate"
|
|
:max="maxDate"
|
|
class="!w-full !mb-0 !rounded-lg !bg-n-alpha-black2 !outline-n-strong -outline-offset-1 !px-3 !py-2 !text-sm text-n-slate-12 !h-8"
|
|
/>
|
|
|
|
<div class="flex items-center gap-2 mt-2">
|
|
<Button
|
|
sm
|
|
slate
|
|
faded
|
|
:label="t('SEARCH.DATE_RANGE.CLEAR_FILTER')"
|
|
:disabled="!hasCustomDates"
|
|
class="flex-1 justify-center"
|
|
@click="clearCustomRange"
|
|
/>
|
|
<Button
|
|
sm
|
|
solid
|
|
color="blue"
|
|
:label="t('SEARCH.DATE_RANGE.APPLY')"
|
|
:disabled="!hasCustomDates"
|
|
class="flex-1 justify-center"
|
|
@click="applyCustomRange"
|
|
/>
|
|
</div>
|
|
</div>
|
|
</template>
|
|
</DropdownMenu>
|
|
</div>
|
|
</template>
|