mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-11-26 21:56:39 +00:00
84279f6a6a
* improvements to caching for lists and relationship to accounts / follows * fix nil panic in AddToList() * ensure list related caches are correctly invalidated * ensure returned ID lists are ordered correctly * bump go-structr to v0.8.9 (returns early if zero uncached keys to be loaded) * remove zero checks in uncached key load functions (go-structr now handles this) * fix issues after rebase on upstream/main * update the expected return order of CSV exports (since list entries are now down by entry creation date) * rename some funcs, allow deleting list entries for multiple follow IDs at a time, fix up more tests * use returning statements on delete to get cache invalidation info * fixes to recent database delete changes * fix broken list entries delete sql * remove unused db function * update remainder of delete functions to behave in similar way, some other small tweaks * fix delete user sql, allow returning on err no entries * uncomment + fix list database tests * update remaining list tests * update envparsing test * add comments to each specific key being invalidated * add more cache invalidation explanatory comments * whoops; actually delete poll votes from database in the DeletePollByID() func * remove added but-commented-out field * improved comment regarding paging being disabled * make cache invalidation comments match what's actually happening * fix up delete query comments to match what is happening * rename function to read a bit better * don't use ErrNoEntries on delete when not needed (it's only needed for a RETURNING call) * update function name in test * move list exclusivity check to AFTER eligibility check. use log.Panic() instead of panic() * use the poll_id column in poll_votes for selecting votes in poll ID * fix function name
357 lines
9.5 KiB
Go
357 lines
9.5 KiB
Go
// 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 bundb
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"slices"
|
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/db"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtscontext"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
"github.com/superseriousbusiness/gotosocial/internal/id"
|
|
"github.com/superseriousbusiness/gotosocial/internal/log"
|
|
"github.com/superseriousbusiness/gotosocial/internal/state"
|
|
"github.com/superseriousbusiness/gotosocial/internal/util"
|
|
"github.com/uptrace/bun"
|
|
)
|
|
|
|
type notificationDB struct {
|
|
db *bun.DB
|
|
state *state.State
|
|
}
|
|
|
|
func (n *notificationDB) GetNotificationByID(ctx context.Context, id string) (*gtsmodel.Notification, error) {
|
|
return n.getNotification(
|
|
ctx,
|
|
"ID",
|
|
func(notif *gtsmodel.Notification) error {
|
|
return n.db.NewSelect().
|
|
Model(notif).
|
|
Where("? = ?", bun.Ident("id"), id).
|
|
Scan(ctx)
|
|
},
|
|
id,
|
|
)
|
|
}
|
|
|
|
func (n *notificationDB) GetNotification(
|
|
ctx context.Context,
|
|
notificationType gtsmodel.NotificationType,
|
|
targetAccountID string,
|
|
originAccountID string,
|
|
statusID string,
|
|
) (*gtsmodel.Notification, error) {
|
|
return n.getNotification(
|
|
ctx,
|
|
"NotificationType,TargetAccountID,OriginAccountID,StatusID",
|
|
func(notif *gtsmodel.Notification) error {
|
|
return n.db.NewSelect().
|
|
Model(notif).
|
|
Where("? = ?", bun.Ident("notification_type"), notificationType).
|
|
Where("? = ?", bun.Ident("target_account_id"), targetAccountID).
|
|
Where("? = ?", bun.Ident("origin_account_id"), originAccountID).
|
|
Where("? = ?", bun.Ident("status_id"), statusID).
|
|
Scan(ctx)
|
|
},
|
|
notificationType, targetAccountID, originAccountID, statusID,
|
|
)
|
|
}
|
|
|
|
func (n *notificationDB) getNotification(ctx context.Context, lookup string, dbQuery func(*gtsmodel.Notification) error, keyParts ...any) (*gtsmodel.Notification, error) {
|
|
// Fetch notification from cache with loader callback
|
|
notif, err := n.state.Caches.DB.Notification.LoadOne(lookup, func() (*gtsmodel.Notification, error) {
|
|
var notif gtsmodel.Notification
|
|
|
|
// Not cached! Perform database query
|
|
if err := dbQuery(¬if); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return ¬if, nil
|
|
}, keyParts...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if gtscontext.Barebones(ctx) {
|
|
// Only a barebones model was requested.
|
|
return notif, nil
|
|
}
|
|
|
|
if err := n.state.DB.PopulateNotification(ctx, notif); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return notif, nil
|
|
}
|
|
|
|
func (n *notificationDB) GetNotificationsByIDs(ctx context.Context, ids []string) ([]*gtsmodel.Notification, error) {
|
|
// Load all notif IDs via cache loader callbacks.
|
|
notifs, err := n.state.Caches.DB.Notification.LoadIDs("ID",
|
|
ids,
|
|
func(uncached []string) ([]*gtsmodel.Notification, error) {
|
|
// Preallocate expected length of uncached notifications.
|
|
notifs := make([]*gtsmodel.Notification, 0, len(uncached))
|
|
|
|
// Perform database query scanning
|
|
// the remaining (uncached) IDs.
|
|
if err := n.db.NewSelect().
|
|
Model(¬ifs).
|
|
Where("? IN (?)", bun.Ident("id"), bun.In(uncached)).
|
|
Scan(ctx); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return notifs, nil
|
|
},
|
|
)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Reorder the notifs by their
|
|
// IDs to ensure in correct order.
|
|
getID := func(n *gtsmodel.Notification) string { return n.ID }
|
|
util.OrderBy(notifs, ids, getID)
|
|
|
|
if gtscontext.Barebones(ctx) {
|
|
// no need to fully populate.
|
|
return notifs, nil
|
|
}
|
|
|
|
// Populate all loaded notifs, removing those we fail to
|
|
// populate (removes needing so many nil checks everywhere).
|
|
notifs = slices.DeleteFunc(notifs, func(notif *gtsmodel.Notification) bool {
|
|
if err := n.PopulateNotification(ctx, notif); err != nil {
|
|
log.Errorf(ctx, "error populating notif %s: %v", notif.ID, err)
|
|
return true
|
|
}
|
|
return false
|
|
})
|
|
|
|
return notifs, nil
|
|
}
|
|
|
|
func (n *notificationDB) PopulateNotification(ctx context.Context, notif *gtsmodel.Notification) error {
|
|
var (
|
|
errs gtserror.MultiError
|
|
err error
|
|
)
|
|
|
|
if notif.TargetAccount == nil {
|
|
notif.TargetAccount, err = n.state.DB.GetAccountByID(
|
|
gtscontext.SetBarebones(ctx),
|
|
notif.TargetAccountID,
|
|
)
|
|
if err != nil {
|
|
errs.Appendf("error populating notif target account: %w", err)
|
|
}
|
|
}
|
|
|
|
if notif.OriginAccount == nil {
|
|
notif.OriginAccount, err = n.state.DB.GetAccountByID(
|
|
gtscontext.SetBarebones(ctx),
|
|
notif.OriginAccountID,
|
|
)
|
|
if err != nil {
|
|
errs.Appendf("error populating notif origin account: %w", err)
|
|
}
|
|
}
|
|
|
|
if notif.StatusID != "" && notif.Status == nil {
|
|
notif.Status, err = n.state.DB.GetStatusByID(
|
|
gtscontext.SetBarebones(ctx),
|
|
notif.StatusID,
|
|
)
|
|
if err != nil {
|
|
errs.Appendf("error populating notif status: %w", err)
|
|
}
|
|
}
|
|
|
|
return errs.Combine()
|
|
}
|
|
|
|
func (n *notificationDB) GetAccountNotifications(
|
|
ctx context.Context,
|
|
accountID string,
|
|
maxID string,
|
|
sinceID string,
|
|
minID string,
|
|
limit int,
|
|
types []string,
|
|
excludeTypes []string,
|
|
) ([]*gtsmodel.Notification, error) {
|
|
// Ensure reasonable
|
|
if limit < 0 {
|
|
limit = 0
|
|
}
|
|
|
|
// Make educated guess for slice size
|
|
var (
|
|
notifIDs = make([]string, 0, limit)
|
|
frontToBack = true
|
|
)
|
|
|
|
q := n.db.
|
|
NewSelect().
|
|
TableExpr("? AS ?", bun.Ident("notifications"), bun.Ident("notification")).
|
|
Column("notification.id")
|
|
|
|
if maxID == "" {
|
|
maxID = id.Highest
|
|
}
|
|
|
|
// Return only notifs LOWER (ie., older) than maxID.
|
|
q = q.Where("? < ?", bun.Ident("notification.id"), maxID)
|
|
|
|
if sinceID != "" {
|
|
// Return only notifs HIGHER (ie., newer) than sinceID.
|
|
q = q.Where("? > ?", bun.Ident("notification.id"), sinceID)
|
|
}
|
|
|
|
if minID != "" {
|
|
// Return only notifs HIGHER (ie., newer) than minID.
|
|
q = q.Where("? > ?", bun.Ident("notification.id"), minID)
|
|
|
|
frontToBack = false // page up
|
|
}
|
|
|
|
if len(types) > 0 {
|
|
// Include only requested notification types.
|
|
q = q.Where("? IN (?)", bun.Ident("notification.notification_type"), bun.In(types))
|
|
}
|
|
|
|
if len(excludeTypes) > 0 {
|
|
// Filter out unwanted notif types.
|
|
q = q.Where("? NOT IN (?)", bun.Ident("notification.notification_type"), bun.In(excludeTypes))
|
|
}
|
|
|
|
// Return only notifs for this account.
|
|
q = q.Where("? = ?", bun.Ident("notification.target_account_id"), accountID)
|
|
|
|
if limit > 0 {
|
|
q = q.Limit(limit)
|
|
}
|
|
|
|
if frontToBack {
|
|
// Page down.
|
|
q = q.Order("notification.id DESC")
|
|
} else {
|
|
// Page up.
|
|
q = q.Order("notification.id ASC")
|
|
}
|
|
|
|
if err := q.Scan(ctx, ¬ifIDs); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if len(notifIDs) == 0 {
|
|
return nil, nil
|
|
}
|
|
|
|
// If we're paging up, we still want notifications
|
|
// to be sorted by ID desc, so reverse ids slice.
|
|
// https://zchee.github.io/golang-wiki/SliceTricks/#reversing
|
|
if !frontToBack {
|
|
for l, r := 0, len(notifIDs)-1; l < r; l, r = l+1, r-1 {
|
|
notifIDs[l], notifIDs[r] = notifIDs[r], notifIDs[l]
|
|
}
|
|
}
|
|
|
|
// Fetch notification models by their IDs.
|
|
return n.GetNotificationsByIDs(ctx, notifIDs)
|
|
}
|
|
|
|
func (n *notificationDB) PutNotification(ctx context.Context, notif *gtsmodel.Notification) error {
|
|
return n.state.Caches.DB.Notification.Store(notif, func() error {
|
|
_, err := n.db.NewInsert().Model(notif).Exec(ctx)
|
|
return err
|
|
})
|
|
}
|
|
|
|
func (n *notificationDB) DeleteNotificationByID(ctx context.Context, id string) error {
|
|
// Delete notif from DB.
|
|
if _, err := n.db.
|
|
NewDelete().
|
|
Table("notifications").
|
|
Where("? = ?", bun.Ident("id"), id).
|
|
Exec(ctx); err != nil &&
|
|
!errors.Is(err, db.ErrNoEntries) {
|
|
return err
|
|
}
|
|
|
|
// Invalidate deleted notification by ID.
|
|
n.state.Caches.DB.Notification.Invalidate("ID", id)
|
|
return nil
|
|
}
|
|
|
|
func (n *notificationDB) DeleteNotifications(ctx context.Context, types []string, targetAccountID string, originAccountID string) error {
|
|
if targetAccountID == "" && originAccountID == "" {
|
|
return gtserror.New("one of targetAccountID or originAccountID must be set")
|
|
}
|
|
|
|
q := n.db.
|
|
NewDelete().
|
|
Table("notifications")
|
|
|
|
if len(types) > 0 {
|
|
q = q.Where("? IN (?)", bun.Ident("notification_type"), bun.In(types))
|
|
}
|
|
|
|
if targetAccountID != "" {
|
|
q = q.Where("? = ?", bun.Ident("target_account_id"), targetAccountID)
|
|
}
|
|
|
|
if originAccountID != "" {
|
|
q = q.Where("? = ?", bun.Ident("origin_account_id"), originAccountID)
|
|
}
|
|
|
|
var notifIDs []string
|
|
q = q.Returning("?", bun.Ident("id"))
|
|
|
|
// Delete from DB.
|
|
if _, err := q.
|
|
Exec(ctx, ¬ifIDs); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Invalidate all deleted notifications by IDs.
|
|
n.state.Caches.DB.Notification.InvalidateIDs("ID", notifIDs)
|
|
return nil
|
|
}
|
|
|
|
func (n *notificationDB) DeleteNotificationsForStatus(ctx context.Context, statusID string) error {
|
|
var notifIDs []string
|
|
|
|
if _, err := n.db.
|
|
NewDelete().
|
|
Table("notifications").
|
|
Where("? = ?", bun.Ident("status_id"), statusID).
|
|
Returning("?", bun.Ident("id")).
|
|
Exec(ctx, ¬ifIDs); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Invalidate all deleted notifications by IDs.
|
|
n.state.Caches.DB.Notification.InvalidateIDs("ID", notifIDs)
|
|
return nil
|
|
}
|