[performance] refactoring + add fave / follow / request / visibility caching (#1607)

* refactor visibility checking, add caching for visibility

* invalidate visibility cache items on account / status deletes

* fix requester ID passed to visibility cache nil ptr

* de-interface caches, fix home / public timeline caching + visibility

* finish adding code comments for visibility filter

* fix angry goconst linter warnings

* actually finish adding filter visibility code comments for timeline functions

* move home timeline status author check to after visibility

* remove now-unused code

* add more code comments

* add TODO code comment, update printed cache start names

* update printed cache names on stop

* start adding separate follow(request) delete db functions, add specific visibility cache tests

* add relationship type caching

* fix getting local account follows / followed-bys, other small codebase improvements

* simplify invalidation using cache hooks, add more GetAccountBy___() functions

* fix boosting to return 404 if not boostable but no error (to not leak status ID)

* remove dead code

* improved placement of cache invalidation

* update license headers

* add example follow, follow-request config entries

* add example visibility cache configuration to config file

* use specific PutFollowRequest() instead of just Put()

* add tests for all GetAccountBy()

* add GetBlockBy() tests

* update block to check primitive fields

* update and finish adding Get{Account,Block,Follow,FollowRequest}By() tests

* fix copy-pasted code

* update envparsing test

* whitespace

* fix bun struct tag

* add license header to gtscontext

* fix old license header

* improved error creation to not use fmt.Errorf() when not needed

* fix various rebase conflicts, fix account test

* remove commented-out code, fix-up mention caching

* fix mention select bun statement

* ensure mention target account populated, pass in context to customrenderer logging

* remove more uncommented code, fix typeutil test

* add statusfave database model caching

* add status fave cache configuration

* add status fave cache example config

* woops, catch missed error. nice catch linter!

* add back testrig panic on nil db

* update example configuration to match defaults, slight tweak to cache configuration defaults

* update envparsing test with new defaults

* fetch followingget to use the follow target account

* use accounnt.IsLocal() instead of empty domain check

* use constants for the cache visibility type check

* use bun.In() for notification type restriction in db query

* include replies when fetching PublicTimeline() (to account for single-author threads in Visibility{}.StatusPublicTimelineable())

* use bun query building for nested select statements to ensure working with postgres

* update public timeline future status checks to match visibility filter

* same as previous, for home timeline

* update public timeline tests to dynamically check for appropriate statuses

* migrate accounts to allow unique constraint on public_key

* provide minimal account with publicKey

---------

Signed-off-by: kim <grufwub@gmail.com>
Co-authored-by: tsmethurst <tobi.smethurst@protonmail.com>

1 files changed, 111 insertions, 59 deletions

diff --git a/internal/db/bundb/statusfave.go b/internal/db/bundb/statusfave.go
index c42ab249f..0f7e5df74 100644
--- a/internal/db/bundb/statusfave.go
+++ b/internal/db/bundb/statusfave.go
@@ -23,6 +23,7 @@ import (
 	"fmt"
 
 	"github.com/superseriousbusiness/gotosocial/internal/db"
+	"github.com/superseriousbusiness/gotosocial/internal/gtscontext"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
 	"github.com/superseriousbusiness/gotosocial/internal/log"
 	"github.com/superseriousbusiness/gotosocial/internal/state"
@@ -34,29 +35,82 @@ type statusFaveDB struct {
 	state *state.State
 }
 
-func (s *statusFaveDB) GetStatusFave(ctx context.Context, id string) (*gtsmodel.StatusFave, db.Error) {
-	fave := new(gtsmodel.StatusFave)
+func (s *statusFaveDB) GetStatusFave(ctx context.Context, accountID string, statusID string) (*gtsmodel.StatusFave, db.Error) {
+	return s.getStatusFave(
+		ctx,
+		"AccountID.StatusID",
+		func(fave *gtsmodel.StatusFave) error {
+			return s.conn.
+				NewSelect().
+				Model(fave).
+				Where("? = ?", bun.Ident("account_id"), accountID).
+				Where("? = ?", bun.Ident("status_id"), statusID).
+				Scan(ctx)
+		},
+		accountID,
+		statusID,
+	)
+}
 
-	err := s.conn.
-		NewSelect().
-		Model(fave).
-		Where("? = ?", bun.Ident("status_fave.ID"), id).
-		Scan(ctx)
+func (s *statusFaveDB) GetStatusFaveByID(ctx context.Context, id string) (*gtsmodel.StatusFave, db.Error) {
+	return s.getStatusFave(
+		ctx,
+		"ID",
+		func(fave *gtsmodel.StatusFave) error {
+			return s.conn.
+				NewSelect().
+				Model(fave).
+				Where("? = ?", bun.Ident("id"), id).
+				Scan(ctx)
+		},
+		id,
+	)
+}
+
+func (s *statusFaveDB) getStatusFave(ctx context.Context, lookup string, dbQuery func(*gtsmodel.StatusFave) error, keyParts ...any) (*gtsmodel.StatusFave, error) {
+	// Fetch status fave from database cache with loader callback
+	fave, err := s.state.Caches.GTS.StatusFave().Load(lookup, func() (*gtsmodel.StatusFave, error) {
+		var fave gtsmodel.StatusFave
+
+		// Not cached! Perform database query.
+		if err := dbQuery(&fave); err != nil {
+			return nil, s.conn.ProcessError(err)
+		}
+
+		return &fave, nil
+	}, keyParts...)
 	if err != nil {
-		return nil, s.conn.ProcessError(err)
+		return nil, err
+	}
+
+	if gtscontext.Barebones(ctx) {
+		// no need to fully populate.
+		return fave, nil
 	}
 
-	fave.Account, err = s.state.DB.GetAccountByID(ctx, fave.AccountID)
+	// Fetch the status fave author account.
+	fave.Account, err = s.state.DB.GetAccountByID(
+		gtscontext.SetBarebones(ctx),
+		fave.AccountID,
+	)
 	if err != nil {
 		return nil, fmt.Errorf("error getting status fave account %q: %w", fave.AccountID, err)
 	}
 
-	fave.TargetAccount, err = s.state.DB.GetAccountByID(ctx, fave.TargetAccountID)
+	// Fetch the status fave target account.
+	fave.TargetAccount, err = s.state.DB.GetAccountByID(
+		gtscontext.SetBarebones(ctx),
+		fave.TargetAccountID,
+	)
 	if err != nil {
 		return nil, fmt.Errorf("error getting status fave target account %q: %w", fave.TargetAccountID, err)
 	}
 
-	fave.Status, err = s.state.DB.GetStatusByID(ctx, fave.StatusID)
+	// Fetch the status fave target status.
+	fave.Status, err = s.state.DB.GetStatusByID(
+		gtscontext.SetBarebones(ctx),
+		fave.StatusID,
+	)
 	if err != nil {
 		return nil, fmt.Errorf("error getting status fave status %q: %w", fave.StatusID, err)
 	}
@@ -64,38 +118,22 @@ func (s *statusFaveDB) GetStatusFave(ctx context.Context, id string) (*gtsmodel.
 	return fave, nil
 }
 
-func (s *statusFaveDB) GetStatusFaveByAccountID(ctx context.Context, accountID string, statusID string) (*gtsmodel.StatusFave, db.Error) {
-	var id string
-
-	err := s.conn.
-		NewSelect().
-		TableExpr("? AS ?", bun.Ident("status_faves"), bun.Ident("status_fave")).
-		Column("status_fave.id").
-		Where("? = ?", bun.Ident("status_fave.account_id"), accountID).
-		Where("? = ?", bun.Ident("status_fave.status_id"), statusID).
-		Scan(ctx, &id)
-	if err != nil {
-		return nil, s.conn.ProcessError(err)
-	}
-
-	return s.GetStatusFave(ctx, id)
-}
-
-func (s *statusFaveDB) GetStatusFaves(ctx context.Context, statusID string) ([]*gtsmodel.StatusFave, db.Error) {
+func (s *statusFaveDB) GetStatusFavesForStatus(ctx context.Context, statusID string) ([]*gtsmodel.StatusFave, db.Error) {
 	ids := []string{}
 
 	if err := s.conn.
 		NewSelect().
-		TableExpr("? AS ?", bun.Ident("status_faves"), bun.Ident("status_fave")).
-		Column("status_fave.id").
-		Where("? = ?", bun.Ident("status_fave.status_id"), statusID).
+		Table("status_faves").
+		Column("id").
+		Where("? = ?", bun.Ident("status_id"), statusID).
 		Scan(ctx, &ids); err != nil {
 		return nil, s.conn.ProcessError(err)
 	}
 
 	faves := make([]*gtsmodel.StatusFave, 0, len(ids))
+
 	for _, id := range ids {
-		fave, err := s.GetStatusFave(ctx, id)
+		fave, err := s.GetStatusFaveByID(ctx, id)
 		if err != nil {
 			log.Errorf(ctx, "error getting status fave %q: %v", id, err)
 			continue
@@ -107,23 +145,27 @@ func (s *statusFaveDB) GetStatusFaves(ctx context.Context, statusID string) ([]*
 	return faves, nil
 }
 
-func (s *statusFaveDB) PutStatusFave(ctx context.Context, statusFave *gtsmodel.StatusFave) db.Error {
-	_, err := s.conn.
-		NewInsert().
-		Model(statusFave).
-		Exec(ctx)
-
-	return s.conn.ProcessError(err)
+func (s *statusFaveDB) PutStatusFave(ctx context.Context, fave *gtsmodel.StatusFave) db.Error {
+	return s.state.Caches.GTS.StatusFave().Store(fave, func() error {
+		_, err := s.conn.
+			NewInsert().
+			Model(fave).
+			Exec(ctx)
+		return s.conn.ProcessError(err)
+	})
 }
 
-func (s *statusFaveDB) DeleteStatusFave(ctx context.Context, id string) db.Error {
-	_, err := s.conn.
+func (s *statusFaveDB) DeleteStatusFaveByID(ctx context.Context, id string) db.Error {
+	if _, err := s.conn.
 		NewDelete().
-		TableExpr("? AS ?", bun.Ident("status_faves"), bun.Ident("status_fave")).
-		Where("? = ?", bun.Ident("status_fave.id"), id).
-		Exec(ctx)
+		Table("status_faves").
+		Where("? = ?", bun.Ident("id"), id).
+		Exec(ctx); err != nil {
+		return s.conn.ProcessError(err)
+	}
 
-	return s.conn.ProcessError(err)
+	s.state.Caches.GTS.StatusFave().Invalidate("ID", id)
+	return nil
 }
 
 func (s *statusFaveDB) DeleteStatusFaves(ctx context.Context, targetAccountID string, originAccountID string) db.Error {
@@ -131,42 +173,52 @@ func (s *statusFaveDB) DeleteStatusFaves(ctx context.Context, targetAccountID st
 		return errors.New("DeleteStatusFaves: one of targetAccountID or originAccountID must be set")
 	}
 
-	// TODO: Capture fave IDs in a RETURNING
-	// statement (when faves have a cache),
-	// + use the IDs to invalidate cache entries.
+	// Capture fave IDs in a RETURNING statement.
+	var faveIDs []string
 
 	q := s.conn.
 		NewDelete().
-		TableExpr("? AS ?", bun.Ident("status_faves"), bun.Ident("status_fave"))
+		Table("status_faves").
+		Returning("?", bun.Ident("id"))
 
 	if targetAccountID != "" {
-		q = q.Where("? = ?", bun.Ident("status_fave.target_account_id"), targetAccountID)
+		q = q.Where("? = ?", bun.Ident("target_account_id"), targetAccountID)
 	}
 
 	if originAccountID != "" {
-		q = q.Where("? = ?", bun.Ident("status_fave.account_id"), originAccountID)
+		q = q.Where("? = ?", bun.Ident("account_id"), originAccountID)
 	}
 
-	if _, err := q.Exec(ctx); err != nil {
+	if _, err := q.Exec(ctx, &faveIDs); err != nil {
 		return s.conn.ProcessError(err)
 	}
 
+	for _, id := range faveIDs {
+		// Invalidate each of the returned status fave IDs.
+		s.state.Caches.GTS.StatusFave().Invalidate("ID", id)
+	}
+
 	return nil
 }
 
 func (s *statusFaveDB) DeleteStatusFavesForStatus(ctx context.Context, statusID string) db.Error {
-	// TODO: Capture fave IDs in a RETURNING
-	// statement (when faves have a cache),
-	// + use the IDs to invalidate cache entries.
+	// Capture fave IDs in a RETURNING statement.
+	var faveIDs []string
 
 	q := s.conn.
 		NewDelete().
-		TableExpr("? AS ?", bun.Ident("status_faves"), bun.Ident("status_fave")).
-		Where("? = ?", bun.Ident("status_fave.status_id"), statusID)
+		Table("status_faves").
+		Where("? = ?", bun.Ident("status_id"), statusID).
+		Returning("?", bun.Ident("id"))
 
-	if _, err := q.Exec(ctx); err != nil {
+	if _, err := q.Exec(ctx, &faveIDs); err != nil {
 		return s.conn.ProcessError(err)
 	}
 
+	for _, id := range faveIDs {
+		// Invalidate each of the returned status fave IDs.
+		s.state.Caches.GTS.StatusFave().Invalidate("ID", id)
+	}
+
 	return nil
 }