ddf347994a
* chore(deps): update dependencies and fix security vulnerabilities Update TypeScript 4.9 → 5.4. Update Zod 3 → 4. Update nodemailer 6 → 7. Update @typescript-eslint packages to v7. Update xml2js, undici, lodash, axios, swr, winston- Add pnpm.overrides for transitive dependency vulnerabilities * chore: fix import ordering for TypeScript 5.4 compatibility prettier-plugin-organize-imports behaves differently with TypeScript 5.4 vs 4.9, causing CI formatting checks to fail. This reformats imports to match the ordering expected by the plugin with the upgraded TS version.
337 lines
10 KiB
TypeScript
337 lines
10 KiB
TypeScript
import { IssueType, IssueTypeName } from '@server/constants/issue';
|
|
import { MediaRequestStatus, MediaType } from '@server/constants/media';
|
|
import { getRepository } from '@server/datasource';
|
|
import MediaRequest from '@server/entity/MediaRequest';
|
|
import { User } from '@server/entity/User';
|
|
import { UserPushSubscription } from '@server/entity/UserPushSubscription';
|
|
import type { NotificationAgentConfig } from '@server/lib/settings';
|
|
import { NotificationAgentKey, getSettings } from '@server/lib/settings';
|
|
import logger from '@server/logger';
|
|
import webpush from 'web-push';
|
|
import { Notification, shouldSendAdminNotification } from '..';
|
|
import type { NotificationAgent, NotificationPayload } from './agent';
|
|
import { BaseAgent } from './agent';
|
|
|
|
interface PushNotificationPayload {
|
|
notificationType: string;
|
|
subject: string;
|
|
message?: string;
|
|
image?: string;
|
|
actionUrl?: string;
|
|
actionUrlTitle?: string;
|
|
requestId?: number;
|
|
pendingRequestsCount?: number;
|
|
isAdmin?: boolean;
|
|
}
|
|
|
|
interface WebPushError extends Error {
|
|
statusCode?: number;
|
|
status?: number;
|
|
body?: string | unknown;
|
|
response?: {
|
|
body?: string | unknown;
|
|
};
|
|
}
|
|
|
|
class WebPushAgent
|
|
extends BaseAgent<NotificationAgentConfig>
|
|
implements NotificationAgent
|
|
{
|
|
protected getSettings(): NotificationAgentConfig {
|
|
if (this.settings) {
|
|
return this.settings;
|
|
}
|
|
|
|
const settings = getSettings();
|
|
|
|
return settings.notifications.agents.webpush;
|
|
}
|
|
|
|
private getNotificationPayload(
|
|
type: Notification,
|
|
payload: NotificationPayload
|
|
): PushNotificationPayload {
|
|
const { embedPoster } = getSettings().notifications.agents.webpush;
|
|
|
|
const mediaType = payload.media
|
|
? payload.media.mediaType === MediaType.MOVIE
|
|
? 'movie'
|
|
: 'series'
|
|
: undefined;
|
|
const is4k = payload.request?.is4k;
|
|
|
|
const issueType = payload.issue
|
|
? payload.issue.issueType !== IssueType.OTHER
|
|
? `${IssueTypeName[payload.issue.issueType].toLowerCase()} issue`
|
|
: 'issue'
|
|
: undefined;
|
|
|
|
let message: string | undefined;
|
|
switch (type) {
|
|
case Notification.TEST_NOTIFICATION:
|
|
message = payload.message;
|
|
break;
|
|
case Notification.MEDIA_AUTO_REQUESTED:
|
|
message = `Automatically submitted a new ${
|
|
is4k ? '4K ' : ''
|
|
}${mediaType} request.`;
|
|
break;
|
|
case Notification.MEDIA_APPROVED:
|
|
message = `Your ${
|
|
is4k ? '4K ' : ''
|
|
}${mediaType} request has been approved.`;
|
|
break;
|
|
case Notification.MEDIA_AUTO_APPROVED:
|
|
message = `Automatically approved a new ${
|
|
is4k ? '4K ' : ''
|
|
}${mediaType} request from ${
|
|
payload.request?.requestedBy.displayName
|
|
}.`;
|
|
break;
|
|
case Notification.MEDIA_AVAILABLE:
|
|
message = `Your ${
|
|
is4k ? '4K ' : ''
|
|
}${mediaType} request is now available!`;
|
|
break;
|
|
case Notification.MEDIA_DECLINED:
|
|
message = `Your ${is4k ? '4K ' : ''}${mediaType} request was declined.`;
|
|
break;
|
|
case Notification.MEDIA_FAILED:
|
|
message = `Failed to process ${is4k ? '4K ' : ''}${mediaType} request.`;
|
|
break;
|
|
case Notification.MEDIA_PENDING:
|
|
message = `Approval required for a new ${
|
|
is4k ? '4K ' : ''
|
|
}${mediaType} request from ${
|
|
payload.request?.requestedBy.displayName
|
|
}.`;
|
|
break;
|
|
case Notification.ISSUE_CREATED:
|
|
message = `A new ${issueType} was reported by ${payload.issue?.createdBy.displayName}.`;
|
|
break;
|
|
case Notification.ISSUE_COMMENT:
|
|
message = `${payload.comment?.user.displayName} commented on the ${issueType}.`;
|
|
break;
|
|
case Notification.ISSUE_RESOLVED:
|
|
message = `The ${issueType} was marked as resolved by ${payload.issue?.modifiedBy?.displayName}!`;
|
|
break;
|
|
case Notification.ISSUE_REOPENED:
|
|
message = `The ${issueType} was reopened by ${payload.issue?.modifiedBy?.displayName}.`;
|
|
break;
|
|
default:
|
|
return {
|
|
notificationType: Notification[type],
|
|
subject: 'Unknown',
|
|
};
|
|
}
|
|
|
|
const actionUrl = payload.issue
|
|
? `/issues/${payload.issue.id}`
|
|
: payload.media
|
|
? `/${payload.media.mediaType}/${payload.media.tmdbId}`
|
|
: undefined;
|
|
|
|
const actionUrlTitle = actionUrl
|
|
? `View ${payload.issue ? 'Issue' : 'Media'}`
|
|
: undefined;
|
|
|
|
return {
|
|
notificationType: Notification[type],
|
|
subject: payload.subject,
|
|
message,
|
|
image: embedPoster ? payload.image : undefined,
|
|
requestId: payload.request?.id,
|
|
actionUrl,
|
|
actionUrlTitle,
|
|
pendingRequestsCount: payload.pendingRequestsCount,
|
|
isAdmin: payload.isAdmin,
|
|
};
|
|
}
|
|
|
|
public shouldSend(): boolean {
|
|
if (this.getSettings().enabled) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
public async send(
|
|
type: Notification,
|
|
payload: NotificationPayload
|
|
): Promise<boolean> {
|
|
const userRepository = getRepository(User);
|
|
const userPushSubRepository = getRepository(UserPushSubscription);
|
|
const settings = getSettings();
|
|
|
|
const pushSubs: UserPushSubscription[] = [];
|
|
|
|
const mainUser = await userRepository.findOne({ where: { id: 1 } });
|
|
|
|
const requestRepository = getRepository(MediaRequest);
|
|
|
|
const pendingRequests = await requestRepository.find({
|
|
where: { status: MediaRequestStatus.PENDING },
|
|
});
|
|
|
|
const webPushNotification = async (
|
|
pushSub: UserPushSubscription,
|
|
notificationPayload: Buffer
|
|
) => {
|
|
logger.debug('Sending web push notification', {
|
|
label: 'Notifications',
|
|
recipient: pushSub.user.displayName,
|
|
type: Notification[type],
|
|
subject: payload.subject,
|
|
});
|
|
|
|
try {
|
|
await webpush.sendNotification(
|
|
{
|
|
endpoint: pushSub.endpoint,
|
|
keys: {
|
|
auth: pushSub.auth,
|
|
p256dh: pushSub.p256dh,
|
|
},
|
|
},
|
|
notificationPayload
|
|
);
|
|
} catch (e) {
|
|
const webPushError = e as WebPushError;
|
|
const statusCode = webPushError.statusCode || webPushError.status;
|
|
const errorMessage = webPushError.message || String(e);
|
|
|
|
// RFC 8030: 410/404 are permanent failures, others are transient
|
|
const isPermanentFailure = statusCode === 410 || statusCode === 404;
|
|
|
|
logger.error(
|
|
isPermanentFailure
|
|
? 'Error sending web push notification; removing invalid subscription'
|
|
: 'Error sending web push notification (transient error, keeping subscription)',
|
|
{
|
|
label: 'Notifications',
|
|
recipient: pushSub.user.displayName,
|
|
type: Notification[type],
|
|
subject: payload.subject,
|
|
errorMessage,
|
|
statusCode: statusCode || 'unknown',
|
|
}
|
|
);
|
|
|
|
if (isPermanentFailure) {
|
|
await userPushSubRepository.remove(pushSub);
|
|
}
|
|
}
|
|
};
|
|
|
|
if (
|
|
payload.notifyUser &&
|
|
// Check if user has webpush notifications enabled and fallback to true if undefined
|
|
// since web push should default to true
|
|
(payload.notifyUser.settings?.hasNotificationType(
|
|
NotificationAgentKey.WEBPUSH,
|
|
type
|
|
) ??
|
|
true)
|
|
) {
|
|
const notifySubs = await userPushSubRepository.find({
|
|
where: { user: { id: payload.notifyUser.id } },
|
|
});
|
|
|
|
pushSubs.push(...notifySubs);
|
|
}
|
|
|
|
if (
|
|
payload.notifyAdmin ||
|
|
type === Notification.MEDIA_APPROVED ||
|
|
type === Notification.MEDIA_DECLINED
|
|
) {
|
|
const users = await userRepository.find();
|
|
|
|
const manageUsers = users.filter(
|
|
(user) =>
|
|
// Check if user has webpush notifications enabled and fallback to true if undefined
|
|
// since web push should default to true
|
|
(user.settings?.hasNotificationType(
|
|
NotificationAgentKey.WEBPUSH,
|
|
type
|
|
) ??
|
|
true) &&
|
|
shouldSendAdminNotification(type, user, payload)
|
|
);
|
|
|
|
const allSubs = await userPushSubRepository
|
|
.createQueryBuilder('pushSub')
|
|
.leftJoinAndSelect('pushSub.user', 'user')
|
|
.where('pushSub.userId IN (:...users)', {
|
|
users: manageUsers.map((user) => user.id),
|
|
})
|
|
.getMany();
|
|
|
|
// We only want to send the custom notification when type is approved or declined
|
|
// Otherwise, default to the normal notification
|
|
if (
|
|
type === Notification.MEDIA_APPROVED ||
|
|
type === Notification.MEDIA_DECLINED
|
|
) {
|
|
if (mainUser && allSubs.length > 0) {
|
|
webpush.setVapidDetails(
|
|
`mailto:${mainUser.email}`,
|
|
settings.vapidPublic,
|
|
settings.vapidPrivate
|
|
);
|
|
|
|
// Custom payload only for updating the app badge
|
|
const notificationBadgePayload = Buffer.from(
|
|
JSON.stringify(
|
|
this.getNotificationPayload(type, {
|
|
subject: payload.subject,
|
|
notifySystem: false,
|
|
notifyAdmin: true,
|
|
isAdmin: true,
|
|
pendingRequestsCount: pendingRequests.length,
|
|
})
|
|
),
|
|
'utf-8'
|
|
);
|
|
|
|
await Promise.all(
|
|
allSubs.map(async (sub) => {
|
|
webPushNotification(sub, notificationBadgePayload);
|
|
})
|
|
);
|
|
}
|
|
} else {
|
|
pushSubs.push(...allSubs);
|
|
}
|
|
}
|
|
|
|
if (mainUser && pushSubs.length > 0) {
|
|
webpush.setVapidDetails(
|
|
`mailto:${mainUser.email}`,
|
|
settings.vapidPublic,
|
|
settings.vapidPrivate
|
|
);
|
|
|
|
if (type === Notification.MEDIA_PENDING) {
|
|
payload = { ...payload, pendingRequestsCount: pendingRequests.length };
|
|
}
|
|
|
|
const notificationPayload = Buffer.from(
|
|
JSON.stringify(this.getNotificationPayload(type, payload)),
|
|
'utf-8'
|
|
);
|
|
|
|
await Promise.all(
|
|
pushSubs.map(async (sub) => {
|
|
webPushNotification(sub, notificationPayload);
|
|
})
|
|
);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
export default WebPushAgent;
|