cc-haha/desktop/src/lib/desktopNotifications.ts
程序员阿江(Relakkes) 3c23788ff7 fix: preserve notification plugin listener context
The notification plugin can return an object whose unregister method
expects its original listener object as this. Calling the extracted
method directly drops that context and produces an unhandled rejection
when the browser shell cleans up listeners.

Constraint: The desktop frontend also runs in browser-like dev shells where Tauri plugin APIs may be partially present
Rejected: Ignore cleanup errors | it leaves noisy unhandled rejections during local UI smoke tests
Confidence: high
Scope-risk: narrow
Tested: cd desktop && bun run test -- desktopNotifications
Not-tested: Native notification click behavior on every desktop platform
2026-05-18 23:00:54 +08:00

452 lines
15 KiB
TypeScript

import { useSettingsStore } from '../stores/settingsStore'
const DEFAULT_COOLDOWN_MS = 750
export type DesktopNotificationOptions = {
title: string
body?: string
dedupeKey?: string
cooldownScope?: string
cooldownMs?: number
requestAttention?: boolean
target?: DesktopNotificationTarget
}
export type DesktopNotificationTarget =
| { type: 'session'; sessionId: string; title?: string }
| { type: 'scheduled' }
type NativeNotificationPayload = {
title: string
body?: string
id?: number
extra?: Record<string, unknown>
target?: DesktopNotificationTarget
}
type NativeNotificationSender = (options: NativeNotificationPayload) => Promise<boolean> | boolean
export type DesktopNotificationPermission = NotificationPermission | 'unsupported'
type PluginPermissionState = DesktopNotificationPermission | 'prompt' | 'prompt-with-rationale'
const TARGET_EXTRA_KEY = 'ccHahaTarget'
const notifiedKeys = new Set<string>()
const pendingKeys = new Set<string>()
const lastNotificationAtByScope = new Map<string, number>()
const pendingCooldownScopes = new Set<string>()
const notificationTargetById = new Map<number, DesktopNotificationTarget>()
let overrideNativeNotificationSender: NativeNotificationSender | null = null
let nextNotificationId = 1
function readBrowserNotificationPermission(): DesktopNotificationPermission {
if (typeof window === 'undefined' || !('Notification' in window)) {
return 'unsupported'
}
return window.Notification.permission
}
function detectPlatform(): 'darwin' | 'win32' | 'linux' | 'unknown' {
const platform = typeof navigator !== 'undefined' ? navigator.platform.toLowerCase() : ''
const userAgent = typeof navigator !== 'undefined' ? navigator.userAgent.toLowerCase() : ''
if (platform.includes('mac')) return 'darwin'
if (platform.includes('win')) return 'win32'
if (platform.includes('linux')) return 'linux'
if (userAgent.includes('mac')) return 'darwin'
if (userAgent.includes('win')) return 'win32'
if (userAgent.includes('linux')) return 'linux'
return 'unknown'
}
function getNotificationSettingsUrl(): string | null {
switch (detectPlatform()) {
case 'darwin':
return 'x-apple.systempreferences:com.apple.preference.notifications'
case 'win32':
return 'ms-settings:notifications'
default:
return null
}
}
function normalizePermission(value: unknown): DesktopNotificationPermission {
if (value === true) return 'granted'
if (value === false) return 'denied'
if (value === null) return 'default'
if (value === 'prompt' || value === 'prompt-with-rationale') return 'default'
return ['default', 'denied', 'granted', 'unsupported'].includes(value as string)
? value as DesktopNotificationPermission
: 'unsupported'
}
async function invokeWindowsNotificationPermissionState(): Promise<DesktopNotificationPermission | null> {
if (detectPlatform() !== 'win32') return null
try {
const { invoke } = await import('@tauri-apps/api/core')
const granted = await invoke<boolean | null>('plugin:notification|is_permission_granted')
return normalizePermission(granted)
} catch (err) {
if (typeof console !== 'undefined') {
console.warn('[desktopNotifications] failed to read Windows notification permission:', err)
}
return 'unsupported'
}
}
async function invokeWindowsNotificationPermissionRequest(): Promise<DesktopNotificationPermission | null> {
if (detectPlatform() !== 'win32') return null
try {
const { invoke } = await import('@tauri-apps/api/core')
const permission = await invoke<PluginPermissionState>('plugin:notification|request_permission')
return normalizePermission(permission)
} catch (err) {
if (typeof console !== 'undefined') {
console.warn('[desktopNotifications] failed to request Windows notification permission:', err)
}
return 'unsupported'
}
}
async function invokeMacNotificationPermissionState(): Promise<DesktopNotificationPermission | null> {
if (detectPlatform() !== 'darwin') return null
try {
const { invoke } = await import('@tauri-apps/api/core')
const permission = await invoke<DesktopNotificationPermission>('macos_notification_permission_state')
return ['default', 'denied', 'granted', 'unsupported'].includes(permission) ? permission : 'unsupported'
} catch (err) {
if (typeof console !== 'undefined') {
console.warn('[desktopNotifications] failed to read macOS notification permission:', err)
}
return 'unsupported'
}
}
async function invokeMacNotificationPermissionRequest(): Promise<DesktopNotificationPermission | null> {
if (detectPlatform() !== 'darwin') return null
try {
const { invoke } = await import('@tauri-apps/api/core')
const permission = await invoke<DesktopNotificationPermission>('macos_request_notification_permission')
return ['default', 'denied', 'granted', 'unsupported'].includes(permission) ? permission : 'unsupported'
} catch (err) {
if (typeof console !== 'undefined') {
console.warn('[desktopNotifications] failed to request macOS notification permission:', err)
}
return 'unsupported'
}
}
function isNotificationTarget(value: unknown): value is DesktopNotificationTarget {
if (!value || typeof value !== 'object') return false
const target = value as Partial<DesktopNotificationTarget>
if (target.type === 'scheduled') return true
if (target.type === 'session') {
return typeof target.sessionId === 'string' && target.sessionId.length > 0 &&
(target.title === undefined || typeof target.title === 'string')
}
return false
}
function parseTargetJson(value: unknown): DesktopNotificationTarget | null {
if (typeof value !== 'string' || !value.trim()) return null
try {
const parsed = JSON.parse(value) as unknown
return isNotificationTarget(parsed) ? parsed : null
} catch {
return null
}
}
function notificationTargetFromPayload(payload: unknown): DesktopNotificationTarget | null {
if (isNotificationTarget(payload)) return payload
const jsonTarget = parseTargetJson(payload)
if (jsonTarget) return jsonTarget
if (!payload || typeof payload !== 'object') return null
const record = payload as Record<string, unknown>
const directTarget = notificationTargetFromPayload(record.target)
if (directTarget) return directTarget
const extra = record.extra && typeof record.extra === 'object'
? record.extra as Record<string, unknown>
: null
const extraTarget = extra ? notificationTargetFromPayload(extra[TARGET_EXTRA_KEY]) : null
if (extraTarget) return extraTarget
const data = record.data && typeof record.data === 'object'
? record.data as Record<string, unknown>
: null
const dataTarget = data ? notificationTargetFromPayload(data[TARGET_EXTRA_KEY]) : null
if (dataTarget) return dataTarget
const id = typeof record.id === 'number' ? record.id : null
return id !== null ? notificationTargetById.get(id) ?? null : null
}
function buildNativeNotificationPayload(options: {
title: string
body?: string
target?: DesktopNotificationTarget
}): NativeNotificationPayload {
const payload: NativeNotificationPayload = {
title: options.title,
body: options.body,
}
if (options.target) {
const id = nextNotificationId++
notificationTargetById.set(id, options.target)
payload.id = id
payload.extra = { [TARGET_EXTRA_KEY]: JSON.stringify(options.target) }
payload.target = options.target
}
return payload
}
async function sendMacNotification(options: { title: string; body?: string; target?: DesktopNotificationTarget }): Promise<boolean | null> {
if (detectPlatform() !== 'darwin') return null
try {
const { invoke } = await import('@tauri-apps/api/core')
const target = options.target ? JSON.stringify(options.target) : undefined
const sent = await invoke<boolean>('macos_send_notification', {
title: options.title,
body: options.body,
...(target ? { target } : {}),
})
return typeof sent === 'boolean' ? sent : false
} catch (err) {
if (typeof console !== 'undefined') {
console.warn('[desktopNotifications] failed to send macOS native notification:', err)
}
return false
}
}
export async function getDesktopNotificationPermission(): Promise<DesktopNotificationPermission> {
const macPermission = await invokeMacNotificationPermissionState()
if (macPermission) return macPermission
const windowsPermission = await invokeWindowsNotificationPermissionState()
if (windowsPermission) return windowsPermission
try {
const { isPermissionGranted } = await import('@tauri-apps/plugin-notification')
if (await isPermissionGranted()) return 'granted'
} catch {
// Fall back to the Web Notification permission state below.
}
return readBrowserNotificationPermission()
}
export async function requestDesktopNotificationPermission(): Promise<DesktopNotificationPermission> {
const macPermission = await invokeMacNotificationPermissionRequest()
if (macPermission) return macPermission
const windowsPermission = await invokeWindowsNotificationPermissionRequest()
if (windowsPermission) return windowsPermission
try {
const {
isPermissionGranted,
requestPermission,
} = await import('@tauri-apps/plugin-notification')
if (await isPermissionGranted()) return 'granted'
return await requestPermission()
} catch {
return readBrowserNotificationPermission()
}
}
export async function openDesktopNotificationSettings(): Promise<boolean> {
const url = getNotificationSettingsUrl()
if (!url) return false
if (detectPlatform() === 'win32') {
try {
const { invoke } = await import('@tauri-apps/api/core')
const opened = await invoke<boolean>('open_windows_notification_settings')
if (opened) return true
} catch {
// Fall back to shell.open/window.open below.
}
}
try {
const { open } = await import('@tauri-apps/plugin-shell')
await open(url)
return true
} catch {
try {
window.open(url, '_blank', 'noopener,noreferrer')
return true
} catch {
return false
}
}
}
async function sendNativeNotification(options: { title: string; body?: string; target?: DesktopNotificationTarget }): Promise<boolean> {
const macSent = await sendMacNotification(options)
if (macSent !== null) return macSent
const {
isPermissionGranted,
sendNotification,
} = await import('@tauri-apps/plugin-notification')
const windowsPermission = await invokeWindowsNotificationPermissionState()
const permissionGranted = windowsPermission ? windowsPermission === 'granted' : await isPermissionGranted()
if (!permissionGranted) {
return false
}
const payload = buildNativeNotificationPayload(options)
sendNotification(payload)
return true
}
async function requestWindowAttention(): Promise<boolean> {
try {
const { getCurrentWindow, UserAttentionType } = await import('@tauri-apps/api/window')
await getCurrentWindow().requestUserAttention(UserAttentionType.Critical)
return true
} catch {
return false
}
}
async function focusCurrentWindow(): Promise<void> {
try {
const { getCurrentWindow } = await import('@tauri-apps/api/window')
const win = getCurrentWindow()
await (win as unknown as { show?: () => Promise<void> | void }).show?.()
await (win as unknown as { setFocus?: () => Promise<void> | void }).setFocus?.()
} catch {
// Best effort only: the notification target can still be opened in the UI.
}
}
function disposePluginListener(listener: unknown): void {
if (typeof listener === 'function') {
listener()
return
}
const unregister = listener && typeof listener === 'object'
? (listener as { unregister?: () => Promise<void> | void }).unregister
: undefined
if (typeof unregister === 'function') void unregister.call(listener)
}
export async function installDesktopNotificationClickListener(
onTarget: (target: DesktopNotificationTarget) => void,
): Promise<() => void> {
const cleanups: Array<() => void> = []
const handlePayload = (payload: unknown) => {
const target = notificationTargetFromPayload(payload)
if (!target) return
void focusCurrentWindow()
onTarget(target)
}
try {
const { listen } = await import('@tauri-apps/api/event')
const unlisten = await listen<unknown>('desktop-notification-clicked', (event) => {
handlePayload(event.payload)
})
cleanups.push(unlisten)
} catch {
// Non-Tauri browser tests and unsupported runtimes do not expose native events.
}
try {
const { onAction } = await import('@tauri-apps/plugin-notification') as {
onAction?: (cb: (notification: unknown) => void) => Promise<unknown>
}
if (onAction) {
const listener = await onAction(handlePayload)
cleanups.push(() => disposePluginListener(listener))
}
} catch {
// The desktop plugin does not expose click actions on every platform.
}
return () => {
for (const cleanup of cleanups.splice(0)) cleanup()
}
}
export async function notifyDesktop(options: DesktopNotificationOptions): Promise<boolean> {
if (!useSettingsStore.getState().desktopNotificationsEnabled) {
return false
}
if (options.dedupeKey && (notifiedKeys.has(options.dedupeKey) || pendingKeys.has(options.dedupeKey))) {
return false
}
const cooldownScope = options.cooldownScope
if (cooldownScope) {
const now = Date.now()
const lastNotificationAt = lastNotificationAtByScope.get(cooldownScope) ?? 0
if (pendingCooldownScopes.has(cooldownScope) || now - lastNotificationAt < (options.cooldownMs ?? DEFAULT_COOLDOWN_MS)) {
return false
}
pendingCooldownScopes.add(cooldownScope)
}
if (options.dedupeKey) {
pendingKeys.add(options.dedupeKey)
}
if (options.requestAttention) {
void requestWindowAttention()
}
const sender = overrideNativeNotificationSender ?? sendNativeNotification
try {
const sent = await Promise.resolve(sender({
title: options.title,
body: options.body,
...(options.target ? { target: options.target } : {}),
}))
if (options.dedupeKey) {
pendingKeys.delete(options.dedupeKey)
if (sent) notifiedKeys.add(options.dedupeKey)
}
if (sent && cooldownScope) {
lastNotificationAtByScope.set(cooldownScope, Date.now())
}
if (cooldownScope) pendingCooldownScopes.delete(cooldownScope)
if (!sent && typeof console !== 'undefined') {
console.warn('[desktopNotifications] native notification permission was not granted')
}
return sent
} catch (err) {
if (options.dedupeKey) pendingKeys.delete(options.dedupeKey)
if (cooldownScope) pendingCooldownScopes.delete(cooldownScope)
if (typeof console !== 'undefined') {
console.warn('[desktopNotifications] failed to send native notification:', err)
}
return false
}
}
export function resetDesktopNotificationsForTests(): void {
notifiedKeys.clear()
pendingKeys.clear()
lastNotificationAtByScope.clear()
pendingCooldownScopes.clear()
notificationTargetById.clear()
overrideNativeNotificationSender = null
nextNotificationId = 1
}
export function setNativeNotificationSenderForTests(sender: NativeNotificationSender | null): void {
overrideNativeNotificationSender = sender
}