Add Webhook Notification Testing to Admin Tools

- Introduced a new section for testing webhook notifications within the admin tools.
- Added a form to input webhook URL, secret, custom headers, and payload for testing.
- Implemented backend logic to handle webhook test requests and display results.
- Created a toast notification component to show success or failure messages for webhook tests.
- Updated the AdminToolsData structure to include fields for webhook test results.
This commit is contained in:
StarFleetCPTN
2025-03-20 18:49:32 -07:00
parent d6bd471eb0
commit 73362793ad
+223
View File
@@ -39,6 +39,10 @@ type AdminToolsData struct {
EmailTestSuccess *bool
EmailTestMessage string
SmtpServer string
WebhookTestSuccess *bool
WebhookTestMessage string
WebhookStatusCode int
WebhookResponse string
}
// Dialog component for confirmation dialogs
@@ -561,6 +565,160 @@ templ AdminTools(ctx context.Context, data AdminToolsData) {
</div>
</div>
<!-- Notification Testing Tools -->
<div class="mt-8">
<div class="card">
<div class="card-header">
<h3 class="text-lg font-medium text-secondary-900 dark:text-secondary-100">
<i class="fas fa-bell mr-2 text-primary-500"></i>
Webhook Notification Testing
</h3>
</div>
<div class="card-body">
<p class="text-sm text-secondary-600 dark:text-secondary-400 mb-4">
Test webhook notifications by sending a sample job execution payload to your webhook endpoint.
</p>
<form id="webhook-test-form" hx-post="/admin/test-webhook" hx-target="#webhook-test-result" hx-swap="outerHTML" hx-indicator="#webhook-test-indicator">
<div class="space-y-4">
<div>
<label for="webhook-url" class="block text-sm font-medium text-secondary-700 dark:text-secondary-300 mb-1">
Webhook URL
</label>
<div class="relative">
<div class="absolute inset-y-0 left-0 pl-3 flex items-center pointer-events-none">
<i class="fas fa-link text-secondary-400 dark:text-secondary-600"></i>
</div>
<input
type="url"
id="webhook-url"
name="webhook_url"
class="form-input pl-10 w-full"
placeholder="https://example.com/webhook"
required
/>
</div>
</div>
<div>
<label for="webhook-secret" class="block text-sm font-medium text-secondary-700 dark:text-secondary-300 mb-1">
Webhook Secret <span class="text-secondary-500 dark:text-secondary-400">(optional)</span>
</label>
<div class="relative">
<div class="absolute inset-y-0 left-0 pl-3 flex items-center pointer-events-none">
<i class="fas fa-key text-secondary-400 dark:text-secondary-600"></i>
</div>
<input
type="password"
id="webhook-secret"
name="webhook_secret"
class="form-input pl-10 w-full"
placeholder="Secret token for signing requests"
/>
</div>
<p class="mt-1 text-xs text-secondary-500 dark:text-secondary-400">
<i class="fas fa-info-circle mr-1"></i>
Used to sign webhook payloads (X-Hub-Signature-256 header)
</p>
</div>
<div>
<label for="webhook-headers" class="block text-sm font-medium text-secondary-700 dark:text-secondary-300 mb-1">
Custom Headers <span class="text-secondary-500 dark:text-secondary-400">(optional)</span>
</label>
<div class="relative">
<div class="absolute inset-y-0 left-0 pl-3 flex items-center pointer-events-none">
<i class="fas fa-code text-secondary-400 dark:text-secondary-600"></i>
</div>
<input
type="text"
id="webhook-headers"
name="webhook_headers"
class="form-input pl-10 w-full"
placeholder='{"X-Custom-Header": "value"}'
/>
</div>
<p class="mt-1 text-xs text-secondary-500 dark:text-secondary-400">
<i class="fas fa-info-circle mr-1"></i>
Additional HTTP headers as JSON
</p>
</div>
<div>
<label for="webhook-payload" class="block text-sm font-medium text-secondary-700 dark:text-secondary-300 mb-1">
Custom Payload <span class="text-secondary-500 dark:text-secondary-400">(optional)</span>
</label>
<textarea
id="webhook-payload"
name="webhook_payload"
rows="5"
class="form-textarea w-full font-mono text-sm"
placeholder='{
"event_type": "job_execution",
"job_id": 123,
"job_name": "Test Job",
"status": "completed"
}'></textarea>
<p class="mt-1 text-xs text-secondary-500 dark:text-secondary-400">
<i class="fas fa-info-circle mr-1"></i>
Leave empty to use default test payload
</p>
</div>
<div class="flex justify-end">
<button type="submit" class="btn-primary flex items-center justify-center" onclick="fadeInAnimation()">
<i class="fas fa-paper-plane mr-2"></i>
<span>Send Test Webhook</span>
<div id="webhook-test-indicator" class="htmx-indicator ml-2">
<i class="fas fa-circle-notch fa-spin"></i>
</div>
</button>
</div>
</div>
</form>
<!-- Result container for webhook test -->
<div id="webhook-test-result" class="mt-4 hidden">
if data.WebhookTestSuccess != nil {
@WebhookTestToast(*data.WebhookTestSuccess, data.WebhookTestMessage, data.WebhookStatusCode, data.WebhookResponse)
}
</div>
<!-- Sample payload section -->
<div class="mt-6 bg-secondary-50 dark:bg-secondary-800/50 p-4 rounded-lg">
<h4 class="text-sm font-medium text-secondary-900 dark:text-secondary-100 flex items-center">
<i class="fas fa-info-circle mr-2 text-blue-500"></i>
Default Webhook Test Payload
</h4>
<div class="mt-2 bg-white dark:bg-secondary-900 p-3 rounded border border-secondary-200 dark:border-secondary-700 overflow-auto">
<pre class="text-xs text-secondary-600 dark:text-secondary-400 font-mono">&#123;
"event_type": "job_execution",
"job_id": 123,
"job_name": "Test Job",
"config_id": 456,
"config_name": "Test Config",
"status": "completed",
"start_time": "2023-06-18T15:30:45Z",
"end_time": "2023-06-18T15:35:12Z",
"duration_seconds": 267,
"history_id": 789,
"bytes_transferred": 1048576,
"files_transferred": 5,
"source": &#123;
"type": "local",
"path": "/path/to/source"
&#125;,
"destination": &#123;
"type": "s3",
"path": "bucket/path"
&#125;
&#125;</pre>
</div>
</div>
</div>
</div>
</div>
<!-- Available Backups -->
<div id="backups-container" class="mt-8">
@BackupsList(data)
@@ -1169,3 +1327,68 @@ script fadeInAnimation() {
document.head.appendChild(style);
}
}
// WebhookTestToast is a component for showing webhook test results
templ WebhookTestToast(success bool, message string, statusCode int, responseBody string) {
<div id="webhook-test-result" class="mt-4 animate-fade-in">
<div class={
"rounded-lg p-4 flex items-start",
templ.KV("bg-green-50 dark:bg-green-900/20 border-l-4 border-green-400", success),
templ.KV("bg-red-50 dark:bg-red-900/20 border-l-4 border-red-400", !success),
}>
<div class="flex-shrink-0">
if success {
<i class="fas fa-check-circle text-green-400"></i>
} else {
<i class="fas fa-exclamation-circle text-red-400"></i>
}
</div>
<div class="ml-3 flex-grow">
<h3 class={
"text-sm font-medium",
templ.KV("text-green-800 dark:text-green-300", success),
templ.KV("text-red-800 dark:text-red-300", !success),
}>
if success {
Webhook Sent Successfully
} else {
Webhook Sending Failed
}
</h3>
<div class={
"mt-1 text-sm",
templ.KV("text-green-700 dark:text-green-400", success),
templ.KV("text-red-700 dark:text-red-400", !success),
}>
{ message }
</div>
<!-- Additional response details -->
<div class="mt-3 text-sm">
<div class="font-medium text-secondary-700 dark:text-secondary-300">Status Code: { fmt.Sprint(statusCode) }</div>
if responseBody != "" {
<div class="mt-2">
<div class="font-medium text-secondary-700 dark:text-secondary-300 mb-1">Response:</div>
<div class="bg-white dark:bg-secondary-900 p-2 rounded border border-secondary-200 dark:border-secondary-700">
<pre class="text-xs text-secondary-600 dark:text-secondary-400 font-mono overflow-auto max-h-40">{ responseBody }</pre>
</div>
</div>
}
</div>
</div>
<div class="ml-auto pl-3 flex-shrink-0">
<button
type="button"
onclick="document.getElementById('webhook-test-result').classList.add('hidden');"
class={
"inline-flex rounded-md p-1.5 focus:outline-none focus:ring-2 focus:ring-offset-2",
templ.KV("text-green-500 hover:bg-green-100 dark:hover:bg-green-900/30 focus:ring-green-500", success),
templ.KV("text-red-500 hover:bg-red-100 dark:hover:bg-red-900/30 focus:ring-red-500", !success),
}
>
<i class="fas fa-times"></i>
</button>
</div>
</div>
</div>
}