[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, 50 insertions, 14 deletions

diff --git a/internal/processing/account/follow.go b/internal/processing/account/follow.go
index 8d053e92a..ab8fecd94 100644
--- a/internal/processing/account/follow.go
+++ b/internal/processing/account/follow.go
@@ -40,7 +40,7 @@ func (p *Processor) FollowCreate(ctx context.Context, requestingAccount *gtsmode
 	}
 
 	// Check if a follow exists already.
-	if follows, err := p.state.DB.IsFollowing(ctx, requestingAccount, targetAccount); err != nil {
+	if follows, err := p.state.DB.IsFollowing(ctx, requestingAccount.ID, targetAccount.ID); err != nil {
 		err = fmt.Errorf("FollowCreate: db error checking follow: %w", err)
 		return nil, gtserror.NewErrorInternalError(err)
 	} else if follows {
@@ -49,7 +49,7 @@ func (p *Processor) FollowCreate(ctx context.Context, requestingAccount *gtsmode
 	}
 
 	// Check if a follow request exists already.
-	if followRequested, err := p.state.DB.IsFollowRequested(ctx, requestingAccount, targetAccount); err != nil {
+	if followRequested, err := p.state.DB.IsFollowRequested(ctx, requestingAccount.ID, targetAccount.ID); err != nil {
 		err = fmt.Errorf("FollowCreate: db error checking follow request: %w", err)
 		return nil, gtserror.NewErrorInternalError(err)
 	} else if followRequested {
@@ -75,7 +75,7 @@ func (p *Processor) FollowCreate(ctx context.Context, requestingAccount *gtsmode
 		Notify:          form.Notify,
 	}
 
-	if err := p.state.DB.Put(ctx, fr); err != nil {
+	if err := p.state.DB.PutFollowRequest(ctx, fr); err != nil {
 		err = fmt.Errorf("FollowCreate: error creating follow request in db: %s", err)
 		return nil, gtserror.NewErrorInternalError(err)
 	}
@@ -141,7 +141,7 @@ func (p *Processor) getFollowTarget(ctx context.Context, requestingAccountID str
 	}
 
 	// Do nothing if a block exists in either direction between accounts.
-	if blocked, err := p.state.DB.IsBlocked(ctx, requestingAccountID, targetAccountID, true); err != nil {
+	if blocked, err := p.state.DB.IsEitherBlocked(ctx, requestingAccountID, targetAccountID); err != nil {
 		err = fmt.Errorf("db error checking block between accounts: %w", err)
 		return nil, gtserror.NewErrorInternalError(err)
 	} else if blocked {
@@ -173,12 +173,30 @@ func (p *Processor) getFollowTarget(ctx context.Context, requestingAccountID str
 // messages will be returned which should then be processed by a client
 // api worker.
 func (p *Processor) unfollow(ctx context.Context, requestingAccount *gtsmodel.Account, targetAccount *gtsmodel.Account) ([]messages.FromClientAPI, error) {
-	msgs := []messages.FromClientAPI{}
+	var msgs []messages.FromClientAPI
 
-	if fURI, err := p.state.DB.Unfollow(ctx, requestingAccount.ID, targetAccount.ID); err != nil {
-		err = fmt.Errorf("unfollow: error deleting follow from %s targeting %s: %w", requestingAccount.ID, targetAccount.ID, err)
+	// Get follow from requesting account to target account.
+	follow, err := p.state.DB.GetFollow(ctx, requestingAccount.ID, targetAccount.ID)
+	if err != nil && !errors.Is(err, db.ErrNoEntries) {
+		err = fmt.Errorf("unfollow: error getting follow from %s targeting %s: %w", requestingAccount.ID, targetAccount.ID, err)
 		return nil, err
-	} else if fURI != "" {
+	}
+
+	if follow != nil {
+		// Delete known follow from database with ID.
+		err = p.state.DB.DeleteFollowByID(ctx, follow.ID)
+		if err != nil {
+			if !errors.Is(err, db.ErrNoEntries) {
+				err = fmt.Errorf("unfollow: error deleting request from %s targeting %s: %w", requestingAccount.ID, targetAccount.ID, err)
+				return nil, err
+			}
+
+			// If err == db.ErrNoEntries here then it
+			// indicates a race condition with another
+			// unfollow for the same requester->target.
+			return msgs, nil
+		}
+
 		// Follow status changed, process side effects.
 		msgs = append(msgs, messages.FromClientAPI{
 			APObjectType:   ap.ActivityFollow,
@@ -186,25 +204,43 @@ func (p *Processor) unfollow(ctx context.Context, requestingAccount *gtsmodel.Ac
 			GTSModel: &gtsmodel.Follow{
 				AccountID:       requestingAccount.ID,
 				TargetAccountID: targetAccount.ID,
-				URI:             fURI,
+				URI:             follow.URI,
 			},
 			OriginAccount: requestingAccount,
 			TargetAccount: targetAccount,
 		})
 	}
 
-	if frURI, err := p.state.DB.UnfollowRequest(ctx, requestingAccount.ID, targetAccount.ID); err != nil {
-		err = fmt.Errorf("unfollow: error deleting follow request from %s targeting %s: %w", requestingAccount.ID, targetAccount.ID, err)
+	// Get follow request from requesting account to target account.
+	followReq, err := p.state.DB.GetFollowRequest(ctx, requestingAccount.ID, targetAccount.ID)
+	if err != nil && !errors.Is(err, db.ErrNoEntries) {
+		err = fmt.Errorf("unfollow: error getting follow request from %s targeting %s: %w", requestingAccount.ID, targetAccount.ID, err)
 		return nil, err
-	} else if frURI != "" {
-		// Follow request status changed, process side effects.
+	}
+
+	if followReq != nil {
+		// Delete known follow request from database with ID.
+		err = p.state.DB.DeleteFollowRequestByID(ctx, followReq.ID)
+		if err != nil {
+			if !errors.Is(err, db.ErrNoEntries) {
+				err = fmt.Errorf("unfollow: error deleting follow request from %s targeting %s: %w", requestingAccount.ID, targetAccount.ID, err)
+				return nil, err
+			}
+
+			// If err == db.ErrNoEntries here then it
+			// indicates a race condition with another
+			// unfollow for the same requester->target.
+			return msgs, nil
+		}
+
+		// Follow status changed, process side effects.
 		msgs = append(msgs, messages.FromClientAPI{
 			APObjectType:   ap.ActivityFollow,
 			APActivityType: ap.ActivityUndo,
 			GTSModel: &gtsmodel.Follow{
 				AccountID:       requestingAccount.ID,
 				TargetAccountID: targetAccount.ID,
-				URI:             frURI,
+				URI:             followReq.URI,
 			},
 			OriginAccount: requestingAccount,
 			TargetAccount: targetAccount,