Files
apes-sidebar/tests/e2e/host.ts
T
Menghuan1918 51546f7433 feat(native): render the plugin's tabs in DSH's native right Sidebar
Phase 2 of the 0.1.5 adaptation: the plugin stops drawing its own right
panel and contributes tab TYPES to DSH's native right Sidebar, which owns
the right column. The bottom workbench (terminal dock) stays plugin-owned.

Registrations (src/client/native/):
- every TabDescriptor becomes a native tab type (kind = descriptor.id, the
  default `extension` band) plus a keyed body in `sidebar.right.pane.tab`
  and a live chip title in `sidebar.right.pane.tab.title`
- the `editor` type also claims `dsh-resource://file/**`, so it outranks
  the built-in `text` preview (fallback) and every file the product opens
  lands in the plugin's editor
- the built-in `files` page kind is TAKEN OVER by an extension
  registration of the same kind: `openTab('files')` draws the plugin's
  explorer, and the built-in resumes when the plugin unregisters
- registrations follow the plugin registry + the side-card settings: a
  type registered later (external plugin) gets its native type too, a
  disabled type is unregistered (absent from the guide, refuses opens)

Adapter (src/client/native/tab-adapter.tsx):
- one synthetic plugin `SidebarTab` per native tab id, minted from the
  native record + navigation params (or the descriptor's own createTab,
  which a native guide open bypasses), kept live across navigations and
  updateTab writes
- the explorer's per-tab expansion/reveal sets and the per-kind instance
  counter, which the plugin's own layout used to hold

Service routing (src/client/service.ts):
- `setSurface` installs the native write face; openTab/openFile land
  natively (a path becomes a resource address, a path-less editor open
  becomes the `files` page, the rest carry the seed as navigation params),
  closeTab/updateTab/activateTab recognise native tab ids
- new optional `OpenTabSeed.target` ('right' default, 'bottom' keeps the
  bottom workbench); the bottom panel's own + menu and auto-terminal pass
  'bottom'
- src/client/native/surface.ts probes the controller's per-session writes
  (`openTabIn`/`openResourceIn`/`closeIn`, not in `ISidebarRight`) and
  queues opens for a session whose surface is not mounted yet

Right panel retired behaviourally (Phase 3 deletes the code): Sidebar
renders its bottom workbench only, keeps the panel collapsed, and hides
the right-panel toggle. The panel-specific e2e specs are removed; the
mount lane now drives the native guide (tab sweep), the plugin explorer
inside the native pane (editor/mermaid/README chunks) and the sidechat
host routes.

Verified: pnpm typecheck / lint / build / test (126 files, 1349 tests) /
check:consumer-types, plus pnpm test:mount against a real
@deepseek-ai/dsh@0.1.5-alpha.1 host (7/7).
2026-09-09 11:47:31 +08:00

156 lines
6.4 KiB
TypeScript

/**
* Host glue for the e2e lanes: page/asset URL construction, the authenticated
* request context, and the host RPC. The transport contracts (one-time-token
* launch URL, slash `/api` endpoints) live in ./host-protocol.ts; this
* module only wires them to Playwright.
*
* Every lane consumes the same contract:
* - `PAGE_URL` / `pageUrl({...})` for page.goto (the token URL performs the
* browser's token→cookie exchange),
* - `sidebarApi(path)` for the plugin's own public routes,
* - `createHostApi()` for an APIRequestContext carrying the auth cookie,
* - `hostRpc(api, 'workspace.create', {...})` for the host's unary RPC.
*/
import { expect, request, type APIRequestContext, type Page } from '@playwright/test'
import { parseLaunchUrl, pageUrlWith, rpcAttempt } from './host-protocol'
const envUrl = process.env.DSH_E2E_URL
if (!envUrl) {
throw new Error('DSH_E2E_URL is not set — boot a DSH web instance with the plugin mounted and point this lane at it (see scripts/e2e-mount.sh)')
}
// Re-bind with an explicit string type: closure bodies below do not inherit
// the guard's narrowing of envUrl.
const RAW_URL: string = envUrl
const LAUNCH = parseLaunchUrl(RAW_URL)
/** Origin for URL construction (a token URL would corrupt path joins). */
export const ORIGIN = LAUNCH.origin
/** page.goto target: the launch URL as printed (token included —
* navigating it exchanges the token for the cookie). */
export const PAGE_URL = LAUNCH.pageUrl
/** page.goto target with extra query stamps merged (token preserved). */
export function pageUrl(extra: Record<string, string>): string {
return pageUrlWith(RAW_URL, extra)
}
/** Absolute URL for the plugin's own (public, unauthenticated) API route. */
export function sidebarApi(path: string): string {
return `${ORIGIN}/sidebar/api/${path}`
}
/** Exchange the one-time launch token for the auth-cookie header pair: the
* token URL answers 303 with Set-Cookie (following the redirect would lose
* it, hence `redirect: 'manual'`). Pure aside from the injected fetch —
* unit tests stub it (tests/e2e-host-protocol.spec.ts). */
export async function exchangeLaunchCookie(
launchUrl: string,
fetchImpl: typeof fetch = fetch,
): Promise<string> {
const res = await fetchImpl(launchUrl, { redirect: 'manual' })
const setCookie = res.headers.get('set-cookie')
if (setCookie === null) {
throw new Error(`token exchange failed: HTTP ${res.status} carried no set-cookie — cannot authenticate /api seeding`)
}
return setCookie.split(';', 1)[0] ?? ''
}
/** The `name=value` pair of the auth cookie, once per process. */
let cookieHeader: string | undefined
/** page.goto through the host auth. A plain navigation goes to PAGE_URL (the
* token URL performs the browser's exchange), but a STAMPED navigation
* cannot: the exchange answers `303 → /` and silently DROPS every sibling
* query param (the mount lane caught the desktop-shell stamps vanishing
* this way), so pre-seed the browser context with the exchanged cookie and
* navigate the stamped URL directly. Playwright gives every test a fresh
* context, so the seeding is per-call and idempotent. */
export async function gotoPage(page: Page, extra: Record<string, string> = {}): Promise<void> {
if (Object.keys(extra).length > 0) {
if (cookieHeader === undefined) cookieHeader = await exchangeLaunchCookie(RAW_URL)
const eq = cookieHeader.indexOf('=')
await page.context().addCookies([{
name: cookieHeader.slice(0, eq),
value: cookieHeader.slice(eq + 1),
url: ORIGIN,
}])
await page.goto(pageUrlWith(ORIGIN, extra), { waitUntil: 'domcontentloaded' })
return
}
await page.goto(pageUrl(extra), { waitUntil: 'domcontentloaded' })
}
/** Authenticated request context for host RPC seeding (cookie attached). */
export async function createHostApi(): Promise<APIRequestContext> {
if (cookieHeader === undefined) {
cookieHeader = await exchangeLaunchCookie(RAW_URL)
}
return request.newContext({
baseURL: ORIGIN,
extraHTTPHeaders: { cookie: cookieHeader },
})
}
/** The unwrapped `result` of a successful host RPC. */
export interface HostRpcOk<T> {
ok: true
value: T
}
let rpcCounter = 0
/** Call a host unary RPC (`'workspace.create'`, `'session.create'`, …).
* Throws with the response body when the HTTP call or the envelope result
* fails — the lanes' seeding treats any failure as fatal, so the error text
* carries everything a report needs. */
export async function hostRpc<T = unknown>(
api: APIRequestContext,
method: string,
args: Record<string, unknown> = {},
): Promise<HostRpcOk<T>> {
const attempt = rpcAttempt(method, args)
rpcCounter += 1
const rpcId = `e2e-${method}-${rpcCounter}`
const res = await api.post(attempt.path, {
data: { type: 'client-request', rpcId, method: attempt.method, payload: attempt.payload },
})
const bodyText = await res.text()
if (!res.ok()) {
throw new Error(`hostRpc ${method} [${attempt.path}] HTTP ${res.status()}: ${bodyText.slice(0, 400)}`)
}
let envelope: { type?: string; result?: { ok: true; value: T } | { ok: false; error: unknown } }
try {
envelope = JSON.parse(bodyText) as typeof envelope
} catch {
throw new Error(`hostRpc ${method} [${attempt.path}]: non-JSON response: ${bodyText.slice(0, 400)}`)
}
const result = envelope.result
if (result === undefined || result.ok !== true) {
throw new Error(`hostRpc ${method} [${attempt.path}] envelope error: ${bodyText.slice(0, 400)}`)
}
return result
}
/**
* Send one message in the session the shell opened, so the conversation header
* (and the native right Sidebar's corner control) exists: DSH renders the
* header only for a session with content, while a freshly seeded blank
* session shows the empty hero.
*
* DSH 0.1.5's composer is a Lexical contenteditable — `fill()` writes the DOM
* but not the editor model, so the send button would stay disabled. Type real
* keys instead.
* @param page - the lane's page.
*/
export async function sendFirstMessage(page: Page): Promise<void> {
const composer = page.getByRole('textbox', { name: /^(Describe what you want to build|描述你想要构建)/ })
await expect(composer).toBeVisible({ timeout: 60_000 })
await composer.click()
await page.keyboard.type('mount lane smoke')
const send = page.getByRole('button', { name: /^(Send message|发送消息)$/ })
await expect(send).toBeEnabled({ timeout: 30_000 })
await send.click()
}