mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-05-08 05:19:48 -05:00
Dries Peeters
a18de04a6a
Implement comprehensive webhook system supporting 40+ event types with automatic retries, HMAC signatures, delivery tracking, REST API, and admin UI. Integrates with Activity logging for automatic event triggering. - Database: Add webhooks and webhook_deliveries tables (migration 046) - API: Full CRUD endpoints with read:webhooks/write:webhooks scopes - UI: Admin interface for webhook management and testing - Service: Automatic retry with exponential backoff every 5 minutes - Security: HMAC-SHA256 signature verification - Tests: Model and service tests included - Docs: Complete integration guide with examples
105 lines
5.3 KiB
Python
105 lines
5.3 KiB
Python
"""Add webhooks system for integrations
|
|
|
|
Revision ID: 046
|
|
Revises: 045
|
|
Create Date: 2025-01-23
|
|
|
|
"""
|
|
from alembic import op
|
|
import sqlalchemy as sa
|
|
from sqlalchemy.dialects import postgresql
|
|
|
|
|
|
# revision identifiers, used by Alembic.
|
|
revision = '046'
|
|
down_revision = '045'
|
|
branch_labels = None
|
|
depends_on = None
|
|
|
|
|
|
def upgrade():
|
|
"""Create webhooks and webhook_deliveries tables"""
|
|
|
|
# Create webhooks table
|
|
op.create_table('webhooks',
|
|
sa.Column('id', sa.Integer(), nullable=False),
|
|
sa.Column('name', sa.String(length=200), nullable=False),
|
|
sa.Column('description', sa.Text(), nullable=True),
|
|
sa.Column('url', sa.String(length=500), nullable=False),
|
|
sa.Column('secret', sa.String(length=128), nullable=True),
|
|
sa.Column('events', sa.JSON(), nullable=False, server_default='[]'),
|
|
sa.Column('http_method', sa.String(length=10), nullable=False, server_default='POST'),
|
|
sa.Column('content_type', sa.String(length=50), nullable=False, server_default='application/json'),
|
|
sa.Column('headers', sa.JSON(), nullable=True),
|
|
sa.Column('is_active', sa.Boolean(), nullable=False, server_default='1'),
|
|
sa.Column('user_id', sa.Integer(), nullable=False),
|
|
sa.Column('max_retries', sa.Integer(), nullable=False, server_default='3'),
|
|
sa.Column('retry_delay_seconds', sa.Integer(), nullable=False, server_default='60'),
|
|
sa.Column('timeout_seconds', sa.Integer(), nullable=False, server_default='30'),
|
|
sa.Column('total_deliveries', sa.Integer(), nullable=False, server_default='0'),
|
|
sa.Column('successful_deliveries', sa.Integer(), nullable=False, server_default='0'),
|
|
sa.Column('failed_deliveries', sa.Integer(), nullable=False, server_default='0'),
|
|
sa.Column('last_delivery_at', sa.DateTime(), nullable=True),
|
|
sa.Column('last_success_at', sa.DateTime(), nullable=True),
|
|
sa.Column('last_failure_at', sa.DateTime(), nullable=True),
|
|
sa.Column('created_at', sa.DateTime(), nullable=False, server_default=sa.text('CURRENT_TIMESTAMP')),
|
|
sa.Column('updated_at', sa.DateTime(), nullable=False, server_default=sa.text('CURRENT_TIMESTAMP')),
|
|
sa.ForeignKeyConstraint(['user_id'], ['users.id'], ondelete='CASCADE'),
|
|
sa.PrimaryKeyConstraint('id')
|
|
)
|
|
|
|
# Create indexes for webhooks
|
|
op.create_index('ix_webhooks_user_id', 'webhooks', ['user_id'])
|
|
op.create_index('ix_webhooks_is_active', 'webhooks', ['is_active'])
|
|
op.create_index('ix_webhooks_created_at', 'webhooks', ['created_at'])
|
|
|
|
# Create webhook_deliveries table
|
|
op.create_table('webhook_deliveries',
|
|
sa.Column('id', sa.Integer(), nullable=False),
|
|
sa.Column('webhook_id', sa.Integer(), nullable=False),
|
|
sa.Column('event_type', sa.String(length=100), nullable=False),
|
|
sa.Column('event_id', sa.String(length=100), nullable=True),
|
|
sa.Column('payload', sa.Text(), nullable=False),
|
|
sa.Column('payload_hash', sa.String(length=64), nullable=True),
|
|
sa.Column('status', sa.String(length=20), nullable=False, server_default='pending'),
|
|
sa.Column('attempt_number', sa.Integer(), nullable=False, server_default='1'),
|
|
sa.Column('response_status_code', sa.Integer(), nullable=True),
|
|
sa.Column('response_body', sa.Text(), nullable=True),
|
|
sa.Column('response_headers', sa.JSON(), nullable=True),
|
|
sa.Column('error_message', sa.Text(), nullable=True),
|
|
sa.Column('error_type', sa.String(length=100), nullable=True),
|
|
sa.Column('started_at', sa.DateTime(), nullable=False, server_default=sa.text('CURRENT_TIMESTAMP')),
|
|
sa.Column('completed_at', sa.DateTime(), nullable=True),
|
|
sa.Column('duration_ms', sa.Integer(), nullable=True),
|
|
sa.Column('next_retry_at', sa.DateTime(), nullable=True),
|
|
sa.Column('retry_count', sa.Integer(), nullable=False, server_default='0'),
|
|
sa.ForeignKeyConstraint(['webhook_id'], ['webhooks.id'], ondelete='CASCADE'),
|
|
sa.PrimaryKeyConstraint('id')
|
|
)
|
|
|
|
# Create indexes for webhook_deliveries
|
|
op.create_index('ix_webhook_deliveries_webhook_id', 'webhook_deliveries', ['webhook_id'])
|
|
op.create_index('ix_webhook_deliveries_status', 'webhook_deliveries', ['status'])
|
|
op.create_index('ix_webhook_deliveries_event_type', 'webhook_deliveries', ['event_type'])
|
|
op.create_index('ix_webhook_deliveries_next_retry_at', 'webhook_deliveries', ['next_retry_at'])
|
|
op.create_index('ix_webhook_deliveries_started_at', 'webhook_deliveries', ['started_at'])
|
|
|
|
|
|
def downgrade():
|
|
"""Remove webhooks system tables"""
|
|
|
|
# Drop webhook_deliveries table
|
|
op.drop_index('ix_webhook_deliveries_started_at', table_name='webhook_deliveries')
|
|
op.drop_index('ix_webhook_deliveries_next_retry_at', table_name='webhook_deliveries')
|
|
op.drop_index('ix_webhook_deliveries_event_type', table_name='webhook_deliveries')
|
|
op.drop_index('ix_webhook_deliveries_status', table_name='webhook_deliveries')
|
|
op.drop_index('ix_webhook_deliveries_webhook_id', table_name='webhook_deliveries')
|
|
op.drop_table('webhook_deliveries')
|
|
|
|
# Drop webhooks table
|
|
op.drop_index('ix_webhooks_created_at', table_name='webhooks')
|
|
op.drop_index('ix_webhooks_is_active', table_name='webhooks')
|
|
op.drop_index('ix_webhooks_user_id', table_name='webhooks')
|
|
op.drop_table('webhooks')
|
|
|