brobert
/
taskbot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Compare commits

base: brobert:0ecd0a6f8e1cb55fada31daa6779129ede33eef9
Branches Tags
brobert:main
..
compare: brobert:cf6526661faa54af190c3a5f60ab334ad5019329
Branches Tags
brobert:main

No commits in common. '0ecd0a6f8e1cb55fada31daa6779129ede33eef9' and 'cf6526661faa54af190c3a5f60ab334ad5019329' have entirely different histories.
0ecd0a6f8e ... cf6526661f

3 changed files with 64 additions and 259 deletions
Show Stats

116
README.md
Unescape Escape View File

@ -1,21 +1,13 @@
# Task WhatsApp Chatbot # Task WhatsApp Chatbot
A WhatsApp chatbot for task management, designed to work with Evolution API in a secure internal network environment. ## Future Steps
## 📌 Overview ### Core Principles
This service provides a WhatsApp interface for task management within WhatsApp groups. It: 1. **Trust-but-Verify Approach**: Leverage WhatsApp's message metadata to minimize API calls while maintaining security
- Listens for `/tarea` commands in WhatsApp groups 2. **Progressive Validation**: Verify users naturally through interactions rather than upfront checks
- Stores tasks in a SQLite database 3. **Background Reconciliation**: Use periodic syncs to maintain data accuracy without impacting real-time performance
- Manages user permissions and group membership
- Integrates with Evolution API for WhatsApp connectivity
## 🔐 Security Model ### Message Processing Flow
- **Internal Networking**: The webhook only accepts connections from Evolution API via internal Docker networking
- **Environment Variables**: Sensitive configuration is managed through environment variables
- **Group Restrictions**: Only operates within pre-approved WhatsApp groups
- **Input Validation**: Sanitizes and validates all user inputs
## 🧱 Architecture
```mermaid ```mermaid
graph TD graph TD
A[Webhook Received] --> B{Valid Payload?} A[Webhook Received] --> B{Valid Payload?}
@ -32,77 +24,25 @@ graph TD
H -->|No| J[Process Command] H -->|No| J[Process Command]
``` ```
## ✅ Current Features ### Alias for actions
- Task creation with optional due dates
- Basic command parsing (`/tarea nueva`, `/tarea mostrar`) - I want that, when an user sends `/tarea` to the bot, with no extra arguments, it should show all the pending tasks for the user in a private message (the same behaviour as calling `/tarea mostrar`
- Group membership tracking
- SQLite database persistence ### Periodic Sync Strategy
- Health check endpoint 1. **Rotating Group Check**:
- Environment validation - Verify 1-2 groups per sync cycle
- Input validation for dates and commands - Prioritize recently active groups
2. **User Reconciliation**:
## 🛠️ Setup - Add newly discovered users
### Environment Variables - Update `last_confirmed` for active users
```env 3. **Optimizations**:
EVOLUTION_API_URL=http://evolution-api:3000 - Cache active group IDs in memory
EVOLUTION_API_KEY=your-api-key - Batch database writes
EVOLUTION_API_INSTANCE=main - Exponential backoff for API failures
WHATSAPP_COMMUNITY_ID=your-community-id
CHATBOT_PHONE_NUMBER=1234567890 ### Security Considerations
WEBHOOK_URL=https://your-webhook.com - Reject messages from:
PORT=3007 - Non-community groups
NODE_ENV=production - Unknown private chats
``` - Implement rate limiting
- Maintain audit logs of verification events
### Development Setup
```bash
# Install dependencies
bun install
# Start development server
bun run dev
# Run tests
bun test
```
## 📅 Roadmap
### High Priority
- [ ] Implement ResponseQueue processing logic with retries
- [ ] Add database schema validation and migrations
- [ ] Add error recovery with transaction rollback
- [ ] Implement group sync delta updates
### Medium Priority
- [ ] Add task assignment and ownership
- [ ] Implement user permissions system
- [ ] Add rate limiting for API calls
- [ ] Create task history tracking
### Low Priority
- [ ] Add task reminders system
- [ ] Implement multi-language support
- [ ] Create analytics dashboard
- [ ] Add user-friendly task list UI
## 🧪 Testing
### Running Tests
```bash
bun test
```
### Test Coverage
- Webhook validation
- Command parsing
- Environment checks
- Basic error handling
- Input validation
## 🧑‍💻 Contributing
1. Fork the repository
2. Create a feature branch
3. Add tests for new functionality
4. Submit a pull request
## 📚 Documentation
For detailed API documentation and architecture decisions, see the [docs/](docs/) directory.

52
src/server.ts
Unescape Escape View File

@ -41,6 +41,12 @@ export class WebhookServer {
if (process.env.NODE_ENV !== 'test') { if (process.env.NODE_ENV !== 'test') {
console.log('ℹ️ Incoming webhook request:') console.log('ℹ️ Incoming webhook request:')
// console.log('ℹ️ Incoming webhook request:', {
// method: request.method,
// path: url.pathname,
// time: new Date().toISOString()
// });
} }
// 1. Method validation // 1. Method validation
@ -77,12 +83,10 @@ export class WebhookServer {
switch (payload.event) { switch (payload.event) {
case 'messages.upsert': case 'messages.upsert':
if (process.env.NODE_ENV !== 'test') { console.log('ℹ️ Handling message upsert:', {
console.log('ℹ️ Handling message upsert:', { groupId: payload.data?.key?.remoteJid,
groupId: payload.data?.key?.remoteJid, message: payload.data?.message?.conversation
message: payload.data?.message?.conversation });
});
}
await WebhookServer.handleMessageUpsert(payload.data); await WebhookServer.handleMessageUpsert(payload.data);
break; break;
// Other events will be added later // Other events will be added later
@ -101,10 +105,8 @@ export class WebhookServer {
static async handleMessageUpsert(data: any) { static async handleMessageUpsert(data: any) {
if (!data?.key?.remoteJid || !data.message || !data.message.conversation) { if (!data?.key?.remoteJid || !data.message || !data.message.conversation) {
if (process.env.NODE_ENV !== 'test') { console.log('⚠️ Invalid message format - missing required fields');
console.log('⚠️ Invalid message format - missing required fields'); console.log(data);
console.log(data);
}
return; return;
} }
@ -127,9 +129,6 @@ export class WebhookServer {
let dueDate = ''; let dueDate = '';
// Process remaining parts // Process remaining parts
const dateCandidates = [];
// First collect all valid future dates
for (let i = 2; i < commandParts.length; i++) { for (let i = 2; i < commandParts.length; i++) {
const part = commandParts[i]; const part = commandParts[i];
// Check for date (YYYY-MM-DD) // Check for date (YYYY-MM-DD)
@ -139,31 +138,16 @@ export class WebhookServer {
today.setHours(0, 0, 0, 0); today.setHours(0, 0, 0, 0);
if (date >= today) { if (date >= today) {
dateCandidates.push({ index: i, date, part }); dueDate = part;
} else {
descriptionParts.push(part); // Keep past dates in description
} }
} } else {
}
// Use the last valid future date as due date
if (dateCandidates.length > 0) {
const lastDate = dateCandidates[dateCandidates.length - 1];
dueDate = lastDate.part;
// Add all parts except the last date to description
for (let i = 2; i < commandParts.length; i++) {
// Skip the due date part
if (i === lastDate.index) continue;
// Add to description if it's a date candidate but not selected or a regular part
const part = commandParts[i];
descriptionParts.push(part); descriptionParts.push(part);
} }
} else {
// No valid future dates, add all parts to description
descriptionParts = commandParts.slice(2);
} }
const description = descriptionParts.join(' ').trim(); const description = descriptionParts.join(' ');
console.log('🔍 Detected /tarea command:', { console.log('🔍 Detected /tarea command:', {
timestamp: new Date().toISOString(), timestamp: new Date().toISOString(),
@ -172,7 +156,7 @@ export class WebhookServer {
rawMessage: messageText rawMessage: messageText
}); });
const mentions = data.message?.contextInfo?.mentionedJid || []; const mentions = data.contextInfo?.mentionedJid || [];
console.log('✅ Successfully parsed command:', { console.log('✅ Successfully parsed command:', {
action, action,
description, description,

155
tests/unit/server.test.ts
Unescape Escape View File

@ -223,12 +223,6 @@ describe('WebhookServer', () => {
} }
}); });
function getFutureDate(days: number): string {
const date = new Date();
date.setDate(date.getDate() + days);
return date.toISOString().split('T')[0];
}
describe('/tarea command logging', () => { describe('/tarea command logging', () => {
let consoleSpy: any; let consoleSpy: any;
@ -274,7 +268,6 @@ describe('WebhookServer', () => {
}); });
test('should log command with due date', async () => { test('should log command with due date', async () => {
const futureDate = getFutureDate(3); // Get date 3 days in future
const payload = { const payload = {
event: 'messages.upsert', event: 'messages.upsert',
instance: 'test-instance', instance: 'test-instance',
@ -284,7 +277,7 @@ describe('WebhookServer', () => {
participant: 'user123@s.whatsapp.net' participant: 'user123@s.whatsapp.net'
}, },
message: { message: {
conversation: `/tarea nueva Finish project @user2 ${futureDate}`, conversation: '/tarea nueva Finish project @user2 2025-04-30',
contextInfo: { contextInfo: {
mentionedJid: ['user2@s.whatsapp.net'] mentionedJid: ['user2@s.whatsapp.net']
} }
@ -295,25 +288,24 @@ describe('WebhookServer', () => {
await WebhookServer.handleRequest(createTestRequest(payload)); await WebhookServer.handleRequest(createTestRequest(payload));
// Verify the two command-related log calls // Verify the two command-related log calls
expect(consoleSpy).toHaveBeenCalledTimes(2); expect(consoleSpy).toHaveBeenCalledWith(
'🔍 Detected /tarea command:',
// First call should be the command detection expect.objectContaining({
expect(consoleSpy.mock.calls[0][0]).toBe('🔍 Detected /tarea command:'); from: 'user123@s.whatsapp.net',
expect(consoleSpy.mock.calls[0][1]).toEqual({ group: 'group123@g.us',
timestamp: expect.any(String), rawMessage: '/tarea nueva Finish project @user2 2025-04-30'
from: 'user123@s.whatsapp.net', })
group: 'group123@g.us', );
rawMessage: `/tarea nueva Finish project @user2 ${futureDate}`
});
// Second call should be the successful parsing expect(consoleSpy).toHaveBeenCalledWith(
expect(consoleSpy.mock.calls[1][0]).toBe('✅ Successfully parsed command:'); '✅ Successfully parsed command:',
expect(consoleSpy.mock.calls[1][1]).toEqual({ expect.objectContaining({
action: 'nueva', action: 'nueva',
description: 'Finish project @user2', description: 'Finish project @user2',
dueDate: futureDate, dueDate: '2025-04-30',
mentionCount: 1 mentionCount: expect.any(Number)
}); })
);
}); });
}); });
@ -335,115 +327,4 @@ describe('WebhookServer', () => {
expect(response.status).toBe(200); expect(response.status).toBe(200);
expect(mockAdd).toHaveBeenCalled(); expect(mockAdd).toHaveBeenCalled();
}); });
test('should handle multiple dates in command (use last one as due date)', async () => {
const futureDate1 = getFutureDate(3);
const futureDate2 = getFutureDate(5);
const payload = {
event: 'messages.upsert',
instance: 'test-instance',
data: {
key: {
remoteJid: 'group-id@g.us',
participant: 'sender-id@s.whatsapp.net'
},
message: {
conversation: `/tarea nueva Test task ${futureDate1} some text ${futureDate2}`
}
}
};
await WebhookServer.handleRequest(createTestRequest(payload));
expect(console.log).toHaveBeenCalledWith(
'✅ Successfully parsed command:',
expect.objectContaining({
description: `Test task ${futureDate1} some text`,
dueDate: futureDate2
})
);
});
test('should ignore past dates as due dates', async () => {
const pastDate = '2020-01-01';
const futureDate = getFutureDate(2);
const payload = {
event: 'messages.upsert',
instance: 'test-instance',
data: {
key: {
remoteJid: 'group-id@g.us',
participant: 'sender-id@s.whatsapp.net'
},
message: {
conversation: `/tarea nueva Test task ${pastDate} more text ${futureDate}`
}
}
};
await WebhookServer.handleRequest(createTestRequest(payload));
expect(console.log).toHaveBeenCalledWith(
'✅ Successfully parsed command:',
expect.objectContaining({
description: `Test task ${pastDate} more text`,
dueDate: futureDate
})
);
});
test('should handle multiple past dates correctly', async () => {
const pastDate1 = '2020-01-01';
const pastDate2 = '2021-01-01';
const payload = {
event: 'messages.upsert',
instance: 'test-instance',
data: {
key: {
remoteJid: 'group-id@g.us',
participant: 'sender-id@s.whatsapp.net'
},
message: {
conversation: `/tarea nueva Test task ${pastDate1} and ${pastDate2}`
}
}
};
await WebhookServer.handleRequest(createTestRequest(payload));
expect(console.log).toHaveBeenCalledWith(
'✅ Successfully parsed command:',
expect.objectContaining({
description: `Test task ${pastDate1} and ${pastDate2}`,
dueDate: 'none'
})
);
});
test('should handle mixed valid and invalid date formats', async () => {
const futureDate = getFutureDate(2);
const payload = {
event: 'messages.upsert',
instance: 'test-instance',
data: {
key: {
remoteJid: 'group-id@g.us',
participant: 'sender-id@s.whatsapp.net'
},
message: {
conversation: `/tarea nueva Test task 2023-13-01 (invalid) ${futureDate} 25/12/2023 (invalid)`
}
}
};
await WebhookServer.handleRequest(createTestRequest(payload));
expect(console.log).toHaveBeenCalledWith(
'✅ Successfully parsed command:',
expect.objectContaining({
description: 'Test task 2023-13-01 (invalid) 25/12/2023 (invalid)',
dueDate: futureDate
})
);
});
}); });

Write Preview
Loading…
Cancel
Save