jupyterlab-codex-sidebar 0.1.4 → 0.1.6

package/tests/e2e/cell-output-error-tail.spec.js

@@ -0,0 +1,156 @@
+const fs = require('fs');
+const path = require('path');
+const { test, expect } = require('@playwright/test');
+
+const NOTEBOOK_RELATIVE_PATH = 'tests/e2e/fixtures/notebooks/error-output-tail.ipynb';
+const NOTEBOOK_NAME = 'error-output-tail.ipynb';
+const NOTEBOOK_PY_PATH = path.resolve(__dirname, 'fixtures/notebooks/error-output-tail.py');
+const NOTEBOOK_IPYNB_PATH = path.resolve(__dirname, 'fixtures/notebooks/error-output-tail.ipynb');
+const TRACE_HEAD_MARKER = 'TRACE_HEAD_MARKER_ABCDEFGHIJ';
+const TRACE_TAIL_MARKER = 'TRACE_TAIL_MARKER_ZYXWVUTSRQ';
+
+function buildInitialNotebookUrl(baseLabUrl, notebookPath) {
+  const parsed = new URL(baseLabUrl);
+  const basePath = parsed.pathname.replace(/\/$/, '');
+  parsed.pathname = `${basePath}/tree/${notebookPath}`;
+  parsed.searchParams.set('reset', '1');
+  return parsed.toString();
+}
+
+async function dismissBlockingDialogs(page) {
+  for (let attempt = 0; attempt < 8; attempt += 1) {
+    const dialog = page.locator('dialog.jp-Dialog, [role="dialog"].jp-Dialog, [role="dialog"]').first();
+    if (!(await dialog.count()) || !(await dialog.isVisible())) {
+      return;
+    }
+
+    const noKernelButton = page.getByRole('button', { name: /^No Kernel$/ }).first();
+    if ((await noKernelButton.count()) > 0 && (await noKernelButton.isVisible())) {
+      await noKernelButton.click();
+      await page.waitForTimeout(150);
+      continue;
+    }
+
+    await page.keyboard.press('Escape');
+    await page.waitForTimeout(150);
+  }
+}
+
+async function ensureCodexPanel(page) {
+  await dismissBlockingDialogs(page);
+  const composer = page.locator('.jp-CodexPanel .jp-CodexComposer textarea');
+  if ((await composer.count()) > 0 && (await composer.first().isVisible())) {
+    return;
+  }
+
+  const codexSideTab = page
+    .locator('.jp-SideBar.jp-mod-right .lm-TabBar-tab[title="Codex"], .jp-SideBar.jp-mod-right .lm-TabBar-tab')
+    .filter({ hasText: 'Codex' })
+    .first();
+  await expect(codexSideTab).toBeVisible({ timeout: 20000 });
+  await codexSideTab.click();
+  await expect(composer.first()).toBeVisible({ timeout: 20000 });
+}
+
+function writeNotebookFixture() {
+  const traceback = [
+    'Traceback (most recent call last):',
+    `  ${TRACE_HEAD_MARKER}`,
+    `${'A'.repeat(22000)}`,
+    `ValueError: ${TRACE_TAIL_MARKER}`
+  ];
+  const notebook = {
+    cells: [
+      {
+        cell_type: 'code',
+        execution_count: 1,
+        id: 'error-output-tail-cell',
+        metadata: {},
+        outputs: [
+          {
+            output_type: 'error',
+            ename: 'ValueError',
+            evalue: TRACE_TAIL_MARKER,
+            traceback
+          }
+        ],
+        source: ['raise ValueError("synthetic traceback for tail truncation test")\n']
+      }
+    ],
+    metadata: {
+      jupytext: {
+        formats: 'ipynb,py:percent'
+      },
+      kernelspec: {
+        display_name: 'Python 3 (ipykernel)',
+        language: 'python',
+        name: 'python3'
+      },
+      language_info: {
+        codemirror_mode: {
+          name: 'ipython',
+          version: 3
+        },
+        file_extension: '.py',
+        mimetype: 'text/x-python',
+        name: 'python',
+        nbconvert_exporter: 'python',
+        pygments_lexer: 'ipython3',
+        version: '3.13.9'
+      }
+    },
+    nbformat: 4,
+    nbformat_minor: 5
+  };
+
+  fs.writeFileSync(NOTEBOOK_IPYNB_PATH, `${JSON.stringify(notebook, null, 2)}\n`, 'utf8');
+  fs.writeFileSync(
+    NOTEBOOK_PY_PATH,
+    [
+      '# %%',
+      'raise ValueError("synthetic traceback for tail truncation test")',
+      ''
+    ].join('\n'),
+    'utf8'
+  );
+}
+
+test('error cell output sends the tail of the traceback to Codex', async ({ page, baseURL }) => {
+  writeNotebookFixture();
+  const codexCommandPath =
+    process.env.PLAYWRIGHT_CODEX_COMMAND || path.resolve(__dirname, 'mock-codex-cli-prompt-echo.py');
+  const targetUrl = baseURL || process.env.JUPYTERLAB_URL || 'http://127.0.0.1:8888/lab';
+
+  await page.addInitScript(commandPath => {
+    window.localStorage.setItem('jupyterlab-codex:command-path', commandPath);
+    window.localStorage.setItem('jupyterlab-codex:include-active-cell', 'true');
+    window.localStorage.setItem('jupyterlab-codex:include-active-cell-output', 'true');
+  }, codexCommandPath);
+
+  await page.goto(buildInitialNotebookUrl(targetUrl, NOTEBOOK_RELATIVE_PATH), { waitUntil: 'domcontentloaded' });
+  await page.waitForSelector('main[aria-label="Main Content"], .jp-LabShell, .lm-DockPanel', {
+    timeout: 30000
+  });
+  await dismissBlockingDialogs(page);
+  await ensureCodexPanel(page);
+
+  const notebookCell = page.locator('.jp-Notebook .jp-Cell').first();
+  await expect(notebookCell).toBeVisible({ timeout: 20000 });
+  await notebookCell.click();
+
+  const composer = page.locator('.jp-CodexComposer textarea');
+  const sendBtn = page.locator('.jp-CodexSendBtn');
+  await composer.fill('Inspect the attached output.');
+  await expect(sendBtn).toBeEnabled({ timeout: 15000 });
+  await sendBtn.click();
+  await expect(page.locator('.jp-CodexSendBtn.is-stop')).toHaveCount(0, { timeout: 30000 });
+
+  const assistantMessage = page.locator('.jp-CodexChat-message.jp-mod-assistant').last();
+  await expect(assistantMessage).toContainText('PROMPT_TAIL_START', { timeout: 30000 });
+  const responseText = await assistantMessage.innerText();
+
+  const tailSection = responseText.split('PROMPT_TAIL_START\n')[1]?.split('\nPROMPT_TAIL_END')[0] || '';
+  expect(tailSection).toContain(TRACE_TAIL_MARKER);
+  expect(tailSection).not.toContain(TRACE_HEAD_MARKER);
+  expect(responseText).toContain('Current Cell Output:');
+});

package/tests/e2e/codex-ui-test-helpers.js

@@ -0,0 +1,138 @@
+const path = require('node:path');
+
+function buildNotebookUrl(baseLabUrl, notebookPath) {
+  const parsed = new URL(baseLabUrl);
+  const basePath = parsed.pathname.replace(/\/$/, '');
+  parsed.pathname = `${basePath}/tree/${notebookPath}`;
+  parsed.searchParams.set('reset', '1');
+  return parsed.toString();
+}
+
+function escapeRegExp(value) {
+  return String(value).replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
+async function dismissBlockingDialogs(page) {
+  for (let attempt = 0; attempt < 12; attempt += 1) {
+    const dialog = page.locator('dialog.jp-Dialog, [role="dialog"].jp-Dialog, [role="dialog"]').first();
+    if (!(await dialog.count()) || !(await dialog.isVisible())) {
+      return;
+    }
+
+    const noKernelButton = page.getByRole('button', { name: /^No Kernel$/ }).first();
+    if ((await noKernelButton.count()) > 0 && (await noKernelButton.isVisible())) {
+      await noKernelButton.click();
+      await page.waitForTimeout(120);
+      continue;
+    }
+
+    const selectKernelButton = page.getByRole('button', { name: /^Select$/ }).first();
+    if ((await selectKernelButton.count()) > 0 && (await selectKernelButton.isVisible())) {
+      await selectKernelButton.click();
+      await page.waitForTimeout(120);
+      continue;
+    }
+
+    const cancelButton = page.getByRole('button', { name: /^Cancel$/ }).first();
+    if ((await cancelButton.count()) > 0 && (await cancelButton.isVisible())) {
+      await cancelButton.click();
+      await page.waitForTimeout(120);
+      continue;
+    }
+
+    await page.keyboard.press('Escape');
+    await page.waitForTimeout(120);
+  }
+}
+
+async function ensureFileBrowserVisible(page) {
+  await dismissBlockingDialogs(page);
+  const fileBrowserTab = page.getByRole('tab', { name: /File Browser/i }).first();
+  if (await fileBrowserTab.count()) {
+    const isActiveBefore = await fileBrowserTab.evaluate(
+      element =>
+        element.getAttribute('aria-selected') === 'true' ||
+        (typeof element.className === 'string' && element.className.includes('lm-mod-current'))
+    );
+    if (!isActiveBefore) {
+      await fileBrowserTab.click();
+    }
+    const isActiveAfter = await fileBrowserTab.evaluate(
+      element =>
+        element.getAttribute('aria-selected') === 'true' ||
+        (typeof element.className === 'string' && element.className.includes('lm-mod-current'))
+    );
+    if (!isActiveAfter) {
+      await fileBrowserTab.click();
+    }
+  }
+  await page.getByRole('list', { name: /files/i }).first().waitFor({ state: 'visible', timeout: 10000 }).catch(() => {});
+}
+
+async function openDocumentFromFileBrowser(page, documentName) {
+  await ensureFileBrowserVisible(page);
+  let item = page
+    .getByRole('listitem', { name: new RegExp(`\\b${escapeRegExp(documentName)}\\b`, 'i') })
+    .first();
+  if (!(await item.count())) {
+    item = page.locator('.jp-DirListing-item', { hasText: documentName }).first();
+  }
+  if (!(await item.count())) {
+    item = page.locator('.jp-FileBrowser').getByText(documentName, { exact: true }).first();
+  }
+  await item.first().waitFor({ state: 'visible', timeout: 20000 });
+  await item.first().dblclick();
+  await dismissBlockingDialogs(page);
+}
+
+async function activateDocumentTab(page, documentName) {
+  await dismissBlockingDialogs(page);
+  const exactTab = page
+    .getByRole('tab', { name: new RegExp(`^${escapeRegExp(documentName)}$`) })
+    .first();
+  await exactTab.click();
+}
+
+async function ensureCodexPanel(page) {
+  await dismissBlockingDialogs(page);
+  const composer = page.locator('.jp-CodexPanel .jp-CodexComposer textarea');
+  if ((await composer.count()) > 0 && (await composer.first().isVisible())) {
+    return;
+  }
+
+  const codexSideTab = page
+    .locator('.jp-SideBar.jp-mod-right .lm-TabBar-tab[title="Codex"], .jp-SideBar.jp-mod-right .lm-TabBar-tab')
+    .filter({ hasText: 'Codex' })
+    .first();
+  await codexSideTab.click();
+  await expect(composer.first()).toBeVisible({ timeout: 20000 });
+}
+
+async function openNotebookInCodex(page, baseURL, notebook) {
+  const commandPath = notebook.commandPath || path.resolve(__dirname, 'mock-codex-cli.py');
+  await page.addInitScript(cmd => {
+    window.localStorage.setItem('jupyterlab-codex:command-path', cmd);
+    if (!window.localStorage.getItem('jupyterlab-codex:model')) {
+      window.localStorage.removeItem('jupyterlab-codex:model');
+    }
+  }, commandPath);
+
+  const targetUrl = buildNotebookUrl(baseURL, notebook.path);
+  await page.goto(targetUrl, { waitUntil: 'domcontentloaded' });
+  await page.waitForSelector('main[aria-label="Main Content"], .jp-LabShell, .lm-DockPanel', { timeout: 30000 });
+  await dismissBlockingDialogs(page);
+  await ensureCodexPanel(page);
+
+  await openDocumentFromFileBrowser(page, notebook.name);
+  await activateDocumentTab(page, notebook.name);
+}
+
+module.exports = {
+  buildNotebookUrl,
+  dismissBlockingDialogs,
+  ensureFileBrowserVisible,
+  openDocumentFromFileBrowser,
+  activateDocumentTab,
+  ensureCodexPanel,
+  openNotebookInCodex
+};

package/tests/e2e/fixtures/notebooks/error-output-tail.ipynb

@@ -0,0 +1,58 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "error-output-tail-cell",
+   "metadata": {},
+   "outputs": [
+    {
+     "ename": "ValueError",
+     "evalue": "synthetic traceback for tail truncation test",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
+      "\u001b[0;31mValueError\u001b[0m                                Traceback (most recent call last)",
+      "Cell \u001b[0;32mIn[1], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[38;5;28;01mraise\u001b[39;00m \u001b[38;5;167;01mValueError\u001b[39;00m(\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124msynthetic traceback for tail truncation test\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n",
+      "\u001b[0;31mValueError\u001b[0m: synthetic traceback for tail truncation test"
+     ]
+    }
+   ],
+   "source": [
+    "raise ValueError(\"synthetic traceback for tail truncation test\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "05fa12e1-3ea7-4081-b658-7e2799c32d07",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "jupytext": {
+   "formats": "ipynb,py:percent"
+  },
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

package/tests/e2e/fixtures/notebooks/error-output-tail.py

@@ -0,0 +1,19 @@
+# ---
+# jupyter:
+#   jupytext:
+#     formats: ipynb,py:percent
+#     text_representation:
+#       extension: .py
+#       format_name: percent
+#       format_version: '1.3'
+#       jupytext_version: 1.17.1
+#   kernelspec:
+#     display_name: Python 3 (ipykernel)
+#     language: python
+#     name: python3
+# ---
+
+# %%
+raise ValueError("synthetic traceback for tail truncation test")
+
+# %%