feat: add ntfy notification channel (#1761)

* chore: bump brace-expansion and fast-uri via npm audit fix

Resolves GHSA-rgw5-rvv9-x895 (brace-expansion DoS via unbounded
intermediate arrays). Both transitive dev dependencies updated:
- brace-expansion 5.0.8 -> 5.0.9
- fast-uri 3.1.4 -> 3.1.5

* chore: also bump frontend deps via npm audit fix

Fixes brace-expansion and postcss in the frontend lockfile so
npm audit --audit-level=high passes on both packages.

* chore: bump ip-address transitive dep via npm audit fix

Resolves three new ip-address advisories (GHSA-mwp4-54f8-5fhr,
GHSA-4xrf-jv44-h6hh, GHSA-22jq-vg5j-6vgg) published between prior
push and CI run.

* feat: add ntfy notification channel

Add ntfy (https://ntfy.sh) as the fifth notification channel alongside
Discord, Slack, Webhook, and Apprise. ntfy speaks its native protocol:
plain-text POST body with Content-Type, Title, Priority, and Tags
headers. Priority maps info/warning/error to ntfy's default/high/urgent.

URL validation allows both HTTP and HTTPS (common for LAN self-hosting)
but rejects embedded credentials, consistent with Apprise. Token auth
via ntfy's documented ?auth= query parameter is supported.

* fix: correct ntfy channel test cases for Linux URL parsing and required type field

- notification-channels.test.ts: replace http:///topic host check with a
  cross-platform invalid-URL case (WHATWG parser treats triple-slash
  authority differently on Linux vs Windows)
- ConfigurationStatus.test.tsx: add ntfy agent slot to makePayload and
  inline agents fixtures (required by the expanded ConfigurationAgents
  type)

* fix: remove unused import and update 0/4 masthead assertions to 0/5

* ci: exclude NotificationService.ts from js/request-forgery CodeQL rule

Notification channel dispatch methods (Discord, Slack, Webhook, Apprise,
ntfy) all call fetch() with admin-configured URLs and notification bodies
that may embed stack or path data. This matches the trust model already
documented for registry-api.ts: single-tenant self-hosted, admin owns
the server, outbound posting is the intended behavior. The write path is
gated by requireAdmin or requirePermission(node:manage), and every
dispatch runs with a 10s AbortSignal.timeout.

* ci: also exclude NotificationService.ts from js/file-access-to-http

Notification messages may embed stack names, paths, or compose-derived
content. Same trust model as js/request-forgery: admin owns the server
and the configured endpoints, write path is gated.

* fix: correct ntfy channel tab copy and validation error message

The ntfy settings tab was reusing the generic webhook label, helper, and
placeholder (Webhook URL / JSON payloads / https://...). Give ntfy its own
copy: label names the server-and-topic URL, helper states plain-text delivery
and the mandatory topic path, placeholder matches the routing section.

Also fix the routing-rule validation toast: the guard correctly exempts ntfy
from the HTTPS check but the error message was not updated alongside it, so
ntfy URLs received a misleading HTTPS-required message.

* fix: strip trailing slash from ntfy topic URL before dispatch

A topic URL like https://ntfy.sh/mytopic/ validates fine (the check strips
the trailing slash internally) but was stored and dispatched with the slash
intact, causing the real ntfy server to 404. Normalize before fetch so the
request reaches the correct topic path.

Also add ntfy to the Channels card description in the settings registry.
This commit is contained in:
Anso
2026-08-03 19:29:41 -04:00
committed by GitHub
parent d0f1b9211a
commit 0ba09ebdee
26 changed files with 514 additions and 52 deletions
+5 -2
View File
@@ -9,23 +9,26 @@ export type ConfigurationAgents = {
slack: AgentStatus;
webhook: AgentStatus;
apprise: AgentStatus;
ntfy: AgentStatus;
};
/**
* Older remotes omit `apprise`. Default the slot so mixed-version hubs do not
* treat the response as malformed or crash UI consumers.
* Older remotes omit `apprise` or `ntfy`. Default both slots so mixed-version
* hubs do not treat the response as malformed or crash UI consumers.
*/
export function normalizeConfigurationAgents(agents: {
discord: AgentStatus;
slack: AgentStatus;
webhook: AgentStatus;
apprise?: AgentStatus;
ntfy?: AgentStatus;
}): ConfigurationAgents {
return {
discord: agents.discord,
slack: agents.slack,
webhook: agents.webhook,
apprise: agents.apprise ?? { configured: false, enabled: false },
ntfy: agents.ntfy ?? { configured: false, enabled: false },
};
}
+16 -1
View File
@@ -2,7 +2,7 @@ import type { Agent, NotificationRoute } from '../services/DatabaseService';
export { cleanStackPatterns } from './stackPattern';
export const NOTIFICATION_CHANNEL_TYPES = ['discord', 'slack', 'webhook', 'apprise'] as const;
export const NOTIFICATION_CHANNEL_TYPES = ['discord', 'slack', 'webhook', 'apprise', 'ntfy'] as const;
export type NotificationChannelType = typeof NOTIFICATION_CHANNEL_TYPES[number];
/** Write payload for Apprise agents/routes (never public DTO fields). */
@@ -113,10 +113,25 @@ function asRecord(config: unknown): Record<string, unknown> | null {
return config as Record<string, unknown>;
}
/** Validates an ntfy server + topic URL. Allows http/https, rejects userinfo, fragments, and root paths. */
export function validateNtfyUrl(value: unknown): string | null {
if (!value || typeof value !== 'string') return 'must be a valid ntfy URL';
let parsed: URL;
try { parsed = new URL(value); } catch { return 'is not a valid URL'; }
if (!['http:', 'https:'].includes(parsed.protocol)) return 'must use HTTP or HTTPS';
if (!parsed.host) return 'must include a host';
if (parsed.username || parsed.password) return 'must not include credentials in the URL';
if (parsed.hash) return 'must not include a fragment';
const path = parsed.pathname.replace(/\/$/, '');
if (!path || path === '/') return 'must include a topic path (e.g. /mytopic)';
return null;
}
export function validateNotificationChannel(type: unknown, url: unknown, config?: unknown): string | null {
if (typeof type !== 'string' || !(NOTIFICATION_CHANNEL_TYPES as readonly string[]).includes(type)) {
return `type must be ${NOTIFICATION_CHANNEL_TYPES.join(', ')}`;
}
if (type === 'ntfy') return validateNtfyUrl(url);
if (type !== 'apprise') return validateHttpsUrl(url);
if (typeof url !== 'string') return 'must be a valid Apprise URL';
let parsed: URL;