[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, 142 deletions

diff --git a/internal/timeline/unprepare_test.go b/internal/timeline/unprepare_test.go
deleted file mode 100644
index 20bef7537..000000000
--- a/internal/timeline/unprepare_test.go
+++ /dev/null
@@ -1,142 +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"
-	"testing"
-
-	"github.com/stretchr/testify/suite"
-
-	apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
-	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
-	"github.com/superseriousbusiness/gotosocial/internal/id"
-)
-
-type UnprepareTestSuite struct {
-	TimelineStandardTestSuite
-}
-
-func (suite *UnprepareTestSuite) TestUnprepareFromFave() {
-	var (
-		ctx         = context.Background()
-		testAccount = suite.testAccounts["local_account_1"]
-		maxID       = ""
-		sinceID     = ""
-		minID       = ""
-		limit       = 1
-		local       = false
-	)
-
-	suite.fillTimeline(testAccount.ID)
-
-	// Get first status 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())
-	}
-
-	if len(statuses) != 1 {
-		suite.FailNow("couldn't get top status")
-	}
-
-	targetStatus := statuses[0].(*apimodel.Status)
-
-	// Check fave stats of the top status.
-	suite.Equal(0, targetStatus.FavouritesCount)
-	suite.False(targetStatus.Favourited)
-
-	// Fave the top status from testAccount.
-	if err := suite.state.DB.PutStatusFave(ctx, &gtsmodel.StatusFave{
-		ID:              id.NewULID(),
-		AccountID:       testAccount.ID,
-		TargetAccountID: targetStatus.Account.ID,
-		StatusID:        targetStatus.ID,
-		URI:             "https://example.org/some/activity/path",
-	}); err != nil {
-		suite.FailNow(err.Error())
-	}
-
-	// Repeat call to get first status from the top.
-	// Get first status 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())
-	}
-
-	if len(statuses) != 1 {
-		suite.FailNow("couldn't get top status")
-	}
-
-	targetStatus = statuses[0].(*apimodel.Status)
-
-	// We haven't yet uncached/unprepared the status,
-	// we've only inserted the fave, so counts should
-	// stay the same...
-	suite.Equal(0, targetStatus.FavouritesCount)
-	suite.False(targetStatus.Favourited)
-
-	// Now call unprepare.
-	suite.state.Timelines.Home.UnprepareItemFromAllTimelines(ctx, targetStatus.ID)
-
-	// Now a Get should trigger a fresh prepare of the
-	// target status, and the counts should be updated.
-	// Repeat call to get first status from the top.
-	// Get first status 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())
-	}
-
-	if len(statuses) != 1 {
-		suite.FailNow("couldn't get top status")
-	}
-
-	targetStatus = statuses[0].(*apimodel.Status)
-
-	suite.Equal(1, targetStatus.FavouritesCount)
-	suite.True(targetStatus.Favourited)
-}
-
-func TestUnprepareTestSuite(t *testing.T) {
-	suite.Run(t, new(UnprepareTestSuite))
-}