mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-12-05 01:52:46 +00:00
84279f6a6a
* improvements to caching for lists and relationship to accounts / follows * fix nil panic in AddToList() * ensure list related caches are correctly invalidated * ensure returned ID lists are ordered correctly * bump go-structr to v0.8.9 (returns early if zero uncached keys to be loaded) * remove zero checks in uncached key load functions (go-structr now handles this) * fix issues after rebase on upstream/main * update the expected return order of CSV exports (since list entries are now down by entry creation date) * rename some funcs, allow deleting list entries for multiple follow IDs at a time, fix up more tests * use returning statements on delete to get cache invalidation info * fixes to recent database delete changes * fix broken list entries delete sql * remove unused db function * update remainder of delete functions to behave in similar way, some other small tweaks * fix delete user sql, allow returning on err no entries * uncomment + fix list database tests * update remaining list tests * update envparsing test * add comments to each specific key being invalidated * add more cache invalidation explanatory comments * whoops; actually delete poll votes from database in the DeletePollByID() func * remove added but-commented-out field * improved comment regarding paging being disabled * make cache invalidation comments match what's actually happening * fix up delete query comments to match what is happening * rename function to read a bit better * don't use ErrNoEntries on delete when not needed (it's only needed for a RETURNING call) * update function name in test * move list exclusivity check to AFTER eligibility check. use log.Panic() instead of panic() * use the poll_id column in poll_votes for selecting votes in poll ID * fix function name
306 lines
8.5 KiB
Go
306 lines
8.5 KiB
Go
// 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 bundb_test
|
|
|
|
import (
|
|
"context"
|
|
"slices"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/suite"
|
|
"github.com/superseriousbusiness/gotosocial/internal/db"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
)
|
|
|
|
type ListTestSuite struct {
|
|
BunDBStandardTestSuite
|
|
}
|
|
|
|
func (suite *ListTestSuite) testStructs() (*gtsmodel.List, []*gtsmodel.ListEntry, *gtsmodel.Account) {
|
|
testList := >smodel.List{}
|
|
*testList = *suite.testLists["local_account_1_list_1"]
|
|
|
|
// Populate entries on this list as we'd expect them back from the db.
|
|
entries := make([]*gtsmodel.ListEntry, 0, len(suite.testListEntries))
|
|
for _, entry := range suite.testListEntries {
|
|
entries = append(entries, entry)
|
|
}
|
|
|
|
// Sort by ID descending (again, as we'd expect from the db).
|
|
slices.SortFunc(entries, func(a, b *gtsmodel.ListEntry) int {
|
|
const k = -1
|
|
switch {
|
|
case a.ID > b.ID:
|
|
return +k
|
|
case a.ID < b.ID:
|
|
return -k
|
|
default:
|
|
return 0
|
|
}
|
|
})
|
|
|
|
testAccount := >smodel.Account{}
|
|
*testAccount = *suite.testAccounts["local_account_1"]
|
|
|
|
return testList, entries, testAccount
|
|
}
|
|
|
|
func (suite *ListTestSuite) checkList(expected *gtsmodel.List, actual *gtsmodel.List) {
|
|
suite.Equal(expected.ID, actual.ID)
|
|
suite.Equal(expected.Title, actual.Title)
|
|
suite.Equal(expected.AccountID, actual.AccountID)
|
|
suite.Equal(expected.RepliesPolicy, actual.RepliesPolicy)
|
|
suite.NotNil(actual.Account)
|
|
}
|
|
|
|
func (suite *ListTestSuite) checkListEntry(expected *gtsmodel.ListEntry, actual *gtsmodel.ListEntry) {
|
|
suite.Equal(expected.ID, actual.ID)
|
|
suite.Equal(expected.ListID, actual.ListID)
|
|
suite.Equal(expected.FollowID, actual.FollowID)
|
|
}
|
|
|
|
func (suite *ListTestSuite) checkListEntries(expected []*gtsmodel.ListEntry, actual []*gtsmodel.ListEntry) {
|
|
var (
|
|
lExpected = len(expected)
|
|
lActual = len(actual)
|
|
)
|
|
|
|
if lExpected != lActual {
|
|
suite.FailNow("", "expected %d list entries, got %d", lExpected, lActual)
|
|
}
|
|
|
|
var topID string
|
|
for i, expectedEntry := range expected {
|
|
actualEntry := actual[i]
|
|
|
|
// Ensure ID descending.
|
|
if topID == "" {
|
|
topID = actualEntry.ID
|
|
} else {
|
|
suite.Less(actualEntry.ID, topID)
|
|
}
|
|
|
|
suite.checkListEntry(expectedEntry, actualEntry)
|
|
}
|
|
}
|
|
|
|
func (suite *ListTestSuite) TestGetListByID() {
|
|
testList, _, _ := suite.testStructs()
|
|
|
|
dbList, err := suite.db.GetListByID(context.Background(), testList.ID)
|
|
if err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
suite.checkList(testList, dbList)
|
|
}
|
|
|
|
func (suite *ListTestSuite) TestGetListsForAccountID() {
|
|
testList, _, testAccount := suite.testStructs()
|
|
|
|
dbLists, err := suite.db.GetListsByAccountID(context.Background(), testAccount.ID)
|
|
if err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
if l := len(dbLists); l != 1 {
|
|
suite.FailNow("", "expected %d lists, got %d", 1, l)
|
|
}
|
|
|
|
suite.checkList(testList, dbLists[0])
|
|
}
|
|
|
|
func (suite *ListTestSuite) TestPutList() {
|
|
ctx := context.Background()
|
|
_, _, testAccount := suite.testStructs()
|
|
|
|
testList := >smodel.List{
|
|
ID: "01H0J2PMYM54618VCV8Y8QYAT4",
|
|
Title: "Test List!",
|
|
AccountID: testAccount.ID,
|
|
}
|
|
|
|
if err := suite.db.PutList(ctx, testList); err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
dbList, err := suite.db.GetListByID(ctx, testList.ID)
|
|
if err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
// Bodge testlist as though default had been set.
|
|
testList.RepliesPolicy = gtsmodel.RepliesPolicyFollowed
|
|
suite.checkList(testList, dbList)
|
|
}
|
|
|
|
func (suite *ListTestSuite) TestUpdateList() {
|
|
ctx := context.Background()
|
|
testList, _, _ := suite.testStructs()
|
|
|
|
// Get List in the cache first.
|
|
dbList, err := suite.db.GetListByID(ctx, testList.ID)
|
|
if err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
// Now do the update.
|
|
testList.Title = "New Title!"
|
|
if err := suite.db.UpdateList(ctx, testList, "title"); err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
// Cache should be invalidated
|
|
// + we should have updated list.
|
|
dbList, err = suite.db.GetListByID(ctx, testList.ID)
|
|
if err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
suite.checkList(testList, dbList)
|
|
}
|
|
|
|
func (suite *ListTestSuite) TestDeleteList() {
|
|
ctx := context.Background()
|
|
testList, _, _ := suite.testStructs()
|
|
|
|
// Get List in the cache first.
|
|
if _, err := suite.db.GetListByID(ctx, testList.ID); err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
// Now do the delete.
|
|
if err := suite.db.DeleteListByID(ctx, testList.ID); err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
// Cache should be invalidated
|
|
// + we should have no list.
|
|
_, err := suite.db.GetListByID(ctx, testList.ID)
|
|
suite.ErrorIs(err, db.ErrNoEntries)
|
|
|
|
// All accounts / follows attached to this
|
|
// list should now be return empty values.
|
|
listAccounts, err1 := suite.db.GetAccountsInList(ctx, testList.ID, nil)
|
|
listFollows, err2 := suite.db.GetFollowsInList(ctx, testList.ID, nil)
|
|
suite.NoError(err1)
|
|
suite.NoError(err2)
|
|
suite.Empty(listAccounts)
|
|
suite.Empty(listFollows)
|
|
}
|
|
|
|
func (suite *ListTestSuite) TestPutListEntries() {
|
|
ctx := context.Background()
|
|
testList, testEntries, _ := suite.testStructs()
|
|
|
|
listEntries := []*gtsmodel.ListEntry{
|
|
{
|
|
ID: "01H0MKMQY69HWDSDR2SWGA17R4",
|
|
ListID: testList.ID,
|
|
FollowID: "01H0MKNFRFZS8R9WV6DBX31Y03", // random id, doesn't exist
|
|
},
|
|
{
|
|
ID: "01H0MKPGQF0E7QAVW5BKTHZ630",
|
|
ListID: testList.ID,
|
|
FollowID: "01H0MKP6RR8VEHN3GVWFBP2H30", // random id, doesn't exist
|
|
},
|
|
{
|
|
ID: "01H0MKPPP2DT68FRBMR1FJM32T",
|
|
ListID: testList.ID,
|
|
FollowID: "01H0MKQ0KA29C6NFJ27GTZD16J", // random id, doesn't exist
|
|
},
|
|
}
|
|
|
|
if err := suite.db.PutListEntries(ctx, listEntries); err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
// Get all follows stored under this list ID, to ensure
|
|
// the newly added list entry follows are among these.
|
|
followIDs, err := suite.db.GetFollowIDsInList(ctx, testList.ID, nil)
|
|
suite.NoError(err)
|
|
suite.Len(followIDs, len(testEntries)+len(listEntries))
|
|
suite.Contains(followIDs, "01H0MKNFRFZS8R9WV6DBX31Y03")
|
|
suite.Contains(followIDs, "01H0MKP6RR8VEHN3GVWFBP2H30")
|
|
suite.Contains(followIDs, "01H0MKQ0KA29C6NFJ27GTZD16J")
|
|
}
|
|
|
|
func (suite *ListTestSuite) TestDeleteListEntry() {
|
|
ctx := context.Background()
|
|
testList, testEntries, _ := suite.testStructs()
|
|
|
|
// Delete the first entry.
|
|
if err := suite.db.DeleteListEntry(ctx,
|
|
testEntries[0].ListID,
|
|
testEntries[0].FollowID,
|
|
); err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
// Get all follows stored under this list ID, to ensure
|
|
// the newly removed list entry follow is now missing.
|
|
followIDs, err := suite.db.GetFollowIDsInList(ctx, testList.ID, nil)
|
|
suite.NoError(err)
|
|
suite.Len(followIDs, len(testEntries)-1)
|
|
suite.NotContains(followIDs, testEntries[0].FollowID)
|
|
}
|
|
|
|
func (suite *ListTestSuite) TestDeleteAllListEntriesByFollows() {
|
|
ctx := context.Background()
|
|
testList, testEntries, _ := suite.testStructs()
|
|
|
|
// Delete the first entry.
|
|
if err := suite.db.DeleteAllListEntriesByFollows(ctx,
|
|
testEntries[0].FollowID,
|
|
); err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
// Get all follows stored under this list ID, to ensure
|
|
// the newly removed list entry follow is now missing.
|
|
followIDs, err := suite.db.GetFollowIDsInList(ctx, testList.ID, nil)
|
|
suite.NoError(err)
|
|
suite.Len(followIDs, len(testEntries)-1)
|
|
suite.NotContains(followIDs, testEntries[0].FollowID)
|
|
}
|
|
|
|
func (suite *ListTestSuite) TestListIncludesAccount() {
|
|
ctx := context.Background()
|
|
testList, _, _ := suite.testStructs()
|
|
|
|
for accountID, expected := range map[string]bool{
|
|
suite.testAccounts["admin_account"].ID: true,
|
|
suite.testAccounts["local_account_1"].ID: false,
|
|
suite.testAccounts["local_account_2"].ID: true,
|
|
"01H7074GEZJ56J5C86PFB0V2CT": false,
|
|
} {
|
|
includes, err := suite.db.IsAccountInList(ctx, testList.ID, accountID)
|
|
if err != nil {
|
|
suite.FailNow(err.Error())
|
|
}
|
|
|
|
if includes != expected {
|
|
suite.FailNow("", "expected %t for accountID %s got %t", expected, accountID, includes)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestListTestSuite(t *testing.T) {
|
|
suite.Run(t, new(ListTestSuite))
|
|
}
|