Improved webhook delivery failure logging

[kevinansfield]

ref https://linear.app/ghost/issue/ONC-1609/

• Promoted webhook delivery failure logs from warn to error level so they surface in error-level monitoring
• Added structured [WEBHOOK_DELIVERY_FAILURE] prefix with url, status, error_code, and message fields for easy SLO alerting
• Added unit tests verifying the structured log output and fallback values

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 3be232b8-9e04-4b1e-92f5-7c460c053488

📥 Commits

Reviewing files that changed from the base of the PR and between 501ea90 and 80ceb93.

📒 Files selected for processing (2)

• ghost/core/core/server/services/webhooks/webhook-trigger.js
• ghost/core/test/unit/server/services/webhooks/trigger.test.js

✅ Files skipped from review due to trivial changes (1)

• ghost/core/test/unit/server/services/webhooks/trigger.test.js

🚧 Files skipped from review as they are similar to previous changes (1)

• ghost/core/core/server/services/webhooks/webhook-trigger.js

---

Walkthrough

The changes adjust webhook delivery failure logging and add unit tests. The webhook trigger now logs failures at error level with a structured [WEBHOOK_DELIVERY_FAILURE] tag and includes URL (fallback unknown), HTTP status (err.statusCode || 'none'), error code (err.code || 'unknown'), and error message, passing the original error object to the logger. Existing error handling flow (including 410 handling) is unchanged. Tests were added to assert the new logging format and fallback values when properties are absent.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Improved webhook delivery failure logging' directly summarizes the main change: enhancing webhook failure logging with higher severity level and structured fields.
Description check	✅ Passed	The description is directly related to the changeset, detailing the promotion to error level, addition of structured logging tags, and unit tests covering these changes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch webhook-delivery-logging

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

ghost/core/core/server/services/webhooks/webhook-trigger.js (1)

94-94: Consider preserving the error stack trace for debugging.

The structured log format is good for SLO alerting, but the current approach loses the error's stack trace which can be valuable for debugging delivery failures. Per the conventional pattern in the codebase (e.g., stripe/webhook-controller.js line 102 uses logging.error(string, err)), you can pass the error object as a second argument.

♻️ Suggested improvement to preserve stack trace

-            logging.error(`[WEBHOOK_DELIVERY_FAILURE] url=${webhook.get('target_url') || 'unknown'} status=${err.statusCode || 'none'} error_code=${err.code || 'unknown'} message=${err.message || ''}`);
+            logging.error(`[WEBHOOK_DELIVERY_FAILURE] url=${webhook.get('target_url') || 'unknown'} status=${err.statusCode || 'none'} error_code=${err.code || 'unknown'} message=${err.message || ''}`, err);

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@ghost/core/core/server/services/webhooks/webhook-trigger.js` at line 94, The
webhook delivery failure log currently formats key fields but drops the error
stack; update the logging.error call in webhook-trigger.js (the line that logs
`[WEBHOOK_DELIVERY_FAILURE] url=${webhook.get('target_url') ...}` and references
the err object) to pass the err object as a second argument (e.g.,
logging.error(<formatted message>, err)) so the structured message is preserved
while the error stack/metadata from err is also recorded.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@ghost/core/core/server/services/webhooks/webhook-trigger.js`:
- Line 94: The webhook delivery failure log currently formats key fields but
drops the error stack; update the logging.error call in webhook-trigger.js (the
line that logs `[WEBHOOK_DELIVERY_FAILURE] url=${webhook.get('target_url') ...}`
and references the err object) to pass the err object as a second argument
(e.g., logging.error(<formatted message>, err)) so the structured message is
preserved while the error stack/metadata from err is also recorded.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 02125a61-e781-4bd8-ac01-da7a1b02b4ea

📥 Commits

Reviewing files that changed from the base of the PR and between 952a029 and 501ea90.

📒 Files selected for processing (2)

• ghost/core/core/server/services/webhooks/webhook-trigger.js
• ghost/core/test/unit/server/services/webhooks/trigger.test.js

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud