feat: Consolidate Webhook Event System - PRs #48,49,58,68,79,89#43
Draft
codegen-sh[bot] wants to merge 4 commits intomainfrom
Draft
feat: Consolidate Webhook Event System - PRs #48,49,58,68,79,89#43codegen-sh[bot] wants to merge 4 commits intomainfrom
codegen-sh[bot] wants to merge 4 commits intomainfrom
Conversation
- Automated setup script for local Postgres exposure via Cloudflare Workers - Creates dedicated database and read-only user for Codegen - Deploys Cloudflare Worker proxy with health endpoints - Saves credentials to .env file for easy integration - Includes Windows batch and PowerShell scripts for easy setup - Comprehensive testing and status reporting - Full documentation with troubleshooting guide
- Add support for multiple authentication methods - Try common default passwords automatically - Support environment variables for admin credentials - Add interactive password prompt as fallback - Update documentation with authentication troubleshooting - Handle Windows authentication scenarios
- Switch from API token to Global API Key authentication - Add support for Cloudflare email requirement - Update environment variables and batch scripts - Create specialized script with user's credentials - Fix Cloudflare Worker creation authentication
🔄 Comprehensive webhook event system consolidation implementing: ✨ Features Consolidated: - GitHub webhook integration (PR #48, #89) - Event processing pipeline (PR #49) - Webhook validation system (PR #58) - Event routing and distribution (PR #68) - Webhook system & event-driven automation (PR #79) 🏗️ System Architecture: - WebhookHandler: Main processing system with validation & statistics - WebhookRouter: Rule-based event routing and distribution - WebhookAutomationEngine: Event-driven automation with conditions - WebhookValidator: Secure validation (HMAC-SHA256, SHA1, secret, custom) 🔧 Key Components: - Unified event processing pipeline - Consolidated validation patterns - Integrated automation engine - Standardized webhook handlers - Zero duplication in event handling logic 🌐 API Endpoints: - POST /webhooks/github - GitHub webhook processing - POST /webhooks/generic - Generic webhook processing - GET /webhooks/stats - System statistics - GET /webhooks/health - Health monitoring - Management endpoints for handlers, rules, automation 🔒 Security Features: - HMAC signature validation - Rate limiting and cooldowns - Payload size limits - Comprehensive error handling 📊 Monitoring & Analytics: - Real-time statistics tracking - Health status monitoring - Execution history and performance metrics - WebSocket event streaming integration 🎯 Technical Requirements Met: ✅ Zero duplication in event handling logic ✅ Consistent webhook validation patterns ✅ Removal of redundant automation components ✅ Single cohesive event processing system ✅ Clear contracts for webhook integrations 📚 Includes comprehensive example and documentation
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Join our Discord community for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Reviewer's GuideThis PR consolidates the separate webhook-related features from multiple prior PRs into a single cohesive webhook event system by adding new core modules (handler, router, automation, validation, types, and routes), integrating them into the server and main exports, and providing usage examples. Sequence Diagram: Incoming Webhook Processing FlowsequenceDiagram
actor ExternalSource
participant APIEndpoint
participant WebhookHandler
participant ComprehensiveWebhookValidator
participant WebhookRouter
participant WebhookAutomationEngine
ExternalSource->>APIEndpoint: POST /webhooks/{source} (payload, headers)
APIEndpoint->>WebhookHandler: processWebhook(rawPayload, headers, source, eventType)
WebhookHandler->>WebhookHandler: Check system enabled, payload size
WebhookHandler->>WebhookHandler: Create WebhookPayload object
WebhookHandler->>WebhookHandler: Update stats (received)
WebhookHandler->>WebhookHandler: Find handlerConfig for source & eventType
WebhookHandler->>ComprehensiveWebhookValidator: validateWithResult(rawPayload, headers, handlerConfig.validation)
ComprehensiveWebhookValidator-->>WebhookHandler: validationResult
alt Validation Fails
WebhookHandler->>WebhookHandler: Update stats (failed)
WebhookHandler-->>APIEndpoint: Error Response (e.g., 401)
APIEndpoint-->>ExternalSource: Error Response
else Validation Succeeds
WebhookHandler->>WebhookRouter: route(webhookPayload)
WebhookRouter-->>WebhookHandler: routingResult
WebhookHandler->>WebhookAutomationEngine: processWebhook(webhookPayload)
WebhookAutomationEngine-->>WebhookHandler: automationResult
WebhookHandler->>WebhookHandler: Combine routing & automation results
alt Combined Result is Success
WebhookHandler->>WebhookHandler: Update stats (processed)
else Combined Result is Failure
WebhookHandler->>WebhookHandler: Update stats (failed)
end
WebhookHandler->>WebhookHandler: Update average processing time
WebhookHandler-->>APIEndpoint: Success Response (WebhookProcessingResult)
APIEndpoint-->>ExternalSource: Success Response
end
Class Diagram: Core Webhook System ComponentsclassDiagram
class WebhookHandler {
+processWebhook(rawPayload, headers, source, eventType) WebhookProcessingResult
+addHandler(handlerConfig) void
+getHandlers() WebhookHandlerConfig[]
+getStats() WebhookSystemStats
+healthCheck() HealthStatus
#validateWebhook(payload, headers, validationConfig) ValidationResult
}
class WebhookRouter {
+route(payload) WebhookProcessingResult
+addRule(rule) void
+getRules() WebhookRoutingRule[]
#executeAction(action, payload) any
}
class WebhookAutomationEngine {
+processWebhook(payload) WebhookProcessingResult
+addRule(rule) void
+getRules() AutomationRule[]
#executeRule(rule, payload) AutomationExecutionResult
}
class WebhookValidator {
<<static>> +validate(payload, headers, config) boolean
<<static>> +validateHmacSha256(payload, headers, config) boolean
}
class GitHubWebhookValidator {
<<static>> +validate(payload, headers, secret) boolean
<<static>> +getEventType(headers) string
}
class ComprehensiveWebhookValidator {
<<static>> +validateWithResult(payload, headers, config) ValidationResult
}
class AgentEventEmitter {
+getInstance() AgentEventEmitter
+addHistoryEvent() any
}
class AgentRegistry {
+getInstance() AgentRegistry
+getAgent(agentId) Agent
}
class Agent {
+generateText() any
}
WebhookHandler --> ComprehensiveWebhookValidator : uses for validation
WebhookHandler --> WebhookRouter : delegates routing
WebhookHandler --> WebhookAutomationEngine : delegates automation
WebhookHandler --> AgentEventEmitter : emits events
WebhookRouter --> AgentRegistry : uses for agent actions
WebhookRouter --> AgentEventEmitter : emits events
WebhookRouter --> Agent : triggers
WebhookAutomationEngine --> AgentRegistry : uses for agent actions
WebhookAutomationEngine --> AgentEventEmitter : emits events
WebhookAutomationEngine --> Agent : triggers
ComprehensiveWebhookValidator ..> WebhookValidator : uses static methods from
GitHubWebhookValidator ..> WebhookValidator : uses static methods from
Class Diagram: Webhook Data Structures and ConfigurationclassDiagram
class WebhookPayload {
+id string
+source WebhookSource
+eventType WebhookEventType
+data any
+headers Record~string, string~
+timestamp string
+validated boolean
+status string
}
class WebhookHandlerConfig {
+id string
+name string
+source WebhookSource
+eventTypes WebhookEventType[]
+validation WebhookValidationConfig
+enabled boolean
}
class WebhookValidationConfig {
+method string
+secret string
+signatureHeader string
+customValidator function
}
class WebhookRoutingRule {
+id string
+name string
+source WebhookSource
+eventType WebhookEventType
+action WebhookAutomationAction
+priority number
+condition function
}
class AutomationRule {
+id string
+name string
+conditions AutomationCondition[]
+actions WebhookAutomationAction[]
+priority number
+cooldown number
}
class WebhookAutomationAction {
+type string
+agentId string
+toolName string
+notification NotificationConfig
+handler function
}
class AutomationCondition {
+field string
+operator string
+value any
+pattern string
}
class NotificationConfig {
+message string
+channels string[]
}
class WebhookProcessingResult {
+success boolean
+data any
+error string
+duration number
+triggeredActions WebhookAutomationAction[]
+createdEvents string[]
}
class ValidationResult {
+valid boolean
+error string
+errorCode string
}
class WebhookSystemConfig {
+enabled boolean
+basePath string
+maxPayloadSize number
}
class WebhookSystemStats {
+totalReceived number
+totalProcessed number
+totalFailed number
}
class NodeType {
<<enumeration>>
AGENT
TOOL
MEMORY
RETRIEVER
WEBHOOK
}
WebhookHandlerConfig ..> WebhookValidationConfig : uses
WebhookRoutingRule ..> WebhookAutomationAction : defines
AutomationRule ..> AutomationCondition : contains
AutomationRule ..> WebhookAutomationAction : defines
WebhookAutomationAction ..> NotificationConfig : uses
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔄 Webhook Event System Consolidation
This PR consolidates all webhook handling and event processing PRs into a single comprehensive webhook system, addressing ZAM-784.
📋 PRs Consolidated
🎯 Consolidation Objectives ✅
🏗️ System Architecture
Core Components
WebhookHandler (
packages/core/src/webhooks/handler.ts)WebhookRouter (
packages/core/src/webhooks/router.ts)WebhookAutomationEngine (
packages/core/src/webhooks/automation.ts)WebhookValidator (
packages/core/src/webhooks/validation.ts)🌐 API Endpoints
Webhook Processing
POST /webhooks/github- Process GitHub webhooks with signature validationPOST /webhooks/generic- Process generic webhooksManagement
GET /webhooks/handlers- Get all webhook handlersPOST /webhooks/handlers- Create new webhook handlerGET /webhooks/routing-rules- Get routing rulesPOST /webhooks/routing-rules- Create routing ruleGET /webhooks/automation-rules- Get automation rulesPOST /webhooks/automation-rules- Create automation ruleMonitoring
GET /webhooks/stats- Get webhook statisticsGET /webhooks/health- Get system health status🔧 Technical Requirements Met
🔒 Security Features
📊 Monitoring & Analytics
🚀 Usage Examples
Quick Setup
GitHub Webhooks
Custom Automation Rules
📚 Documentation & Examples
examples/webhook-system/README.mdexamples/webhook-system/index.ts🧪 Testing
The example demonstrates:
🔄 Integration
📈 Performance
This consolidation provides a unified, scalable, and secure webhook processing system that eliminates all duplication while maintaining flexibility for various webhook sources and automation requirements.
💻 View my work • About Codegen
Description by Korbit AI
What change is being made?
Consolidate the webhook event system by integrating multiple prior PR functionalities into a comprehensive solution, including GitHub integration, event processing pipeline, validation, routing and distribution, automation, and monitoring.
Why are these changes being made?
This change enhances the manageability, scalability, and consistency of our webhook handling by combining features from previous PRs (#48, #49, #58, #68, #79, #89) into a single, cohesive system, thereby optimizing processing, reducing redundancy, and allowing for more efficient handling of webhook events. This consolidation provides a clear, unified interface for webhook management, as well as improved error handling and performance monitoring.
Summary by Sourcery
Consolidate all previous webhook handling PRs into a single, cohesive webhook event system in @voltagent/core, providing unified processing, validation, routing, automation and monitoring for GitHub, generic and custom webhooks.
New Features:
Enhancements:
Documentation: