240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
333 lines
14 KiB
Go
333 lines
14 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package localcachelayer
|
|
|
|
import (
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/mattermost/mattermost/server/public/model"
|
|
"github.com/mattermost/mattermost/server/public/shared/mlog"
|
|
"github.com/mattermost/mattermost/server/public/shared/request"
|
|
"github.com/mattermost/mattermost/server/v8/channels/store/storetest"
|
|
"github.com/mattermost/mattermost/server/v8/channels/store/storetest/mocks"
|
|
)
|
|
|
|
func TestEmojiStore(t *testing.T) {
|
|
StoreTest(t, storetest.TestEmojiStore)
|
|
}
|
|
|
|
func TestEmojiStoreCache(t *testing.T) {
|
|
rctx := request.TestContext(t)
|
|
logger := mlog.CreateConsoleTestLogger(t)
|
|
|
|
fakeEmoji := model.Emoji{Id: "123", Name: "name123"}
|
|
fakeEmoji2 := model.Emoji{Id: "321", Name: "name321"}
|
|
ctxEmoji := model.Emoji{Id: "master", Name: "name123"}
|
|
|
|
t.Run("first call by id not cached, second cached and returning same data", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
emoji, err := cachedStore.Emoji().Get(rctx, "123", true)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, emoji, &fakeEmoji)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 1)
|
|
emoji, err = cachedStore.Emoji().Get(rctx, "123", true)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, emoji, &fakeEmoji)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 1)
|
|
})
|
|
|
|
t.Run("GetByName: first call by name not cached, second cached and returning same data", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
emoji, err := cachedStore.Emoji().GetByName(rctx, "name123", true)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, emoji, &fakeEmoji)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 1)
|
|
emoji, err = cachedStore.Emoji().GetByName(rctx, "name123", true)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, emoji, &fakeEmoji)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 1)
|
|
})
|
|
|
|
t.Run("GetMultipleByName: first call by name not cached, second cached and returning same data", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
emojis, err := cachedStore.Emoji().GetMultipleByName(rctx, []string{"name123"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 1)
|
|
assert.Equal(t, emojis[0], &fakeEmoji)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 1)
|
|
emojis, err = cachedStore.Emoji().GetMultipleByName(rctx, []string{"name123"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 1)
|
|
assert.Equal(t, emojis[0], &fakeEmoji)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 1)
|
|
})
|
|
|
|
t.Run("GetMultipleByName: multiple elements", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
emojis, err := cachedStore.Emoji().GetMultipleByName(rctx, []string{"name123", "name321"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 2)
|
|
assert.Equal(t, emojis[0], &fakeEmoji)
|
|
assert.Equal(t, emojis[1], &fakeEmoji2)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 1)
|
|
emojis, err = cachedStore.Emoji().GetMultipleByName(rctx, []string{"name123"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 1)
|
|
assert.Equal(t, emojis[0], &fakeEmoji)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 1)
|
|
})
|
|
|
|
t.Run("GetMultipleByName: missing name cached negatively, second call skips store", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
emojis, err := cachedStore.Emoji().GetMultipleByName(rctx, []string{"missing"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 0)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 1)
|
|
emojis, err = cachedStore.Emoji().GetMultipleByName(rctx, []string{"missing"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 0)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 1)
|
|
})
|
|
|
|
t.Run("GetMultipleByName: mix of existing and missing names fully cached after first call", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
emojis, err := cachedStore.Emoji().GetMultipleByName(rctx, []string{"name123", "missing"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 1)
|
|
assert.Equal(t, emojis[0], &fakeEmoji)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 1)
|
|
emojis, err = cachedStore.Emoji().GetMultipleByName(rctx, []string{"name123", "missing"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 1)
|
|
assert.Equal(t, emojis[0], &fakeEmoji)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 1)
|
|
})
|
|
|
|
t.Run("GetMultipleByName: Save invalidates negative cache entry, emoji becomes visible via master", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
emojis, err := cachedStore.Emoji().GetMultipleByName(rctx, []string{"missing"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 0)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 1)
|
|
|
|
missingEmoji := model.Emoji{Id: "456", Name: "missing"}
|
|
_, err = cachedStore.Emoji().Save(&missingEmoji)
|
|
require.NoError(t, err)
|
|
|
|
// The mock returns the emoji only for a master-routed context, so this
|
|
// also pins that Save marks the name for master routing.
|
|
emojis, err = cachedStore.Emoji().GetMultipleByName(rctx, []string{"missing"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 1)
|
|
assert.Equal(t, emojis[0], &missingEmoji)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 2)
|
|
|
|
emojis, err = cachedStore.Emoji().GetMultipleByName(rctx, []string{"missing"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 1)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 2)
|
|
})
|
|
|
|
t.Run("GetByName: negative cache entry does not short-circuit GetByName and is repaired by it", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
emojis, err := cachedStore.Emoji().GetMultipleByName(rctx, []string{"missing"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 0)
|
|
|
|
missingEmoji := model.Emoji{Id: "456", Name: "missing"}
|
|
emoji, err := cachedStore.Emoji().GetByName(rctx, "missing", true)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, emoji, &missingEmoji)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 1)
|
|
|
|
emojis, err = cachedStore.Emoji().GetMultipleByName(rctx, []string{"missing"})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 1)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 1)
|
|
})
|
|
|
|
t.Run("GetMultipleByName: names longer than the maximum are not cached negatively", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
tooLongName := strings.Repeat("z", model.EmojiNameMaxLength+1)
|
|
emojis, err := cachedStore.Emoji().GetMultipleByName(rctx, []string{tooLongName})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 0)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 1)
|
|
emojis, err = cachedStore.Emoji().GetMultipleByName(rctx, []string{tooLongName})
|
|
require.NoError(t, err)
|
|
require.Len(t, emojis, 0)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 2)
|
|
})
|
|
|
|
t.Run("first call by id not cached, second force not cached", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
cachedStore.Emoji().Get(rctx, "123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 1)
|
|
cachedStore.Emoji().Get(rctx, "123", false)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 2)
|
|
})
|
|
|
|
t.Run("first call by name not cached, second force not cached", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
cachedStore.Emoji().GetByName(rctx, "name123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 1)
|
|
cachedStore.Emoji().GetByName(rctx, "name123", false)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 2)
|
|
})
|
|
|
|
t.Run("first call by id force not cached, second not cached, third cached", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
cachedStore.Emoji().Get(rctx, "123", false)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 1)
|
|
cachedStore.Emoji().Get(rctx, "123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 2)
|
|
cachedStore.Emoji().Get(rctx, "123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 2)
|
|
})
|
|
|
|
t.Run("first call by name force not cached, second not cached, third cached", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
cachedStore.Emoji().GetByName(rctx, "name123", false)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 1)
|
|
cachedStore.Emoji().GetByName(rctx, "name123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 2)
|
|
cachedStore.Emoji().GetByName(rctx, "name123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 2)
|
|
})
|
|
|
|
t.Run("first call by id, second call by name and GetMultipleByName cached", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
cachedStore.Emoji().Get(rctx, "123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 1)
|
|
cachedStore.Emoji().GetByName(rctx, "name123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 0)
|
|
cachedStore.Emoji().GetMultipleByName(rctx, []string{"name123"})
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetMultipleByName", 0)
|
|
})
|
|
|
|
t.Run("first call by name, second call by id cached", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
cachedStore.Emoji().GetByName(rctx, "name123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 1)
|
|
cachedStore.Emoji().Get(rctx, "123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 0)
|
|
})
|
|
|
|
t.Run("first call by id not cached, invalidate, and then not cached again", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
cachedStore.Emoji().Get(rctx, "123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 1)
|
|
cachedStore.Emoji().Delete(&fakeEmoji, 0)
|
|
cachedStore.Emoji().Get(rctx, "123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 2)
|
|
})
|
|
|
|
t.Run("call by id, use master", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
cachedStore.Emoji().Get(rctx, "master", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 1)
|
|
cachedStore.Emoji().Delete(&ctxEmoji, 0)
|
|
cachedStore.Emoji().Get(rctx, "master", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "Get", 2)
|
|
})
|
|
|
|
t.Run("first call by name not cached, invalidate, and then not cached again", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
cachedStore.Emoji().GetByName(rctx, "name123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 1)
|
|
cachedStore.Emoji().Delete(&fakeEmoji, 0)
|
|
cachedStore.Emoji().GetByName(rctx, "name123", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 2)
|
|
})
|
|
|
|
t.Run("call by name, use master", func(t *testing.T) {
|
|
mockStore := getMockStore(t)
|
|
mockCacheProvider := getMockCacheProvider()
|
|
cachedStore, err := NewLocalCacheLayer(mockStore, nil, nil, mockCacheProvider, logger)
|
|
require.NoError(t, err)
|
|
|
|
cachedStore.Emoji().GetByName(rctx, "master", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 1)
|
|
cachedStore.Emoji().Delete(&ctxEmoji, 0)
|
|
cachedStore.Emoji().GetByName(rctx, "master", true)
|
|
mockStore.Emoji().(*mocks.EmojiStore).AssertNumberOfCalls(t, "GetByName", 2)
|
|
})
|
|
}
|