mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-09 04:50:59 +00:00
fix(notifications): answer a failed channel test with its cause
The webhook, ntfy and email test routes turned every delivery failure into a bare 500, so the settings card could only say "Test failed" while the server knew the relay had answered 400. A failure at the other end, or on the way to it, is now a 502 with meta.errorCode, the upstream HTTP status or SMTP reply code, and for webhook and ntfy what the relay answered when that is short and holds no credential. The codes reuse the test card's vocabulary; upstream_rejected is new, for a relay that accepted the connection and refused the payload. The private-origin 422 is unchanged, and only a failure the server cannot name stays a 500. The guard that pinned the bare 500 now asserts the opposite, with the reason in its name. The admin fan-out test reports the same code and status per channel, and tests the webhook and email channels, which it used to list as an unknown channel type. Refs #947
This commit is contained in:
1 parent
8c345f600e
commit
f6a890df8a
11 files changed
+744
-39
No files matched your search
+63
-9
@@ -12354,7 +12354,8 @@ paths:
|
||||
|
||||
|
||||
Refuses with 400 when the instance has no SMTP transport, when the account has no email channel, or when the
|
||||
channel carries no recipient — three distinguishable prose messages on one status. A transport failure is a 500.
|
||||
channel carries no recipient — three distinguishable prose messages on one status. A failure at the mail server
|
||||
or on the way to it is a 502 that names its cause; only a failure the server cannot name is a 500.
|
||||
responses:
|
||||
"200":
|
||||
description: The provider accepted the message. Not proof it was delivered.
|
||||
@@ -12365,6 +12366,21 @@ paths:
|
||||
"401": *a1
|
||||
"422": *a4
|
||||
"429": *a5
|
||||
"500":
|
||||
description: The send failed in a way the server could not name. An internal fault, not a statement about the mail server.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorEnvelope"
|
||||
"502":
|
||||
description: "The mail server, or the way to it, failed. `meta.errorCode` names the cause: `credentials_rejected` (the
|
||||
server refused the SMTP login), `upstream_rejected` (a permanent 5xx rejection, e.g. an unknown mailbox or
|
||||
relay denied), `upstream_error` (a temporary 4xx rejection), `timeout`, or `connection_failed`.
|
||||
`meta.smtpCode` carries the SMTP reply code when the mail server sent one."
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorEnvelope"
|
||||
/api/settings/ntfy/test:
|
||||
post:
|
||||
tags:
|
||||
@@ -12372,9 +12388,10 @@ paths:
|
||||
summary: Send a test message to the saved ntfy topic
|
||||
description: Publishes one message to the account's configured ntfy server and topic. Takes no body. Rate-limited 5 per
|
||||
5 minutes per user. Refuses with 400 when no ntfy channel is saved or when the saved config is missing a server
|
||||
URL or topic; a publish failure is a 500. A server on a private network is refused with 422 and `meta.errorCode`
|
||||
= `private_origin_not_approved` unless the operator listed its exact origin in `NOTIFICATION_PRIVATE_ORIGINS`;
|
||||
the test and the scheduled delivery take the same decision.
|
||||
URL or topic. A failure at the ntfy server or on the way to it is a 502 that carries the upstream status and,
|
||||
when safe, what the server answered; only a failure the server cannot name is a 500. A server on a private
|
||||
network is refused with 422 and `meta.errorCode` = `private_origin_not_approved` unless the operator listed its
|
||||
exact origin in `NOTIFICATION_PRIVATE_ORIGINS`; the test and the scheduled delivery take the same decision.
|
||||
responses:
|
||||
"200":
|
||||
description: The provider accepted the message. Not proof it was delivered.
|
||||
@@ -12392,6 +12409,24 @@ paths:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorEnvelope"
|
||||
"429": *a5
|
||||
"500":
|
||||
description: The send failed in a way the server could not name. An internal fault, not a statement about the ntfy server.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorEnvelope"
|
||||
"502":
|
||||
description: "The ntfy server, or the way to it, failed. `meta.errorCode` names the cause: `upstream_rejected` (the
|
||||
other end refused the payload, e.g. 400/409/415/422), `credentials_rejected` (401/403), `endpoint_not_found`
|
||||
(404/410), `rate_limited` (429), `upstream_error` (5xx), `redirected` (3xx, never followed), `timeout`, or
|
||||
`connection_failed`. `meta.upstreamStatus` carries the HTTP status whenever one arrived, and
|
||||
`meta.upstreamBody` up to 200 characters of what the other end answered, with control characters removed; it
|
||||
is omitted when the body was empty or could carry a credential (a token-shaped string, or the saved header
|
||||
value, auth token, topic or URL token)."
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorEnvelope"
|
||||
/api/settings/telegram/test:
|
||||
post:
|
||||
tags:
|
||||
@@ -12421,11 +12456,12 @@ paths:
|
||||
- Notifications
|
||||
summary: Send a test payload to the saved webhook
|
||||
description: Posts one payload to the account's configured webhook URL. Takes no body. Rate-limited 5 per 5 minutes per
|
||||
user. Refuses with 400 when no webhook channel is saved or the saved config has no URL; a delivery failure is a
|
||||
500. The URL was checked against the SSRF floor when it was saved, so a test cannot be used to reach an internal
|
||||
host. A URL on a private network is refused with 422 and `meta.errorCode` = `private_origin_not_approved` unless
|
||||
the operator listed its exact origin in `NOTIFICATION_PRIVATE_ORIGINS`; the test and the scheduled delivery take
|
||||
the same decision.
|
||||
user. Refuses with 400 when no webhook channel is saved or the saved config has no URL. A failure at the relay
|
||||
or on the way to it is a 502 that carries the upstream status and, when safe, what the relay answered; only a
|
||||
failure the server cannot name is a 500. The URL was checked against the SSRF floor when it was saved, so a test
|
||||
cannot be used to reach an internal host. A URL on a private network is refused with 422 and `meta.errorCode` =
|
||||
`private_origin_not_approved` unless the operator listed its exact origin in `NOTIFICATION_PRIVATE_ORIGINS`; the
|
||||
test and the scheduled delivery take the same decision.
|
||||
responses:
|
||||
"200":
|
||||
description: The provider accepted the message. Not proof it was delivered.
|
||||
@@ -12443,6 +12479,24 @@ paths:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorEnvelope"
|
||||
"429": *a5
|
||||
"500":
|
||||
description: The send failed in a way the server could not name. An internal fault, not a statement about the relay.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorEnvelope"
|
||||
"502":
|
||||
description: "The relay, or the way to it, failed. `meta.errorCode` names the cause: `upstream_rejected` (the other end
|
||||
refused the payload, e.g. 400/409/415/422), `credentials_rejected` (401/403), `endpoint_not_found`
|
||||
(404/410), `rate_limited` (429), `upstream_error` (5xx), `redirected` (3xx, never followed), `timeout`, or
|
||||
`connection_failed`. `meta.upstreamStatus` carries the HTTP status whenever one arrived, and
|
||||
`meta.upstreamBody` up to 200 characters of what the other end answered, with control characters removed; it
|
||||
is omitted when the body was empty or could carry a credential (a token-shaped string, or the saved header
|
||||
value, auth token, topic or URL token)."
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorEnvelope"
|
||||
/api/settings/data:
|
||||
delete:
|
||||
tags:
|
||||
|
||||
Reference in new issue
Block a user