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:
@@ -7260,6 +7260,130 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/api/me/push-subscriptions": {
|
||||
"post": {
|
||||
"operationId": "NotificationsController_subscribePush",
|
||||
"parameters": [],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PushSubscriptionDto"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": ""
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid input",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ApiErrorDto"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Missing or rejected Pireon token",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ApiErrorDto"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Not a member of the project (or not allowed)",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ApiErrorDto"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not found",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ApiErrorDto"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"409": {
|
||||
"description": "Someone changed it at the same time: retry",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ApiErrorDto"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422": {
|
||||
"description": "Business rule (e.g. a transition the workflow forbids)",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ApiErrorDto"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"pireon-oauth": []
|
||||
},
|
||||
{
|
||||
"pireon": []
|
||||
}
|
||||
],
|
||||
"summary": "Push on this device (a browser's Web Push subscription)",
|
||||
"tags": [
|
||||
"Users"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"operationId": "NotificationsController_unsubscribePush",
|
||||
"parameters": [],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PushEndpointDto"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": ""
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"pireon-oauth": []
|
||||
},
|
||||
{
|
||||
"pireon": []
|
||||
}
|
||||
],
|
||||
"summary": "Push off on this device",
|
||||
"tags": [
|
||||
"Users"
|
||||
]
|
||||
}
|
||||
},
|
||||
"/api/projects/{project}/filters": {
|
||||
"get": {
|
||||
"operationId": "SavedFiltersController_list",
|
||||
@@ -12933,11 +13057,17 @@
|
||||
"emailAvailable": {
|
||||
"type": "boolean",
|
||||
"description": "Whether this installation can send e-mail"
|
||||
},
|
||||
"pushPublicKey": {
|
||||
"type": "string",
|
||||
"nullable": true,
|
||||
"description": "VAPID public key to subscribe a device to push with; null: no push here"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"email",
|
||||
"emailAvailable"
|
||||
"emailAvailable",
|
||||
"pushPublicKey"
|
||||
]
|
||||
},
|
||||
"NotificationSettingsDto": {
|
||||
@@ -12952,6 +13082,40 @@
|
||||
"email"
|
||||
]
|
||||
},
|
||||
"PushSubscriptionDto": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"endpoint": {
|
||||
"type": "string",
|
||||
"description": "The push service URL (PushSubscription.endpoint)"
|
||||
},
|
||||
"p256dh": {
|
||||
"type": "string",
|
||||
"description": "keys.p256dh of the subscription"
|
||||
},
|
||||
"auth": {
|
||||
"type": "string",
|
||||
"description": "keys.auth of the subscription"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"endpoint",
|
||||
"p256dh",
|
||||
"auth"
|
||||
]
|
||||
},
|
||||
"PushEndpointDto": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"endpoint": {
|
||||
"type": "string",
|
||||
"description": "The endpoint of the device to turn off"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"endpoint"
|
||||
]
|
||||
},
|
||||
"SavedFilterCriteriaResponseDto": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
||||
@@ -772,6 +772,9 @@ type Mutation {
|
||||
"""Start a planned sprint (only one under way per project)"""
|
||||
startSprint(sprintId: ID!): CommandResult!
|
||||
|
||||
"""Push on this device"""
|
||||
subscribePush(subscription: PushSubscriptionInput!): Boolean!
|
||||
|
||||
"""Send a ping now and tell how it went"""
|
||||
testWebhook(webhookId: ID!): WebhookDelivery!
|
||||
|
||||
@@ -781,6 +784,9 @@ type Mutation {
|
||||
trashIssue(issueId: ID!): CommandResult!
|
||||
unlinkIssues(input: LinkIssuesInput!): CommandResult!
|
||||
|
||||
"""Push off on this device"""
|
||||
unsubscribePush(endpoint: String!): Boolean!
|
||||
|
||||
"""Stop following a ticket"""
|
||||
unwatchIssue(issueId: ID!): CommandResult!
|
||||
|
||||
@@ -859,6 +865,11 @@ type NotificationSettings {
|
||||
|
||||
"""Whether this installation can send e-mail at all"""
|
||||
emailAvailable: Boolean!
|
||||
|
||||
"""
|
||||
VAPID public key to subscribe a device to push with; null: no push here
|
||||
"""
|
||||
pushPublicKey: String
|
||||
}
|
||||
|
||||
type Project {
|
||||
@@ -980,6 +991,13 @@ type ProjectStats {
|
||||
total: Int!
|
||||
}
|
||||
|
||||
"""A browser's Web Push subscription (PushSubscription.toJSON())"""
|
||||
input PushSubscriptionInput {
|
||||
auth: String!
|
||||
endpoint: String!
|
||||
p256dh: String!
|
||||
}
|
||||
|
||||
type QaStats {
|
||||
failed: Int!
|
||||
failureRate: Float
|
||||
|
||||
@@ -52,6 +52,11 @@ export const configSchema = Joi.object({
|
||||
// E-mail copies of notifications (optional): without SMTP_URL nothing is sent.
|
||||
SMTP_URL: Joi.string().allow('').optional(),
|
||||
MAIL_FROM: Joi.string().allow('').optional(),
|
||||
// Push notifications (optional): without both VAPID keys nothing is sent.
|
||||
// Make them once with `npx web-push generate-vapid-keys`.
|
||||
VAPID_PUBLIC_KEY: Joi.string().allow('').optional(),
|
||||
VAPID_PRIVATE_KEY: Joi.string().allow('').optional(),
|
||||
VAPID_SUBJECT: Joi.string().allow('').optional(),
|
||||
// Public address of the web app, for links in e-mails.
|
||||
WEB_URL: Joi.string().allow('').optional(),
|
||||
});
|
||||
|
||||
@@ -1112,6 +1112,24 @@ export interface paths {
|
||||
patch?: never;
|
||||
trace?: never;
|
||||
};
|
||||
"/api/me/push-subscriptions": {
|
||||
parameters: {
|
||||
query?: never;
|
||||
header?: never;
|
||||
path?: never;
|
||||
cookie?: never;
|
||||
};
|
||||
get?: never;
|
||||
put?: never;
|
||||
/** Push on this device (a browser's Web Push subscription) */
|
||||
post: operations["NotificationsController_subscribePush"];
|
||||
/** Push off on this device */
|
||||
delete: operations["NotificationsController_unsubscribePush"];
|
||||
options?: never;
|
||||
head?: never;
|
||||
patch?: never;
|
||||
trace?: never;
|
||||
};
|
||||
"/api/projects/{project}/filters": {
|
||||
parameters: {
|
||||
query?: never;
|
||||
@@ -2531,11 +2549,25 @@ export interface components {
|
||||
email: boolean;
|
||||
/** @description Whether this installation can send e-mail */
|
||||
emailAvailable: boolean;
|
||||
/** @description VAPID public key to subscribe a device to push with; null: no push here */
|
||||
pushPublicKey: string | null;
|
||||
};
|
||||
NotificationSettingsDto: {
|
||||
/** @description Copies by e-mail */
|
||||
email: boolean;
|
||||
};
|
||||
PushSubscriptionDto: {
|
||||
/** @description The push service URL (PushSubscription.endpoint) */
|
||||
endpoint: string;
|
||||
/** @description keys.p256dh of the subscription */
|
||||
p256dh: string;
|
||||
/** @description keys.auth of the subscription */
|
||||
auth: string;
|
||||
};
|
||||
PushEndpointDto: {
|
||||
/** @description The endpoint of the device to turn off */
|
||||
endpoint: string;
|
||||
};
|
||||
SavedFilterCriteriaResponseDto: {
|
||||
types?: string[];
|
||||
areas?: string[];
|
||||
@@ -7792,6 +7824,102 @@ export interface operations {
|
||||
};
|
||||
};
|
||||
};
|
||||
NotificationsController_subscribePush: {
|
||||
parameters: {
|
||||
query?: never;
|
||||
header?: never;
|
||||
path?: never;
|
||||
cookie?: never;
|
||||
};
|
||||
requestBody: {
|
||||
content: {
|
||||
"application/json": components["schemas"]["PushSubscriptionDto"];
|
||||
};
|
||||
};
|
||||
responses: {
|
||||
204: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content?: never;
|
||||
};
|
||||
/** @description Invalid input */
|
||||
400: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content: {
|
||||
"application/json": components["schemas"]["ApiErrorDto"];
|
||||
};
|
||||
};
|
||||
/** @description Missing or rejected Pireon token */
|
||||
401: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content: {
|
||||
"application/json": components["schemas"]["ApiErrorDto"];
|
||||
};
|
||||
};
|
||||
/** @description Not a member of the project (or not allowed) */
|
||||
403: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content: {
|
||||
"application/json": components["schemas"]["ApiErrorDto"];
|
||||
};
|
||||
};
|
||||
/** @description Not found */
|
||||
404: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content: {
|
||||
"application/json": components["schemas"]["ApiErrorDto"];
|
||||
};
|
||||
};
|
||||
/** @description Someone changed it at the same time: retry */
|
||||
409: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content: {
|
||||
"application/json": components["schemas"]["ApiErrorDto"];
|
||||
};
|
||||
};
|
||||
/** @description Business rule (e.g. a transition the workflow forbids) */
|
||||
422: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content: {
|
||||
"application/json": components["schemas"]["ApiErrorDto"];
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
NotificationsController_unsubscribePush: {
|
||||
parameters: {
|
||||
query?: never;
|
||||
header?: never;
|
||||
path?: never;
|
||||
cookie?: never;
|
||||
};
|
||||
requestBody: {
|
||||
content: {
|
||||
"application/json": components["schemas"]["PushEndpointDto"];
|
||||
};
|
||||
};
|
||||
responses: {
|
||||
204: {
|
||||
headers: {
|
||||
[name: string]: unknown;
|
||||
};
|
||||
content?: never;
|
||||
};
|
||||
};
|
||||
};
|
||||
SavedFiltersController_list: {
|
||||
parameters: {
|
||||
query?: never;
|
||||
|
||||
@@ -28,6 +28,19 @@ server {
|
||||
proxy_read_timeout 1h;
|
||||
}
|
||||
|
||||
# The service worker and the manifest have no hash in their name: never
|
||||
# cached, or browsers would keep an old one (exact matches win over the
|
||||
# regex below).
|
||||
location = /push-sw.js {
|
||||
add_header Cache-Control "no-cache";
|
||||
try_files $uri =404;
|
||||
}
|
||||
location = /manifest.webmanifest {
|
||||
add_header Cache-Control "no-cache";
|
||||
default_type application/manifest+json;
|
||||
try_files $uri =404;
|
||||
}
|
||||
|
||||
# Hashed bundles can be cached forever; index.html never.
|
||||
location ~* \.(js|css|woff2?|svg|png|ico)$ {
|
||||
expires 1y;
|
||||
|
||||
BIN
apps/web/public/logo-192.png
Normal file
BIN
apps/web/public/logo-192.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
BIN
apps/web/public/logo-512.png
Normal file
BIN
apps/web/public/logo-512.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 98 KiB |
25
apps/web/public/manifest.webmanifest
Normal file
25
apps/web/public/manifest.webmanifest
Normal file
@@ -0,0 +1,25 @@
|
||||
{
|
||||
"name": "TaskStream",
|
||||
"short_name": "TaskStream",
|
||||
"description": "Gestión de proyectos y tickets en tiempo real",
|
||||
"lang": "es",
|
||||
"start_url": "/",
|
||||
"scope": "/",
|
||||
"display": "standalone",
|
||||
"background_color": "#f7f7fa",
|
||||
"theme_color": "#a347e1",
|
||||
"icons": [
|
||||
{
|
||||
"src": "/logo-192.png",
|
||||
"sizes": "192x192",
|
||||
"type": "image/png",
|
||||
"purpose": "any"
|
||||
},
|
||||
{
|
||||
"src": "/logo-512.png",
|
||||
"sizes": "512x512",
|
||||
"type": "image/png",
|
||||
"purpose": "any"
|
||||
}
|
||||
]
|
||||
}
|
||||
52
apps/web/public/push-sw.js
Normal file
52
apps/web/public/push-sw.js
Normal file
@@ -0,0 +1,52 @@
|
||||
/*
|
||||
* TaskStream's service worker: push notifications only. It caches nothing,
|
||||
* so a new deploy never leaves an old version of the app behind.
|
||||
*
|
||||
* The API sends `{ title, body, url, tag }` (see Notifier's payloadOf).
|
||||
*/
|
||||
self.addEventListener('install', () => self.skipWaiting());
|
||||
self.addEventListener('activate', (event) =>
|
||||
event.waitUntil(self.clients.claim()),
|
||||
);
|
||||
|
||||
self.addEventListener('push', (event) => {
|
||||
let data = {};
|
||||
try {
|
||||
data = event.data ? event.data.json() : {};
|
||||
} catch {
|
||||
data = { body: event.data ? event.data.text() : '' };
|
||||
}
|
||||
event.waitUntil(
|
||||
self.registration.showNotification(data.title || 'TaskStream', {
|
||||
body: data.body || '',
|
||||
tag: data.tag,
|
||||
icon: '/logo-192.png',
|
||||
badge: '/logo-96.png',
|
||||
data: { url: data.url || '/' },
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
// A tap opens the ticket: in a TaskStream tab already open, or in a new one.
|
||||
self.addEventListener('notificationclick', (event) => {
|
||||
event.notification.close();
|
||||
const target = new URL(
|
||||
event.notification.data?.url || '/',
|
||||
self.location.origin,
|
||||
).href;
|
||||
event.waitUntil(
|
||||
self.clients
|
||||
.matchAll({ type: 'window', includeUncontrolled: true })
|
||||
.then((tabs) => {
|
||||
for (const tab of tabs) {
|
||||
if (
|
||||
new URL(tab.url).origin === self.location.origin &&
|
||||
'focus' in tab
|
||||
) {
|
||||
return tab.focus().then(() => tab.navigate(target));
|
||||
}
|
||||
}
|
||||
return self.clients.openWindow(target);
|
||||
}),
|
||||
);
|
||||
});
|
||||
@@ -12,6 +12,8 @@
|
||||
<link rel="icon" type="image/x-icon" href="favicon.ico" />
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="logo-96.png" />
|
||||
<link rel="apple-touch-icon" href="logo.png" />
|
||||
<!-- Installable (on iPhone, push only reaches an installed web app) -->
|
||||
<link rel="manifest" href="manifest.webmanifest" />
|
||||
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
<!-- Inter, like pireon.dev · Geist Mono only for data (ticket keys, counters, versions) -->
|
||||
|
||||
Reference in New Issue
Block a user