Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(server): server info lookup cache #3808

Merged
merged 2 commits into from
Jan 14, 2025
Merged

feat(server): server info lookup cache #3808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c68b7d9
feat(server): server info lookup cache
gjedlicska Jan 13, 2025
550353a
Merge branch 'main' of github.com:specklesystems/speckle-server into …
gjedlicska Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions packages/server/modules/core/graph/resolvers/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,18 @@ import {
getServerInfoFactory,
updateServerInfoFactory,
getPublicRolesFactory,
getPublicScopesFactory
getPublicScopesFactory,
getServerInfoFromCacheFactory,
storeServerInfoInCacheFactory
} from '@/modules/core/repositories/server'
import { db } from '@/db/knex'
import { Resolvers } from '@/modules/core/graph/generated/graphql'
import { LRUCache } from 'lru-cache'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why use lru-cache if all we care about is ttl?

From lru-cache docs:

This is not primarily a TTL cache, and does not make strong TTL guarantees. There is no preemptive pruning of expired items by default, but you may set a TTL on the cache or on a single set. If you do so, it will treat expired items as missing, and delete them when fetched. If you are more interested in TTL caching than LRU caching, check out @isaacs/ttlcache.

import { ServerInfo } from '@/modules/core/helpers/types'

const cache = new LRUCache<string, ServerInfo>({ max: 1, ttl: 60 * 1000 })
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Defining it here means we will have a separate cache (and a potentially different response) everywhere that getServerInfo is called. Better to move this into a shared location.

const getServerInfoFromCache = getServerInfoFromCacheFactory({ cache })
const storeServerInfoInCache = storeServerInfoInCacheFactory({ cache })
const getServerInfo = getServerInfoFactory({ db })
const updateServerInfo = updateServerInfoFactory({ db })
const getPublicRoles = getPublicRolesFactory({ db })
Expand All @@ -22,7 +29,11 @@ const getPublicScopes = getPublicScopesFactory({ db })
export = {
Query: {
async serverInfo() {
return await getServerInfo()
const cachedServerInfo = getServerInfoFromCache()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would we place this complexity in the caller? All callers will now have to implement the caching get/set calls.
getServerInfo is widespread throughout the codebase; if we want to get the full benefit of the cache we need to apply it wherever getServerInfo is called.
Better to move the complexity out of the caller and into the factory.

if (cachedServerInfo) return cachedServerInfo
const serverInfo = await getServerInfo()
storeServerInfoInCache({ serverInfo })
return serverInfo
}
},
ServerInfo: {
Expand Down Expand Up @@ -58,6 +69,9 @@ export = {

const update = removeNullOrUndefinedKeys(args.info)
await updateServerInfo(update)
// we're currently going to ignore, that this should be propagated to all
// backend instances, and going to rely on the TTL in the cache to propagate the changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We spoke last week of using Redis to minimise split-brain effects. What changed?

cache.clear()
return true
},
serverInfoMutations: () => ({})
Expand Down
16 changes: 16 additions & 0 deletions packages/server/modules/core/repositories/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import {
getServerVersion
} from '@/modules/shared/helpers/envHelper'
import { Knex } from 'knex'
import { LRUCache } from 'lru-cache'

const ServerConfig = buildTableHelper('server_config', [
'id',
Expand All @@ -38,6 +39,21 @@ const tables = {
scopes: (db: Knex) => db<ScopeRecord>(Scopes.name)
}

const SERVER_CONFIG_CACHE_KEY = 'server_config'

export const getServerInfoFromCacheFactory =
({ cache }: { cache: LRUCache<string, ServerInfo> }) =>
() => {
const serverInfo = cache.get(SERVER_CONFIG_CACHE_KEY)
return serverInfo ?? null
}

export const storeServerInfoInCacheFactory =
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are no guarantees thatstoreServerInfoInCacheFactory is interacting with the same cache that getServerInfoFromCacheFactory is. That now becomes another responsibility of the caller, and places more complexity in the caller.

({ cache }: { cache: LRUCache<string, ServerInfo> }) =>
({ serverInfo }: { serverInfo: ServerInfo }) => {
cache.set(SERVER_CONFIG_CACHE_KEY, serverInfo)
}

export const getServerInfoFactory =
(deps: { db: Knex }): GetServerInfo =>
async () => {
Expand Down