Files
openmaic/OpenMAIC/e2e/tests/settings-kv-persistence.spec.ts
2026-08-16 14:58:47 +08:00

101 lines
3.6 KiB
TypeScript

import { test, expect } from '../fixtures/base';
import { HomePage } from '../pages/home.page';
import { createSettingsStorage, SETTINGS_KV_KEY } from '../fixtures/test-data/settings';
/**
* The settings store persists through the `@openmaic/storage` KVStore, and does
* not migrate pre-cutover data. These two cases pin both facts: a store whose
* data is already in the KV scope loads it, and a store still holding the old
* raw `settings-storage` blob has it ignored and purged rather than migrated.
*
* The Playwright Chromium locale is en-US, so UI strings are English.
*/
// fetchServerProviders reads data.tts/asr/pdf/image/video/webSearch via
// Object.keys(); omitting them throws and is silently swallowed by its
// try/catch, so the mock must return the full shape.
function serverProvidersBody(providers: Record<string, { models?: string[] }>) {
return JSON.stringify({
providers,
tts: {},
asr: {},
pdf: {},
image: {},
video: {},
webSearch: {},
});
}
const SETTINGS = createSettingsStorage({
modelId: 'gpt-4o',
providerId: 'openai',
providersConfig: { openai: { apiKey: 'test-key' } },
autoConfigApplied: true,
});
test.describe.configure({ mode: 'serial' });
test.describe('settings persistence through the KVStore', () => {
test.beforeEach(async ({ page }) => {
await page.route('**/api/server-providers', (route) =>
route.fulfill({
status: 200,
headers: { 'Content-Type': 'application/json' },
body: serverProvidersBody({ openai: { models: ['gpt-4o', 'gpt-4o-mini'] } }),
}),
);
});
test('loads a store already living in the KV scope, with no raw key present', async ({
page,
}) => {
// The steady state: the value is in the KV scope, nothing under the raw key.
await page.addInitScript(
({ key, settings }) => {
localStorage.setItem(key, settings);
},
{ key: SETTINGS_KV_KEY, settings: SETTINGS },
);
const home = new HomePage(page);
await Promise.all([page.waitForResponse('**/api/server-providers'), home.goto()]);
await expect(home.textarea).toBeVisible();
// The seeded provider/model reached the UI, so hydration read the KV scope.
const modelPill = page.locator('button[aria-label^="OpenAI / "]');
await expect(modelPill).toBeVisible({ timeout: 15_000 });
await expect(modelPill).toHaveAttribute('aria-label', /OpenAI \/ gpt-4o/);
await home.fillRequirement('Explain how photosynthesis works');
await expect(home.enterButton).toBeEnabled();
// Nothing was written under the raw key.
expect(await page.evaluate(() => localStorage.getItem('settings-storage'))).toBeNull();
});
test('ignores a pre-cutover raw key and purges it on first load', async ({ page }) => {
await page.addInitScript((settings) => {
localStorage.setItem('settings-storage', settings);
}, SETTINGS);
const home = new HomePage(page);
await Promise.all([page.waitForResponse('**/api/server-providers'), home.goto()]);
await expect(home.textarea).toBeVisible();
// No migration: the raw blob is not read, and it is best-effort purged
// (it held plaintext provider API keys).
await expect
.poll(() => page.evaluate(() => localStorage.getItem('settings-storage')), {
timeout: 15_000,
})
.toBeNull();
// And the seeded apiKey never reached the KV scope.
const leakedKey = await page.evaluate((key) => {
const raw = localStorage.getItem(key);
return raw ? JSON.parse(raw)?.state?.providersConfig?.openai?.apiKey : undefined;
}, SETTINGS_KV_KEY);
expect(leakedKey).not.toBe('test-key');
});
});