交互与用户体验 / 系统课时

为关键交互编写状态验收用例

为关键交互编写状态验收用例

一次发送能成功,不足以说明聊天界面可靠。本课把发送、流式回复、停止、重试、引用和工具确认拆成可检查的状态用例,同时核对屏幕结果、网络副作用和失败后的恢复入口,形成可以交给开发与测试共同执行的验收标准。

学习目标

  • 为六类关键操作写出正常、边界和失败状态的验收断言。
  • 区分“界面显示成功”和“请求确实只执行一次”。
  • 使用 Playwright 模拟服务失败并验证重试与工具确认。

先定义状态和副作用

约定消息主状态为 idle、sending、streaming、stopping、stopped、completed、failed。sending 或 streaming 可以失败或进入停止流程;只有收到所用协议的成功终止事件,并且该事件属于当前尝试,才显示 completed。连接关闭、取消和部分正文单独处理。重试产生新的尝试,但不能再次插入同一条用户消息。

工具操作记录 awaiting_confirmation、running、succeeded、failed、cancelled 和 unknown。只有可信的业务回执能确认成功或失败。待确认时,执行接口调用次数必须为 0;引用是否可定位应独立记录,不要因为答案完成就默认来源有效。

消息生成与工具确认的验收状态路径

六类操作的十八条验收用例

下表每个单元格各对应一条用例。观察界面状态之外,还要统计网络请求或工具执行次数;否则双击造成两次扣款或删除,也可能被一个“成功”提示掩盖。

操作 正常场景 边界场景 失败场景
发送 提交“查询 A”后用户消息恰好 1 条、请求 1 次 连点发送两次,仍只有 1 个在途请求 503 且业务回执确认未受理时,保留草稿和重试入口
流式回复 依次收到“数”“据”,显示“数据”后进入完成态 空片段或重复序号不得让文本重复、回退 收到“数”后断流,保留“数”并提示中断
停止 生成中点停止进入停止中,收到对应确认后显示已停止 已完成时停止按钮不可再触发取消 取消未完成时不能伪装成已完成
重试 确认未受理后复用客户端消息 ID 重试,只保留 1 条用户消息 连点重试最多启动 1 次新尝试 再遇传输故障且受理状态未知时,显示待核对并保留原请求
引用 点击引用 [1] 能定位到指定来源段落 两处相同 sourceId 均定位到同一来源 来源失效时明确提示无法定位,不打开空白页
工具确认 展示操作对象,确认后调用执行接口 1 次 取消调用 0 次;重复确认最多执行 1 次 执行接口返回 502 且业务结果未知时,显示待核对。查询原动作,避免重复执行

对流式回复应使用可控的 SSE 或 WebSocket 测试数据:先释放第一片并断言 streaming,再释放第二片;不要用固定等待 2 秒代替事件同步。这里的状态名和 sourceId 是示例产品的验收契约,不是浏览器或 Playwright 的内置字段。

运行本地模拟的 Playwright 验收

HTTP 502 表示网关收到无效的上游响应。上游可能已经完成写操作。对照测试应分别注入已确认失败和结果未知,并检查后者是否保留原动作标识及核对入口。即使网络上只观察到一次执行请求,也无法由此前端测试证明生产后端只提交了一次副作用。

下面的 HTML 夹具和模拟路由包含在同一个脚本中。使用 Node.js 20+,在测试目录运行 npm install -D playwright-core、npx playwright-core install chromium。将代码保存为 chat-state.mjs,运行 node chat-state.mjs。所有请求由脚本接管,不接真实服务。

js
import assert from "node:assert/strict";
import { chromium } from "playwright-core";

const html = `<!doctype html>
<meta charset="utf-8">
<textarea aria-label="消息"></textarea>
<button id="send">发送</button><button id="retry" hidden>重试</button>
<ul id="messages"></ul><p id="reply" role="status"></p>
<section id="action" hidden>
  <p>确认对象:演示项目</p>
  <button id="confirm">确认归档</button>
  <button id="cancel">取消</button>
  <button id="check" hidden>核对结果</button>
  <p id="tool" role="status"></p>
</section>
<script>
  const get = id => document.getElementById(id);
  let pending, sending = false, action = "awaiting", actionId;
  async function send() {
    if (sending) return;
    if (!pending) {
      const text = document.querySelector("textarea").value;
      if (!text.trim()) return;
      pending = { messageId: "m-demo", text };
      const row = document.createElement("li");
      row.textContent = text;
      get("messages").append(row);
    }
    sending = true;
    get("retry").hidden = true;
    get("send").disabled = true;
    try {
      const response = await fetch("/api/chat", {
        method: "POST", headers: {"content-type": "application/json"},
        body: JSON.stringify(pending),
      });
      const data = await response.json();
      if (response.ok && data.state === "accepted" && typeof data.actionId === "string") {
        actionId = data.actionId;
        get("reply").textContent = "消息已受理。";
        get("action").hidden = false;
      } else if (data.state === "not_accepted") {
        get("reply").textContent = "未受理,可重试。";
        get("retry").hidden = false;
      } else {
        get("reply").textContent = "消息状态待核对。";
      }
    } catch {
      get("reply").textContent = "消息状态待核对。";
    } finally {
      sending = false;
    }
  }
  get("send").onclick = send;
  get("retry").onclick = send;
  get("cancel").onclick = () => {
    if (action !== "awaiting") return;
    action = "cancelled";
    get("confirm").disabled = true;
    get("tool").textContent = "已取消。";
  };
  get("confirm").onclick = async () => {
    if (action !== "awaiting") return;
    action = "running";
    get("confirm").disabled = true;
    get("cancel").disabled = true;
    try {
      const response = await fetch("/api/tool/execute", {
        method: "POST", headers: {"content-type": "application/json"},
        body: JSON.stringify({ actionId }),
      });
      if (response.ok && (await response.json()).state === "succeeded") {
        action = "succeeded";
        get("tool").textContent = "已确认成功。";
        return;
      }
    } catch { /* 传输失败,等待核对业务状态。 */ }
    action = "unknown";
    get("tool").textContent = "结果待核对。";
    get("check").hidden = false;
  };
  get("check").onclick = async () => {
    if (action !== "unknown") return;
    try {
      const response = await fetch("/api/tool/status?actionId=" + encodeURIComponent(actionId));
      if (response.ok && (await response.json()).state === "succeeded") {
        action = "succeeded";
        get("tool").textContent = "已核对成功。";
        get("check").hidden = true;
      }
    } catch { /* 保留待核对状态。 */ }
  };
</script>`;

const browser = await chromium.launch({
  headless: true,
  executablePath: process.env.BROWSER_EXECUTABLE || undefined,
});
try {
  const page = await browser.newPage({ serviceWorkers: "block" });
  const messages = [];
  let executions = 0, checked = 0;
  await page.route("**/*", async route => {
    const request = route.request();
    const url = new URL(request.url());
    if (url.origin !== "https://chat.test") return route.abort();
    if (url.pathname === "/chat") {
      return route.fulfill({ contentType: "text/html; charset=utf-8", body: html });
    }
    if (url.pathname === "/api/chat" && request.method() === "POST") {
      messages.push(request.postDataJSON());
      return messages.length === 1
        ? route.fulfill({ status: 503, json: { state: "not_accepted" } })
        : route.fulfill({ json: { state: "accepted", actionId: "a-demo" } });
    }
    if (url.pathname === "/api/tool/execute" && request.method() === "POST") {
      assert.deepEqual(request.postDataJSON(), { actionId: "a-demo" });
      executions++;
      return route.fulfill({ status: 502, json: { error: "bad_gateway" } });
    }
    if (url.pathname === "/api/tool/status" && request.method() === "GET"
        && url.searchParams.get("actionId") === "a-demo") {
      checked++;
      return route.fulfill({ json: { state: "succeeded" } });
    }
    return route.abort();
  });

  await page.goto("https://chat.test/chat");
  await page.getByLabel("消息").fill("归档演示项目");
  await page.getByRole("button", { name: "发送" }).click();
  await page.getByText("未受理,可重试。").waitFor();
  await page.getByRole("button", { name: "重试" }).click();
  await page.getByText("消息已受理。").waitFor();
  assert.equal(await page.getByRole("listitem").count(), 1);
  assert.deepEqual(messages, [
    { messageId: "m-demo", text: "归档演示项目" },
    { messageId: "m-demo", text: "归档演示项目" },
  ]);

  assert.equal(executions, 0);
  await page.getByRole("button", { name: "确认归档" }).click();
  await page.getByText("结果待核对。").waitFor();
  assert.equal(await page.getByRole("button", { name: "确认归档" }).isDisabled(), true);
  assert.equal(executions, 1);
  await page.getByRole("button", { name: "核对结果" }).click();
  await page.getByText("已核对成功。").waitFor();
  assert.equal(executions, 1);
  assert.equal(checked, 1);

  await page.reload();
  await page.getByLabel("消息").fill("归档演示项目");
  await page.getByRole("button", { name: "发送" }).click();
  await page.getByRole("button", { name: "取消" }).click();
  await page.getByText("已取消。").waitFor();
  assert.equal(executions, 1);
  console.log("消息重试、待确认、结果核对与取消通过");
} finally {
  await browser.close();
}

预期输出

text
消息重试、待确认、结果核对与取消通过

上例只验证夹具及模拟接口。迁移到项目时,将夹具替换为实际页面,并让服务端集成测试核对动作 ID、当前权限、幂等记录和真实业务状态。演示的固定 ID 不能用于生产,真实的客户端消息 ID 和动作 ID 由可信运行时生成。

记录验收证据

用例保存前置状态、操作、界面断言、请求断言和必要的脱敏 Trace。流式用例还应按事件释放片段,收到成功终止、取消确认或断流时分别断言。核对取消在途操作时,检查迟到片段不会更新新尝试,也不要因隐藏按钮就判定后端已经取消。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

为关键交互编写状态验收用例

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通