Files
cs249r_book/socratiq/tests/reader-learning.spec.mjs

240 lines
13 KiB
JavaScript

import {test, expect} from '@playwright/test';
const endpoint = 'https://mlsysbook.ai/api/socratiq/ai/stream**';
const answer = '**Bandwidth** moves data.';
const sse = text => `data: ${JSON.stringify({choices: [{delta: {content: text}, finish_reason: null}]})}\n\ndata: ${JSON.stringify({choices: [{delta: {}, finish_reason: 'stop'}]})}\n\ndata: [DONE]\n\n`;
const payload = request => {
const content = request.postDataJSON().messages.at(-1).content;
return JSON.parse(content.slice(content.indexOf('{'), content.lastIndexOf('}') + 1));
};
async function openSelected(page) {
await page.goto('/vol1/chapter/');
await page.locator('#passage').evaluate(node => {
const range = document.createRange(); range.selectNodeContents(node);
const selection = window.getSelection(); selection.removeAllRanges(); selection.addRange(range);
document.dispatchEvent(new Event('selectionchange'));
});
await expect(page.getByRole('button', {name: 'Explain this', exact: true})).toBeVisible();
await page.getByRole('button', {name: 'Ask SocratiQ', exact: true}).click();
}
test('learning actions retain source and completed history, and launcher sends nothing', async ({page}) => {
const requests = [];
await page.route(endpoint, route => {
requests.push(payload(route.request()));
return route.fulfill({contentType: 'text/event-stream', body: sse(answer)});
});
await openSelected(page);
expect(requests).toHaveLength(0);
const input = page.getByRole('textbox', {name: 'Ask a follow-up question'});
await input.fill('Keep my draft');
for (const label of ['Simplify', 'Show an example', 'Check my understanding', 'Map to taxonomy']) {
await page.getByRole('button', {name: label, exact: true}).click();
await expect(page.getByText('Explanation ready.', {exact: true})).toBeVisible();
await expect(input).toHaveValue('Keep my draft');
}
expect(requests[0].history).toEqual([]);
expect(requests[1].history).toEqual([{role: 'user', content: requests[0].question}, {role: 'assistant', content: answer}]);
expect(requests[2].source).toEqual(requests[0].source);
expect(requests[2].question).toContain('one conceptual question at a time');
expect(requests[2].question).toContain('Do not reveal the answer until I respond');
expect(requests[3].question).toContain('ML Systems Taxonomy');
await input.fill('I think it measures data movement.');
await page.getByRole('button', {name: 'Send question'}).click();
await expect(page.getByText('Explanation ready.', {exact: true})).toBeVisible();
expect(requests[4].history.at(-2).content).toEqual(requests[3].question);
});
test('start over aborts pending work, clears draft and history, and retains passage', async ({page}) => {
const requests = [];
let release;
const pending = new Promise(resolve => {release = resolve;});
await page.route(endpoint, async route => {
requests.push(payload(route.request()));
if (requests.length === 1) await pending;
await route.fulfill({contentType: 'text/event-stream', body: sse(answer)}).catch(() => {});
});
await openSelected(page);
const input = page.getByRole('textbox', {name: 'Ask a follow-up question'});
await input.fill('Draft to clear');
await page.getByRole('button', {name: 'Simplify', exact: true}).click();
await expect.poll(() => requests.length).toBe(1);
await expect(page.getByRole('button', {name: 'Show an example', exact: true})).toBeDisabled();
await page.getByRole('button', {name: 'Start over', exact: true}).click();
release();
await expect(input).toHaveValue('');
await expect(page.locator('#socratiq-reader .reader-turn')).toHaveCount(0);
await expect(page.locator('#socratiq-reader .reader-source-link')).toBeVisible();
await page.getByRole('button', {name: 'Show an example', exact: true}).click();
await expect(page.getByText('Explanation ready.', {exact: true})).toBeVisible();
expect(requests[1].history).toEqual([]);
expect(requests[1].source).toEqual(requests[0].source);
await expect(page.locator('#socratiq-reader .reader-turn')).toHaveCount(2);
});
test('copy keeps Markdown and source provenance and reports clipboard rejection', async ({page}) => {
await page.addInitScript(() => {
window.copiedNotes = [];
Object.defineProperty(navigator, 'clipboard', {configurable: true, value: {writeText: async text => {
if (window.rejectCopy) throw new Error('Denied');
window.copiedNotes.push(text);
}}});
});
await page.route(endpoint, route => route.fulfill({contentType: 'text/event-stream', body: sse(answer)}));
await openSelected(page);
await page.getByRole('button', {name: 'Simplify', exact: true}).click();
const copy = page.getByRole('button', {name: 'Copy answer as Markdown'});
await copy.click();
await expect(page.getByText('Answer copied as Markdown.', {exact: true})).toBeVisible();
const copied = await page.evaluate(() => window.copiedNotes[0]);
expect(copied).toContain(answer);
expect(copied).toContain('SocratiQ AI explanation');
expect(copied).toContain('Source:');
expect(copied).toContain('/vol1/chapter/');
expect(copied).toContain('> Memory bandwidth');
await page.evaluate(() => {window.rejectCopy = true;});
await copy.click();
await expect(page.getByText('Could not copy the answer. Select the answer text and copy it manually.', {exact: true})).toBeVisible();
await expect(copy).toBeEnabled();
});
test('failed quick action keeps draft and start over clears retry state', async ({page}) => {
let calls = 0;
await page.route(endpoint, route => {
calls += 1;
return route.fulfill({status: 400, contentType: 'application/json', body: JSON.stringify({error: 'Invalid request'})});
});
await openSelected(page);
const input = page.getByRole('textbox', {name: 'Ask a follow-up question'});
await input.fill('A question I am still writing');
await page.getByRole('button', {name: 'Simplify', exact: true}).click();
await expect(page.getByRole('button', {name: 'Retry', exact: true})).toBeVisible();
await expect(input).toHaveValue('A question I am still writing');
await page.getByRole('button', {name: 'Start over', exact: true}).click();
await expect(input).toHaveValue('');
await expect(page.getByRole('button', {name: 'Retry', exact: true})).toBeHidden();
await expect(page.locator('#socratiq-reader .reader-turn')).toHaveCount(0);
expect(calls).toBe(1);
});
test('keyboard users can focus and scroll the answer region without trapping book navigation', async ({page}) => {
const longAnswer = 'A paragraph about bandwidth and latency.\n\n'.repeat(60);
await page.route(endpoint, route => route.fulfill({contentType: 'text/event-stream', body: sse(longAnswer)}));
await openSelected(page);
await page.getByRole('button', {name: 'Simplify', exact: true}).click();
await expect(page.getByText('Explanation ready.', {exact: true})).toBeVisible();
const body = page.getByRole('region', {name: 'Selected passage and answers'});
await page.getByRole('button', {name: 'Close SocratiQ reader'}).focus();
await page.keyboard.press('Tab');
await expect(body).toBeFocused();
await page.keyboard.press('Tab');
await expect(page.getByText('Learning preferences', {exact: true})).toBeFocused();
await page.keyboard.press('Tab');
await expect(page.getByRole('button', {name: 'Study tools', exact: true})).toBeFocused();
await page.keyboard.press('Shift+Tab');
await expect(page.getByText('Learning preferences', {exact: true})).toBeFocused();
await page.keyboard.press('Shift+Tab');
await expect(body).toBeFocused();
await body.evaluate(node => {node.scrollTop = 0;});
await page.keyboard.press('PageDown');
await expect.poll(() => body.evaluate(node => node.scrollTop)).toBeGreaterThan(0);
await page.keyboard.press('Escape');
await expect(page.getByRole('button', {name: 'Ask SocratiQ', exact: true})).toBeFocused();
});
test('short mobile viewport leaves room to read an answer with the composer visible', async ({page}, testInfo) => {
await page.setViewportSize({width: 390, height: 360});
await page.route(endpoint, route => route.fulfill({contentType: 'text/event-stream', body: sse(answer)}));
await openSelected(page);
await page.getByRole('button', {name: 'Simplify', exact: true}).click();
await expect(page.getByText('Explanation ready.', {exact: true})).toBeVisible();
const body = page.getByRole('region', {name: 'Selected passage and answers'});
await body.evaluate(node => {node.scrollTop = node.scrollHeight;});
const readingSpace = await body.evaluate(node => {
const source = node.querySelector('.reader-source');
const answerNode = node.querySelector('.reader-answer');
const pinnedHeight = getComputedStyle(source).position === 'sticky' ? source.offsetHeight : 0;
return {height: node.clientHeight - pinnedHeight, answerBottom: answerNode.getBoundingClientRect().bottom, sourceBottom: source.getBoundingClientRect().bottom};
});
expect(readingSpace.height).toBeGreaterThan(40);
expect(readingSpace.answerBottom).toBeGreaterThan(readingSpace.sourceBottom);
await expect(page.getByRole('button', {name: 'Send question'})).toBeInViewport();
await page.screenshot({path: testInfo.outputPath('short-mobile.png')});
});
test('configurable PopClip selection bar supports Ask, Check me, Taxonomy, and custom action toggles', async ({page}) => {
const requests = [];
await page.route(endpoint, route => {
requests.push(payload(route.request()));
return route.fulfill({contentType: 'text/event-stream', body: sse(answer)});
});
await page.goto('/vol1/chapter/');
const selectPassage = () => page.locator('#passage').evaluate(node => {
const range = document.createRange(); range.selectNodeContents(node);
const selection = window.getSelection(); selection.removeAllRanges(); selection.addRange(range);
document.dispatchEvent(new Event('selectionchange'));
});
await selectPassage();
const clip = page.getByRole('toolbar', {name: 'Selection actions'});
await expect(clip).toBeVisible();
for (const label of ['Explain this', 'Ask…', 'Check me', 'Taxonomy', 'Configure selection actions']) {
await expect(clip.getByRole('button', {name: label, exact: true})).toBeVisible();
}
await expect(clip.getByRole('button', {name: 'Simplify', exact: true})).toBeHidden();
// Configure via gear menu: enable Simplify and persist
await clip.getByRole('button', {name: 'Configure selection actions', exact: true}).click();
const menu = clip.getByRole('group', {name: 'Selection clip actions'});
await expect(menu).toBeVisible();
await menu.getByLabel('Simplify', {exact: true}).check();
await expect(clip.getByRole('button', {name: 'Simplify', exact: true})).toBeVisible();
// Clicking Ask… opens reader and focuses textarea without auto-sending a prompt
await clip.getByRole('button', {name: 'Ask…', exact: true}).click();
expect(requests).toHaveLength(0);
const input = page.getByRole('textbox', {name: 'Ask a follow-up question'});
await expect(input).toBeFocused();
await page.getByRole('button', {name: 'Close SocratiQ reader'}).click();
// Re-select passage: Simplify remains enabled and Taxonomy sends taxonomy prompt
await selectPassage();
await expect(clip.getByRole('button', {name: 'Simplify', exact: true})).toBeVisible();
await clip.getByRole('button', {name: 'Taxonomy', exact: true}).click();
await expect(page.getByText('Explanation ready.', {exact: true})).toBeVisible();
expect(requests).toHaveLength(1);
expect(requests[0].question).toContain('ML Systems Taxonomy');
});
test('Focused Reader footer displays Free shared model status and connects/disconnects a session-only Gemini or Claude model', async ({page}) => {
await page.goto('/vol1/chapter/');
await page.getByRole('button', {name: 'Ask SocratiQ', exact: true}).click();
await expect(page.locator('#socratiq-reader .reader-model-status')).toHaveText('Free shared model');
const connectLink = page.getByRole('button', {name: 'Connect your own Gemini or Claude', exact: true});
await expect(connectLink).toBeVisible();
await connectLink.click();
const byokBox = page.locator('#socratiq-reader .reader-byok-box');
await expect(byokBox).toBeVisible();
await expect(byokBox.locator('.reader-byok-sso')).toContainText('Sign in with OpenRouter');
await byokBox.locator('.reader-byok-provider').selectOption('anthropic');
await expect(byokBox.locator('.reader-byok-model')).toHaveValue('claude-sonnet-4-20250514');
await byokBox.locator('.reader-byok-key').fill('sk-ant-constructed-session-only-key');
await byokBox.getByRole('button', {name: 'Connect model', exact: true}).click();
await expect(page.locator('#socratiq-reader .reader-model-status')).toContainText('Connected: Anthropic Claude');
const storageCheck = await page.evaluate(() => ({
session: sessionStorage.getItem('socratiq_byok_session_v1'),
persisted: localStorage.getItem('socratiq_byok_persisted_v1'),
legacyKey: JSON.parse(localStorage.getItem('userSettings') || '{}')?.customAPI?.apiKey || '',
}));
expect(storageCheck.session).toContain('sk-ant-constructed-session-only-key');
expect(storageCheck.persisted).toBeNull();
expect(storageCheck.legacyKey).toBe('');
await byokBox.getByRole('button', {name: 'Use free shared model', exact: true}).click();
await expect(page.locator('#socratiq-reader .reader-model-status')).toHaveText('Free shared model');
});