Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
Guard desktop-smoke against vacuous green; quarantine terminal-dock (#2180)
Nick Gomezfe856f1d562e
diff --git a/knip.config.ts b/knip.config.tsindex eb5629fb6..c3ba40caa 100644--- a/knip.config.ts+++ b/knip.config.ts@@ -49,6 +49,9 @@ export default {'scripts/bun-install-ci.test.mjs': ['files'],'scripts/measure-scripts-contract.test.mjs': ['files'],'scripts/promote-stable-token.test.mjs': ['files'],+ 'scripts/assert-smoke-not-vacuous.mjs': ['files'],+ 'scripts/assert-smoke-not-vacuous.test.mjs': ['files'],+ 'scripts/check-no-ci-skip-in-e2e.test.mjs': ['files'],'.github/scripts/cla-gate.test.mjs': ['files'],'.github/scripts/cla-gate.mjs': ['exports'],'.github/scripts/bridge-public-pr-to-monorepo.test.mjs': ['files'],diff --git a/packages/app/src/components/ClaudeReadinessBanner.tsx b/packages/app/src/components/ClaudeReadinessBanner.tsxindex 22d884fad..885399d01 100644--- a/packages/app/src/components/ClaudeReadinessBanner.tsx+++ b/packages/app/src/components/ClaudeReadinessBanner.tsx@@ -60,6 +60,7 @@ export function ClaudeReadinessBanner({return (<divrole="status"+ data-testid="terminal-readiness-banner"className="flex shrink-0 items-center gap-3 border-border border-b bg-muted px-3 py-2 text-foreground text-xs"><p className="min-w-0 flex-1">{message}</p>diff --git a/packages/app/src/components/TerminalPanel.dom.test.tsx b/packages/app/src/components/TerminalPanel.dom.test.tsxindex 5f2f3b41c..39d81c63a 100644--- a/packages/app/src/components/TerminalPanel.dom.test.tsx+++ b/packages/app/src/components/TerminalPanel.dom.test.tsx@@ -122,7 +122,11 @@ function makeBridge(createResult: CreateResult, preflight: ClaudeReadiness = WIRrewireClaudeMcp,};return {- bridge: { terminal, shell: { openExternal } } as unknown as OkDesktopBridge,+ bridge: {+ terminal,+ shell: { openExternal },+ config: { e2eSmoke: false },+ } as unknown as OkDesktopBridge,terminal,openExternal,rewireClaudeMcp,@@ -457,7 +461,7 @@ describe('TerminalPanel', () => {onData: mock(() => mock(() => {})),onExit: mock(() => mock(() => {})),};- const bridge = { terminal } as unknown as OkDesktopBridge;+ const bridge = { terminal, config: { e2eSmoke: false } } as unknown as OkDesktopBridge;const { unmount } = render(<TerminalPanel bridge={bridge} />);await waitFor(() => expect(terminal.create).toHaveBeenCalledTimes(1));@@ -549,6 +553,7 @@ describe('TerminalPanel', () => {const bridge = {terminal,shell: { openExternal: mock(async () => {}) },+ config: { e2eSmoke: false },} as unknown as OkDesktopBridge;render(<TerminalPanel bridge={bridge} />);@@ -663,6 +668,7 @@ describe('TerminalPanel', () => {const bridge = {terminal,shell: { openExternal: mock(async () => {}) },+ config: { e2eSmoke: false },} as unknown as OkDesktopBridge;const pushExit = (m: OkPtyExit) => {for (const f of exitSubs) f(m);diff --git a/packages/app/src/components/TerminalPanel.launch.dom.test.tsx b/packages/app/src/components/TerminalPanel.launch.dom.test.tsxindex 0730441ea..bdd8927d4 100644--- a/packages/app/src/components/TerminalPanel.launch.dom.test.tsx+++ b/packages/app/src/components/TerminalPanel.launch.dom.test.tsx@@ -90,6 +90,7 @@ function makeBridge(preflight: ClaudeReadiness = WIRED, cliReadiness: CliReadinebridge: {terminal,shell: { openExternal: mock(async () => {}) },+ config: { e2eSmoke: false },} as unknown as OkDesktopBridge,terminal,pushData: (m: OkPtyData) => {@@ -158,6 +159,7 @@ describe('TerminalPanel "Open in terminal" launch', () => {const bridge = {terminal,shell: { openExternal: mock(async () => {}) },+ config: { e2eSmoke: false },} as unknown as OkDesktopBridge;render(<TerminalPanel bridge={bridge} launch={{ prompt: 'hi', cli: 'claude', nonce: 1 }} />);@@ -234,6 +236,7 @@ describe('TerminalPanel "Open in terminal" launch', () => {const bridge = {terminal,shell: { openExternal: mock(async () => {}) },+ config: { e2eSmoke: false },} as unknown as OkDesktopBridge;const pushData = (m: OkPtyData) => {for (const f of dataSubs) f(m);@@ -273,6 +276,7 @@ describe('TerminalPanel "Open in terminal" launch', () => {const bridge = {terminal,shell: { openExternal: mock(async () => {}) },+ config: { e2eSmoke: false },} as unknown as OkDesktopBridge;const pushData = (m: OkPtyData) => {for (const f of dataSubs) f(m);@@ -315,6 +319,7 @@ describe('TerminalPanel "Open in terminal" launch', () => {const bridge = {terminal,shell: { openExternal: mock(async () => {}) },+ config: { e2eSmoke: false },} as unknown as OkDesktopBridge;const pushData = (m: OkPtyData) => {for (const f of dataSubs) f(m);diff --git a/packages/app/src/components/TerminalPanel.tsx b/packages/app/src/components/TerminalPanel.tsxindex 74eea7b3a..a10031666 100644--- a/packages/app/src/components/TerminalPanel.tsx+++ b/packages/app/src/components/TerminalPanel.tsx@@ -135,17 +135,20 @@ function TerminalSession({term.open(container);- try {- const webgl = new WebglAddon();- webgl.onContextLoss(() => {- console.warn('[terminal] WebGL context lost, falling back to DOM renderer');- webgl.dispose();- });- term.loadAddon(webgl);- } catch (err) {- const expected = err instanceof Error && /webgl2?|context/i.test(err.message);- const log = expected ? console.warn : console.error;- log('[terminal] WebGL addon failed, using DOM renderer:', err);+ const useDomRenderer = bridge.config.e2eSmoke === true;+ if (!useDomRenderer) {+ try {+ const webgl = new WebglAddon();+ webgl.onContextLoss(() => {+ console.warn('[terminal] WebGL context lost, falling back to DOM renderer');+ webgl.dispose();+ });+ term.loadAddon(webgl);+ } catch (err) {+ const expected = err instanceof Error && /webgl2?|context/i.test(err.message);+ const log = expected ? console.warn : console.error;+ log('[terminal] WebGL addon failed, using DOM renderer:', err);+ }}fit.fit();diff --git a/packages/app/src/lib/desktop-bridge-types.ts b/packages/app/src/lib/desktop-bridge-types.tsindex 7941e30ec..5f1edadd8 100644--- a/packages/app/src/lib/desktop-bridge-types.ts+++ b/packages/app/src/lib/desktop-bridge-types.ts@@ -116,6 +116,7 @@ export interface OkDesktopConfig {readonly projectPath: string;readonly projectName: string;readonly mode: OkDesktopMode;+ readonly e2eSmoke: boolean;readonly singleFile: boolean;readonly initialDoc: string | null;}diff --git a/packages/app/tests/stress/fixtures/handoff-mocks.ts b/packages/app/tests/stress/fixtures/handoff-mocks.tsindex 23b13c955..b29e47ebe 100644--- a/packages/app/tests/stress/fixtures/handoff-mocks.ts+++ b/packages/app/tests/stress/fixtures/handoff-mocks.ts@@ -209,6 +209,7 @@ export async function installHandoffMocks(page: Page, cfg: HandoffMockConfig): PprojectPath: workerContentDir,projectName: 'handoff-e2e-fixture',mode: 'editor' as const,+ e2eSmoke: false,singleFile: false,initialDoc: null,},diff --git a/packages/desktop/playwright.config.ts b/packages/desktop/playwright.config.tsindex 352dfb43a..134a826b3 100644--- a/packages/desktop/playwright.config.ts+++ b/packages/desktop/playwright.config.ts@@ -10,7 +10,11 @@ export default defineConfig({globalSetup: './tests/smoke/_helpers/stale-build-guard.ts',workers: 1,fullyParallel: false,- reporter: [['list'], ['html', { open: 'never' }]],+ reporter: [+ ['list'],+ ['html', { open: 'never' }],+ ['json', { outputFile: 'test-results/desktop-smoke-results.json' }],+ ],use: {trace: 'retain-on-failure',},diff --git a/packages/desktop/src/main/index.ts b/packages/desktop/src/main/index.tsindex a6dc87ec6..d2367bbbc 100644--- a/packages/desktop/src/main/index.ts+++ b/packages/desktop/src/main/index.ts@@ -487,7 +487,10 @@ function runDriverBootSmokeInProduction(): void {}function withDebugFlagIfAllowed(args: readonly string[]): string[] {- return isDebugKeyringSmokeAllowed() ? [...args, '--ok-debug-keyring-smoke=1'] : [...args];+ const withDebug = isDebugKeyringSmokeAllowed()+ ? [...args, '--ok-debug-keyring-smoke=1']+ : [...args];+ return process.env.OK_DESKTOP_E2E_SMOKE === '1' ? [...withDebug, '--ok-e2e-smoke=1'] : withDebug;}function ensureDebugIpc(): DebugIpcHandle {@@ -1932,6 +1935,7 @@ function registerIpcHandlers() {projectPath: ctx.projectPath,projectName: ctx.projectName,mode: 'editor' as const,+ e2eSmoke: process.env.OK_DESKTOP_E2E_SMOKE === '1',singleFile: ctx.ephemeral !== undefined,initialDoc: null,};diff --git a/packages/desktop/src/preload/index.ts b/packages/desktop/src/preload/index.tsindex 0dfe992b6..cfd2309dc 100644--- a/packages/desktop/src/preload/index.ts+++ b/packages/desktop/src/preload/index.ts@@ -156,12 +156,14 @@ function readConfigFromArgv(): OkDesktopConfig {const mode: OkDesktopConfig['mode'] = modeRaw === 'navigator' ? 'navigator' : 'editor';const singleFile = parseArg('single-file') === '1';const initialDoc = parseArg('initial-doc') ?? null;+ const e2eSmoke = parseArg('e2e-smoke') === '1';return Object.freeze({collabUrl,apiOrigin,projectPath,projectName,mode,+ e2eSmoke,singleFile,initialDoc,});diff --git a/packages/desktop/src/shared/bridge-contract.ts b/packages/desktop/src/shared/bridge-contract.tsindex 18db73879..3e5d25de3 100644--- a/packages/desktop/src/shared/bridge-contract.ts+++ b/packages/desktop/src/shared/bridge-contract.ts@@ -78,6 +78,7 @@ export interface OkDesktopConfig {readonly projectPath: string;readonly projectName: string;readonly mode: OkDesktopMode;+ readonly e2eSmoke: boolean;readonly singleFile: boolean;readonly initialDoc: string | null;}diff --git a/packages/desktop/tests/smoke/terminal-dock.e2e.ts b/packages/desktop/tests/smoke/terminal-dock.e2e.tsindex f06fe95fc..b4bdcd71f 100644--- a/packages/desktop/tests/smoke/terminal-dock.e2e.ts+++ b/packages/desktop/tests/smoke/terminal-dock.e2e.ts@@ -26,6 +26,9 @@ const DESKTOP_PRODUCT_NAME = '@inkeep/open-knowledge-desktop';interface SeedOpts {consent?: boolean;+ /** Explicitly opt out — seed .ok/local/config.yml terminal.enabled: false (the+ * one state that refuses the shell under the default-on/opt-out model). */+ optOut?: boolean;claudeJson?: Record<string, unknown> | null;fakeClaudeOnPath?: boolean;}@@ -45,9 +48,13 @@ function seed(prefix: string, opts: SeedOpts = {}): Seed {writeFileSync(join(projectDir, '.ok', 'config.yml'), "content:\n dir: '.'\n");writeFileSync(join(projectDir, 'start.md'), '# Start\n\nSeed document.\n');- if (opts.consent) {+ if (opts.consent || opts.optOut) {mkdirSync(join(projectDir, '.ok', 'local'), { recursive: true });- writeFileSync(join(projectDir, '.ok', 'local', 'config.yml'), 'terminal:\n enabled: true\n');+ const enabled = opts.optOut ? 'false' : 'true';+ writeFileSync(+ join(projectDir, '.ok', 'local', 'config.yml'),+ `terminal:\n enabled: ${enabled}\n`,+ );}if (opts.claudeJson !== undefined && opts.claudeJson !== null) {@@ -150,6 +157,7 @@ async function viewTerminalLabel(app: ElectronApplication): Promise<string | nulconst terminalSection = (page: Page) => page.locator('section[aria-label="Terminal"]');const terminalStatus = (page: Page) => page.locator('[data-terminal-status]');+const readinessBanner = (page: Page) => page.getByTestId('terminal-readiness-banner');async function openTerminal(app: ElectronApplication, page: Page): Promise<void> {await clickViewTerminalItem(app);@@ -188,7 +196,7 @@ test.describe('Docked terminal — live Electron', () => {test.skip(!BUILD_EXISTS, `Main build missing at ${MAIN_ENTRY} — run "bun run build:desktop".`);test.skip(IS_CI,- 'Temporarily disabled on CI (panel does not mount on the CI Electron runner); runs in local dev. See file header.',+ 'Quarantined on CI: terminal-dock degrades on the constrained runner — see inkeep/agents-private#2187.',);test.afterEach(() => {@@ -199,76 +207,54 @@ test.describe('Docked terminal — live Electron', () => {}});- test('QA-004 first open shows consent dialog with verbatim copy', async ({+ test('QA-004 first open mounts the live panel (no consent dialog)', async ({captureStderrFor,}) => {- const s = seed('consent-copy');+ const s = seed('default-on'); // terminal.enabled absent => default-ontrack(s.tmpHome, s.projectDir);const app = await launchApp(s, { restrictPath: true });captureStderrFor(app, { cleanupDirs: [s.tmpHome, s.projectDir] });const page = await findEditorWindow(app);await openTerminal(app, page);-- const dialog = page.getByRole('dialog');- await expect(dialog).toBeVisible({ timeout: 15_000 });- await expect(dialog).toContainText('Enable a terminal for this project?');- await expect(dialog).toContainText(- 'This runs a real terminal inside OpenKnowledge — the same as opening Terminal on your Mac',- );- await expect(dialog).toContainText(- 'Commands you run have the full access of your macOS user account',- );- await expect(dialog).toContainText(- 'OpenKnowledge doesn’t limit or sandbox what the terminal can do.',- );- await expect(dialog).toContainText('never included when you sync, clone, or share the project');- await expect(page.getByRole('button', { name: 'Enable terminal' })).toBeVisible();- await expect(page.getByRole('button', { name: 'Not now' })).toBeVisible();+ await waitForStatus(page, 'running', 25_000);+ await expect(page.getByRole('dialog')).toHaveCount(0);});- test('QA-005 consent accept persists enabled=true and spawns the shell', async ({+ test('QA-005 default-on spawns without writing terminal.enabled', async ({captureStderrFor,}) => {- const s = seed('consent-accept');+ const s = seed('default-on-no-write');track(s.tmpHome, s.projectDir);const app = await launchApp(s, { restrictPath: true });captureStderrFor(app, { cleanupDirs: [s.tmpHome, s.projectDir] });const page = await findEditorWindow(app);await openTerminal(app, page);-- await page.getByRole('button', { name: 'Enable terminal' }).click();await waitForStatus(page, 'running', 25_000);const localCfg = join(s.projectDir, '.ok', 'local', 'config.yml');- await expect- .poll(() => (existsSync(localCfg) ? readFileSync(localCfg, 'utf8') : ''), { timeout: 10_000 })- .toMatch(/terminal:\s*[\s\S]*enabled:\s*true/);-- await clickViewTerminalItem(app); // hide- await expect(terminalSection(page))- .toBeHidden({ timeout: 10_000 })- .catch(() => {});- await clickViewTerminalItem(app); // reopen- await expect(terminalSection(page)).toBeVisible({ timeout: 10_000 });- await expect(page.getByRole('dialog')).toHaveCount(0, { timeout: 5_000 });+ const persisted = existsSync(localCfg) ? readFileSync(localCfg, 'utf8') : '';+ expect(persisted).not.toMatch(/enabled:\s*true/);});- test('QA-006 consent decline shows not-enabled, no shell spawns', async ({+ test('QA-006 opted-out shows not-enabled notice; Enable re-enables the shell', async ({captureStderrFor,}) => {- const s = seed('consent-decline');+ const s = seed('opt-out', { optOut: true });track(s.tmpHome, s.projectDir);const app = await launchApp(s, { restrictPath: true });captureStderrFor(app, { cleanupDirs: [s.tmpHome, s.projectDir] });const page = await findEditorWindow(app);- await openTerminal(app, page);- await page.getByRole('button', { name: 'Not now' }).click();- await expect(page.getByRole('button', { name: 'Enable terminal' })).toBeVisible({- timeout: 10_000,+ await clickViewTerminalItem(app);+ await expect(page.getByRole('region', { name: 'Terminal disabled' })).toBeVisible({+ timeout: 15_000,});+ await expect(page.getByRole('button', { name: 'Enable terminal' })).toBeVisible();await expect(terminalStatus(page)).toHaveCount(0);- expect(existsSync(join(s.projectDir, '.ok', 'local', 'config.yml'))).toBe(false);++ await page.getByRole('button', { name: 'Enable terminal' }).click();+ await expect(terminalSection(page)).toBeVisible({ timeout: 15_000 });+ await waitForStatus(page, 'running', 25_000);});test('QA-002 View-menu Terminal item toggles the panel and flips label', async ({@@ -453,7 +439,7 @@ test.describe('Docked terminal — live Electron', () => {await expect(page.getByRole('alert')).toBeVisible({ timeout: 5_000 });const restart = page.getByRole('button', { name: /Restart terminal/i });await expect(restart).toBeVisible();- await expect(page.getByRole('status')).toHaveCount(0);+ await expect(readinessBanner(page)).toHaveCount(0);await restart.click();await waitForStatus(page, 'running', 25_000);@@ -470,9 +456,9 @@ test.describe('Docked terminal — live Electron', () => {await openTerminal(app, page);await waitForStatus(page, 'running', 25_000);- const banner = page.getByRole('status');+ const banner = readinessBanner(page);await expect(banner).toBeVisible({ timeout: 15_000 });- await expect(banner).toContainText('isn’t installed or on your PATH');+ await expect(banner).toContainText('installed or on your PATH');await expect(page.getByRole('button', { name: 'Get Claude Code' })).toBeVisible();});@@ -491,9 +477,9 @@ test.describe('Docked terminal — live Electron', () => {await openTerminal(app, page);await waitForStatus(page, 'running', 25_000);- const banner = page.getByRole('status');+ const banner = readinessBanner(page);await expect(banner).toBeVisible({ timeout: 15_000 });- await expect(banner).toContainText('OpenKnowledge tools aren’t connected');+ await expect(banner).toContainText('OpenKnowledge tools');await expect(page.getByRole('button', { name: 'Connect tools' })).toBeVisible();});});