From de6e3e5f2a8ea639d76e310a11cb9bc093fef3a9 Mon Sep 17 00:00:00 2001 From: kim <89579420+NyaaaWhatsUpDoc@users.noreply.github.com> Date: Tue, 28 Mar 2023 14:03:14 +0100 Subject: [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 Co-authored-by: tsmethurst --- internal/cache/visibility.go | 81 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 internal/cache/visibility.go (limited to 'internal/cache/visibility.go') diff --git a/internal/cache/visibility.go b/internal/cache/visibility.go new file mode 100644 index 000000000..8706a8015 --- /dev/null +++ b/internal/cache/visibility.go @@ -0,0 +1,81 @@ +// 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 . + +package cache + +import ( + "codeberg.org/gruf/go-cache/v3/result" + "github.com/superseriousbusiness/gotosocial/internal/config" +) + +type VisibilityCache struct { + *result.Cache[*CachedVisibility] +} + +// Init will initialize the visibility cache in this collection. +// NOTE: the cache MUST NOT be in use anywhere, this is not thread-safe. +func (c *VisibilityCache) Init() { + c.Cache = result.New([]result.Lookup{ + {Name: "ItemID"}, + {Name: "RequesterID"}, + {Name: "Type.RequesterID.ItemID"}, + }, func(v1 *CachedVisibility) *CachedVisibility { + v2 := new(CachedVisibility) + *v2 = *v1 + return v2 + }, config.GetCacheVisibilityMaxSize()) + c.Cache.SetTTL(config.GetCacheVisibilityTTL(), true) + c.Cache.IgnoreErrors(ignoreErrors) +} + +// Start will attempt to start the visibility cache, or panic. +func (c *VisibilityCache) Start() { + tryStart(c.Cache, config.GetCacheVisibilitySweepFreq()) +} + +// Stop will attempt to stop the visibility cache, or panic. +func (c *VisibilityCache) Stop() { + tryStop(c.Cache, config.GetCacheVisibilitySweepFreq()) +} + +// VisibilityType represents a visibility lookup type. +// We use a byte type here to improve performance in the +// result cache when generating the key. +type VisibilityType byte + +const ( + // Possible cache visibility lookup types. + VisibilityTypeAccount = VisibilityType('a') + VisibilityTypeStatus = VisibilityType('s') + VisibilityTypeHome = VisibilityType('h') + VisibilityTypePublic = VisibilityType('p') +) + +// CachedVisibility represents a cached visibility lookup value. +type CachedVisibility struct { + // ItemID is the ID of the item in question (status / account). + ItemID string + + // RequesterID is the ID of the requesting account for this visibility lookup. + RequesterID string + + // Type is the visibility lookup type. + Type VisibilityType + + // Value is the actual visibility value. + Value bool +} -- cgit v1.2.3