🐑 fix: Avoid Per-User Copies of Base App Config (#18057)

This commit is contained in:
dwaddle 2026-11-12 13:25:14 +01:00 • committed by GitHub
parent 50f8dd9720
commit 40671fd88c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 55 additions and 3 deletions

View file

@ -17,6 +17,7 @@ import {
createAppConfigService,
createMessageBudgetReader,
DEFAULT_OVERRIDE_CACHE_TTL,
BASE_OVERRIDE_SENTINEL,
_resetOverrideStrictCache,
getAppConfigOptionsFromUser,
} from './service';
@ -1106,6 +1107,43 @@ describe('createAppConfigService', () => {
expect(deps.getApplicableConfigs).toHaveBeenCalledTimes(1);
});
it('caches empty result using sentinel to avoid storing full config duplicates', async () => {
const deps = createDeps({ getApplicableConfigs: jest.fn().mockResolvedValue([]) });
const { getAppConfig } = createAppConfigService(deps);
await getAppConfig({ role: 'USER', userId: 'user-empty' });
const setCalls = deps._cache.set.mock.calls.filter(([key]: [string, unknown]) =>
key.includes('_OVERRIDE_'),
);
expect(setCalls).toHaveLength(1);
expect(setCalls[0][1]).toBe(BASE_OVERRIDE_SENTINEL);
const cached = await getAppConfig({ role: 'USER', userId: 'user-empty' });
expect(cached).toEqual(deps._baseConfig);
expect(deps.getApplicableConfigs).toHaveBeenCalledTimes(1);
});
it('caches merged config object when overrides exist', async () => {
const deps = createDeps({
getApplicableConfigs: jest
.fn()
.mockResolvedValue([
{ priority: 10, overrides: { interface: { modelSelect: false } }, isActive: true },
]),
});
const { getAppConfig } = createAppConfigService(deps);
await getAppConfig({ role: 'ADMIN', userId: 'admin-override' });
const setCalls = deps._cache.set.mock.calls.filter(([key]: [string, unknown]) =>
key.includes('_OVERRIDE_'),
);
expect(setCalls).toHaveLength(1);
expect(setCalls[0][1]).not.toBe(BASE_OVERRIDE_SENTINEL);
expect(typeof setCalls[0][1]).toBe('object');
});
it('merges DB configs when found', async () => {
const deps = createDeps({
getApplicableConfigs: jest

View file

@ -36,6 +36,12 @@ import { checkAppConfigTheme } from './theme';
const BASE_CONFIG_KEY = '_BASE_';
/**
* Sentinel stored in the override cache when a principal has no DB overrides.
* Avoids storing duplicate serialized copies of the full base config per user.
*/
export const BASE_OVERRIDE_SENTINEL = '__BASE_OVERRIDE__';
/** A base-config load: the config it serves, and why it failed when that is the last good one. */
interface BaseConfigLoad {
config: AppConfig;
@ -1078,9 +1084,12 @@ export function createAppConfigService(deps: AppConfigServiceDeps): {
*/
let cacheable = bypassOverrideCache !== true && (resolvedPrincipals == null || !!userId);
if (cacheable && !refresh) {
let cachedMerged: AppConfig | undefined;
let cachedMerged: AppConfig | typeof BASE_OVERRIDE_SENTINEL | undefined;
try {
cachedMerged = (await cache.get(cacheKey)) as AppConfig | undefined;
cachedMerged = (await cache.get(cacheKey)) as
| AppConfig
| typeof BASE_OVERRIDE_SENTINEL
| undefined;
} catch (error) {
cacheable = false;
logger.warn(
@ -1089,14 +1098,19 @@ export function createAppConfigService(deps: AppConfigServiceDeps): {
);
}
if (cachedMerged) {
if (cachedMerged === BASE_OVERRIDE_SENTINEL) {
return await augment(withRuntimeSecrets(scopedBaseConfig));
}
return await augment(withRuntimeSecrets(cachedMerged));
}
}
let merged = scopedBaseConfig;
let hasOverrides = false;
try {
const configs = await getApplicableConfigs(principals);
if (configs.length > 0) {
hasOverrides = true;
const { appConfig: layered, raw } = mergeOverrideLayersWithSource(
scopedBaseConfig,
configs,
@ -1133,7 +1147,7 @@ export function createAppConfigService(deps: AppConfigServiceDeps): {
if (cacheable && getOverrideGeneration(cacheTenantId) === generation) {
try {
await cache.set(cacheKey, merged, overrideCacheTtl);
await cache.set(cacheKey, hasOverrides ? merged : BASE_OVERRIDE_SENTINEL, overrideCacheTtl);
if (getOverrideGeneration(cacheTenantId) !== generation) {
await cache.delete(cacheKey);
}