mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-26 00:03:09 -06:00
Code Issues Packages Projects Releases Wiki Activity

Adding comments about RoomInfoCache safety

Browse source
This commit is contained in:
Neil Alexander 2020-12-16 12:14:51 +00:00
parent e336d53f5e
commit 384ad0e2a0
No known key found for this signature in database
GPG key ID: A02A2019A2BB0944
1 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
internal/caching/cache_roominfo.go
View file

@ -4,6 +4,14 @@ import (
"github.com/matrix-org/dendrite/roomserver/types" "github.com/matrix-org/dendrite/roomserver/types"
) )
// WARNING: This cache is mutable because it's entirely possible that
// the IsStub or StateSnaphotNID fields can change, even though the
// room version and room NID fields will not. This is only safe because
// the RoomInfoCache is used ONLY within the roomserver and because it
// will be kept up-to-date by the latest events updater. It MUST NOT be
// used from other components as we currently have no way to invalidate
// the cache in downstream components.
const ( const (
RoomInfoCacheName = "roominfo" RoomInfoCacheName = "roominfo"
RoomInfoCacheMaxEntries = 1024 RoomInfoCacheMaxEntries = 1024
@ -11,12 +19,15 @@ const (
) )
// RoomInfosCache contains the subset of functions needed for // RoomInfosCache contains the subset of functions needed for
// a room Info cache. // a room Info cache. It must only be used from the roomserver only
// It is not safe for use from other components.
type RoomInfoCache interface { type RoomInfoCache interface {
GetRoomInfo(roomID string) (roomInfo types.RoomInfo, ok bool) GetRoomInfo(roomID string) (roomInfo types.RoomInfo, ok bool)
StoreRoomInfo(roomID string, roomInfo types.RoomInfo) StoreRoomInfo(roomID string, roomInfo types.RoomInfo)
} }
// GetRoomInfo must only be called from the roomserver only. It is not
// safe for use from other components.
func (c Caches) GetRoomInfo(roomID string) (types.RoomInfo, bool) { func (c Caches) GetRoomInfo(roomID string) (types.RoomInfo, bool) {
val, found := c.RoomInfos.Get(roomID) val, found := c.RoomInfos.Get(roomID)
if found && val != nil { if found && val != nil {
@ -27,6 +38,8 @@ func (c Caches) GetRoomInfo(roomID string) (types.RoomInfo, bool) {
return types.RoomInfo{}, false return types.RoomInfo{}, false
} }
// StoreRoomInfo must only be called from the roomserver only. It is not
// safe for use from other components.
func (c Caches) StoreRoomInfo(roomID string, roomInfo types.RoomInfo) { func (c Caches) StoreRoomInfo(roomID string, roomInfo types.RoomInfo) {
c.RoomInfos.Set(roomID, roomInfo) c.RoomInfos.Set(roomID, roomInfo)
} }