mirror of
				https://github.com/superseriousbusiness/gotosocial.git
				synced 2025-11-04 01:02:25 -06:00 
			
		
		
		
	* 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 🤦
* 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
		
	
			
		
			
				
	
	
		
			293 lines
		
	
	
	
		
			8.2 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			293 lines
		
	
	
	
		
			8.2 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 importdata_test
 | 
						|
 | 
						|
import (
 | 
						|
	"bytes"
 | 
						|
	"context"
 | 
						|
	"io"
 | 
						|
	"net/http"
 | 
						|
	"net/http/httptest"
 | 
						|
	"testing"
 | 
						|
 | 
						|
	"github.com/stretchr/testify/suite"
 | 
						|
 | 
						|
	importdata "github.com/superseriousbusiness/gotosocial/internal/api/client/import"
 | 
						|
	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
 | 
						|
	"github.com/superseriousbusiness/gotosocial/internal/oauth"
 | 
						|
	"github.com/superseriousbusiness/gotosocial/internal/state"
 | 
						|
	"github.com/superseriousbusiness/gotosocial/testrig"
 | 
						|
)
 | 
						|
 | 
						|
type ImportTestSuite struct {
 | 
						|
	// Suite interfaces
 | 
						|
	suite.Suite
 | 
						|
	state state.State
 | 
						|
 | 
						|
	// standard suite models
 | 
						|
	testTokens       map[string]*gtsmodel.Token
 | 
						|
	testApplications map[string]*gtsmodel.Application
 | 
						|
	testUsers        map[string]*gtsmodel.User
 | 
						|
	testAccounts     map[string]*gtsmodel.Account
 | 
						|
 | 
						|
	// module being tested
 | 
						|
	importModule *importdata.Module
 | 
						|
}
 | 
						|
 | 
						|
func (suite *ImportTestSuite) SetupSuite() {
 | 
						|
	suite.testTokens = testrig.NewTestTokens()
 | 
						|
	suite.testApplications = testrig.NewTestApplications()
 | 
						|
	suite.testUsers = testrig.NewTestUsers()
 | 
						|
	suite.testAccounts = testrig.NewTestAccounts()
 | 
						|
}
 | 
						|
 | 
						|
func (suite *ImportTestSuite) SetupTest() {
 | 
						|
	suite.state.Caches.Init()
 | 
						|
 | 
						|
	testrig.InitTestConfig()
 | 
						|
	testrig.InitTestLog()
 | 
						|
 | 
						|
	suite.state.DB = testrig.NewTestDB(&suite.state)
 | 
						|
	suite.state.Storage = testrig.NewInMemoryStorage()
 | 
						|
 | 
						|
	testrig.StandardDBSetup(suite.state.DB, nil)
 | 
						|
	testrig.StandardStorageSetup(suite.state.Storage, "../../../../testrig/media")
 | 
						|
 | 
						|
	mediaManager := testrig.NewTestMediaManager(&suite.state)
 | 
						|
 | 
						|
	federator := testrig.NewTestFederator(
 | 
						|
		&suite.state,
 | 
						|
		testrig.NewTestTransportController(
 | 
						|
			&suite.state,
 | 
						|
			testrig.NewMockHTTPClient(nil, "../../../../testrig/media"),
 | 
						|
		),
 | 
						|
		mediaManager,
 | 
						|
	)
 | 
						|
 | 
						|
	processor := testrig.NewTestProcessor(
 | 
						|
		&suite.state,
 | 
						|
		federator,
 | 
						|
		testrig.NewEmailSender("../../../../web/template/", nil),
 | 
						|
		testrig.NewNoopWebPushSender(),
 | 
						|
		mediaManager,
 | 
						|
	)
 | 
						|
	testrig.StartWorkers(&suite.state, processor.Workers())
 | 
						|
 | 
						|
	suite.importModule = importdata.New(processor)
 | 
						|
}
 | 
						|
 | 
						|
func (suite *ImportTestSuite) TriggerHandler(
 | 
						|
	importData string,
 | 
						|
	importType string,
 | 
						|
	importMode string,
 | 
						|
) {
 | 
						|
	// Set up request.
 | 
						|
	recorder := httptest.NewRecorder()
 | 
						|
	ctx, _ := testrig.CreateGinTestContext(recorder, nil)
 | 
						|
 | 
						|
	// Authorize the request ctx as though it
 | 
						|
	// had passed through API auth handlers.
 | 
						|
	ctx.Set(oauth.SessionAuthorizedAccount, suite.testAccounts["local_account_1"])
 | 
						|
	ctx.Set(oauth.SessionAuthorizedToken, oauth.DBTokenToToken(suite.testTokens["local_account_1"]))
 | 
						|
	ctx.Set(oauth.SessionAuthorizedApplication, suite.testApplications["application_1"])
 | 
						|
	ctx.Set(oauth.SessionAuthorizedUser, suite.testUsers["local_account_1"])
 | 
						|
 | 
						|
	// Create test request.
 | 
						|
	b, w, err := testrig.CreateMultipartFormData(
 | 
						|
		testrig.StringToDataF("data", "data.csv", importData),
 | 
						|
		map[string][]string{
 | 
						|
			"type": {importType},
 | 
						|
			"mode": {importMode},
 | 
						|
		},
 | 
						|
	)
 | 
						|
	if err != nil {
 | 
						|
		suite.FailNow(err.Error())
 | 
						|
	}
 | 
						|
 | 
						|
	target := "http://localhost:8080/api/v1/import"
 | 
						|
	ctx.Request = httptest.NewRequest(http.MethodPost, target, bytes.NewReader(b.Bytes()))
 | 
						|
	ctx.Request.Header.Set("Accept", "application/json")
 | 
						|
	ctx.Request.Header.Set("Content-Type", w.FormDataContentType())
 | 
						|
 | 
						|
	// Trigger handler.
 | 
						|
	suite.importModule.ImportPOSTHandler(ctx)
 | 
						|
 | 
						|
	if code := recorder.Code; code != http.StatusAccepted {
 | 
						|
		b, err := io.ReadAll(recorder.Body)
 | 
						|
		if err != nil {
 | 
						|
			panic(err)
 | 
						|
		}
 | 
						|
		suite.FailNow("", "expected 202, got %d: %s", code, string(b))
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func (suite *ImportTestSuite) TearDownTest() {
 | 
						|
	testrig.StandardDBTeardown(suite.state.DB)
 | 
						|
	testrig.StandardStorageTeardown(suite.state.Storage)
 | 
						|
	testrig.StopWorkers(&suite.state)
 | 
						|
}
 | 
						|
 | 
						|
func (suite *ImportTestSuite) TestImportFollows() {
 | 
						|
	var (
 | 
						|
		ctx         = context.Background()
 | 
						|
		testAccount = suite.testAccounts["local_account_1"]
 | 
						|
	)
 | 
						|
 | 
						|
	// Clear existing follows from Zork.
 | 
						|
	if err := suite.state.DB.DeleteAccountFollows(ctx, testAccount.ID); err != nil {
 | 
						|
		suite.FailNow(err.Error())
 | 
						|
	}
 | 
						|
 | 
						|
	// Have zork refollow turtle and admin.
 | 
						|
	data := `Account address,Show boosts
 | 
						|
admin@localhost:8080,true
 | 
						|
1happyturtle@localhost:8080,true
 | 
						|
`
 | 
						|
 | 
						|
	// Trigger the import handler.
 | 
						|
	suite.TriggerHandler(data, "following", "merge")
 | 
						|
 | 
						|
	// Wait for zork to be
 | 
						|
	// following admin.
 | 
						|
	if !testrig.WaitFor(func() bool {
 | 
						|
		f, err := suite.state.DB.IsFollowing(
 | 
						|
			ctx,
 | 
						|
			testAccount.ID,
 | 
						|
			suite.testAccounts["admin_account"].ID,
 | 
						|
		)
 | 
						|
		if err != nil {
 | 
						|
			suite.FailNow(err.Error())
 | 
						|
		}
 | 
						|
 | 
						|
		return f
 | 
						|
	}) {
 | 
						|
		suite.FailNow("timed out waiting for zork to follow admin")
 | 
						|
	}
 | 
						|
 | 
						|
	// Wait for zork to be
 | 
						|
	// follow req'ing turtle.
 | 
						|
	if !testrig.WaitFor(func() bool {
 | 
						|
		f, err := suite.state.DB.IsFollowRequested(
 | 
						|
			ctx,
 | 
						|
			testAccount.ID,
 | 
						|
			suite.testAccounts["local_account_2"].ID,
 | 
						|
		)
 | 
						|
		if err != nil {
 | 
						|
			suite.FailNow(err.Error())
 | 
						|
		}
 | 
						|
 | 
						|
		return f
 | 
						|
	}) {
 | 
						|
		suite.FailNow("timed out waiting for zork to follow req turtle")
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func (suite *ImportTestSuite) TestImportMutes() {
 | 
						|
	var (
 | 
						|
		ctx         = context.Background()
 | 
						|
		testAccount = suite.testAccounts["local_account_1"]
 | 
						|
	)
 | 
						|
 | 
						|
	// Clear existing mutes from Zork.
 | 
						|
	if err := suite.state.DB.DeleteAccountMutes(ctx, testAccount.ID); err != nil {
 | 
						|
		suite.FailNow(err.Error())
 | 
						|
	}
 | 
						|
 | 
						|
	// Have zork mute turtle, admin and remote fossbro.
 | 
						|
	data := `Account address,Hide notifications
 | 
						|
admin@localhost:8080,true
 | 
						|
unknown@localhost:8080,true
 | 
						|
1happyturtle@localhost:8080,false
 | 
						|
foss_satan@fossbros-anonymous.io,true
 | 
						|
`
 | 
						|
 | 
						|
	// Trigger the import handler.
 | 
						|
	suite.TriggerHandler(data, "mutes", "merge")
 | 
						|
 | 
						|
	// Wait for mutes to be applied
 | 
						|
	if !testrig.WaitFor(func() bool {
 | 
						|
		mutes, err := suite.state.DB.GetAccountMutes(ctx, testAccount.ID, nil)
 | 
						|
		if err != nil {
 | 
						|
			suite.FailNow(err.Error())
 | 
						|
		}
 | 
						|
		for _, m := range mutes {
 | 
						|
			switch m.TargetAccount.ID {
 | 
						|
			case suite.testAccounts["remote_account_1"].ID:
 | 
						|
				if *m.Notifications != true {
 | 
						|
					suite.FailNow("expected notifications from fossbro to be muted")
 | 
						|
				}
 | 
						|
			case suite.testAccounts["admin_account"].ID:
 | 
						|
				if *m.Notifications != true {
 | 
						|
					suite.FailNow("expected notifications from admin to be muted")
 | 
						|
				}
 | 
						|
			case suite.testAccounts["local_account_2"].ID:
 | 
						|
				if *m.Notifications != false {
 | 
						|
					suite.FailNow("expected notifications from turtle to NOT be muted")
 | 
						|
				}
 | 
						|
			default:
 | 
						|
				suite.FailNow("unexpected muted account", m.TargetAccount)
 | 
						|
			}
 | 
						|
		}
 | 
						|
		return len(mutes) == 3
 | 
						|
	}) {
 | 
						|
		suite.FailNow("timed out waiting for mutes to apply")
 | 
						|
	}
 | 
						|
 | 
						|
	// Import again in overwrite mode:
 | 
						|
	//   - remote fossbro is unmuted, admin and turtle are kept
 | 
						|
	//   - Notification hiding is reversed to confirm mutes are modified
 | 
						|
	data = `Account address,Hide notifications
 | 
						|
admin@localhost:8080,false
 | 
						|
1happyturtle@localhost:8080,true
 | 
						|
`
 | 
						|
 | 
						|
	// Trigger the import handler.
 | 
						|
	suite.TriggerHandler(data, "mutes", "overwrite")
 | 
						|
 | 
						|
	// Wait for mutes to be applied
 | 
						|
	if !testrig.WaitFor(func() bool {
 | 
						|
		mutes, err := suite.state.DB.GetAccountMutes(ctx, testAccount.ID, nil)
 | 
						|
		if err != nil {
 | 
						|
			suite.FailNow(err.Error())
 | 
						|
		}
 | 
						|
		for _, m := range mutes {
 | 
						|
			switch m.TargetAccount.ID {
 | 
						|
			case suite.testAccounts["remote_account_1"].ID:
 | 
						|
				suite.FailNow("fossbro is still muted")
 | 
						|
			case suite.testAccounts["admin_account"].ID:
 | 
						|
				if *m.Notifications != false {
 | 
						|
					suite.FailNow("expected notifications from admin to be NOT muted")
 | 
						|
				}
 | 
						|
			case suite.testAccounts["local_account_2"].ID:
 | 
						|
				if *m.Notifications != true {
 | 
						|
					suite.FailNow("expected notifications from turtle to be muted")
 | 
						|
				}
 | 
						|
			default:
 | 
						|
				suite.FailNow("unexpected muted account", m.TargetAccount)
 | 
						|
			}
 | 
						|
		}
 | 
						|
		return len(mutes) == 2
 | 
						|
	}) {
 | 
						|
		suite.FailNow("timed out waiting for import to apply")
 | 
						|
	}
 | 
						|
 | 
						|
}
 | 
						|
 | 
						|
func TestImportTestSuite(t *testing.T) {
 | 
						|
	suite.Run(t, new(ImportTestSuite))
 | 
						|
}
 |