# Notifications > In-app and external notifications (Planned Feature) ## ๐Ÿ“‹ Overview Notifications keep users informed about important events such as test failures, analysis completions, and project updates through multiple channels including in-app, email, and Slack. ## ๐ŸŽฏ Current Status **Status**: ๐Ÿ“‹ Planned (Phase 4) Notification system is not yet implemented. This is planned as part of the advanced features phase. ## ๐Ÿ—๏ธ Planned Architecture ### Database Schema **notifications table**: ```typescript { id: string userId: string type: 'test_failure' | 'analysis_complete' | 'project_update' | 'mention' title: string message: string data: object // Additional context read: boolean readAt: Date? actionUrl: string? // Link to relevant page createdAt: Date } ``` **notificationSettings table**: ```typescript { id: string userId: string channel: 'in_app' | 'email' | 'slack' | 'webhook' events: string[] // Which events to notify about enabled: boolean config: object // Channel-specific config createdAt: Date updatedAt: Date } ``` ## ๐Ÿ“ฌ Notification Channels (Planned) ### In-App Notifications **Features**: - Real-time updates via WebSocket - Notification bell with badge count - Toast notifications for important events - Notification center/inbox **Implementation**: ```typescript // WebSocket connection const ws = new WebSocket(`wss://api.yourdomain.com/notifications`) ws.onmessage = (event) => { const notification = JSON.parse(event.data) // Show toast toast({ title: notification.title, description: notification.message, action: notification.actionUrl ? ( ) : undefined }) // Update badge count setBadgeCount(prev => prev + 1) } ``` ### Email Notifications **Templates**: ```html

Test Run Failed

Your test run for {{ projectName }} has failed.

Total Tests: {{ totalTests }}
Failed: {{ failedTests }}
Pass Rate: {{ passRate }}%
View Details ``` **Configuration**: ```bash # .env SMTP_HOST=smtp.sendgrid.net SMTP_PORT=587 SMTP_USER=apikey SMTP_PASSWORD=SG.xxxxx SMTP_FROM=notifications@yourdomain.com ``` ### Slack Notifications **Setup**: 1. Create Slack app 2. Add incoming webhook 3. Store webhook URL in user settings **Message format**: ```json { "blocks": [ { "type": "header", "text": { "type": "plain_text", "text": "๐Ÿšจ Test Run Failed" } }, { "type": "section", "fields": [ { "type": "mrkdwn", "text": "*Project:*\nMy Project" }, { "type": "mrkdwn", "text": "*Failed Tests:*\n5/50" } ] }, { "type": "actions", "elements": [ { "type": "button", "text": { "type": "plain_text", "text": "View Details" }, "url": "https://app.yourdomain.com/runs/123" } ] } ] } ``` ## ๐Ÿ”Œ API Reference (Planned) ### Get Notifications ```typescript const notifications = await trpc.notifications.list.query({ read: false, // unread only limit: 20 }) // Response { notifications: [ { id: 'notif_123', type: 'test_failure', title: 'Test Run Failed', message: 'Your test run for Project X failed with 5 errors', data: { runId: 'run_456', projectId: 'proj_789' }, actionUrl: '/dashboard/projects/proj_789/runs/run_456', read: false, createdAt: '2024-01-01T00:00:00Z' } ], unreadCount: 12 } ``` ### Mark as Read ```typescript await trpc.notifications.markRead.mutate({ notificationId: 'notif_123' }) // Or mark all as read await trpc.notifications.markAllRead.mutate() ``` ### Get Notification Settings ```typescript const settings = await trpc.notifications.getSettings.query() // Response { settings: [ { channel: 'email', enabled: true, events: ['test_failure', 'analysis_complete'], config: { email: 'user@example.com' } }, { channel: 'slack', enabled: false, events: ['test_failure'], config: { webhookUrl: 'https://hooks.slack.com/...' } } ] } ``` ### Update Settings ```typescript await trpc.notifications.updateSettings.mutate({ channel: 'email', enabled: true, events: ['test_failure', 'test_success', 'analysis_complete'] }) ``` ## ๐ŸŽจ Frontend Implementation (Planned) ### Notification Bell ```tsx export function NotificationBell() { const { data } = trpc.notifications.list.useQuery({ read: false }) const unreadCount = data?.unreadCount || 0 return (

Notifications

{unreadCount > 0 && ( )}
{data?.notifications.map((notification) => ( ))}
) } ``` ### Notification Item ```tsx interface NotificationItemProps { notification: Notification } export function NotificationItem({ notification }: NotificationItemProps) { const markRead = trpc.notifications.markRead.useMutation() const handleClick = () => { if (!notification.read) { markRead.mutate({ notificationId: notification.id }) } if (notification.actionUrl) { navigate(notification.actionUrl) } } return (

{notification.title}

{notification.message}

{formatDistanceToNow(notification.createdAt)} ago

{!notification.read && (
)}
) } ``` ### Notification Settings Page ```tsx export function NotificationSettings() { const { data } = trpc.notifications.getSettings.useQuery() const updateSettings = trpc.notifications.updateSettings.useMutation() return (

Notification Settings

Email Notifications
updateSettings.mutate({ channel: 'email', enabled }) } />
{['test_failure', 'test_success', 'analysis_complete'].map((event) => (
{ const events = checked ? [...data.email.events, event] : data.email.events.filter(e => e !== event) updateSettings.mutate({ channel: 'email', events }) }} />
))}
Slack Notifications {data?.slack?.webhookUrl ? (
{/* Event selection similar to email */}
) : ( )}
) } ``` ## ๐Ÿ”” Event Types (Planned) ### Test-Related - `test_run.started` - `test_run.completed` - `test_run.failed` - `test_coverage.threshold_failed` ### Analysis-Related - `analysis.completed` - `analysis.failed` - `test_candidates.found` ### Project-Related - `project.created` - `project.updated` - `project.deleted` - `project.member_added` ### Organization-Related - `org.member_added` - `org.member_removed` - `org.role_changed` ## ๐Ÿงช Testing Notifications ```typescript describe('Notifications', () => { it('creates notification on test failure', async () => { await createTestRun({ status: 'FAILED', projectId: 'proj_123' }) const notifications = await db.query.notifications.findMany({ where: eq(notifications.type, 'test_failure') }) expect(notifications.length).toBeGreaterThan(0) }) }) ``` ## ๐Ÿ”— Related Documentation - **Webhooks**: [Programmatic notifications](./webhooks.md) - **Projects**: [Project settings](./projects.md) - **Test Execution**: [Test run events](./test-execution.md) --- *Features section complete! Continue with [Contributing](../contributing/README.md) โ†’*