mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-29 06:22:25 -05:00
[feature] Implement Web Push notification policy (#3721)
* Web Push: add policy column to subscriptions * Web Push: add policy to API * Web Push: test notification policy * go-fmt unrelated file (how did this get thru?)
This commit is contained in:
Vyr Cossont
GitHub
parent
8b74cad422
commit
27844b7da2
16 changed files with 340 additions and 35 deletions
|
|
@ -67,8 +67,7 @@ func (r *realSender) Send(
|
|||
relevantSubscriptions := slices.DeleteFunc(
|
||||
subscriptions,
|
||||
func(subscription *gtsmodel.WebPushSubscription) bool {
|
||||
// Remove subscriptions that don't want this type of notification.
|
||||
return !subscription.NotificationFlags.Get(notification.NotificationType)
|
||||
return r.shouldSkipSubscription(ctx, notification, subscription)
|
||||
},
|
||||
)
|
||||
if len(relevantSubscriptions) == 0 {
|
||||
|
|
@ -117,6 +116,68 @@ func (r *realSender) Send(
|
|||
return nil
|
||||
}
|
||||
|
||||
// shouldSkipSubscription returns true if this subscription is not relevant to this notification.
|
||||
func (r *realSender) shouldSkipSubscription(
|
||||
ctx context.Context,
|
||||
notification *gtsmodel.Notification,
|
||||
subscription *gtsmodel.WebPushSubscription,
|
||||
) bool {
|
||||
// Remove subscriptions that don't want this type of notification.
|
||||
if !subscription.NotificationFlags.Get(notification.NotificationType) {
|
||||
return true
|
||||
}
|
||||
|
||||
// Check against subscription's notification policy.
|
||||
switch subscription.Policy {
|
||||
case gtsmodel.WebPushNotificationPolicyAll:
|
||||
// Allow notifications from any account.
|
||||
return false
|
||||
|
||||
case gtsmodel.WebPushNotificationPolicyFollowed:
|
||||
// Allow if the subscription account follows the notifying account.
|
||||
isFollowing, err := r.state.DB.IsFollowing(ctx, subscription.AccountID, notification.OriginAccountID)
|
||||
if err != nil {
|
||||
log.Errorf(
|
||||
ctx,
|
||||
"error checking whether account %s follows account %s: %v",
|
||||
subscription.AccountID,
|
||||
notification.OriginAccountID,
|
||||
err,
|
||||
)
|
||||
return true
|
||||
}
|
||||
return !isFollowing
|
||||
|
||||
case gtsmodel.WebPushNotificationPolicyFollower:
|
||||
// Allow if the notifying account follows the subscription account.
|
||||
isFollowing, err := r.state.DB.IsFollowing(ctx, notification.OriginAccountID, subscription.AccountID)
|
||||
if err != nil {
|
||||
log.Errorf(
|
||||
ctx,
|
||||
"error checking whether account %s follows account %s: %v",
|
||||
notification.OriginAccountID,
|
||||
subscription.AccountID,
|
||||
err,
|
||||
)
|
||||
return true
|
||||
}
|
||||
return !isFollowing
|
||||
|
||||
case gtsmodel.WebPushNotificationPolicyNone:
|
||||
// This subscription doesn't want any push notifications.
|
||||
return true
|
||||
|
||||
default:
|
||||
log.Errorf(
|
||||
ctx,
|
||||
"unknown Web Push notification policy for subscription with token ID %s: %d",
|
||||
subscription.TokenID,
|
||||
subscription.Policy,
|
||||
)
|
||||
return true
|
||||
}
|
||||
}
|
||||
|
||||
// sendToSubscription sends a notification to a single Web Push subscription.
|
||||
func (r *realSender) sendToSubscription(
|
||||
ctx context.Context,
|
||||
|
|
|
|||
|
|
@ -23,7 +23,6 @@ import (
|
|||
"net/http"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
// for go:linkname
|
||||
_ "unsafe"
|
||||
|
||||
|
|
@ -43,6 +42,7 @@ import (
|
|||
"github.com/superseriousbusiness/gotosocial/internal/subscriptions"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/transport"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/typeutils"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/util"
|
||||
"github.com/superseriousbusiness/gotosocial/internal/webpush"
|
||||
"github.com/superseriousbusiness/gotosocial/testrig"
|
||||
)
|
||||
|
|
@ -62,16 +62,7 @@ type RealSenderStandardTestSuite struct {
|
|||
webPushSender webpush.Sender
|
||||
|
||||
// standard suite models
|
||||
testTokens map[string]*gtsmodel.Token
|
||||
testClients map[string]*gtsmodel.Client
|
||||
testApplications map[string]*gtsmodel.Application
|
||||
testUsers map[string]*gtsmodel.User
|
||||
testAccounts map[string]*gtsmodel.Account
|
||||
testAttachments map[string]*gtsmodel.MediaAttachment
|
||||
testStatuses map[string]*gtsmodel.Status
|
||||
testTags map[string]*gtsmodel.Tag
|
||||
testMentions map[string]*gtsmodel.Mention
|
||||
testEmojis map[string]*gtsmodel.Emoji
|
||||
testNotifications map[string]*gtsmodel.Notification
|
||||
testWebPushSubscriptions map[string]*gtsmodel.WebPushSubscription
|
||||
|
||||
|
|
@ -81,16 +72,7 @@ type RealSenderStandardTestSuite struct {
|
|||
}
|
||||
|
||||
func (suite *RealSenderStandardTestSuite) SetupSuite() {
|
||||
suite.testTokens = testrig.NewTestTokens()
|
||||
suite.testClients = testrig.NewTestClients()
|
||||
suite.testApplications = testrig.NewTestApplications()
|
||||
suite.testUsers = testrig.NewTestUsers()
|
||||
suite.testAccounts = testrig.NewTestAccounts()
|
||||
suite.testAttachments = testrig.NewTestAttachments()
|
||||
suite.testStatuses = testrig.NewTestStatuses()
|
||||
suite.testTags = testrig.NewTestTags()
|
||||
suite.testMentions = testrig.NewTestMentions()
|
||||
suite.testEmojis = testrig.NewTestEmojis()
|
||||
suite.testNotifications = testrig.NewTestNotifications()
|
||||
suite.testWebPushSubscriptions = testrig.NewTestWebPushSubscriptions()
|
||||
}
|
||||
|
|
@ -184,14 +166,16 @@ func (rc *notifyingReadCloser) Close() error {
|
|||
|
||||
// Simulate sending a push notification with the suite's fake web client.
|
||||
func (suite *RealSenderStandardTestSuite) simulatePushNotification(
|
||||
notificationID string,
|
||||
statusCode int,
|
||||
expectSend bool,
|
||||
expectDeletedSubscription bool,
|
||||
) error {
|
||||
// Don't let the test run forever if the push notification was not sent for some reason.
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
|
||||
defer cancel()
|
||||
|
||||
notification, err := suite.state.DB.GetNotificationByID(ctx, suite.testNotifications["local_account_1_like"].ID)
|
||||
notification, err := suite.state.DB.GetNotificationByID(ctx, notificationID)
|
||||
if !suite.NoError(err) {
|
||||
suite.FailNow("Couldn't fetch notification to send")
|
||||
}
|
||||
|
|
@ -221,6 +205,14 @@ func (suite *RealSenderStandardTestSuite) simulatePushNotification(
|
|||
case <-ctx.Done():
|
||||
contextExpired = true
|
||||
}
|
||||
|
||||
// In some cases we expect the notification *not* to be sent.
|
||||
if !expectSend {
|
||||
suite.False(bodyClosed)
|
||||
suite.True(contextExpired)
|
||||
return nil
|
||||
}
|
||||
|
||||
suite.True(bodyClosed)
|
||||
suite.False(contextExpired)
|
||||
|
||||
|
|
@ -240,25 +232,48 @@ func (suite *RealSenderStandardTestSuite) simulatePushNotification(
|
|||
|
||||
// Test a successful response to sending a push notification.
|
||||
func (suite *RealSenderStandardTestSuite) TestSendSuccess() {
|
||||
suite.NoError(suite.simulatePushNotification(http.StatusOK, false))
|
||||
notificationID := suite.testNotifications["local_account_1_like"].ID
|
||||
suite.NoError(suite.simulatePushNotification(notificationID, http.StatusOK, true, false))
|
||||
}
|
||||
|
||||
// Test a rate-limiting response to sending a push notification.
|
||||
// This should not delete the subscription.
|
||||
func (suite *RealSenderStandardTestSuite) TestRateLimited() {
|
||||
suite.NoError(suite.simulatePushNotification(http.StatusTooManyRequests, false))
|
||||
notificationID := suite.testNotifications["local_account_1_like"].ID
|
||||
suite.NoError(suite.simulatePushNotification(notificationID, http.StatusTooManyRequests, true, false))
|
||||
}
|
||||
|
||||
// Test a non-special-cased client error response to sending a push notification.
|
||||
// This should delete the subscription.
|
||||
func (suite *RealSenderStandardTestSuite) TestClientError() {
|
||||
suite.NoError(suite.simulatePushNotification(http.StatusBadRequest, true))
|
||||
notificationID := suite.testNotifications["local_account_1_like"].ID
|
||||
suite.NoError(suite.simulatePushNotification(notificationID, http.StatusBadRequest, true, true))
|
||||
}
|
||||
|
||||
// Test a server error response to sending a push notification.
|
||||
// This should not delete the subscription.
|
||||
func (suite *RealSenderStandardTestSuite) TestServerError() {
|
||||
suite.NoError(suite.simulatePushNotification(http.StatusInternalServerError, false))
|
||||
notificationID := suite.testNotifications["local_account_1_like"].ID
|
||||
suite.NoError(suite.simulatePushNotification(notificationID, http.StatusInternalServerError, true, false))
|
||||
}
|
||||
|
||||
// Don't send a push notification if it doesn't match policy.
|
||||
func (suite *RealSenderStandardTestSuite) TestSendPolicyMismatch() {
|
||||
// Setup: create a new notification from an account that the subscribed account doesn't follow.
|
||||
notification := >smodel.Notification{
|
||||
ID: "01JJZ2Y9Z8E1XKT90EHZ5KZBDW",
|
||||
NotificationType: gtsmodel.NotificationFavourite,
|
||||
TargetAccountID: suite.testAccounts["local_account_1"].ID,
|
||||
OriginAccountID: suite.testAccounts["remote_account_1"].ID,
|
||||
StatusID: "01F8MHAMCHF6Y650WCRSCP4WMY",
|
||||
Read: util.Ptr(false),
|
||||
}
|
||||
if err := suite.db.PutNotification(context.Background(), notification); !suite.NoError(err) {
|
||||
suite.FailNow(err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
suite.NoError(suite.simulatePushNotification(notification.ID, 0, false, false))
|
||||
}
|
||||
|
||||
func TestRealSenderStandardTestSuite(t *testing.T) {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue