summaryrefslogtreecommitdiff
path: root/internal/api/model/webpushnotification.go
diff options
context:
space:
mode:
authorLibravatar Vyr Cossont <VyrCossont@users.noreply.github.com>2025-01-23 16:47:30 -0800
committerLibravatar GitHub <noreply@github.com>2025-01-23 16:47:30 -0800
commit5b765d734ee70f0a8a0790444d60969a727567f8 (patch)
treef76e05a6e5b22df17160be595c40e964bdbe5f22 /internal/api/model/webpushnotification.go
parent[feature] Serve bot accounts over AP as Service instead of Person (#3672) (diff)
downloadgotosocial-5b765d734ee70f0a8a0790444d60969a727567f8.tar.xz
[feature] Push notifications (#3587)
* Update push subscription API model to be Mastodon 4.0 compatible * Add webpush-go dependency # Conflicts: # go.sum * Single-row table for storing instance's VAPID key pair * Generate VAPID key pair during startup * Add VAPID public key to instance info API * Return VAPID public key when registering an app * Store Web Push subscriptions in DB * Add Web Push sender (similar to email sender) * Add no-op push senders to most processor tests * Test Web Push notifications from workers * Delete Web Push subscriptions when account is deleted * Implement push subscription API * Linter fixes * Update Swagger * Fix enum to int migration * Fix GetVAPIDKeyPair * Create web push subscriptions table with indexes * Log Web Push server error messages * Send instance URL as Web Push JWT subject * Accept any 2xx code as a success * Fix malformed VAPID sub claim * Use packed notification flags * Remove unused date columns * Add notification type for update notifications Not used yet * Make GetVAPIDKeyPair idempotent and remove PutVAPIDKeyPair * Post-rebase fixes * go mod tidy * Special-case 400 errors other than 408/429 Most client errors should remove the subscription. * Improve titles, trim body to reasonable length * Disallow cleartext HTTP for Web Push servers * Fix lint * Remove redundant index on unique column Also removes redundant unique and notnull tags on ID column since these are implied by pk * Make realsender.go more readable * Use Tobi's style for wrapping errors * Restore treating all 5xx codes as temporary problems * Always load target account settings * Stub `policy` and `standard` * webpush.Sender: take type converter as ctor param * Move webpush.MockSender and noopSender into testrig
Diffstat (limited to 'internal/api/model/webpushnotification.go')
-rw-r--r--internal/api/model/webpushnotification.go52
1 files changed, 52 insertions, 0 deletions
diff --git a/internal/api/model/webpushnotification.go b/internal/api/model/webpushnotification.go
new file mode 100644
index 000000000..5d7a593fc
--- /dev/null
+++ b/internal/api/model/webpushnotification.go
@@ -0,0 +1,52 @@
+// GoToSocial
+// Copyright (C) GoToSocial Authors admin@gotosocial.org
+// SPDX-License-Identifier: AGPL-3.0-or-later
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+package model
+
+// WebPushNotification represents a notification summary delivered to the client by the Web Push server.
+// It does not contain an entire Notification, just the NotificationID and some preview information.
+// It is not used in the client API directly, but is included in the API doc for decoding Web Push notifications.
+//
+// swagger:model webPushNotification
+type WebPushNotification struct {
+ // NotificationID is the Notification.ID of the referenced Notification.
+ NotificationID string `json:"notification_id"`
+
+ // NotificationType is the Notification.Type of the referenced Notification.
+ NotificationType string `json:"notification_type"`
+
+ // Title is a title for the notification,
+ // generally describing an action taken by a user.
+ Title string `json:"title"`
+
+ // Body is a preview of the notification body,
+ // such as the first line of a status's CW or text,
+ // or the first line of an account bio.
+ Body string `json:"body"`
+
+ // Icon is an image URL that can be displayed with the notification,
+ // normally the account's avatar.
+ Icon string `json:"icon"`
+
+ // PreferredLocale is a BCP 47 language tag for the receiving user's locale.
+ PreferredLocale string `json:"preferred_locale"`
+
+ // AccessToken is the access token associated with the Web Push subscription.
+ // I don't know why this is sent, given that the client should know that already,
+ // but Feditext does use it.
+ AccessToken string `json:"access_token"`
+}