## 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>
196 lines
5.2 KiB
Vue
196 lines
5.2 KiB
Vue
<script setup>
|
|
import {
|
|
computed,
|
|
onMounted,
|
|
useTemplateRef,
|
|
ref,
|
|
getCurrentInstance,
|
|
} from 'vue';
|
|
import Icon from 'next/icon/Icon.vue';
|
|
import { timeStampAppendedURL } from 'dashboard/helper/URLHelper';
|
|
import { downloadFile } from '@chatwoot/utils';
|
|
import { useEmitter } from 'dashboard/composables/emitter';
|
|
import { emitter } from 'shared/helpers/mitt';
|
|
|
|
const { attachment } = defineProps({
|
|
attachment: {
|
|
type: Object,
|
|
required: true,
|
|
},
|
|
showTranscribedText: {
|
|
type: Boolean,
|
|
default: true,
|
|
},
|
|
});
|
|
|
|
defineOptions({
|
|
inheritAttrs: false,
|
|
});
|
|
|
|
const timeStampURL = computed(() => {
|
|
return timeStampAppendedURL(attachment.dataUrl);
|
|
});
|
|
|
|
const audioPlayer = useTemplateRef('audioPlayer');
|
|
|
|
const isPlaying = ref(false);
|
|
const isMuted = ref(false);
|
|
const currentTime = ref(0);
|
|
const duration = ref(0);
|
|
const playbackSpeed = ref(1);
|
|
|
|
const { uid } = getCurrentInstance();
|
|
|
|
const onLoadedMetadata = () => {
|
|
duration.value = audioPlayer.value?.duration;
|
|
};
|
|
|
|
const playbackSpeedLabel = computed(() => {
|
|
return `${playbackSpeed.value}x`;
|
|
});
|
|
|
|
// There maybe a chance that the audioPlayer ref is not available
|
|
// When the onLoadMetadata is called, so we need to set the duration
|
|
// value when the component is mounted
|
|
onMounted(() => {
|
|
duration.value = audioPlayer.value?.duration;
|
|
audioPlayer.value.playbackRate = playbackSpeed.value;
|
|
});
|
|
|
|
// Listen for global audio play events and pause if it's not this audio
|
|
useEmitter('pause_playing_audio', currentPlayingId => {
|
|
if (currentPlayingId !== uid && isPlaying.value) {
|
|
try {
|
|
audioPlayer.value.pause();
|
|
} catch {
|
|
/* ignore pause errors */
|
|
}
|
|
isPlaying.value = false;
|
|
}
|
|
});
|
|
|
|
const formatTime = time => {
|
|
if (!time || Number.isNaN(time)) return '00:00';
|
|
const minutes = Math.floor(time / 60);
|
|
const seconds = Math.floor(time % 60);
|
|
return `${minutes.toString().padStart(2, '0')}:${seconds.toString().padStart(2, '0')}`;
|
|
};
|
|
|
|
const toggleMute = () => {
|
|
audioPlayer.value.muted = !audioPlayer.value.muted;
|
|
isMuted.value = audioPlayer.value.muted;
|
|
};
|
|
|
|
const onTimeUpdate = () => {
|
|
currentTime.value = audioPlayer.value?.currentTime;
|
|
};
|
|
|
|
const seek = event => {
|
|
const time = Number(event.target.value);
|
|
audioPlayer.value.currentTime = time;
|
|
currentTime.value = time;
|
|
};
|
|
|
|
const playOrPause = () => {
|
|
if (isPlaying.value) {
|
|
audioPlayer.value.pause();
|
|
isPlaying.value = false;
|
|
} else {
|
|
// Emit event to pause all other audio
|
|
emitter.emit('pause_playing_audio', uid);
|
|
audioPlayer.value.play();
|
|
isPlaying.value = true;
|
|
}
|
|
};
|
|
|
|
const onEnd = () => {
|
|
isPlaying.value = false;
|
|
currentTime.value = 0;
|
|
playbackSpeed.value = 1;
|
|
audioPlayer.value.playbackRate = 1;
|
|
};
|
|
|
|
const changePlaybackSpeed = () => {
|
|
const speeds = [1, 1.5, 2];
|
|
const currentIndex = speeds.indexOf(playbackSpeed.value);
|
|
const nextIndex = (currentIndex + 1) % speeds.length;
|
|
playbackSpeed.value = speeds[nextIndex];
|
|
audioPlayer.value.playbackRate = playbackSpeed.value;
|
|
};
|
|
|
|
const downloadAudio = async () => {
|
|
const { fileType, dataUrl, extension } = attachment;
|
|
downloadFile({ url: dataUrl, type: fileType, extension });
|
|
};
|
|
</script>
|
|
|
|
<template>
|
|
<audio
|
|
ref="audioPlayer"
|
|
controls
|
|
class="hidden"
|
|
playsinline
|
|
@loadedmetadata="onLoadedMetadata"
|
|
@timeupdate="onTimeUpdate"
|
|
@ended="onEnd"
|
|
>
|
|
<source :src="timeStampURL" />
|
|
</audio>
|
|
<div
|
|
v-bind="$attrs"
|
|
class="rounded-xl w-full gap-2 p-1.5 bg-n-alpha-white flex flex-col items-center border border-n-container shadow-[0px_2px_8px_0px_rgba(94,94,94,0.06)]"
|
|
>
|
|
<div class="flex gap-1 w-full flex-1 items-center justify-start">
|
|
<button class="p-0 border-0 size-8" @click="playOrPause">
|
|
<Icon
|
|
v-if="isPlaying"
|
|
class="size-8"
|
|
icon="i-teenyicons-pause-small-solid"
|
|
/>
|
|
<Icon v-else class="size-8" icon="i-teenyicons-play-small-solid" />
|
|
</button>
|
|
<div class="tabular-nums text-xs">
|
|
{{ formatTime(currentTime) }} / {{ formatTime(duration) }}
|
|
</div>
|
|
<div class="flex-1 items-center flex px-2">
|
|
<input
|
|
type="range"
|
|
min="0"
|
|
:max="duration"
|
|
:value="currentTime"
|
|
class="w-full h-1 bg-n-slate-12/40 rounded-lg appearance-none cursor-pointer accent-current"
|
|
@input="seek"
|
|
/>
|
|
</div>
|
|
<button
|
|
class="border-0 w-10 h-6 grid place-content-center bg-n-alpha-2 hover:bg-alpha-3 rounded-2xl"
|
|
@click="changePlaybackSpeed"
|
|
>
|
|
<span class="text-xs text-n-slate-11 font-medium">
|
|
{{ playbackSpeedLabel }}
|
|
</span>
|
|
</button>
|
|
<button
|
|
class="p-0 border-0 size-8 grid place-content-center"
|
|
@click="toggleMute"
|
|
>
|
|
<Icon v-if="isMuted" class="size-4" icon="i-lucide-volume-off" />
|
|
<Icon v-else class="size-4" icon="i-lucide-volume-2" />
|
|
</button>
|
|
<button
|
|
class="p-0 border-0 size-8 grid place-content-center"
|
|
@click="downloadAudio"
|
|
>
|
|
<Icon class="size-4" icon="i-lucide-download" />
|
|
</button>
|
|
</div>
|
|
|
|
<div
|
|
v-if="attachment.transcribedText && showTranscribedText"
|
|
class="text-n-slate-12 p-3 text-sm bg-n-alpha-1 rounded-lg w-full break-words"
|
|
>
|
|
{{ attachment.transcribedText }}
|
|
</div>
|
|
</div>
|
|
</template>
|