mirror of
https://github.com/tester-army/e2e.git
synced 2026-11-21 03:05:26 +08:00
* feat(test): set fixtures up once per worker and pass them to beforeAll
test.extend() takes [fn, { scope: 'worker' }]: one instance per worker and
target, torn down when the worker ends. Suite hooks receive worker fixtures.
Engines can declare isolation: 'worker'; @e2e-dev/mobile does, so its device,
app, and screen reach beforeAll, afterAll, and worker fixtures.
Refs ENG-1297
* feat(e2e)!: set up fixtures on demand
A test now sets up only the test.extend() fixtures its body and its
beforeEach and afterEach hooks name in their first parameter, the fixtures
those name, and the auto ones. A suite hook sets up the worker fixtures it
names and the auto worker fixtures. Names are read from the function's
source, as Playwright and Vitest read them.
- [fn, { auto: true }] and [fn, { scope: 'worker', auto: true }] run a
fixture nothing names.
- A fixture can name the fixtures declared beside it in the same extend()
call. Fixtures run in declaration order, each after the ones it names.
- The attempt is resolved as one unit before the session launches: a
fixture only an afterEach names is set up before the first beforeEach.
An afterEach that names a fixture whose setup failed is skipped.
- Fixture rules fail as COLLECTION_ERROR with the file and line of the
code: a parameter that is not destructured or takes a rest property, and
a cycle, when the file is collected; a name the target lacks, a test
fixture named by a suite hook or a worker fixture, and a fixture named
like an engine's, at selection, for the pairs that run on that target.
- On an engine with isolation: 'worker', a suite hook or a worker fixture
teardown that names no engine-backed fixture opens no engine attempt.
BREAKING CHANGE: a fixture nothing names no longer runs unless it is
declared with auto: true, and a test body, hook, or fixture function that
takes the whole fixture object (async (fixtures) => {}) no longer loads.
Refs ENG-1297
* refactor(core): declare core fixtures in one table
The five core fixtures (agent, app, screen, platform, session) are one
table in @e2e-dev/core: name, scope, and factory. createFixtures builds
the built-ins object through one loop over that table and the engine's
factories, every fixture a lazy accessor behind the same gate as before.
The runner's fixture pool, test.extend() validation, and launch read the
names and scopes from the table, so the name lists and the per-name scope
checks are gone. A launch session exposes the core fixtures that do not
belong to a test: app, screen, platform.
No behaviour change. app and screen were built with the attempt and are
now built on first read, like agent and the engine's fixtures.
Refs ENG-1297
* feat(e2e): extend a built-in fixture through test.extend
A test.extend() fixture named like one the test already has extends it,
by Playwright's rule: inside its function its own name is the fixture it
extends (the built-in, or an earlier fixture of that name), and tests,
hooks, and other fixtures that name it receive what it hands to use().
base.extend({ device: async ({ device }, use) => {
await device.setPermission('camera', 'deny');
await use(device);
} })
- A plain function takes the scope the extended fixture has on the
target: device is a worker fixture on mobile, so its override runs once
per worker and reaches beforeAll; app is a test fixture on web and a
worker fixture on mobile. A declared scope that differs is a
COLLECTION_ERROR naming both.
- A worker-scoped override receives what a worker fixture receives for
that built-in, the forwarder to the attempt that is running.
- On a target without the built-in nothing fails until code that runs
there names it; then the target has no such fixture.
- Only user code sees the override: the attempt's own built-ins, which the
runner and the worker fixtures' forwarders read, are untouched.
- Types: the override keeps the extended fixture's type and scope, through
an extend() overload that takes overrides without type arguments.
A fixture named like a core fixture, an engine's, or an earlier one of the
chain was refused before.
Refs ENG-1297
* docs(fixtures): name built-in fixtures and give their scope per engine
The docs now use one term, built-in fixtures, for agent, app, screen,
platform, session, and the ones an engine contributes (browser, device),
where pages said core fixtures, contributed fixtures, or engine fixtures.
The test reference gets one table with each built-in fixture's scope on
web and on mobile, and says what the scope decides: a test fixture reaches
test bodies, beforeEach, and afterEach; a worker fixture also reaches
beforeAll, afterAll, and worker fixtures. The hooks, worker fixtures, and
override sections link to it, as do the fixtures guide and the engine
pages. The Japanese and Chinese pages carry the table and the same terms.
Refs ENG-1297
* docs(ja): translate the fixture scope and on-demand changes
* docs(zh): translate the fixture scope and on-demand changes
* fix(e2e): let a worker fixture name an extended app or screen
A fixture that extends `app` or `screen` was taken for a test fixture when
its test.extend() call was checked, before any target is known. A worker
fixture declared after it that names `app` then failed at import on every
target, though the same fixture is accepted without the override and the
plan resolves both to worker scope on an engine whose state outlives a
test.
The scope of a plain function is now unresolved until a target is known,
whatever it extends, as it already was for an engine's own fixtures.
Refs ENG-1297
* fix(e2e): fail a suite hook that left an engine step running
On an engine whose state outlives a test, a beforeAll or afterAll hook, or
a worker fixture's teardown, can start a device step and not await it. The
hook's attempt then closed under the step, and its failure arrived later
as a stray rejection charged to whichever test ran then.
The suite attempt now does what a test attempt does once its body settled:
the step is failed at its call and cancelled, its outcome is awaited within
the cleanup budget, and the hook fails with STEP_NOT_AWAITED (HOOK_FAILED
for a suite hook).
The suite attempt keeps no step records, and StepRecorder dropped the
record of the step it had just opened before marking it running, so there
was nothing to abandon: a step now counts as running before the retained
window is trimmed.
Refs ENG-1297
* refactor(e2e): keep the fixtures a function names beside it
Registration parsed each test body, hook, and fixture function for the
fixtures it names, dropped the result, and left it in a WeakMap that the
planner and the pool read back with placeholder subjects. A cache miss
there would have named the wrong code and no line.
The parse result is now data: `names` on the registered test, the hook,
and the fixture definition. The planner and the pool read it, the WeakMap
and the per-function wrappers are gone, and one describeUser() gives an
error its subject. The explore test, registered by hand, parses its body
where it builds the record.
Unit tests state the names instead of generating source text for them.
Refs ENG-1297
* refactor(core): resolve built-in fixtures in one place
The core table declared the core fixtures, but what a target's built-in
fixtures are was still assembled around it: core names plus engine names in
three files, the 'engine' scope resolved in e2e through a cast into the
table, `platform` hard-coded as the one fixture that needs no attempt, and
two structural copies of the target.
core now exports builtInFixtures(target): names, scope(name),
needsAttempt(name), attemptless(name), and the unknown-fixture message,
over one BuiltInTarget. `platform` declares in the table that the target
alone decides it. launch, the planner, and the pool read from it.
DECLARED_BUILT_INS is the same view before a target is known: a scope the
engine decides is 'unresolved'. The planner takes either one, so its
no-target mode and the `target === undefined` branches through scopeOf and
read are gone. The scope of a fixture that extends `app` before a target
is known is 'unresolved' by construction.
Refs ENG-1297
* refactor(e2e): hand each function the fixtures it names
Every test body, hook, and fixture function must destructure its first
parameter, so what it reads is known before it runs. bindFixtures still
built a Proxy-gated bag for arbitrary property reads: one value in three
stores, the gate run twice (once over a faked plan), a third derivation of
scope, and an own-name shadow that re-derived what the planner had resolved.
No test code could reach the gate's throwing branches; only unit tests did,
by reading the bag directly.
The plan now records, per function, what each name it reads resolved to: a
chain fixture or a built-in. The pool hands each function a plain object
with exactly those names, the value a chain fixture handed over, or a
built-in read off the attempt when the function destructures it, so
built-ins stay lazy. An override that names itself receives the fixture it
extends because that is what its own name resolved to.
- bound.call(user) replaces user.fn(bound.fixtures); ready(user) asks
whether every chain fixture it names was provided.
- attemptlessBuiltIns is a function from a name to a value that throws the
reason for a built-in that needs an attempt.
- The planner runs once: it records what each fixture names, and the order
is one declaration-order walk over that record. A second validating pass
only reordered.
Behaviour: a bound or native function, whose parameters cannot be read, is
a COLLECTION_ERROR; it used to parse as naming nothing and still got lazy
built-ins. The docs no longer promise hooks and the body one shared object.
Refs ENG-1297
* refactor(e2e): move the suite attempt out of TargetExecutor
dispose, openSuiteHooks, and openSuiteAttempt were 177 lines of a second
attempt lifecycle inside TargetExecutor, written as closures in one method.
run/suite-attempt.ts now owns it: a SuiteAttempt class with open, acquire,
within, and close, over a SuiteAttemptHost interface the executor satisfies
(the way serial.ts borrows it through SerialHost), plus the worker
fixtures' teardown pass. It is the realm's SuiteHookSession itself, so the
executor keeps a context object and two call sites.
The three branches that built an attemptless reader with a "not available
to the <label>" error are one NoAttempt value ('isolated', 'unnamed',
'interrupted', or the launch failure) and one mapper to the message.
execute.ts: 1244 lines to 1052.
Refs ENG-1297
* refactor(e2e): share the attempt's fixture sequence
A run's attempt and an `e2e mcp` session's test each planned the test's
fixtures, bound them, entered the worker pool, set them up, ran the
beforeEach hooks and the body, filtered the afterEach hooks that can still
run, and labelled the teardowns. This PR widened that copy, and
standalone-test.ts asked the realm for the same hooks four times.
planAttemptFixtures(target, test, hooks) plans before any session exists
and returns open(), which binds the plan to the attempt: enter(), run()
for setup, hooks, and body, and cleanup() for the labelled afterEach hooks
and teardowns. Both call sites keep their own phases, budgets, and error
handling around it.
execute.ts: 1052 lines to 1031, its size on main.
Refs ENG-1297
* refactor(e2e): open the suite-hook pass without a lazy thunk
withSuiteHooks handed its work a thunk that opened the pass on first use.
Opening one does no I/O: the suite attempt launches nothing until a hook
that names an engine fixture runs. The pass is now opened up front and
closed in finally, and the `opened` slot and the `hooks()` call form go.
Refs ENG-1297
* refactor(e2e): ask the registry which hooks apply to a test
The selection-time fixture check rebuilt the scope chain of a test and
filtered the file's hooks by it, which the realm already did its own way.
registry.ts now exports scopeChain(test) and hooksFor(registration, test),
and both use them.
Refs ENG-1297
* refactor(core): move the fixture types into types/fixtures.ts
types.ts grew from 1679 to 1798 lines in this PR. The fixture scope, the
worker fixtures, and what test.extend() takes (definitions and overrides)
are one coherent group that nothing else in the file defines against, so
they move to types/fixtures.ts and types.ts re-exports them. The public
surface is the same.
types.ts: 1798 lines to 1715.
Refs ENG-1297
* refactor(core): drop the redundant override branch in FixtureDefinitions
A fixture that extends one the base already has was typed three ways: a
conditional branch inside the `Extra` map of FixtureDefinitions, the
`& FixtureOverrides` intersection, and the extend(overrides) overload.
Compiling the type tests without each in turn: the intersection types an
override written beside new fixtures with type arguments, and the overload
types an override-only call without them; both fail the tests when
removed. The conditional branch does not: with it gone the tests pass, and
a base name in `Extra` is `never` again, as it was before overrides. It is
removed, and the reference's copy of the declaration follows.
Refs ENG-1297
* refactor(e2e): split fixture errors from the parser, share hookLog
fixture-names.ts parses a parameter list, and also held FixtureUseError and
declarationSite, which format an error. They move to fixture-errors.ts.
Its identifier pattern held two raw zero-width characters; they are
written as escapes now.
hookLog and LOG_MODULE were pasted into three integration tests; they are
one helper in tests/helpers/hook-log.ts.
Refs ENG-1297
* docs(e2e): name the scope rule in the selection check's summary
The summary of assertFixtureUse still listed a chain fixture named like an
engine's as an error. Such a fixture extends the built-in now; the rule
left is a declared scope that differs from the extended fixture's.
Refs ENG-1297
* refactor(e2e): take execute.ts under 1000 lines
Two more pieces that are not the attempt's own sequence leave the file.
- Holding steps for `e2e run --step`: reading the screen a hold starts on
and wiring AttemptHolds to the runner's hook move to step-hold.ts, beside
the holds they configure (holdAttemptSteps, readHeldScreen).
- The result of a finished test or setup unit is a pure function of the
pair, the verdict, the attempts, and a beforeAll failure: unitResult in
units.ts, beside pairResult.
execute.ts: 1031 lines to 956. It was 1031 on main and 1226 at the review.
Refs ENG-1297
* test(e2e): match the not-awaited message without a step label
Main's #1880 names an unlabeled step by its api alone ("gadget.hang
finished"), where the message used to quote an empty label. The suite-hook
test's pattern required a label between the two, so it failed on the merge
with main.
* feat(e2e): an override inherits auto from the fixture it extends
A fixture that extends another and does not state `auto` now has the
extended fixture's, the way it has its scope: an override of an auto
fixture is set up for every test, and one of a built-in fixture on demand.
An `auto` that differs from the extended fixture's is a COLLECTION_ERROR
naming both, worded like the scope mismatch. This matches Playwright.
It also fixes which fixtures the plan starts from. An auto fixture was a
root by its own flag, so with an auto base and its override in one chain
the base was set up and the override skipped, while the name resolved to
the override; an override that replaced the base without naming it still
left the base running. An auto fixture is now a root only where its name
stands for it: the base runs once through the override's own name, or not
at all when the override replaces it.
Refs ENG-1297
* fix(core): name the hook or fixture that left a step running
STEP_NOT_AWAITED said "the test body returned before ..." for a step a
beforeAll, afterAll or beforeEach hook, a fixture's setup or a worker
fixture's teardown left running. The recorder now keeps the owner each
step was started under, and the runner says which code runs: the pool
for fixtures, hooks and the body, the suite attempt for suite hooks, and
a hosted session for itself.
---------
Co-authored-by: Oskar Kwaśniewski <oskar@okwasniewski.com>
273 lines
14 KiB
Plaintext
273 lines
14 KiB
Plaintext
---
|
||
title: 引擎协议
|
||
description: 在另一个进程、另一台机器上,或使用另一种语言运行引擎。
|
||
---
|
||
|
||
引擎协议是以 JSON-RPC 消息形式表达的[引擎契约](/reference/engine)。运行器通过它驱动所有引擎。要在另一个进程、另一台机器上,或使用另一种语言运行引擎,请参阅[引擎服务器](/engine-servers)。
|
||
|
||
```ts title="e2e.config.ts"
|
||
import type { E2EConfig } from 'e2e';
|
||
import { connectEngine, spawnTransport } from 'e2e/engine';
|
||
|
||
export default {
|
||
targets: [
|
||
{
|
||
name: 'kiosk',
|
||
engine: connectEngine({
|
||
manifest: { name: 'kiosk', version: '1.0.0', spiVersion: 1, platform: 'kiosk', methods: ['engine/observe'] },
|
||
transport: spawnTransport({ command: './kiosk-engine' }),
|
||
resolveLocators: true,
|
||
}),
|
||
},
|
||
],
|
||
} satisfies E2EConfig;
|
||
```
|
||
|
||
## 参考
|
||
|
||
| 函数 | 返回值 |
|
||
| --- | --- |
|
||
| [`connectEngine`](#connectengine) | `EngineHandle` |
|
||
| [`serveEngine`](#serveengine) | `Promise<void>` |
|
||
| [`describeEngine`](#describeengine) | `EngineManifest` |
|
||
| [`spawnTransport`](#spawntransport) | `EngineTransport` |
|
||
| [`socketTransport`](#sockettransport) | `EngineTransport` |
|
||
| [`loopbackTransport`](#loopbacktransport) | `EngineTransport` |
|
||
|
||
### `connectEngine`
|
||
|
||
将引擎服务器转换为引擎句柄,即测试目标的 `engine` 接受的值。
|
||
|
||
```ts
|
||
export function connectEngine(options: ConnectEngineOptions): EngineHandle;
|
||
|
||
export interface ConnectEngineOptions {
|
||
/** What the server is; the server's manifest from `initialize` must match it. */
|
||
readonly manifest: EngineManifest;
|
||
/** How to reach the server. */
|
||
readonly transport: EngineTransport;
|
||
/** Engine options the server receives in `initialize`, as JSON. */
|
||
readonly initializationOptions?: JsonValue;
|
||
/** The `secrets.get()` handles the server may resolve. */
|
||
readonly secrets?: readonly Secret[];
|
||
/** Fixtures that run on the client, beside the test. */
|
||
readonly fixtures?: Engine['fixtures'];
|
||
/** Checks the target's app at config load, on the client. */
|
||
readonly validateApp?: Engine['validateApp'];
|
||
/** Answers locators on the client from observations, for a server without `engine/locate`. */
|
||
readonly resolveLocators?: boolean;
|
||
/** Session hooks the client answers instead of the server. */
|
||
readonly session?: EngineSession;
|
||
}
|
||
```
|
||
|
||
运行器在加载配置时读取清单,此时还没有任何服务器运行。如果服务器的清单不一致,其首次连接就会失败。
|
||
|
||
句柄在测试执行框架调用引擎的位置建立连接。在运行器中,每个测试目标的一个连接从 `prepare` 持续到 `finish`,并且只有当服务器支持 `lifecycle/prepare` 或 `lifecycle/finish` 时才会打开。每个工作进程中的一个连接从 `init` 持续到 `dispose`。`e2e doctor` 为每个测试目标打开一个 `doctor` 连接,仅用于 `lifecycle/doctor`,之后关闭。传输层可以像 `spawnTransport` 一样为其启动服务器,但不得配置机器、租用设备或安装应用。收到 doctor 信号后,服务器有 5 秒时间响应,之后连接会关闭。在 `init`..`dispose` 之外调用操作会以 `INVALID_STATE` 失败。从未运行 `init` 的工作进程没有连接,因此服务器不会收到它的 `lifecycle/dispose`。两个连接是否共享状态由服务器决定:派生的服务器为每个连接创建一个进程,而回环或套接字服务器可以通过同一个引擎处理所有连接。
|
||
|
||
使用 `resolveLocators` 时,每次 `locate` 都会观察并通过 [`resolveExpression`](/reference/engine#resolveexpression) 解析表达式。`fixtures`、`validateApp`、`secrets` 和 `session` 钩子在客户端运行;`session` 钩子会替换服务器的同名方法。参阅[将主机工作保留在客户端](/engine-servers#keep-host-work-on-the-client)。
|
||
|
||
<Warning>
|
||
`lifecycle/prepare`、`lifecycle/init`、`lifecycle/finish` 和 `lifecycle/doctor` 会携带本次运行的环境,包括模型密钥和 `E2E_SECRET_*` 值,而 `attempt/resolveSecret` 会以明文响应。只连接你信任的服务器:`socketTransport` 不会加密。
|
||
</Warning>
|
||
|
||
| 抛出的错误 | 触发条件 |
|
||
| --- | --- |
|
||
| `INVALID_CONFIG` | 清单格式有误:包含未知方法、重复列出某个方法,或包含 `defineEngine` 拒绝的成员,例如有 `keyboard/type` 却没有 `keyboard/press`、有 `engine/perform` 却没有 `actions`,或有 `engine/perform` 却没有 `engine/observe`。 |
|
||
| `ENGINE_FAILURE` | 服务器清单不一致,或连接在调用过程中关闭。消息包含传输层诊断信息,例如服务器最后几行 stderr 输出。 |
|
||
|
||
### `serveEngine`
|
||
|
||
通过一个连接提供使用 `defineEngine` 构建的引擎,直到客户端发送 `exit` 或流关闭。
|
||
|
||
```ts
|
||
export function serveEngine(
|
||
engine: EngineHandle | ((initializationOptions: unknown) => EngineHandle | Promise<EngineHandle>),
|
||
streams?: MessageStreams, // default: process.stdin and process.stdout
|
||
): Promise<void>;
|
||
```
|
||
|
||
服务器自身的日志应写入 stderr:stdout 用于传输协议。参阅[提供 TypeScript 引擎服务](/engine-servers#serve-a-typescript-engine)。
|
||
|
||
### `describeEngine`
|
||
|
||
返回 `serveEngine` 为引擎句柄公布的清单:其静态成员、声明的成员所响应的方法,以及 `serveEngine` 始终响应的 `lifecycle/startAttempt` 和 `lifecycle/endAttempt`。用它声明在其他位置提供服务的 TypeScript 引擎的清单。
|
||
|
||
```ts
|
||
export function describeEngine(engine: EngineHandle): EngineManifest;
|
||
```
|
||
|
||
### `spawnTransport`
|
||
|
||
为每个连接以子进程形式启动服务器,并通过其 stdin 和 stdout 通信,就像编辑器启动语言服务器一样。
|
||
|
||
```ts
|
||
export function spawnTransport(options: {
|
||
readonly command: string;
|
||
readonly args?: readonly string[];
|
||
/** Added to the worker's environment. */
|
||
readonly env?: Readonly<Record<string, string>>;
|
||
readonly cwd?: string; // default: the project root
|
||
}): EngineTransport;
|
||
```
|
||
|
||
关闭连接会结束 stdin、发送 `SIGTERM`,并在清理预算耗尽后发送 `SIGKILL`。
|
||
|
||
### `socketTransport`
|
||
|
||
连接到本机或另一台机器上已监听 TCP 端口的服务器。关闭连接会结束套接字;服务器继续运行。
|
||
|
||
```ts
|
||
export function socketTransport(options: { readonly host: string; readonly port: number }): EngineTransport;
|
||
```
|
||
|
||
### `loopbackTransport`
|
||
|
||
通过内存流在当前进程中提供引擎服务。每次调用仍会经过协议,并像其他传输方式一样序列化。
|
||
|
||
```ts
|
||
export function loopbackTransport(engine: EngineHandle): EngineTransport;
|
||
```
|
||
|
||
## 消息
|
||
|
||
基础协议采用 [Language Server Protocol 的基础协议](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#baseProtocol):使用 UTF-8 编码的 JSON-RPC 2.0 消息,每条消息前都有一个 `Content-Length` 头和一个空行。双方都可以发送请求和通知。
|
||
|
||
### 生命周期
|
||
|
||
连接的建立和关闭方式与 LSP 连接相同。
|
||
|
||
| 消息 | 方向 | 参数 | 结果 |
|
||
| --- | --- | --- | --- |
|
||
| `initialize` | 请求,客户端到服务器 | `{ protocolVersion: 1, clientInfo, role, initializationOptions? }` | `{ protocolVersion: 1, manifest }` |
|
||
| `initialized` | 通知,客户端到服务器 | `{}` | - |
|
||
| `shutdown` | 请求,客户端到服务器 | - | `null` |
|
||
| `exit` | 通知,客户端到服务器 | - | - |
|
||
|
||
双方都拒绝 `1` 以外的任何 `protocolVersion`。`shutdown` 之后,各方保持其信号状态不变。如果连接未经过 `shutdown` 就关闭,则中止其持有的所有信号。
|
||
|
||
### 清单
|
||
|
||
其 JSON Schema 随 `e2e` 包提供,路径为 `schema/engine-manifest-v1.schema.json`。
|
||
|
||
```ts
|
||
export interface EngineManifest {
|
||
readonly name: string;
|
||
readonly version: string;
|
||
readonly spiVersion: 1;
|
||
readonly platform?: string;
|
||
readonly workers?: number;
|
||
/** The engine methods the server answers; one left out is a capability the engine lacks. */
|
||
readonly methods: readonly EngineMethod[];
|
||
/** Required with `engine/perform`. */
|
||
readonly actions?: readonly LocatorActionKind[];
|
||
/** Required with `engine/performAt`. */
|
||
readonly pointerActions?: readonly PointerActionKind[];
|
||
readonly tapModifiers?: boolean;
|
||
/** See `Engine.isolation`; left out for `attempt`. */
|
||
readonly isolation?: 'worker';
|
||
}
|
||
```
|
||
|
||
### 引擎方法
|
||
|
||
每个方法对应一个引擎成员,是从客户端发往服务器的请求。其参数按成员的参数名称传递,每个 `OperationContext` 都表示为 `operation`。`ENGINE_METHODS` 列出了这些方法。
|
||
|
||
| 方法 | 参数 | 结果 |
|
||
| --- | --- | --- |
|
||
| `engine/observe` | `{ operation, options? }` | `EngineSnapshot` |
|
||
| `engine/readStyle` | `{ ref, properties, operation }` | `ComputedStyleValues` |
|
||
| `engine/locate` | `{ expression, operation }` | `SemanticNode[]` |
|
||
| `engine/perform` | `{ ref, action, operation }` | `null` |
|
||
| `engine/performAt` | `{ point, action, operation }` | `null` |
|
||
| `keyboard/type` | `{ text, options: { replace }, operation }` | `null` |
|
||
| `keyboard/press` | `{ key, operation }` | `null` |
|
||
| `keyboard/dismiss` | `{ operation }` | `null` |
|
||
| `state/capture` | `{ operation }` | `EngineState` |
|
||
| `state/restore` | `{ state, operation }` | `null` |
|
||
| `artifacts/screenshot` | `{ label?, operation }` | `{ path }` 或 `{ data, mediaType }` |
|
||
| `artifacts/startVideo` | `{ operation }` | `null` |
|
||
| `artifacts/stopVideo` | `{ operation }` | `VideoSegment[]` |
|
||
| `session/open` | `{ url, operation }` | `null` |
|
||
| `session/openLink` | `{ url, operation }` | `null` |
|
||
| `session/back`, `session/restart`, `session/reset` | `{ operation }` | `null` |
|
||
| `session/resize` | `{ size: { width, height }, operation }` | `null` |
|
||
| `session/switchTab` | `{ index, operation }` | `null` |
|
||
| `session/closeTab` | `{ index, operation }` | `null` |
|
||
| `lifecycle/prepare` | 不含 `log` 的 `EnginePrepareInfo` | `EnginePrepareResult` 或 `null` |
|
||
| `lifecycle/finish` | 不含 `log` 的 `EngineFinishInfo` | `null` |
|
||
| `lifecycle/doctor` | 不含 `log` 的 `EngineDoctorInfo` | `EngineDoctorCheck[]` |
|
||
| `lifecycle/init` | 不含 `log` 的 `EngineInitInfo` | `null` |
|
||
| `lifecycle/startAttempt` | `{ attemptId, artifactsDir, signal, screens }` | `null` |
|
||
| `lifecycle/settleAttempt`, `lifecycle/endAttempt` | `{ signal, timeoutMs }` | `null` |
|
||
| `lifecycle/dispose` | `{ signal, timeoutMs, reuseSignal? }` | `null` |
|
||
|
||
当服务器无法写入本次尝试的产物目录时(例如服务器运行在设备上),`artifacts/screenshot` 返回 `{ data, mediaType: 'image/png' }`,图像以 base64 编码。客户端会将其写入 `screenshots/`。观察所得的像素数据以同样方式传输:`pixels.data` 为 base64。
|
||
|
||
`lifecycle/startAttempt` 中的 `screens` 表示本次尝试是否保留追踪记录;保留时,服务器才可以发送 `attempt/screen`。
|
||
|
||
### 服务器到客户端
|
||
|
||
引擎对测试执行框架的回调以服务器到客户端的消息形式传输。每条 `attempt/*` 消息都携带其所属的 `attemptId`;如果对应尝试已经结束,客户端会丢弃该消息。
|
||
|
||
| 消息 | 类型 | 参数 |
|
||
| --- | --- | --- |
|
||
| `engine/log` | 通知 | `{ line }`,来自 `prepare`、`init` 或 `finish` |
|
||
| `attempt/appLog` | 通知 | `{ attemptId, entry }` |
|
||
| `attempt/navigation` | 通知 | `{ attemptId, line }` |
|
||
| `attempt/environment` | 通知 | `{ attemptId, facts }` |
|
||
| `attempt/screen` | 通知 | `{ attemptId, snapshot }` |
|
||
| `attempt/resolveSecret` | 请求 | `{ attemptId, name, derivation? }`,结果为 `{ value }` |
|
||
|
||
存在 `derivation` 时,客户端会在响应前反向发起 `attempt/deriveSecret` 请求,参数为 `{ derivation, plaintext }`。服务器返回 `{ values }`,即引擎从该值派生的形式,例如 basic-auth 请求头;客户端会以该机密值的名称对这些形式脱敏。
|
||
|
||
### 信号
|
||
|
||
`AbortSignal` 以 `{ id, aborted?, reason? }` 形式传输。客户端为每个信号生成一个 ID,并在中止时发送带有 `{ id, reason? }` 的 `$/abort`。发送时已中止的信号携带 `aborted: true`。如果测试执行框架因自身错误(例如测试超时)而中止,`reason` 就是以 JSON-RPC 错误对象表示的中止原因,编码方式与失败方法的[错误](#errors)相同。服务器使用该错误中止信号,因此重新抛出 `signal.reason` 的引擎会抛出与进程内运行时相同的错误。没有 `reason` 时,信号以平台的 `AbortError` 中止。信号中止后,服务器会遗忘其 ID;`lifecycle/endAttempt` 完成后,服务器也会遗忘在该次尝试中首次出现的所有 ID。之后再次发送的同一 ID 会被视为新信号。
|
||
|
||
### 错误
|
||
|
||
失败的引擎方法以 JSON-RPC 错误码 `-32000` 响应,并将 e2e 错误放在 `data` 中,因此测试执行框架对远程失败的分类与本地失败完全一致:
|
||
|
||
| `data` | 引擎抛出的错误 |
|
||
| --- | --- |
|
||
| `{ type: 'engine', code, retryable }` | [`EngineError`](/reference/engine#engineerror)。只有 `NODE_STALE` 和 `FRAME_NOT_FOUND` 可以重试。 |
|
||
| `{ type: 'e2e', category, code, retryable, details? }` | 运行器错误,例如 `TestError` 或 `ConfigurationError`。 |
|
||
|
||
其他错误码只携带消息。测试执行框架将其视为 infrastructure 类别的错误,与本地引擎抛出的普通 `Error` 一样处理。每个错误的 `data` 还可以携带 `stack`、`errno`(例如 `ECONNREFUSED` 这样的 Node 错误码)和 `cause`(同样结构的错误对象),让报告显示引擎失败的位置。
|
||
|
||
## 类型
|
||
|
||
传输层打开一个连接的字节流。参阅[编写传输层](/engine-servers#write-a-transport)。
|
||
|
||
```ts
|
||
export interface EngineTransport {
|
||
/** For error messages: the command, or the address. */
|
||
readonly label: string;
|
||
open(context: TransportContext): Promise<TransportConnection>;
|
||
}
|
||
|
||
export interface TransportContext {
|
||
readonly role: 'run' | 'worker' | 'doctor';
|
||
readonly env: Readonly<Record<string, string | undefined>>;
|
||
/** The project root. */
|
||
readonly cwd: string;
|
||
readonly signal: AbortSignal;
|
||
/** The target's app, from `prepare`, `init`, or `doctor`: what a transport installs, since a server elsewhere cannot read the project's files. */
|
||
readonly app?: EngineAppInfo;
|
||
}
|
||
|
||
export interface TransportConnection {
|
||
readonly input: Readable;
|
||
readonly output: Writable;
|
||
/** Releases the process or socket, within `timeoutMs`. */
|
||
close(timeoutMs: number): Promise<void>;
|
||
/** What went wrong, for an error message. */
|
||
diagnostics?(): string;
|
||
}
|
||
```
|
||
|
||
## 相关内容
|
||
|
||
[引擎](/engines)比较了构建引擎的不同方式。[`e2e/engine`](/reference/engine) 是每条消息所承载的契约。[引擎服务器](/engine-servers)和[编写引擎](/writing-an-engine)逐步介绍了构建过程。
|