feat: push notifications on each device (Web Push)
- What reaches the bell also reaches the devices where the person turned «Avisos en este dispositivo» on, with TaskStream closed: the Notifier sends each new notification encrypted (aes128gcm) and signed with VAPID, and forgets subscriptions the push service dropped (404/410). A failure never blocks the event stream. - The API keeps one subscription per device (push_subscriptions) and exposes the VAPID public key in the notification settings; GraphQL subscribePush/unsubscribePush, REST /me/push-subscriptions. Without VAPID_PUBLIC_KEY and VAPID_PRIVATE_KEY push is off. - The web registers /push-sw.js, a service worker that only shows the notification and opens its ticket on a tap (no caching, served without cache by nginx), and a manifest that makes it installable, which iPhones need for push. - The bell's toggles show their text next to them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -4,6 +4,8 @@ import { NotificationReadModel } from '@task-stream/api/tracker/domain';
|
||||
import { SendDueRemindersCommand } from './notifications/reminders';
|
||||
import {
|
||||
MarkNotificationsReadCommand,
|
||||
SubscribePushCommand,
|
||||
UnsubscribePushCommand,
|
||||
UpdateNotificationSettingsCommand,
|
||||
} from './notifications/notifications.commands';
|
||||
import {
|
||||
@@ -37,6 +39,24 @@ export class NotificationsService {
|
||||
}
|
||||
|
||||
/** `ids` omitted: everything. */
|
||||
/** Push on this device (a browser's Web Push subscription). */
|
||||
subscribePush(
|
||||
userId: string,
|
||||
endpoint: string,
|
||||
keys: { p256dh: string; auth: string },
|
||||
): Promise<void> {
|
||||
return this.commandBus.execute(
|
||||
new SubscribePushCommand(userId, endpoint, keys),
|
||||
);
|
||||
}
|
||||
|
||||
/** Push off on this device. */
|
||||
unsubscribePush(userId: string, endpoint: string): Promise<void> {
|
||||
return this.commandBus.execute(
|
||||
new UnsubscribePushCommand(userId, endpoint),
|
||||
);
|
||||
}
|
||||
|
||||
/** Tells of the tickets due around `day` (YYYY-MM-DD); how many it sent. */
|
||||
sendDueReminders(day: string): Promise<number> {
|
||||
return this.commandBus.execute(new SendDueRemindersCommand(day));
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
import { Command, CommandHandler, ICommandHandler } from '@nestjs/cqrs';
|
||||
import { assertThat } from '@task-stream/api/shared/domain';
|
||||
import { NotificationsRepository } from '../ports/notifications.repository';
|
||||
import { PushSender } from '../ports/push-sender';
|
||||
import { PushSubscriptionsRepository } from '../ports/push-subscriptions.repository';
|
||||
|
||||
/*
|
||||
* Per-person state, outside the event store: whether a notification was read
|
||||
@@ -49,3 +52,64 @@ export class UpdateNotificationSettingsCommandHandler
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/** Push on this device: the browser's subscription is kept for its owner. */
|
||||
export class SubscribePushCommand extends Command<void> {
|
||||
constructor(
|
||||
public readonly userId: string,
|
||||
public readonly endpoint: string,
|
||||
public readonly keys: { p256dh: string; auth: string },
|
||||
) {
|
||||
super();
|
||||
}
|
||||
}
|
||||
|
||||
/** Push off on this device. */
|
||||
export class UnsubscribePushCommand extends Command<void> {
|
||||
constructor(
|
||||
public readonly userId: string,
|
||||
public readonly endpoint: string,
|
||||
) {
|
||||
super();
|
||||
}
|
||||
}
|
||||
|
||||
@CommandHandler(SubscribePushCommand)
|
||||
export class SubscribePushCommandHandler
|
||||
implements ICommandHandler<SubscribePushCommand>
|
||||
{
|
||||
constructor(
|
||||
private readonly subscriptions: PushSubscriptionsRepository,
|
||||
private readonly push: PushSender,
|
||||
) {}
|
||||
|
||||
async execute(command: SubscribePushCommand): Promise<void> {
|
||||
assertThat(!!this.push.publicKey, 'Push is not set up here');
|
||||
// Push services are https; anything else is not a browser's endpoint.
|
||||
assertThat(
|
||||
/^https:\/\/[^\s]{8,2000}$/.test(command.endpoint),
|
||||
'Not a push endpoint',
|
||||
);
|
||||
assertThat(
|
||||
!!command.keys?.p256dh && !!command.keys?.auth,
|
||||
'The subscription keys are missing',
|
||||
);
|
||||
await this.subscriptions.save({
|
||||
userId: command.userId,
|
||||
endpoint: command.endpoint,
|
||||
keys: { p256dh: command.keys.p256dh, auth: command.keys.auth },
|
||||
createdAt: new Date().toISOString(),
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@CommandHandler(UnsubscribePushCommand)
|
||||
export class UnsubscribePushCommandHandler
|
||||
implements ICommandHandler<UnsubscribePushCommand>
|
||||
{
|
||||
constructor(private readonly subscriptions: PushSubscriptionsRepository) {}
|
||||
|
||||
async execute(command: UnsubscribePushCommand): Promise<void> {
|
||||
await this.subscriptions.remove(command.userId, command.endpoint);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import { IQueryHandler, Query, QueryHandler } from '@nestjs/cqrs';
|
||||
import { NotificationReadModel } from '@task-stream/api/tracker/domain';
|
||||
import { NotificationMailer } from '../ports/notification-mailer';
|
||||
import { PushSender } from '../ports/push-sender';
|
||||
import { NotificationsRepository } from '../ports/notifications.repository';
|
||||
|
||||
export interface MyNotifications {
|
||||
@@ -13,6 +14,8 @@ export interface MyNotificationSettings {
|
||||
email: boolean;
|
||||
/** Whether this installation can send e-mail at all. */
|
||||
emailAvailable: boolean;
|
||||
/** VAPID public key to subscribe a device with; null: no push here. */
|
||||
pushPublicKey: string | null;
|
||||
}
|
||||
|
||||
export class GetMyNotificationsQuery extends Query<MyNotifications> {
|
||||
@@ -57,6 +60,7 @@ export class GetMyNotificationSettingsQueryHandler
|
||||
constructor(
|
||||
private readonly notifications: NotificationsRepository,
|
||||
private readonly mailer: NotificationMailer,
|
||||
private readonly push: PushSender,
|
||||
) {}
|
||||
|
||||
async execute(
|
||||
@@ -66,6 +70,7 @@ export class GetMyNotificationSettingsQueryHandler
|
||||
return {
|
||||
email: this.mailer.enabled && settings.email,
|
||||
emailAvailable: this.mailer.enabled,
|
||||
pushPublicKey: this.push.publicKey,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@@ -24,6 +24,12 @@ import { NotificationMailer } from '../ports/notification-mailer';
|
||||
import { NotificationsRepository } from '../ports/notifications.repository';
|
||||
import { NotificationsEventHandler } from './notifications.event-handler';
|
||||
import { Notifier } from './notifier';
|
||||
import {
|
||||
PushPayload,
|
||||
PushSender,
|
||||
PushSubscriptionRecord,
|
||||
} from '../ports/push-sender';
|
||||
import { PushSubscriptionsRepository } from '../ports/push-subscriptions.repository';
|
||||
|
||||
class InMemoryNotifications extends NotificationsRepository {
|
||||
readonly all: NotificationReadModel[] = [];
|
||||
@@ -56,10 +62,14 @@ const at = <T extends TrackerEvent>(event: T, version = 2): T =>
|
||||
occurredAt: '2026-10-08T10:00:00.000Z',
|
||||
});
|
||||
|
||||
function setup(mailEnabled = false) {
|
||||
function setup(mailEnabled = false, pushEnabled = false) {
|
||||
const repo = new InMemoryNotifications();
|
||||
const published: NotificationReadModel[] = [];
|
||||
const mailed: string[] = [];
|
||||
/** Endpoint → what was pushed to it. */
|
||||
const pushed: [string, PushPayload][] = [];
|
||||
const devices: PushSubscriptionRecord[] = [];
|
||||
const forgotten: string[] = [];
|
||||
const users = new FakeUserDirectory()
|
||||
.add('ana')
|
||||
.add('bob')
|
||||
@@ -90,6 +100,21 @@ function setup(mailEnabled = false) {
|
||||
},
|
||||
} as unknown as NotificationMailer,
|
||||
users,
|
||||
{
|
||||
publicKey: pushEnabled ? 'vapid-public' : null,
|
||||
send: async (device: PushSubscriptionRecord, payload: PushPayload) => {
|
||||
pushed.push([device.endpoint, payload]);
|
||||
// A browser that dropped the subscription.
|
||||
return device.endpoint.endsWith('/gone') ? 'gone' : 'sent';
|
||||
},
|
||||
} as unknown as PushSender,
|
||||
{
|
||||
forUser: async (userId: string) =>
|
||||
devices.filter((d) => d.userId === userId),
|
||||
forget: async (endpoint: string) => {
|
||||
forgotten.push(endpoint);
|
||||
},
|
||||
} as unknown as PushSubscriptionsRepository,
|
||||
);
|
||||
const handler = new NotificationsEventHandler(
|
||||
notifier,
|
||||
@@ -118,7 +143,7 @@ function setup(mailEnabled = false) {
|
||||
id === 's-14' ? { id, name: 'Sprint 14' } : null,
|
||||
} as unknown as FindSprintsRepository,
|
||||
);
|
||||
return { repo, published, mailed, handler };
|
||||
return { repo, published, mailed, pushed, devices, forgotten, handler };
|
||||
}
|
||||
|
||||
describe('notifications', () => {
|
||||
@@ -340,4 +365,32 @@ describe('notifications', () => {
|
||||
NotificationKind.ADDED_TO_PROJECT,
|
||||
]);
|
||||
});
|
||||
|
||||
it('pushes to every device of whoever is told, and forgets dropped ones', async () => {
|
||||
const { handler, pushed, devices, forgotten } = setup(false, true);
|
||||
const device = (userId: string, endpoint: string) => ({
|
||||
userId,
|
||||
endpoint,
|
||||
keys: { p256dh: 'p', auth: 'a' },
|
||||
createdAt: '2026-10-01T00:00:00.000Z',
|
||||
});
|
||||
devices.push(
|
||||
device('bob', 'https://push.example/phone'),
|
||||
device('bob', 'https://push.example/gone'),
|
||||
device('qa', 'https://push.example/qa'),
|
||||
);
|
||||
await handler.handle(
|
||||
at(new IssueAssignedEvent('ana', 'i-1', 'p-1', 'bob', null)),
|
||||
);
|
||||
|
||||
expect(pushed.map(([endpoint]) => endpoint)).toEqual([
|
||||
'https://push.example/phone',
|
||||
'https://push.example/gone',
|
||||
]);
|
||||
expect(pushed[0][1]).toMatchObject({
|
||||
title: 'TaskStream · WEB-1',
|
||||
url: '/p/WEB/issues/WEB-1',
|
||||
});
|
||||
expect(forgotten).toEqual(['https://push.example/gone']);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -9,6 +9,8 @@ import {
|
||||
import { ChangeFeed } from '../ports/change-feed';
|
||||
import { NotificationMailer } from '../ports/notification-mailer';
|
||||
import { NotificationsRepository } from '../ports/notifications.repository';
|
||||
import { PushPayload, PushSender } from '../ports/push-sender';
|
||||
import { PushSubscriptionsRepository } from '../ports/push-subscriptions.repository';
|
||||
import { UserDirectory } from '../ports/user-directory';
|
||||
import { versionOf } from '../event-handlers/read-model-notifier';
|
||||
|
||||
@@ -39,6 +41,8 @@ export class Notifier {
|
||||
private readonly changeFeed: ChangeFeed,
|
||||
private readonly mailer: NotificationMailer,
|
||||
private readonly users: UserDirectory,
|
||||
private readonly push: PushSender,
|
||||
private readonly pushSubscriptions: PushSubscriptionsRepository,
|
||||
) {}
|
||||
|
||||
async deliver(
|
||||
@@ -89,6 +93,33 @@ export class Notifier {
|
||||
if (this.mailer.enabled && delivered.length) {
|
||||
await this.email(delivered);
|
||||
}
|
||||
if (this.push.publicKey && delivered.length) {
|
||||
await this.pushToDevices(delivered);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* To every device where the person turned push on. Like e-mail, a failure
|
||||
* never blocks the event stream; a device the push service forgot is
|
||||
* forgotten here too.
|
||||
*/
|
||||
private async pushToDevices(
|
||||
notifications: NotificationReadModel[],
|
||||
): Promise<void> {
|
||||
for (const notification of notifications) {
|
||||
const devices = await this.pushSubscriptions.forUser(notification.userId);
|
||||
for (const device of devices) {
|
||||
try {
|
||||
const result = await this.push.send(device, payloadOf(notification));
|
||||
if (result === 'gone')
|
||||
await this.pushSubscriptions.forget(device.endpoint);
|
||||
} catch (error) {
|
||||
this.logger.warn(
|
||||
`Push to ${notification.userId} failed: ${(error as Error).message}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** A failed e-mail never blocks the event stream: it is logged and skipped. */
|
||||
@@ -116,3 +147,18 @@ export class Notifier {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** What the device shows: the ticket (or project), the line and its page. */
|
||||
export function payloadOf(notification: NotificationReadModel): PushPayload {
|
||||
const project = encodeURIComponent(notification.projectKey);
|
||||
return {
|
||||
title: notification.issueKey
|
||||
? `TaskStream · ${notification.issueKey}`
|
||||
: `TaskStream · ${notification.projectKey}`,
|
||||
body: notification.summary,
|
||||
url: notification.issueKey
|
||||
? `/p/${project}/issues/${encodeURIComponent(notification.issueKey)}`
|
||||
: `/p/${project}`,
|
||||
tag: notification.id,
|
||||
};
|
||||
}
|
||||
|
||||
@@ -28,3 +28,5 @@ export * from './outgoing-webhooks.repository';
|
||||
export * from './automations.repository';
|
||||
export * from './rate-limit.store';
|
||||
export * from './calendar-feeds.repository';
|
||||
export * from './push-sender';
|
||||
export * from './push-subscriptions.repository';
|
||||
|
||||
32
libs/api/tracker/application/src/lib/ports/push-sender.ts
Normal file
32
libs/api/tracker/application/src/lib/ports/push-sender.ts
Normal file
@@ -0,0 +1,32 @@
|
||||
/** A browser's push subscription (Web Push), as the browser hands it over. */
|
||||
export interface PushSubscriptionRecord {
|
||||
userId: string;
|
||||
/** The push service URL of that browser on that device: unique. */
|
||||
endpoint: string;
|
||||
keys: { p256dh: string; auth: string };
|
||||
createdAt: string;
|
||||
}
|
||||
|
||||
/** What the service worker shows: a title, a line and where a tap goes. */
|
||||
export interface PushPayload {
|
||||
title: string;
|
||||
body: string;
|
||||
/** A path in the web app, e.g. `/p/WEB/issues/WEB-12`. */
|
||||
url: string;
|
||||
/** Replaces an earlier notification with the same tag on the device. */
|
||||
tag: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sends Web Push messages (VAPID). Without keys configured it is off and
|
||||
* nobody is offered push.
|
||||
*/
|
||||
export abstract class PushSender {
|
||||
/** The VAPID public key browsers subscribe with; null: push is off. */
|
||||
abstract get publicKey(): string | null;
|
||||
/** `gone`: the browser dropped the subscription; forget it. */
|
||||
abstract send(
|
||||
subscription: PushSubscriptionRecord,
|
||||
payload: PushPayload,
|
||||
): Promise<'sent' | 'gone'>;
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
import { PushSubscriptionRecord } from './push-sender';
|
||||
|
||||
/** The devices where each person turned push on. */
|
||||
export abstract class PushSubscriptionsRepository {
|
||||
abstract forUser(userId: string): Promise<PushSubscriptionRecord[]>;
|
||||
/** By endpoint: a device subscribing again replaces its entry. */
|
||||
abstract save(subscription: PushSubscriptionRecord): Promise<void>;
|
||||
/** Only the owner's: nobody drops someone else's device. */
|
||||
abstract remove(userId: string, endpoint: string): Promise<void>;
|
||||
/** The push service said it no longer exists. */
|
||||
abstract forget(endpoint: string): Promise<void>;
|
||||
}
|
||||
@@ -29,6 +29,8 @@ import {
|
||||
import {
|
||||
MarkNotificationsReadCommandHandler,
|
||||
UpdateNotificationSettingsCommandHandler,
|
||||
SubscribePushCommandHandler,
|
||||
UnsubscribePushCommandHandler,
|
||||
} from './notifications/notifications.commands';
|
||||
|
||||
import { SAVED_FILTERS } from './saved-filters/saved-filters';
|
||||
@@ -55,6 +57,8 @@ const NOTIFICATIONS = [
|
||||
GetMyNotificationSettingsQueryHandler,
|
||||
MarkNotificationsReadCommandHandler,
|
||||
UpdateNotificationSettingsCommandHandler,
|
||||
SubscribePushCommandHandler,
|
||||
UnsubscribePushCommandHandler,
|
||||
SendDueRemindersCommandHandler,
|
||||
];
|
||||
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
import { createHash } from 'node:crypto';
|
||||
import { Injectable } from '@nestjs/common';
|
||||
import { InjectModel } from '@nestjs/mongoose';
|
||||
import {
|
||||
PushSubscriptionRecord,
|
||||
PushSubscriptionsRepository,
|
||||
} from '@task-stream/api/tracker/application';
|
||||
import { Model } from 'mongoose';
|
||||
import { PushSubscriptionDoc, ReadModels } from './read-model.schemas';
|
||||
|
||||
/** Endpoints are long URLs: their hash makes a tidy, unique `id`. */
|
||||
const idOf = (endpoint: string) =>
|
||||
createHash('sha256').update(endpoint).digest('hex');
|
||||
|
||||
@Injectable()
|
||||
export class MongoPushSubscriptionsRepository extends PushSubscriptionsRepository {
|
||||
constructor(
|
||||
@InjectModel(ReadModels.PushSubscription)
|
||||
private readonly subscriptions: Model<PushSubscriptionDoc>,
|
||||
) {
|
||||
super();
|
||||
}
|
||||
|
||||
async forUser(userId: string): Promise<PushSubscriptionRecord[]> {
|
||||
const docs = await this.subscriptions
|
||||
.find({ userId })
|
||||
.lean<PushSubscriptionDoc[]>();
|
||||
return docs.map(({ userId: owner, endpoint, keys, createdAt }) => ({
|
||||
userId: owner,
|
||||
endpoint,
|
||||
keys,
|
||||
createdAt,
|
||||
}));
|
||||
}
|
||||
|
||||
async save(subscription: PushSubscriptionRecord): Promise<void> {
|
||||
await this.subscriptions.updateOne(
|
||||
{ id: idOf(subscription.endpoint) },
|
||||
{ $set: subscription },
|
||||
{ upsert: true },
|
||||
);
|
||||
}
|
||||
|
||||
async remove(userId: string, endpoint: string): Promise<void> {
|
||||
await this.subscriptions.deleteOne({ id: idOf(endpoint), userId });
|
||||
}
|
||||
|
||||
async forget(endpoint: string): Promise<void> {
|
||||
await this.subscriptions.deleteOne({ id: idOf(endpoint) });
|
||||
}
|
||||
}
|
||||
@@ -64,6 +64,14 @@ export interface GitIntegrationDoc {
|
||||
secret?: string;
|
||||
createdAt?: string;
|
||||
}
|
||||
export interface PushSubscriptionDoc {
|
||||
/** sha256 of the endpoint. */
|
||||
id: string;
|
||||
userId: string;
|
||||
endpoint: string;
|
||||
keys: { p256dh: string; auth: string };
|
||||
createdAt: string;
|
||||
}
|
||||
export interface CalendarFeedDoc {
|
||||
/** The user's id. */
|
||||
id: string;
|
||||
@@ -92,6 +100,7 @@ export const ReadModels = {
|
||||
Automation: 'Automation',
|
||||
AutomationRun: 'AutomationRun',
|
||||
CalendarFeed: 'CalendarFeed',
|
||||
PushSubscription: 'PushSubscription',
|
||||
} as const;
|
||||
|
||||
/*
|
||||
@@ -347,6 +356,20 @@ class CalendarFeedDocument {
|
||||
export const CalendarFeedSchema =
|
||||
SchemaFactory.createForClass(CalendarFeedDocument);
|
||||
|
||||
/** The devices where each person turned push on. */
|
||||
@Schema({ ...LOOSE, collection: 'push_subscriptions' })
|
||||
class PushSubscriptionDocument {
|
||||
/** sha256 of the endpoint. */
|
||||
@Prop({ type: String, required: true, unique: true }) id!: string;
|
||||
@Prop({ type: String, index: true }) userId!: string;
|
||||
@Prop({ type: String }) endpoint!: string;
|
||||
@Prop({ type: Object }) keys!: { p256dh: string; auth: string };
|
||||
@Prop({ type: String }) createdAt!: string;
|
||||
}
|
||||
export const PushSubscriptionSchema = SchemaFactory.createForClass(
|
||||
PushSubscriptionDocument,
|
||||
);
|
||||
|
||||
// Redeliveries happen within minutes; a month of memory is plenty.
|
||||
AutomationRunSchema.index({ at: 1 }, { expireAfterSeconds: 30 * 86_400 });
|
||||
|
||||
@@ -366,6 +389,7 @@ export const READ_MODEL_SCHEMAS = [
|
||||
{ name: ReadModels.NotificationSettings, schema: NotificationSettingsSchema },
|
||||
{ name: ReadModels.SavedFilter, schema: SavedFilterSchema },
|
||||
{ name: ReadModels.CalendarFeed, schema: CalendarFeedSchema },
|
||||
{ name: ReadModels.PushSubscription, schema: PushSubscriptionSchema },
|
||||
];
|
||||
|
||||
/** A document as the model it holds: Mongo's own `_id` left out. */
|
||||
|
||||
@@ -0,0 +1,110 @@
|
||||
import { createECDH, randomBytes } from 'node:crypto';
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import * as webpush from 'web-push';
|
||||
import { WebPushSender } from './web-push.sender';
|
||||
|
||||
// The real library, but nothing leaves the machine.
|
||||
jest.mock('web-push', () => ({
|
||||
...jest.requireActual('web-push'),
|
||||
sendNotification: jest.fn(),
|
||||
}));
|
||||
const sendNotification = webpush.sendNotification as jest.MockedFunction<
|
||||
typeof webpush.sendNotification
|
||||
>;
|
||||
|
||||
/** What a browser hands over: its P-256 public key and an auth secret. */
|
||||
function device(endpoint = 'https://push.example/abc') {
|
||||
const ecdh = createECDH('prime256v1');
|
||||
ecdh.generateKeys();
|
||||
return {
|
||||
userId: 'ana',
|
||||
endpoint,
|
||||
keys: {
|
||||
p256dh: ecdh.getPublicKey().toString('base64url'),
|
||||
auth: randomBytes(16).toString('base64url'),
|
||||
},
|
||||
createdAt: '2026-10-15T00:00:00.000Z',
|
||||
};
|
||||
}
|
||||
|
||||
const VAPID = webpush.generateVAPIDKeys();
|
||||
|
||||
function sender(withKeys = true) {
|
||||
const values: Record<string, string> = withKeys
|
||||
? {
|
||||
VAPID_PUBLIC_KEY: VAPID.publicKey,
|
||||
VAPID_PRIVATE_KEY: VAPID.privateKey,
|
||||
VAPID_SUBJECT: 'mailto:test@example.org',
|
||||
}
|
||||
: {};
|
||||
return new WebPushSender({
|
||||
get: (key: string) => values[key],
|
||||
} as unknown as ConfigService);
|
||||
}
|
||||
|
||||
const PAYLOAD = {
|
||||
title: 'TaskStream · WEB-1',
|
||||
body: 'Ana te asignó WEB-1',
|
||||
url: '/p/WEB/issues/WEB-1',
|
||||
tag: 'n-1',
|
||||
};
|
||||
|
||||
describe('WebPushSender', () => {
|
||||
afterEach(() => sendNotification.mockReset());
|
||||
|
||||
it('is off without VAPID keys, on with them', () => {
|
||||
expect(sender(false).publicKey).toBeNull();
|
||||
expect(sender().publicKey).toBe(VAPID.publicKey);
|
||||
});
|
||||
|
||||
it('builds an encrypted, VAPID-signed message for the device', () => {
|
||||
sender();
|
||||
const subscriber = device();
|
||||
const request = webpush.generateRequestDetails(
|
||||
{ endpoint: subscriber.endpoint, keys: subscriber.keys },
|
||||
JSON.stringify(PAYLOAD),
|
||||
{ TTL: 86_400 },
|
||||
);
|
||||
expect(request.headers['Content-Encoding']).toBe('aes128gcm');
|
||||
expect(String(request.headers['Authorization'])).toMatch(
|
||||
new RegExp(`^vapid t=.+, k=${VAPID.publicKey}$`),
|
||||
);
|
||||
// Encrypted: nothing of the text travels in the clear.
|
||||
expect(String(request.body)).not.toContain('WEB-1');
|
||||
});
|
||||
|
||||
it('sends the payload as JSON and keeps it a day', async () => {
|
||||
sendNotification.mockResolvedValue({
|
||||
statusCode: 201,
|
||||
body: '',
|
||||
headers: {},
|
||||
});
|
||||
expect(await sender().send(device(), PAYLOAD)).toBe('sent');
|
||||
const [target, body, options] = sendNotification.mock.calls[0];
|
||||
expect(target.endpoint).toBe('https://push.example/abc');
|
||||
expect(JSON.parse(String(body))).toEqual(PAYLOAD);
|
||||
expect(options).toMatchObject({ TTL: 86_400 });
|
||||
});
|
||||
|
||||
it('tells a subscription the push service dropped (404, 410)', async () => {
|
||||
for (const status of [404, 410]) {
|
||||
sendNotification.mockRejectedValueOnce(
|
||||
new webpush.WebPushError(
|
||||
'gone',
|
||||
status,
|
||||
{},
|
||||
'',
|
||||
'https://push.example/abc',
|
||||
),
|
||||
);
|
||||
expect(await sender().send(device(), PAYLOAD)).toBe('gone');
|
||||
}
|
||||
});
|
||||
|
||||
it('lets other failures through, to be logged', async () => {
|
||||
sendNotification.mockRejectedValue(
|
||||
new webpush.WebPushError('busy', 503, {}, '', 'https://push.example/abc'),
|
||||
);
|
||||
await expect(sender().send(device(), PAYLOAD)).rejects.toThrow('busy');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,61 @@
|
||||
import { Injectable, Logger } from '@nestjs/common';
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import {
|
||||
PushPayload,
|
||||
PushSender,
|
||||
PushSubscriptionRecord,
|
||||
} from '@task-stream/api/tracker/application';
|
||||
import * as webpush from 'web-push';
|
||||
|
||||
/**
|
||||
* Web Push with VAPID keys (VAPID_PUBLIC_KEY, VAPID_PRIVATE_KEY and
|
||||
* VAPID_SUBJECT, a `mailto:` or https URL the push services can reach
|
||||
* someone at). Make the keys once with `npx web-push generate-vapid-keys`;
|
||||
* changing them drops every subscription. Without them push is off.
|
||||
*/
|
||||
@Injectable()
|
||||
export class WebPushSender extends PushSender {
|
||||
private readonly logger = new Logger(WebPushSender.name);
|
||||
private readonly key: string | null;
|
||||
|
||||
constructor(config: ConfigService) {
|
||||
super();
|
||||
const publicKey = config.get<string>('VAPID_PUBLIC_KEY') || '';
|
||||
const privateKey = config.get<string>('VAPID_PRIVATE_KEY') || '';
|
||||
const subject =
|
||||
config.get<string>('VAPID_SUBJECT') || 'mailto:no-reply@pireon.dev';
|
||||
this.key = publicKey && privateKey ? publicKey : null;
|
||||
if (this.key) {
|
||||
webpush.setVapidDetails(subject, publicKey, privateKey);
|
||||
this.logger.log('Push notifications enabled');
|
||||
}
|
||||
}
|
||||
|
||||
get publicKey(): string | null {
|
||||
return this.key;
|
||||
}
|
||||
|
||||
async send(
|
||||
subscription: PushSubscriptionRecord,
|
||||
payload: PushPayload,
|
||||
): Promise<'sent' | 'gone'> {
|
||||
if (!this.key) return 'sent';
|
||||
try {
|
||||
await webpush.sendNotification(
|
||||
{ endpoint: subscription.endpoint, keys: subscription.keys },
|
||||
JSON.stringify(payload),
|
||||
// Kept a day by the push service while the device is off.
|
||||
{ TTL: 86_400, urgency: 'normal' },
|
||||
);
|
||||
return 'sent';
|
||||
} catch (error) {
|
||||
// 404 / 410: that browser dropped the subscription for good.
|
||||
if (
|
||||
error instanceof webpush.WebPushError &&
|
||||
(error.statusCode === 404 || error.statusCode === 410)
|
||||
)
|
||||
return 'gone';
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -8,6 +8,8 @@ import {
|
||||
NotificationMailer,
|
||||
NotificationsRepository,
|
||||
CalendarFeedsRepository,
|
||||
PushSubscriptionsRepository,
|
||||
PushSender,
|
||||
SavedFiltersRepository,
|
||||
GitIntegrationsRepository,
|
||||
OutgoingWebhooksRepository,
|
||||
@@ -67,6 +69,8 @@ import { RedisChangeFeed } from './realtime/redis-change-feed';
|
||||
import { RedisRateLimitStore } from './redis/redis-rate-limit.store';
|
||||
import { MongoNotificationsRepository } from './mongo/notifications.repository';
|
||||
import { MongoCalendarFeedsRepository } from './mongo/calendar-feeds.repository';
|
||||
import { MongoPushSubscriptionsRepository } from './mongo/push-subscriptions.repository';
|
||||
import { WebPushSender } from './push/web-push.sender';
|
||||
import { MongoSavedFiltersRepository } from './mongo/saved-filters.repository';
|
||||
import { MongoGitIntegrationsRepository } from './mongo/git-integrations.repository';
|
||||
import { MongoOutgoingWebhooksRepository } from './mongo/outgoing-webhooks.repository';
|
||||
@@ -133,6 +137,11 @@ const PORTS = [
|
||||
// Notifications → MongoDB (per person), copies by e-mail → SMTP (optional)
|
||||
{ provide: NotificationsRepository, useClass: MongoNotificationsRepository },
|
||||
{ provide: CalendarFeedsRepository, useClass: MongoCalendarFeedsRepository },
|
||||
{
|
||||
provide: PushSubscriptionsRepository,
|
||||
useClass: MongoPushSubscriptionsRepository,
|
||||
},
|
||||
{ provide: PushSender, useClass: WebPushSender },
|
||||
{ provide: SavedFiltersRepository, useClass: MongoSavedFiltersRepository },
|
||||
{
|
||||
provide: GitIntegrationsRepository,
|
||||
|
||||
@@ -689,3 +689,14 @@ export class ProjectSettingsInput {
|
||||
@Type(() => AreaOptionInput)
|
||||
areas!: AreaOptionInput[];
|
||||
}
|
||||
|
||||
@InputType({
|
||||
description: "A browser's Web Push subscription (PushSubscription.toJSON())",
|
||||
})
|
||||
export class PushSubscriptionInput {
|
||||
@Field()
|
||||
@IsUrl({ protocols: ['https'], require_tld: false })
|
||||
endpoint!: string;
|
||||
@Field() @IsString() @MaxLength(200) p256dh!: string;
|
||||
@Field() @IsString() @MaxLength(100) auth!: string;
|
||||
}
|
||||
|
||||
@@ -7,6 +7,7 @@ import {
|
||||
NotificationGql,
|
||||
NotificationSettingsGql,
|
||||
} from './types';
|
||||
import { PushSubscriptionInput } from './inputs';
|
||||
|
||||
/** The signed-in person's notifications. */
|
||||
@Resolver(() => NotificationGql)
|
||||
@@ -40,6 +41,27 @@ export class NotificationResolver {
|
||||
return true;
|
||||
}
|
||||
|
||||
@Mutation(() => Boolean, { description: 'Push on this device' })
|
||||
async subscribePush(
|
||||
@CurrentUser() me: User,
|
||||
@Args('subscription') subscription: PushSubscriptionInput,
|
||||
) {
|
||||
await this.notifications.subscribePush(me.id, subscription.endpoint, {
|
||||
p256dh: subscription.p256dh,
|
||||
auth: subscription.auth,
|
||||
});
|
||||
return true;
|
||||
}
|
||||
|
||||
@Mutation(() => Boolean, { description: 'Push off on this device' })
|
||||
async unsubscribePush(
|
||||
@CurrentUser() me: User,
|
||||
@Args('endpoint') endpoint: string,
|
||||
) {
|
||||
await this.notifications.unsubscribePush(me.id, endpoint);
|
||||
return true;
|
||||
}
|
||||
|
||||
@Mutation(() => NotificationSettingsGql)
|
||||
updateNotificationSettings(
|
||||
@CurrentUser() me: User,
|
||||
|
||||
@@ -642,6 +642,12 @@ export class NotificationSettingsGql {
|
||||
description: 'Whether this installation can send e-mail at all',
|
||||
})
|
||||
emailAvailable!: boolean;
|
||||
@Field(() => String, {
|
||||
nullable: true,
|
||||
description:
|
||||
'VAPID public key to subscribe a device to push with; null: no push here',
|
||||
})
|
||||
pushPublicKey!: string | null;
|
||||
}
|
||||
|
||||
@ObjectType('CommandResult', {
|
||||
|
||||
@@ -1212,6 +1212,31 @@ export class NotificationSettingsDto {
|
||||
email!: boolean;
|
||||
}
|
||||
|
||||
export class PushSubscriptionDto {
|
||||
@ApiProperty({
|
||||
description: 'The push service URL (PushSubscription.endpoint)',
|
||||
})
|
||||
@IsUrl({ protocols: ['https'], require_tld: false })
|
||||
endpoint!: string;
|
||||
|
||||
@ApiProperty({ description: 'keys.p256dh of the subscription' })
|
||||
@IsString()
|
||||
@MaxLength(200)
|
||||
p256dh!: string;
|
||||
|
||||
@ApiProperty({ description: 'keys.auth of the subscription' })
|
||||
@IsString()
|
||||
@MaxLength(100)
|
||||
auth!: string;
|
||||
}
|
||||
|
||||
export class PushEndpointDto {
|
||||
@ApiProperty({ description: 'The endpoint of the device to turn off' })
|
||||
@IsString()
|
||||
@MaxLength(2000)
|
||||
endpoint!: string;
|
||||
}
|
||||
|
||||
// ---- Git --------------------------------------------------------------------
|
||||
|
||||
export class AddGitRepositoryDto {
|
||||
|
||||
@@ -844,4 +844,11 @@ export class NotificationSettingsResponseDto {
|
||||
@ApiProperty({ description: 'Copies by e-mail' }) email!: boolean;
|
||||
@ApiProperty({ description: 'Whether this installation can send e-mail' })
|
||||
emailAvailable!: boolean;
|
||||
@ApiProperty({
|
||||
type: String,
|
||||
nullable: true,
|
||||
description:
|
||||
'VAPID public key to subscribe a device to push with; null: no push here',
|
||||
})
|
||||
pushPublicKey!: string | null;
|
||||
}
|
||||
|
||||
@@ -1,5 +1,19 @@
|
||||
import { Body, Controller, Get, Post, Put, Query } from '@nestjs/common';
|
||||
import { ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
|
||||
import {
|
||||
Body,
|
||||
Controller,
|
||||
Delete,
|
||||
Get,
|
||||
HttpCode,
|
||||
Post,
|
||||
Put,
|
||||
Query,
|
||||
} from '@nestjs/common';
|
||||
import {
|
||||
ApiNoContentResponse,
|
||||
ApiOkResponse,
|
||||
ApiOperation,
|
||||
ApiTags,
|
||||
} from '@nestjs/swagger';
|
||||
import { User } from '@task-stream/api/identity/domain';
|
||||
import {
|
||||
ApiPireonAuth,
|
||||
@@ -14,6 +28,8 @@ import {
|
||||
MarkNotificationsReadDto,
|
||||
MyNotificationsQueryDto,
|
||||
NotificationSettingsDto,
|
||||
PushEndpointDto,
|
||||
PushSubscriptionDto,
|
||||
} from './dto/requests.dto';
|
||||
import {
|
||||
MyNotificationsDto,
|
||||
@@ -67,4 +83,32 @@ export class NotificationsController {
|
||||
) {
|
||||
return this.notifications.updateSettings(me.id, body);
|
||||
}
|
||||
|
||||
@Post('push-subscriptions')
|
||||
@HttpCode(204)
|
||||
@ApiOperation({
|
||||
summary: "Push on this device (a browser's Web Push subscription)",
|
||||
})
|
||||
@ApiNoContentResponse()
|
||||
@ApiCommandErrors()
|
||||
async subscribePush(
|
||||
@CurrentUser() me: User,
|
||||
@Body() body: PushSubscriptionDto,
|
||||
): Promise<void> {
|
||||
await this.notifications.subscribePush(me.id, body.endpoint, {
|
||||
p256dh: body.p256dh,
|
||||
auth: body.auth,
|
||||
});
|
||||
}
|
||||
|
||||
@Delete('push-subscriptions')
|
||||
@HttpCode(204)
|
||||
@ApiOperation({ summary: 'Push off on this device' })
|
||||
@ApiNoContentResponse()
|
||||
async unsubscribePush(
|
||||
@CurrentUser() me: User,
|
||||
@Body() body: PushEndpointDto,
|
||||
): Promise<void> {
|
||||
await this.notifications.unsubscribePush(me.id, body.endpoint);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user