[performance] rewrite timelines to rely on new timeline cache type (#3941)

* start work rewriting timeline cache type

* further work rewriting timeline caching

* more work integration new timeline code

* remove old code

* add local timeline, fix up merge conflicts

* remove old use of go-bytes

* implement new timeline code into more areas of codebase, pull in latest go-mangler, go-mutexes, go-structr

* remove old timeline package, add local timeline cache

* remove references to old timeline types that needed starting up in tests

* start adding page validation

* fix test-identified timeline cache package issues

* fix up more tests, fix missing required changes, etc

* add exclusion for test.out in gitignore

* clarify some things better in code comments

* tweak cache size limits

* fix list timeline cache fetching

* further list timeline fixes

* linter, ssssssssshhhhhhhhhhhh please

* fix linter hints

* reslice the output if it's beyond length of 'lim'

* remove old timeline initialization code, bump go-structr to v0.9.4

* continued from previous commit

* improved code comments

* don't allow multiple entries for BoostOfID values to prevent repeated boosts of same boosts

* finish writing more code comments

* some variable renaming, for ease of following

* change the way we update lo,hi paging values during timeline load

* improved code comments for updated / returned lo , hi paging values

* finish writing code comments for the StatusTimeline{} type itself

* fill in more code comments

* update go-structr version to latest with changed timeline unique indexing logic

* have a local and public timeline *per user*

* rewrite calls to public / local timeline calls

* remove the zero length check, as lo, hi values might still be set

* simplify timeline cache loading, fix lo/hi returns, fix timeline invalidation side-effects missing for some federated actions

* swap the lo, hi values :facepalm:

* add (now) missing slice reverse of tag timeline statuses when paging ASC

* remove local / public caches (is out of scope for this work), share more timeline code

* remove unnecessary change

* again, remove more unused code

* remove unused function to appease the linter

* move boost checking to prepare function

* fix use of timeline.lastOrder, fix incorrect range functions used

* remove comments for repeat code

* remove the boost logic from prepare function

* do a maximum of 5 loads, not 10

* add repeat boost filtering logic, update go-structr, general improvements

* more code comments

* add important note

* fix timeline tests now that timelines are returned in page order

* remove unused field

* add StatusTimeline{} tests

* add more status timeline tests

* start adding preloading support

* ensure repeat boosts are marked in preloaded entries

* share a bunch of the database load code in timeline cache, don't clear timelines on relationship change

* add logic to allow dynamic clear / preloading of timelines

* comment-out unused functions, but leave in place as we might end-up using them

* fix timeline preload state check

* much improved status timeline code comments

* more code comments, don't bother inserting statuses if timeline not preloaded

* shift around some logic to make sure things aren't accidentally left set

* finish writing code comments

* remove trim-after-insert behaviour

* fix-up some comments referring to old logic

* remove unsetting of lo, hi

* fix preload repeatBoost checking logic

* don't return on status filter errors, these are usually transient

* better concurrency safety in Clear() and Done()

* fix test broken due to addition of preloader

* fix repeatBoost logic that doesn't account for already-hidden repeatBoosts

* ensure edit submodels are dropped on cache insertion

* update code-comment to expand CAS accronym

* use a plus1hULID() instead of 24h

* remove unused functions

* add note that public / local timeline requester can be nil

* fix incorrect visibility filtering of tag timeline statuses

* ensure we filter home timeline statuses on local only

* some small re-orderings to confirm query params in correct places

* fix the local only home timeline filter func

1 files changed, 0 insertions, 704 deletions

diff --git a/internal/timeline/get_test.go b/internal/timeline/get_test.go
deleted file mode 100644
index 91a456560..000000000
--- a/internal/timeline/get_test.go
+++ /dev/null
@@ -1,704 +0,0 @@
-// GoToSocial
-// Copyright (C) GoToSocial Authors admin@gotosocial.org
-// SPDX-License-Identifier: AGPL-3.0-or-later
-//
-// This program is free software: you can redistribute it and/or modify
-// it under the terms of the GNU Affero General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU Affero General Public License for more details.
-//
-// You should have received a copy of the GNU Affero General Public License
-// along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-package timeline_test
-
-import (
-	"context"
-	"sync"
-	"testing"
-
-	"github.com/stretchr/testify/suite"
-	"github.com/superseriousbusiness/gotosocial/internal/gtscontext"
-	"github.com/superseriousbusiness/gotosocial/internal/id"
-	"github.com/superseriousbusiness/gotosocial/internal/timeline"
-)
-
-type GetTestSuite struct {
-	TimelineStandardTestSuite
-}
-
-func (suite *GetTestSuite) checkStatuses(statuses []timeline.Preparable, maxID string, minID string, expectedLength int) {
-	if l := len(statuses); l != expectedLength {
-		suite.FailNow("", "expected %d statuses in slice, got %d", expectedLength, l)
-	} else if l == 0 {
-		// Can't test empty slice.
-		return
-	}
-
-	// Check ordering + bounds of statuses.
-	highest := statuses[0].GetID()
-	for _, status := range statuses {
-		id := status.GetID()
-
-		if id >= maxID {
-			suite.FailNow("", "%s greater than maxID %s", id, maxID)
-		}
-
-		if id <= minID {
-			suite.FailNow("", "%s smaller than minID %s", id, minID)
-		}
-
-		if id > highest {
-			suite.FailNow("", "statuses in slice were not ordered highest -> lowest ID")
-		}
-
-		highest = id
-	}
-}
-
-func (suite *GetTestSuite) emptyAccountFollows(ctx context.Context, accountID string) {
-	// Get all of account's follows.
-	follows, err := suite.state.DB.GetAccountFollows(
-		gtscontext.SetBarebones(ctx),
-		accountID,
-		nil, // select all
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	// Remove each follow.
-	for _, follow := range follows {
-		if err := suite.state.DB.DeleteFollowByID(ctx, follow.ID); err != nil {
-			suite.FailNow(err.Error())
-		}
-	}
-
-	// Ensure no follows left.
-	follows, err = suite.state.DB.GetAccountFollows(
-		gtscontext.SetBarebones(ctx),
-		accountID,
-		nil, // select all
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-	if len(follows) != 0 {
-		suite.FailNow("follows should be empty")
-	}
-}
-
-func (suite *GetTestSuite) emptyAccountStatuses(ctx context.Context, accountID string) {
-	// Get all of account's statuses.
-	statuses, err := suite.state.DB.GetAccountStatuses(
-		ctx,
-		accountID,
-		9999,
-		false,
-		false,
-		id.Highest,
-		id.Lowest,
-		false,
-		false,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	// Remove each status.
-	for _, status := range statuses {
-		if err := suite.state.DB.DeleteStatusByID(ctx, status.ID); err != nil {
-			suite.FailNow(err.Error())
-		}
-	}
-}
-
-func (suite *GetTestSuite) TestGetNewTimelinePageDown() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = ""
-		limit       = 5
-		local       = false
-	)
-
-	// Get 5 from the top.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-	suite.checkStatuses(statuses, id.Highest, id.Lowest, 5)
-
-	// Get 5 from next maxID.
-	maxID = statuses[len(statuses)-1].GetID()
-	statuses, err = suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-	suite.checkStatuses(statuses, maxID, id.Lowest, 5)
-}
-
-func (suite *GetTestSuite) TestGetNewTimelinePageUp() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = id.Lowest
-		limit       = 5
-		local       = false
-	)
-
-	// Get 5 from the back.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-	suite.checkStatuses(statuses, id.Highest, minID, 5)
-
-	// Page up from next minID.
-	minID = statuses[0].GetID()
-	statuses, err = suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-	suite.checkStatuses(statuses, id.Highest, minID, 5)
-}
-
-func (suite *GetTestSuite) TestGetNewTimelineMoreThanPossible() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = ""
-		limit       = 100
-		local       = false
-	)
-
-	// Get 100 from the top.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-	suite.checkStatuses(statuses, id.Highest, id.Lowest, 22)
-}
-
-func (suite *GetTestSuite) TestGetNewTimelineMoreThanPossiblePageUp() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = id.Lowest
-		limit       = 100
-		local       = false
-	)
-
-	// Get 100 from the back.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-	suite.checkStatuses(statuses, id.Highest, id.Lowest, 22)
-}
-
-func (suite *GetTestSuite) TestGetNewTimelineNoFollowing() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = ""
-		limit       = 10
-		local       = false
-	)
-
-	suite.emptyAccountFollows(ctx, testAccount.ID)
-
-	// Try to get 10 from the top of the timeline.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-	suite.checkStatuses(statuses, id.Highest, id.Lowest, 9)
-
-	for _, s := range statuses {
-		if s.GetAccountID() != testAccount.ID {
-			suite.FailNow("timeline with no follows should only contain posts by timeline owner account")
-		}
-	}
-}
-
-func (suite *GetTestSuite) TestGetNewTimelineNoFollowingNoStatuses() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = ""
-		limit       = 5
-		local       = false
-	)
-
-	suite.emptyAccountFollows(ctx, testAccount.ID)
-	suite.emptyAccountStatuses(ctx, testAccount.ID)
-
-	// Try to get 5 from the top of the timeline.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-	suite.checkStatuses(statuses, id.Highest, id.Lowest, 0)
-}
-
-func (suite *GetTestSuite) TestGetNoParams() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = ""
-		limit       = 10
-		local       = false
-	)
-
-	suite.fillTimeline(testAccount.ID)
-
-	// Get 10 statuses from the top (no params).
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	suite.checkStatuses(statuses, id.Highest, id.Lowest, 10)
-
-	// First status should have the highest ID in the testrig.
-	suite.Equal(suite.highestStatusID, statuses[0].GetID())
-}
-
-func (suite *GetTestSuite) TestGetMaxID() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = "01F8MHBQCBTDKN6X5VHGMMN4MA"
-		sinceID     = ""
-		minID       = ""
-		limit       = 10
-		local       = false
-	)
-
-	suite.fillTimeline(testAccount.ID)
-
-	// Ask for 10 with a max ID somewhere in the middle of the stack.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	// We'll only get 6 statuses back.
-	suite.checkStatuses(statuses, maxID, id.Lowest, 6)
-}
-
-func (suite *GetTestSuite) TestGetSinceID() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = "01F8MHBQCBTDKN6X5VHGMMN4MA"
-		minID       = ""
-		limit       = 10
-		local       = false
-	)
-
-	suite.fillTimeline(testAccount.ID)
-
-	// Ask for 10 with a since ID somewhere in the middle of the stack.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	suite.checkStatuses(statuses, id.Highest, sinceID, 10)
-
-	// The first status in the stack should have the highest ID of all
-	// in the testrig, because we're paging down.
-	suite.Equal(suite.highestStatusID, statuses[0].GetID())
-}
-
-func (suite *GetTestSuite) TestGetSinceIDOneOnly() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = "01F8MHBQCBTDKN6X5VHGMMN4MA"
-		minID       = ""
-		limit       = 1
-		local       = false
-	)
-
-	suite.fillTimeline(testAccount.ID)
-
-	// Ask for 1 with a since ID somewhere in the middle of the stack.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	suite.checkStatuses(statuses, id.Highest, sinceID, 1)
-
-	// The one status we got back should have the highest ID of all in
-	// the testrig, because using sinceID means we're paging down.
-	suite.Equal(suite.highestStatusID, statuses[0].GetID())
-}
-
-func (suite *GetTestSuite) TestGetMinID() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = "01F8MHBQCBTDKN6X5VHGMMN4MA"
-		limit       = 5
-		local       = false
-	)
-
-	suite.fillTimeline(testAccount.ID)
-
-	// Ask for 5 with a min ID somewhere in the middle of the stack.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	suite.checkStatuses(statuses, id.Highest, minID, 5)
-
-	// We're paging up so even the highest status ID in the pile
-	// shouldn't be the highest ID we have.
-	suite.NotEqual(suite.highestStatusID, statuses[0])
-}
-
-func (suite *GetTestSuite) TestGetMinIDOneOnly() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = "01F8MHBQCBTDKN6X5VHGMMN4MA"
-		limit       = 1
-		local       = false
-	)
-
-	suite.fillTimeline(testAccount.ID)
-
-	// Ask for 1 with a min ID somewhere in the middle of the stack.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	suite.checkStatuses(statuses, id.Highest, minID, 1)
-
-	// The one status we got back should have the an ID equal to the
-	// one ID immediately newer than it.
-	suite.Equal("01F8MHC0H0A7XHTVH5F596ZKBM", statuses[0].GetID())
-}
-
-func (suite *GetTestSuite) TestGetMinIDFromLowestInTestrig() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = suite.lowestStatusID
-		limit       = 1
-		local       = false
-	)
-
-	suite.fillTimeline(testAccount.ID)
-
-	// Ask for 1 with minID equal to the lowest status in the testrig.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	suite.checkStatuses(statuses, id.Highest, minID, 1)
-
-	// The one status we got back should have an id higher than
-	// the lowest status in the testrig, since minID is not inclusive.
-	suite.Greater(statuses[0].GetID(), suite.lowestStatusID)
-}
-
-func (suite *GetTestSuite) TestGetMinIDFromLowestPossible() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = id.Lowest
-		limit       = 1
-		local       = false
-	)
-
-	suite.fillTimeline(testAccount.ID)
-
-	// Ask for 1 with the lowest possible min ID.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	suite.checkStatuses(statuses, id.Highest, minID, 1)
-
-	// The one status we got back should have the an ID equal to the
-	// lowest ID status in the test rig.
-	suite.Equal(suite.lowestStatusID, statuses[0].GetID())
-}
-
-func (suite *GetTestSuite) TestGetBetweenID() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = "01F8MHCP5P2NWYQ416SBA0XSEV"
-		sinceID     = ""
-		minID       = "01F8MHBQCBTDKN6X5VHGMMN4MA"
-		limit       = 10
-		local       = false
-	)
-
-	suite.fillTimeline(testAccount.ID)
-
-	// Ask for 10 between these two IDs
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	// There's only two statuses between these two IDs.
-	suite.checkStatuses(statuses, maxID, minID, 2)
-}
-
-func (suite *GetTestSuite) TestGetBetweenIDImpossible() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = id.Lowest
-		sinceID     = ""
-		minID       = id.Highest
-		limit       = 10
-		local       = false
-	)
-
-	suite.fillTimeline(testAccount.ID)
-
-	// Ask for 10 between these two IDs which present
-	// an impossible query.
-	statuses, err := suite.state.Timelines.Home.GetTimeline(
-		ctx,
-		testAccount.ID,
-		maxID,
-		sinceID,
-		minID,
-		limit,
-		local,
-	)
-	if err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	// We should have nothing back.
-	suite.checkStatuses(statuses, maxID, minID, 0)
-}
-
-func (suite *GetTestSuite) TestGetTimelinesAsync() {
-	var (
-		ctx           = context.Background()
-		accountToNuke = suite.testAccounts["local_account_1"]
-		maxID         = ""
-		sinceID       = ""
-		minID         = ""
-		limit         = 5
-		local         = false
-		multiplier    = 5
-	)
-
-	// Nuke one account's statuses and follows,
-	// as though the account had just been created.
-	suite.emptyAccountFollows(ctx, accountToNuke.ID)
-	suite.emptyAccountStatuses(ctx, accountToNuke.ID)
-
-	// Get 5 statuses from each timeline in
-	// our testrig at the same time, five times.
-	wg := new(sync.WaitGroup)
-	wg.Add(len(suite.testAccounts) * multiplier)
-
-	for i := 0; i < multiplier; i++ {
-		go func() {
-			for _, testAccount := range suite.testAccounts {
-				if _, err := suite.state.Timelines.Home.GetTimeline(
-					ctx,
-					testAccount.ID,
-					maxID,
-					sinceID,
-					minID,
-					limit,
-					local,
-				); err != nil {
-					suite.Fail(err.Error())
-				}
-
-				wg.Done()
-			}
-		}()
-	}
-
-	wg.Wait() // Wait until all get calls have returned.
-}
-
-func TestGetTestSuite(t *testing.T) {
-	suite.Run(t, new(GetTestSuite))
-}