[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, 60 insertions, 11 deletions

diff --git a/internal/db/bundb/mention.go b/internal/db/bundb/mention.go
index 3a543f3c2..e64d6dac4 100644
--- a/internal/db/bundb/mention.go
+++ b/internal/db/bundb/mention.go
@@ -19,8 +19,10 @@ package bundb
 
 import (
 	"context"
+	"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"
@@ -32,20 +34,13 @@ type mentionDB struct {
 	state *state.State
 }
 
-func (m *mentionDB) newMentionQ(i interface{}) *bun.SelectQuery {
-	return m.conn.
-		NewSelect().
-		Model(i).
-		Relation("Status").
-		Relation("OriginAccount").
-		Relation("TargetAccount")
-}
-
 func (m *mentionDB) GetMention(ctx context.Context, id string) (*gtsmodel.Mention, db.Error) {
-	return m.state.Caches.GTS.Mention().Load("ID", func() (*gtsmodel.Mention, error) {
+	mention, err := m.state.Caches.GTS.Mention().Load("ID", func() (*gtsmodel.Mention, error) {
 		var mention gtsmodel.Mention
 
-		q := m.newMentionQ(&mention).
+		q := m.conn.
+			NewSelect().
+			Model(&mention).
 			Where("? = ?", bun.Ident("mention.id"), id)
 
 		if err := q.Scan(ctx); err != nil {
@@ -54,6 +49,38 @@ func (m *mentionDB) GetMention(ctx context.Context, id string) (*gtsmodel.Mentio
 
 		return &mention, nil
 	}, id)
+	if err != nil {
+		return nil, err
+	}
+
+	// Set the mention originating status.
+	mention.Status, err = m.state.DB.GetStatusByID(
+		gtscontext.SetBarebones(ctx),
+		mention.StatusID,
+	)
+	if err != nil {
+		return nil, fmt.Errorf("error populating mention status: %w", err)
+	}
+
+	// Set the mention origin account model.
+	mention.OriginAccount, err = m.state.DB.GetAccountByID(
+		gtscontext.SetBarebones(ctx),
+		mention.OriginAccountID,
+	)
+	if err != nil {
+		return nil, fmt.Errorf("error populating mention origin account: %w", err)
+	}
+
+	// Set the mention target account model.
+	mention.TargetAccount, err = m.state.DB.GetAccountByID(
+		gtscontext.SetBarebones(ctx),
+		mention.TargetAccountID,
+	)
+	if err != nil {
+		return nil, fmt.Errorf("error populating mention target account: %w", err)
+	}
+
+	return mention, nil
 }
 
 func (m *mentionDB) GetMentions(ctx context.Context, ids []string) ([]*gtsmodel.Mention, db.Error) {
@@ -73,3 +100,25 @@ func (m *mentionDB) GetMentions(ctx context.Context, ids []string) ([]*gtsmodel.
 
 	return mentions, nil
 }
+
+func (m *mentionDB) PutMention(ctx context.Context, mention *gtsmodel.Mention) error {
+	return m.state.Caches.GTS.Mention().Store(mention, func() error {
+		_, err := m.conn.NewInsert().Model(mention).Exec(ctx)
+		return m.conn.ProcessError(err)
+	})
+}
+
+func (m *mentionDB) DeleteMentionByID(ctx context.Context, id string) error {
+	if _, err := m.conn.
+		NewDelete().
+		Table("mentions").
+		Where("? = ?", bun.Ident("id"), id).
+		Exec(ctx); err != nil {
+		return m.conn.ProcessError(err)
+	}
+
+	// Invalidate mention from the lookup cache.
+	m.state.Caches.GTS.Mention().Invalidate("ID", id)
+
+	return nil
+}