2023-03-12 15:00:57 +00:00
|
|
|
// 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/>.
|
2021-08-15 16:43:08 +00:00
|
|
|
|
|
|
|
package timeline_test
|
|
|
|
|
|
|
|
import (
|
2021-08-25 13:34:33 +00:00
|
|
|
"context"
|
2021-08-15 16:43:08 +00:00
|
|
|
"testing"
|
|
|
|
|
|
|
|
"github.com/stretchr/testify/suite"
|
2023-05-25 08:37:38 +00:00
|
|
|
tlprocessor "github.com/superseriousbusiness/gotosocial/internal/processing/timeline"
|
2022-02-05 11:47:38 +00:00
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/timeline"
|
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/visibility"
|
2021-08-15 16:43:08 +00:00
|
|
|
"github.com/superseriousbusiness/gotosocial/testrig"
|
|
|
|
)
|
|
|
|
|
|
|
|
type ManagerTestSuite struct {
|
|
|
|
TimelineStandardTestSuite
|
|
|
|
}
|
|
|
|
|
|
|
|
func (suite *ManagerTestSuite) SetupSuite() {
|
|
|
|
suite.testAccounts = testrig.NewTestAccounts()
|
|
|
|
suite.testStatuses = testrig.NewTestStatuses()
|
|
|
|
}
|
|
|
|
|
|
|
|
func (suite *ManagerTestSuite) SetupTest() {
|
[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>
2023-03-28 13:03:14 +00:00
|
|
|
suite.state.Caches.Init()
|
2023-03-01 18:26:53 +00:00
|
|
|
|
2021-10-11 12:37:33 +00:00
|
|
|
testrig.InitTestLog()
|
2021-12-07 12:31:39 +00:00
|
|
|
testrig.InitTestConfig()
|
|
|
|
|
[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>
2023-03-28 13:03:14 +00:00
|
|
|
suite.db = testrig.NewTestDB(&suite.state)
|
2021-08-15 16:43:08 +00:00
|
|
|
suite.tc = testrig.NewTestTypeConverter(suite.db)
|
[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>
2023-03-28 13:03:14 +00:00
|
|
|
suite.filter = visibility.NewFilter(&suite.state)
|
2021-08-15 16:43:08 +00:00
|
|
|
|
|
|
|
testrig.StandardDBSetup(suite.db, nil)
|
|
|
|
|
2022-02-05 11:47:38 +00:00
|
|
|
manager := timeline.NewManager(
|
2023-05-25 08:37:38 +00:00
|
|
|
tlprocessor.HomeTimelineGrab(&suite.state),
|
|
|
|
tlprocessor.HomeTimelineFilter(&suite.state, suite.filter),
|
|
|
|
tlprocessor.HomeTimelineStatusPrepare(&suite.state, suite.tc),
|
|
|
|
tlprocessor.SkipInsert(),
|
2022-02-05 11:47:38 +00:00
|
|
|
)
|
2021-08-15 16:43:08 +00:00
|
|
|
suite.manager = manager
|
|
|
|
}
|
|
|
|
|
|
|
|
func (suite *ManagerTestSuite) TearDownTest() {
|
|
|
|
testrig.StandardDBTeardown(suite.db)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (suite *ManagerTestSuite) TestManagerIntegration() {
|
2022-07-10 15:18:21 +00:00
|
|
|
ctx := context.Background()
|
|
|
|
|
2021-08-15 16:43:08 +00:00
|
|
|
testAccount := suite.testAccounts["local_account_1"]
|
|
|
|
|
|
|
|
// should start at 0
|
2022-07-10 15:18:21 +00:00
|
|
|
indexedLen := suite.manager.GetIndexedLength(ctx, testAccount.ID)
|
2021-08-15 16:43:08 +00:00
|
|
|
suite.Equal(0, indexedLen)
|
|
|
|
|
|
|
|
// oldestIndexed should be empty string since there's nothing indexed
|
2023-04-06 11:43:13 +00:00
|
|
|
oldestIndexed := suite.manager.GetOldestIndexedID(ctx, testAccount.ID)
|
2021-08-15 16:43:08 +00:00
|
|
|
suite.Empty(oldestIndexed)
|
|
|
|
|
|
|
|
// get hometimeline
|
2022-07-10 15:18:21 +00:00
|
|
|
statuses, err := suite.manager.GetTimeline(ctx, testAccount.ID, "", "", "", 20, false)
|
2021-08-15 16:43:08 +00:00
|
|
|
suite.NoError(err)
|
2022-07-10 15:18:21 +00:00
|
|
|
suite.Len(statuses, 16)
|
2021-08-15 16:43:08 +00:00
|
|
|
|
|
|
|
// now wipe the last status from all timelines, as though it had been deleted by the owner
|
2022-07-10 15:18:21 +00:00
|
|
|
err = suite.manager.WipeItemFromAllTimelines(ctx, "01F8MH75CBF9JFX4ZAD54N0W0R")
|
2021-08-15 16:43:08 +00:00
|
|
|
suite.NoError(err)
|
|
|
|
|
|
|
|
// timeline should be shorter
|
2022-07-10 15:18:21 +00:00
|
|
|
indexedLen = suite.manager.GetIndexedLength(ctx, testAccount.ID)
|
|
|
|
suite.Equal(15, indexedLen)
|
2021-08-15 16:43:08 +00:00
|
|
|
|
|
|
|
// oldest should now be different
|
2023-04-06 11:43:13 +00:00
|
|
|
oldestIndexed = suite.manager.GetOldestIndexedID(ctx, testAccount.ID)
|
2022-07-10 15:18:21 +00:00
|
|
|
suite.Equal("01F8MH82FYRXD2RC6108DAJ5HB", oldestIndexed)
|
2021-08-15 16:43:08 +00:00
|
|
|
|
|
|
|
// delete the new oldest status specifically from this timeline, as though local_account_1 had muted or blocked it
|
2022-07-10 15:18:21 +00:00
|
|
|
removed, err := suite.manager.Remove(ctx, testAccount.ID, "01F8MH82FYRXD2RC6108DAJ5HB")
|
2021-08-15 16:43:08 +00:00
|
|
|
suite.NoError(err)
|
2023-04-06 11:43:13 +00:00
|
|
|
suite.Equal(1, removed) // 1 status should be removed
|
2021-08-15 16:43:08 +00:00
|
|
|
|
|
|
|
// timeline should be shorter
|
2022-07-10 15:18:21 +00:00
|
|
|
indexedLen = suite.manager.GetIndexedLength(ctx, testAccount.ID)
|
|
|
|
suite.Equal(14, indexedLen)
|
2021-08-15 16:43:08 +00:00
|
|
|
|
|
|
|
// oldest should now be different
|
2023-04-06 11:43:13 +00:00
|
|
|
oldestIndexed = suite.manager.GetOldestIndexedID(ctx, testAccount.ID)
|
2022-07-10 15:18:21 +00:00
|
|
|
suite.Equal("01F8MHAAY43M6RJ473VQFCVH37", oldestIndexed)
|
2021-08-15 16:43:08 +00:00
|
|
|
|
|
|
|
// now remove all entries by local_account_2 from the timeline
|
2022-07-10 15:18:21 +00:00
|
|
|
err = suite.manager.WipeItemsFromAccountID(ctx, testAccount.ID, suite.testAccounts["local_account_2"].ID)
|
2021-08-15 16:43:08 +00:00
|
|
|
suite.NoError(err)
|
|
|
|
|
2021-09-09 14:15:25 +00:00
|
|
|
// timeline should be shorter
|
2022-07-10 15:18:21 +00:00
|
|
|
indexedLen = suite.manager.GetIndexedLength(ctx, testAccount.ID)
|
|
|
|
suite.Equal(7, indexedLen)
|
2021-08-15 16:43:08 +00:00
|
|
|
|
|
|
|
// ingest and prepare another one into the timeline
|
2023-04-06 11:43:13 +00:00
|
|
|
status := suite.testStatuses["local_account_2_status_1"]
|
|
|
|
ingested, err := suite.manager.IngestOne(ctx, testAccount.ID, status)
|
2021-08-15 16:43:08 +00:00
|
|
|
suite.NoError(err)
|
|
|
|
suite.True(ingested)
|
|
|
|
|
|
|
|
// timeline should be longer now
|
2022-07-10 15:18:21 +00:00
|
|
|
indexedLen = suite.manager.GetIndexedLength(ctx, testAccount.ID)
|
2023-04-06 11:43:13 +00:00
|
|
|
suite.Equal(8, indexedLen)
|
2021-08-15 16:43:08 +00:00
|
|
|
|
2023-04-06 11:43:13 +00:00
|
|
|
// try to ingest same status again
|
|
|
|
ingested, err = suite.manager.IngestOne(ctx, testAccount.ID, status)
|
2021-08-15 16:43:08 +00:00
|
|
|
suite.NoError(err)
|
|
|
|
suite.False(ingested) // should be false since it's a duplicate
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestManagerTestSuite(t *testing.T) {
|
|
|
|
suite.Run(t, new(ManagerTestSuite))
|
|
|
|
}
|