Skip to content

Commit

Permalink
[bugfix] Don't copy ptr fields in caches (#2386)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsmethurst authored Nov 27, 2023
1 parent 0bb9b72 commit 33ee615
Show file tree
Hide file tree
Showing 12 changed files with 467 additions and 107 deletions.
329 changes: 247 additions & 82 deletions internal/cache/gts.go

Large diffs are not rendered by default.

20 changes: 20 additions & 0 deletions internal/db/bundb/emoji.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import (

"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/log"
"github.com/superseriousbusiness/gotosocial/internal/state"
Expand Down Expand Up @@ -548,6 +549,25 @@ func (e *emojiDB) getEmoji(ctx context.Context, lookup string, dbQuery func(*gts
return emoji, nil
}

func (e *emojiDB) PopulateEmoji(ctx context.Context, emoji *gtsmodel.Emoji) error {
var (
errs = gtserror.NewMultiError(1)
err error
)

if emoji.CategoryID != "" && emoji.Category == nil {
emoji.Category, err = e.GetEmojiCategory(
ctx, // these are already barebones
emoji.CategoryID,
)
if err != nil {
errs.Appendf("error populating emoji category: %w", err)
}
}

return errs.Combine()
}

func (e *emojiDB) GetEmojisByIDs(ctx context.Context, emojiIDs []string) ([]*gtsmodel.Emoji, error) {
if len(emojiIDs) == 0 {
return nil, db.ErrNoEntries
Expand Down
4 changes: 2 additions & 2 deletions internal/db/bundb/instance.go
Original file line number Diff line number Diff line change
Expand Up @@ -173,14 +173,14 @@ func (i *instanceDB) getInstance(ctx context.Context, lookup string, dbQuery fun
}

// Further populate the instance fields where applicable.
if err := i.populateInstance(ctx, instance); err != nil {
if err := i.PopulateInstance(ctx, instance); err != nil {
return nil, err
}

return instance, nil
}

func (i *instanceDB) populateInstance(ctx context.Context, instance *gtsmodel.Instance) error {
func (i *instanceDB) PopulateInstance(ctx context.Context, instance *gtsmodel.Instance) error {
var (
err error
errs = gtserror.NewMultiError(2)
Expand Down
57 changes: 56 additions & 1 deletion internal/db/bundb/notification.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (

"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"
Expand Down Expand Up @@ -57,7 +58,7 @@ func (n *notificationDB) GetNotification(
originAccountID string,
statusID string,
) (*gtsmodel.Notification, error) {
return n.state.Caches.GTS.Notification().Load("NotificationType.TargetAccountID.OriginAccountID.StatusID", func() (*gtsmodel.Notification, error) {
notif, err := n.state.Caches.GTS.Notification().Load("NotificationType.TargetAccountID.OriginAccountID.StatusID", func() (*gtsmodel.Notification, error) {
var notif gtsmodel.Notification

q := n.db.NewSelect().
Expand All @@ -73,6 +74,60 @@ func (n *notificationDB) GetNotification(

return &notif, nil
}, notificationType, targetAccountID, originAccountID, statusID)
if err != nil {
return nil, err
}

if gtscontext.Barebones(ctx) {
// no need to fully populate.
return notif, nil
}

// Further populate the notif fields where applicable.
if err := n.PopulateNotification(ctx, notif); err != nil {
return nil, err
}

return notif, nil
}

func (n *notificationDB) PopulateNotification(ctx context.Context, notif *gtsmodel.Notification) error {
var (
errs = gtserror.NewMultiError(2)
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(
Expand Down
48 changes: 33 additions & 15 deletions internal/db/bundb/relationship_note.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ package bundb

import (
"context"
"fmt"
"time"

"github.com/superseriousbusiness/gotosocial/internal/gtscontext"
"github.com/superseriousbusiness/gotosocial/internal/gtserror"
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
"github.com/uptrace/bun"
)
Expand Down Expand Up @@ -64,25 +64,43 @@ func (r *relationshipDB) getNote(ctx context.Context, lookup string, dbQuery fun
return note, nil
}

// Set the note source account
note.Account, err = r.state.DB.GetAccountByID(
gtscontext.SetBarebones(ctx),
note.AccountID,
)
if err != nil {
return nil, fmt.Errorf("error getting note source account: %w", err)
// Further populate the account fields where applicable.
if err := r.PopulateNote(ctx, note); err != nil {
return nil, err
}

// Set the note target account
note.TargetAccount, err = r.state.DB.GetAccountByID(
gtscontext.SetBarebones(ctx),
note.TargetAccountID,
return note, nil
}

func (r *relationshipDB) PopulateNote(ctx context.Context, note *gtsmodel.AccountNote) error {
var (
errs = gtserror.NewMultiError(2)
err error
)
if err != nil {
return nil, fmt.Errorf("error getting note target account: %w", err)

// Ensure note source account set.
if note.Account == nil {
note.Account, err = r.state.DB.GetAccountByID(
gtscontext.SetBarebones(ctx),
note.AccountID,
)
if err != nil {
errs.Appendf("error populating note source account: %w", err)
}
}

return note, nil
// Ensure note target account set.
if note.TargetAccount == nil {
note.TargetAccount, err = r.state.DB.GetAccountByID(
gtscontext.SetBarebones(ctx),
note.TargetAccountID,
)
if err != nil {
errs.Appendf("error populating note target account: %w", err)
}
}

return errs.Combine()
}

func (r *relationshipDB) PutNote(ctx context.Context, note *gtsmodel.AccountNote) error {
Expand Down
45 changes: 45 additions & 0 deletions internal/db/bundb/status_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,51 @@ func (suite *StatusTestSuite) TestUpdateStatus() {
suite.True(updated.PinnedAt.IsZero())
}

func (suite *StatusTestSuite) TestPutPopulatedStatus() {
ctx := context.Background()

targetStatus := &gtsmodel.Status{}
*targetStatus = *suite.testStatuses["admin_account_status_1"]

// Populate fields on the target status.
if err := suite.db.PopulateStatus(ctx, targetStatus); err != nil {
suite.FailNow(err.Error())
}

// Delete it from the database.
if err := suite.db.DeleteStatusByID(ctx, targetStatus.ID); err != nil {
suite.FailNow(err.Error())
}

// Reinsert the populated version
// so that it becomes cached.
if err := suite.db.PutStatus(ctx, targetStatus); err != nil {
suite.FailNow(err.Error())
}

// Update the status owner's
// account with a new bio.
account := &gtsmodel.Account{}
*account = *targetStatus.Account
account.Note = "new note for this test"
if err := suite.db.UpdateAccount(ctx, account, "note"); err != nil {
suite.FailNow(err.Error())
}

dbStatus, err := suite.db.GetStatusByID(ctx, targetStatus.ID)
if err != nil {
suite.FailNow(err.Error())
}

// Account note should be updated,
// even though we stored this
// status with the old note.
suite.Equal(
"new note for this test",
dbStatus.Account.Note,
)
}

func TestStatusTestSuite(t *testing.T) {
suite.Run(t, new(StatusTestSuite))
}
35 changes: 28 additions & 7 deletions internal/db/bundb/user.go
Original file line number Diff line number Diff line change
Expand Up @@ -130,18 +130,39 @@ func (u *userDB) getUser(ctx context.Context, lookup string, dbQuery func(*gtsmo
return nil, err
}

// Fetch the related account model for this user.
user.Account, err = u.state.DB.GetAccountByID(
gtscontext.SetBarebones(ctx),
user.AccountID,
)
if err != nil {
return nil, gtserror.Newf("error populating user account: %w", err)
if gtscontext.Barebones(ctx) {
// Return without populating.
return user, nil
}

if err := u.PopulateUser(ctx, user); err != nil {
return nil, err
}

return user, nil
}

// PopulateUser ensures that the user's struct fields are populated.
func (u *userDB) PopulateUser(ctx context.Context, user *gtsmodel.User) error {
var (
errs = gtserror.NewMultiError(1)
err error
)

if user.Account == nil {
// Fetch the related account model for this user.
user.Account, err = u.state.DB.GetAccountByID(
gtscontext.SetBarebones(ctx),
user.AccountID,
)
if err != nil {
errs.Appendf("error populating user account: %w", err)
}
}

return errs.Combine()
}

func (u *userDB) GetAllUsers(ctx context.Context) ([]*gtsmodel.User, error) {
var userIDs []string

Expand Down
16 changes: 16 additions & 0 deletions internal/db/emoji.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,17 @@ const EmojiAllDomains string = "all"
type Emoji interface {
// PutEmoji puts one emoji in the database.
PutEmoji(ctx context.Context, emoji *gtsmodel.Emoji) error

// UpdateEmoji updates the given columns of one emoji.
// If no columns are specified, every column is updated.
UpdateEmoji(ctx context.Context, emoji *gtsmodel.Emoji, columns ...string) error

// DeleteEmojiByID deletes one emoji by its database ID.
DeleteEmojiByID(ctx context.Context, id string) error

// GetEmojisByIDs gets emojis for the given IDs.
GetEmojisByIDs(ctx context.Context, ids []string) ([]*gtsmodel.Emoji, error)

// GetUseableEmojis gets all emojis which are useable by accounts on this instance.
GetUseableEmojis(ctx context.Context) ([]*gtsmodel.Emoji, error)

Expand All @@ -53,23 +57,35 @@ type Emoji interface {

// GetEmojisBy gets emojis based on given parameters. Useful for admin actions.
GetEmojisBy(ctx context.Context, domain string, includeDisabled bool, includeEnabled bool, shortcode string, maxShortcodeDomain string, minShortcodeDomain string, limit int) ([]*gtsmodel.Emoji, error)

// GetEmojiByID gets a specific emoji by its database ID.
GetEmojiByID(ctx context.Context, id string) (*gtsmodel.Emoji, error)

// PopulateEmoji populates the struct pointers on the given emoji.
PopulateEmoji(ctx context.Context, emoji *gtsmodel.Emoji) error

// GetEmojiByShortcodeDomain gets an emoji based on its shortcode and domain.
// For local emoji, domain should be an empty string.
GetEmojiByShortcodeDomain(ctx context.Context, shortcode string, domain string) (*gtsmodel.Emoji, error)

// GetEmojiByURI returns one emoji based on its ActivityPub URI.
GetEmojiByURI(ctx context.Context, uri string) (*gtsmodel.Emoji, error)

// GetEmojiByStaticURL gets an emoji using the URL of the static version of the emoji image.
GetEmojiByStaticURL(ctx context.Context, imageStaticURL string) (*gtsmodel.Emoji, error)

// PutEmojiCategory puts one new emoji category in the database.
PutEmojiCategory(ctx context.Context, emojiCategory *gtsmodel.EmojiCategory) error

// GetEmojiCategoriesByIDs gets emoji categories for given IDs.
GetEmojiCategoriesByIDs(ctx context.Context, ids []string) ([]*gtsmodel.EmojiCategory, error)

// GetEmojiCategories gets a slice of the names of all existing emoji categories.
GetEmojiCategories(ctx context.Context) ([]*gtsmodel.EmojiCategory, error)

// GetEmojiCategory gets one emoji category by its id.
GetEmojiCategory(ctx context.Context, id string) (*gtsmodel.EmojiCategory, error)

// GetEmojiCategoryByName gets one emoji category by its name.
GetEmojiCategoryByName(ctx context.Context, name string) (*gtsmodel.EmojiCategory, error)
}
3 changes: 3 additions & 0 deletions internal/db/instance.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ type Instance interface {
// GetInstanceByID returns the instance entry corresponding to the given id, if it exists.
GetInstanceByID(ctx context.Context, id string) (*gtsmodel.Instance, error)

// PopulateInstance populates the struct pointers on the given instance.
PopulateInstance(ctx context.Context, instance *gtsmodel.Instance) error

// PutInstance inserts the given instance into the database.
PutInstance(ctx context.Context, instance *gtsmodel.Instance) error

Expand Down
3 changes: 3 additions & 0 deletions internal/db/notification.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ type Notification interface {
// Since not all notifications are about a status, statusID can be an empty string.
GetNotification(ctx context.Context, notificationType gtsmodel.NotificationType, targetAccountID string, originAccountID string, statusID string) (*gtsmodel.Notification, error)

// PopulateNotification ensures that the notification's struct fields are populated.
PopulateNotification(ctx context.Context, notif *gtsmodel.Notification) error

// PutNotification will insert the given notification into the database.
PutNotification(ctx context.Context, notif *gtsmodel.Notification) error

Expand Down
3 changes: 3 additions & 0 deletions internal/db/relationship.go
Original file line number Diff line number Diff line change
Expand Up @@ -184,4 +184,7 @@ type Relationship interface {

// PutNote creates or updates a private note.
PutNote(ctx context.Context, note *gtsmodel.AccountNote) error

// PopulateNote populates the struct pointers on the given note.
PopulateNote(ctx context.Context, note *gtsmodel.AccountNote) error
}
Loading

0 comments on commit 33ee615

Please sign in to comment.