[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, 100 insertions, 5 deletions

diff --git a/internal/gtsmodel/status.go b/internal/gtsmodel/status.go
index eda24e316..d04deecef 100644
--- a/internal/gtsmodel/status.go
+++ b/internal/gtsmodel/status.go
@@ -19,6 +19,8 @@ package gtsmodel
 
 import (
 	"time"
+
+	"github.com/superseriousbusiness/gotosocial/internal/log"
 )
 
 // Status represents a user-created 'post' or 'status' in the database, either remote or local
@@ -65,27 +67,120 @@ type Status struct {
 	Likeable                 *bool              `validate:"-" bun:",notnull"`                                                                          // This status can be liked/faved
 }
 
-/*
-	The below functions are added onto the gtsmodel status so that it satisfies
-	the Timelineable interface in internal/timeline.
-*/
-
+// GetID implements timeline.Timelineable{}.
 func (s *Status) GetID() string {
 	return s.ID
 }
 
+// GetAccountID implements timeline.Timelineable{}.
 func (s *Status) GetAccountID() string {
 	return s.AccountID
 }
 
+// GetBoostID implements timeline.Timelineable{}.
 func (s *Status) GetBoostOfID() string {
 	return s.BoostOfID
 }
 
+// GetBoostOfAccountID implements timeline.Timelineable{}.
 func (s *Status) GetBoostOfAccountID() string {
 	return s.BoostOfAccountID
 }
 
+// AttachmentsPopulated returns whether media attachments are populated according to current AttachmentIDs.
+func (s *Status) AttachmentsPopulated() bool {
+	if len(s.AttachmentIDs) != len(s.Attachments) {
+		// this is the quickest indicator.
+		return false
+	}
+
+	// Attachments must be in same order.
+	for i, id := range s.AttachmentIDs {
+		if s.Attachments[i] == nil {
+			log.Warnf(nil, "nil attachment in slice for status %s", s.URI)
+			continue
+		}
+		if s.Attachments[i].ID != id {
+			return false
+		}
+	}
+
+	return true
+}
+
+// TagsPopulated returns whether tags are populated according to current TagIDs.
+func (s *Status) TagsPopulated() bool {
+	if len(s.TagIDs) != len(s.Tags) {
+		// this is the quickest indicator.
+		return false
+	}
+
+	// Tags must be in same order.
+	for i, id := range s.TagIDs {
+		if s.Tags[i] == nil {
+			log.Warnf(nil, "nil tag in slice for status %s", s.URI)
+			continue
+		}
+		if s.Tags[i].ID != id {
+			return false
+		}
+	}
+
+	return true
+}
+
+// MentionsPopulated returns whether mentions are populated according to current MentionIDs.
+func (s *Status) MentionsPopulated() bool {
+	if len(s.MentionIDs) != len(s.Mentions) {
+		// this is the quickest indicator.
+		return false
+	}
+
+	// Mentions must be in same order.
+	for i, id := range s.MentionIDs {
+		if s.Mentions[i] == nil {
+			log.Warnf(nil, "nil mention in slice for status %s", s.URI)
+			continue
+		}
+		if s.Mentions[i].ID != id {
+			return false
+		}
+	}
+
+	return true
+}
+
+// EmojisPopulated returns whether emojis are populated according to current EmojiIDs.
+func (s *Status) EmojisPopulated() bool {
+	if len(s.EmojiIDs) != len(s.Emojis) {
+		// this is the quickest indicator.
+		return false
+	}
+
+	// Emojis must be in same order.
+	for i, id := range s.EmojiIDs {
+		if s.Emojis[i] == nil {
+			log.Warnf(nil, "nil emoji in slice for status %s", s.URI)
+			continue
+		}
+		if s.Emojis[i].ID != id {
+			return false
+		}
+	}
+
+	return true
+}
+
+// MentionsAccount returns whether status mentions the given account ID.
+func (s *Status) MentionsAccount(id string) bool {
+	for _, mention := range s.Mentions {
+		if mention.TargetAccountID == id {
+			return true
+		}
+	}
+	return false
+}
+
 // StatusToTag is an intermediate struct to facilitate the many2many relationship between a status and one or more tags.
 type StatusToTag struct {
 	StatusID string  `validate:"ulid,required" bun:"type:CHAR(26),unique:statustag,nullzero,notnull"`