Skip to content

perf: configurable guest-user + nav-tree cache TTLs (longer defaults) to let Aurora idle under scrapes #2

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

Open
jee7s wants to merge 1 commit into
base: fix/session-store-cleanup-interval
Choose a base branch
from
Open

perf: configurable guest-user + nav-tree cache TTLs (longer defaults) to let Aurora idle under scrapes #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions config.sample.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@ db:
# Optional - How often (in ms) the /healthz endpoint checks the DB (default: 14400000 = 4 hours)
# healthCheckInterval: 14400000

# ---------------------------------------------------------------------
# Navigation
# ---------------------------------------------------------------------

# nav:
# Optional - How long (in seconds) to cache the sidebar navigation tree (default: 3600 = 1 hour)
# A longer TTL means fewer periodic DB queries (helps Aurora Serverless idle/pause);
# admin "Flush Cache" forces an immediate refresh.
# cacheTTL: 3600

# ---------------------------------------------------------------------
# Analytics
# ---------------------------------------------------------------------
Expand All @@ -53,6 +63,11 @@ db:
# Optional - How long (in seconds) to cache deserialized users (default: 14400 = 4 hours, 0 to disable)
# userCacheTTL: 14400

# Optional - How long (in seconds) to cache the guest user + its permissions (default: 3600 = 1 hour)
# A longer TTL means fewer periodic DB queries on anonymous/crawler traffic; changing group
# permissions force-refreshes it immediately.
# guestCacheTTL: 3600

# Optional - PostgreSQL / MySQL / MariaDB only:
# -> Uncomment lines you need below and set `auto` to false
# -> Full list of accepted options: https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options
Expand Down
3 changes: 3 additions & 0 deletions dev/build/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ ssl:
logLevel: $(LOG_LEVEL:info)
logFormat: $(LOG_FORMAT:default)
ha: $(HA_ACTIVE)
nav:
cacheTTL: $(NAV_CACHE_TTL:3600)
analytics:
cacheTTL: $(ANALYTICS_CACHE_TTL:86400)
auth:
userCacheTTL: $(AUTH_USER_CACHE_TTL:14400)
guestCacheTTL: $(AUTH_GUEST_CACHE_TTL:3600)
2 changes: 2 additions & 0 deletions server/app/data.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ defaults:
verifySSL: true
nav:
mode: 'MIXED'
cacheTTL: 3600
theming:
theme: 'default'
iconset: 'md'
Expand All @@ -74,6 +75,7 @@ defaults:
tokenExpiration: '30m'
tokenRenewal: '14d'
userCacheTTL: 14400
guestCacheTTL: 3600
editShortcuts:
editFab: true
editMenuBar: false
Expand Down
2 changes: 1 addition & 1 deletion server/core/auth.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ module.exports = {
if (!user) {
if (WIKI.auth.guest.cacheExpiration <= DateTime.utc()) {
WIKI.auth.guest = await WIKI.models.users.getGuestUser()
WIKI.auth.guest.cacheExpiration = DateTime.utc().plus({ minutes: 1 })
WIKI.auth.guest.cacheExpiration = DateTime.utc().plus({ seconds: WIKI.config.auth.guestCacheTTL })
}
req.user = WIKI.auth.guest
return next()
Expand Down
2 changes: 1 addition & 1 deletion server/models/navigation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ module.exports = class Navigation extends Model {

for (const tree of navTree.config) {
if (cache) {
await WIKI.cache.set(`nav:sidebar:${tree.locale}`, tree.items, 300)
await WIKI.cache.set(`nav:sidebar:${tree.locale}`, tree.items, WIKI.config.nav.cacheTTL)
}
}
if (bypassAuth) {
Expand Down