test: cfg-gate e2e observer payloads
This commit is contained in:
parent
559adb9a3f
commit
b30b43b989
|
|
@ -2,7 +2,7 @@
|
||||||
title: "E2E テストハーネス"
|
title: "E2E テストハーネス"
|
||||||
state: 'inprogress'
|
state: 'inprogress'
|
||||||
created_at: "2026-05-27T00:00:02Z"
|
created_at: "2026-05-27T00:00:02Z"
|
||||||
updated_at: '2026-06-13T15:05:52Z'
|
updated_at: '2026-06-13T15:18:21Z'
|
||||||
queued_by: 'yoi ticket'
|
queued_by: 'yoi ticket'
|
||||||
queued_at: '2026-06-13T14:17:34Z'
|
queued_at: '2026-06-13T14:17:34Z'
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -298,4 +298,40 @@ Validation run in `/home/hare/Projects/yoi/.worktree/e2e-harness`:
|
||||||
No source changes were made during review.
|
No source changes were made during review.
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!-- event: implementation_report author: hare at: 2026-06-13T15:18:21Z -->
|
||||||
|
|
||||||
|
## Implementation report
|
||||||
|
|
||||||
|
Follow-up implementation update for reviewer request `559adb9a ticket: request e2e harness changes`:
|
||||||
|
|
||||||
|
Production/non-production boundary fix:
|
||||||
|
- Removed the normal-build no-op `e2e_observer` module path and now compile the observer module only behind `tui/e2e-test` via `#[cfg(feature = "e2e-test")] mod e2e_observer;`.
|
||||||
|
- Added `#[cfg(feature = "e2e-test")]` to all Panel/TUI observability call sites that build JSON payloads, including terminal cleanup/exit, panel ready, rows-rendered, mouse click, selection changes, action requests, quit request, and background task lifecycle events.
|
||||||
|
- `App::emit_rows_rendered`, `PanelE2eRowKey`, `PanelE2eRect`, `PanelE2eRenderedRow`, `PanelE2eRowsRendered`, and the conversion helpers are now compiled only with `tui/e2e-test`.
|
||||||
|
- Normal builds no longer call `app.emit_rows_rendered()`, no longer evaluate `serde_json::json!` e2e payloads, and no longer retain the Panel E2E DTO/helper logic in the runtime path.
|
||||||
|
- The background reload hold seam remains compiled/called only under `tui/e2e-test`; `YOI_TUI_TEST_EVENTS` and `YOI_TUI_TEST_HOLD_BACKGROUND_TASK` behavior remains feature-gated.
|
||||||
|
|
||||||
|
Preserved E2E behavior:
|
||||||
|
- Mouse E2E still verifies PTY output for normal mouse tracking + SGR mouse enable sequences before any raw SGR click can be sent.
|
||||||
|
- `PanelHarness::click(...)` still fails if mouse capture was not observed.
|
||||||
|
- Quit latency E2E still uses the feature-gated pending reload hold barrier and asserts the reload task is pending before Ctrl+C.
|
||||||
|
|
||||||
|
Validation:
|
||||||
|
- `cargo fmt --check` — passed.
|
||||||
|
- `cargo check -p tui --all-targets` — passed.
|
||||||
|
- `cargo check -p yoi --all-targets` — passed.
|
||||||
|
- `cargo check -p tui --all-targets --features e2e-test` — passed.
|
||||||
|
- `cargo check -p yoi --all-targets --features e2e-test` — passed.
|
||||||
|
- `cargo build -p yoi --features e2e-test` — passed.
|
||||||
|
- `YOI_E2E_BIN=/home/hare/Projects/yoi/.worktree/e2e-harness/target/debug/yoi cargo test -p yoi-e2e --features e2e --test panel -- --nocapture` — passed (2 tests).
|
||||||
|
- `cargo check -p yoi-e2e --all-targets --features e2e` — passed.
|
||||||
|
- `git diff --check` — passed.
|
||||||
|
|
||||||
|
Remaining gaps / risks unchanged:
|
||||||
|
- The E2E harness remains Unix PTY based.
|
||||||
|
- The screen artifact remains raw PTY output rather than a parsed terminal snapshot.
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,3 @@
|
||||||
#[cfg(feature = "e2e-test")]
|
|
||||||
mod imp {
|
|
||||||
use std::fs::{File, OpenOptions};
|
use std::fs::{File, OpenOptions};
|
||||||
use std::io::Write;
|
use std::io::Write;
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
|
|
@ -77,13 +75,3 @@ mod imp {
|
||||||
.ok()
|
.ok()
|
||||||
.map(Mutex::new)
|
.map(Mutex::new)
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "e2e-test")]
|
|
||||||
pub(crate) use imp::{emit, hold_background_task_if_requested};
|
|
||||||
|
|
||||||
#[cfg(not(feature = "e2e-test"))]
|
|
||||||
pub(crate) fn emit<T>(_surface: &'static str, _event: &'static str, _data: T) {}
|
|
||||||
|
|
||||||
#[cfg(not(feature = "e2e-test"))]
|
|
||||||
pub(crate) async fn hold_background_task_if_requested(_task: &'static str) {}
|
|
||||||
|
|
|
||||||
|
|
@ -4,6 +4,7 @@ mod cache;
|
||||||
mod command;
|
mod command;
|
||||||
mod composer_history;
|
mod composer_history;
|
||||||
mod composer_keys;
|
mod composer_keys;
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
mod e2e_observer;
|
mod e2e_observer;
|
||||||
mod input;
|
mod input;
|
||||||
pub mod keys;
|
pub mod keys;
|
||||||
|
|
@ -109,6 +110,7 @@ pub async fn launch(options: LaunchOptions) -> ExitCode {
|
||||||
// Always restore the terminal first so any pending eprintln below
|
// Always restore the terminal first so any pending eprintln below
|
||||||
// shows up cleanly in scrollback rather than inside an active
|
// shows up cleanly in scrollback rather than inside an active
|
||||||
// alternate-screen buffer.
|
// alternate-screen buffer.
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
e2e_observer::emit("tui", "terminal_cleanup_started", serde_json::json!({}));
|
e2e_observer::emit("tui", "terminal_cleanup_started", serde_json::json!({}));
|
||||||
let mut stdout = io::stdout();
|
let mut stdout = io::stdout();
|
||||||
let _ = execute!(
|
let _ = execute!(
|
||||||
|
|
@ -119,10 +121,12 @@ pub async fn launch(options: LaunchOptions) -> ExitCode {
|
||||||
);
|
);
|
||||||
let _ = disable_raw_mode();
|
let _ = disable_raw_mode();
|
||||||
let _ = execute!(stdout, crossterm::cursor::Show);
|
let _ = execute!(stdout, crossterm::cursor::Show);
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
e2e_observer::emit("tui", "terminal_cleanup_finished", serde_json::json!({}));
|
e2e_observer::emit("tui", "terminal_cleanup_finished", serde_json::json!({}));
|
||||||
|
|
||||||
match result {
|
match result {
|
||||||
Ok(()) => {
|
Ok(()) => {
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
e2e_observer::emit("tui", "exit", serde_json::json!({ "status": "success" }));
|
e2e_observer::emit("tui", "exit", serde_json::json!({ "status": "success" }));
|
||||||
ExitCode::SUCCESS
|
ExitCode::SUCCESS
|
||||||
}
|
}
|
||||||
|
|
@ -135,6 +139,7 @@ pub async fn launch(options: LaunchOptions) -> ExitCode {
|
||||||
if e.downcast_ref::<spawn::SpawnError>().is_none() {
|
if e.downcast_ref::<spawn::SpawnError>().is_none() {
|
||||||
eprintln!("yoi: {e}");
|
eprintln!("yoi: {e}");
|
||||||
}
|
}
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
e2e_observer::emit("tui", "exit", serde_json::json!({ "status": "failure" }));
|
e2e_observer::emit("tui", "exit", serde_json::json!({ "status": "failure" }));
|
||||||
ExitCode::FAILURE
|
ExitCode::FAILURE
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -133,6 +133,7 @@ pub(crate) async fn run(
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
let mut next_poll = Instant::now() + MULTI_POD_POLL_INTERVAL;
|
let mut next_poll = Instant::now() + MULTI_POD_POLL_INTERVAL;
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
let mut emitted_panel_ready = false;
|
let mut emitted_panel_ready = false;
|
||||||
|
|
||||||
loop {
|
loop {
|
||||||
|
|
@ -147,11 +148,14 @@ pub(crate) async fn run(
|
||||||
}
|
}
|
||||||
|
|
||||||
terminal.draw(|f| draw(f, app))?;
|
terminal.draw(|f| draw(f, app))?;
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
|
{
|
||||||
if !emitted_panel_ready {
|
if !emitted_panel_ready {
|
||||||
crate::e2e_observer::emit("panel", "panel_ready", serde_json::json!({}));
|
crate::e2e_observer::emit("panel", "panel_ready", serde_json::json!({}));
|
||||||
emitted_panel_ready = true;
|
emitted_panel_ready = true;
|
||||||
}
|
}
|
||||||
app.emit_rows_rendered();
|
app.emit_rows_rendered();
|
||||||
|
}
|
||||||
|
|
||||||
let now = Instant::now();
|
let now = Instant::now();
|
||||||
if now >= next_poll {
|
if now >= next_poll {
|
||||||
|
|
@ -169,6 +173,7 @@ pub(crate) async fn run(
|
||||||
TermEvent::Key(key) => match app.handle_key(key) {
|
TermEvent::Key(key) => match app.handle_key(key) {
|
||||||
MultiPodAction::None => {}
|
MultiPodAction::None => {}
|
||||||
MultiPodAction::Quit => {
|
MultiPodAction::Quit => {
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::emit("panel", "quit_requested", serde_json::json!({}));
|
crate::e2e_observer::emit("panel", "quit_requested", serde_json::json!({}));
|
||||||
abort_panel_background_work_for_quit(
|
abort_panel_background_work_for_quit(
|
||||||
&mut pending_reload,
|
&mut pending_reload,
|
||||||
|
|
@ -177,6 +182,7 @@ pub(crate) async fn run(
|
||||||
return Ok(MultiPodOutcome::Quit);
|
return Ok(MultiPodOutcome::Quit);
|
||||||
}
|
}
|
||||||
MultiPodAction::Open => {
|
MultiPodAction::Open => {
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::emit(
|
crate::e2e_observer::emit(
|
||||||
"panel",
|
"panel",
|
||||||
"action_requested",
|
"action_requested",
|
||||||
|
|
@ -188,6 +194,7 @@ pub(crate) async fn run(
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
MultiPodAction::DispatchTicketAction(request) => {
|
MultiPodAction::DispatchTicketAction(request) => {
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::emit(
|
crate::e2e_observer::emit(
|
||||||
"panel",
|
"panel",
|
||||||
"action_requested",
|
"action_requested",
|
||||||
|
|
@ -204,6 +211,7 @@ pub(crate) async fn run(
|
||||||
next_poll = Instant::now() + MULTI_POD_POLL_INTERVAL;
|
next_poll = Instant::now() + MULTI_POD_POLL_INTERVAL;
|
||||||
}
|
}
|
||||||
MultiPodAction::LaunchIntake(request) => {
|
MultiPodAction::LaunchIntake(request) => {
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::emit(
|
crate::e2e_observer::emit(
|
||||||
"panel",
|
"panel",
|
||||||
"action_requested",
|
"action_requested",
|
||||||
|
|
@ -220,6 +228,7 @@ pub(crate) async fn run(
|
||||||
next_poll = Instant::now() + MULTI_POD_POLL_INTERVAL;
|
next_poll = Instant::now() + MULTI_POD_POLL_INTERVAL;
|
||||||
}
|
}
|
||||||
MultiPodAction::SendCompanion(request) => {
|
MultiPodAction::SendCompanion(request) => {
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::emit(
|
crate::e2e_observer::emit(
|
||||||
"panel",
|
"panel",
|
||||||
"action_requested",
|
"action_requested",
|
||||||
|
|
@ -255,6 +264,7 @@ impl PendingReload {
|
||||||
if self.handle.is_some() {
|
if self.handle.is_some() {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::emit(
|
crate::e2e_observer::emit(
|
||||||
"panel",
|
"panel",
|
||||||
"background_task_started",
|
"background_task_started",
|
||||||
|
|
@ -264,6 +274,7 @@ impl PendingReload {
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
self.handle = Some(tokio::spawn(async move {
|
self.handle = Some(tokio::spawn(async move {
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::hold_background_task_if_requested("reload").await;
|
crate::e2e_observer::hold_background_task_if_requested("reload").await;
|
||||||
load_multi_pod_snapshot(None, lifecycle_mode).await
|
load_multi_pod_snapshot(None, lifecycle_mode).await
|
||||||
}));
|
}));
|
||||||
|
|
@ -288,6 +299,7 @@ impl PendingReload {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
let handle = self.handle.take()?;
|
let handle = self.handle.take()?;
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::emit(
|
crate::e2e_observer::emit(
|
||||||
"panel",
|
"panel",
|
||||||
"background_task_finished",
|
"background_task_finished",
|
||||||
|
|
@ -303,6 +315,7 @@ impl PendingReload {
|
||||||
|
|
||||||
fn abort(&mut self) {
|
fn abort(&mut self) {
|
||||||
if let Some(handle) = self.handle.take() {
|
if let Some(handle) = self.handle.take() {
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::emit(
|
crate::e2e_observer::emit(
|
||||||
"panel",
|
"panel",
|
||||||
"background_task_aborted",
|
"background_task_aborted",
|
||||||
|
|
@ -799,12 +812,14 @@ impl PanelRowHitBox {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
#[derive(Debug, Serialize)]
|
#[derive(Debug, Serialize)]
|
||||||
struct PanelE2eRowKey {
|
struct PanelE2eRowKey {
|
||||||
kind: &'static str,
|
kind: &'static str,
|
||||||
id: String,
|
id: String,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
#[derive(Debug, Serialize)]
|
#[derive(Debug, Serialize)]
|
||||||
struct PanelE2eRect {
|
struct PanelE2eRect {
|
||||||
x: u16,
|
x: u16,
|
||||||
|
|
@ -813,6 +828,7 @@ struct PanelE2eRect {
|
||||||
height: u16,
|
height: u16,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
#[derive(Debug, Serialize)]
|
#[derive(Debug, Serialize)]
|
||||||
struct PanelE2eRenderedRow {
|
struct PanelE2eRenderedRow {
|
||||||
key: PanelE2eRowKey,
|
key: PanelE2eRowKey,
|
||||||
|
|
@ -822,12 +838,14 @@ struct PanelE2eRenderedRow {
|
||||||
rect: PanelE2eRect,
|
rect: PanelE2eRect,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
#[derive(Debug, Serialize)]
|
#[derive(Debug, Serialize)]
|
||||||
struct PanelE2eRowsRendered {
|
struct PanelE2eRowsRendered {
|
||||||
selected: Option<PanelE2eRowKey>,
|
selected: Option<PanelE2eRowKey>,
|
||||||
rows: Vec<PanelE2eRenderedRow>,
|
rows: Vec<PanelE2eRenderedRow>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
fn panel_e2e_row_key(key: &PanelRowKey) -> PanelE2eRowKey {
|
fn panel_e2e_row_key(key: &PanelRowKey) -> PanelE2eRowKey {
|
||||||
match key {
|
match key {
|
||||||
PanelRowKey::Ticket(id) => PanelE2eRowKey {
|
PanelRowKey::Ticket(id) => PanelE2eRowKey {
|
||||||
|
|
@ -841,6 +859,7 @@ fn panel_e2e_row_key(key: &PanelRowKey) -> PanelE2eRowKey {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
fn panel_e2e_rect(rect: Rect) -> PanelE2eRect {
|
fn panel_e2e_rect(rect: Rect) -> PanelE2eRect {
|
||||||
PanelE2eRect {
|
PanelE2eRect {
|
||||||
x: rect.x,
|
x: rect.x,
|
||||||
|
|
@ -1166,6 +1185,7 @@ impl MultiPodApp {
|
||||||
else {
|
else {
|
||||||
return false;
|
return false;
|
||||||
};
|
};
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::emit(
|
crate::e2e_observer::emit(
|
||||||
"panel",
|
"panel",
|
||||||
"mouse_click",
|
"mouse_click",
|
||||||
|
|
@ -1183,6 +1203,7 @@ impl MultiPodApp {
|
||||||
self.row_hit_boxes = row_hit_boxes(rows, area);
|
self.row_hit_boxes = row_hit_boxes(rows, area);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
fn emit_rows_rendered(&self) {
|
fn emit_rows_rendered(&self) {
|
||||||
let rows = self
|
let rows = self
|
||||||
.row_hit_boxes
|
.row_hit_boxes
|
||||||
|
|
@ -1269,8 +1290,10 @@ impl MultiPodApp {
|
||||||
if let PanelRowKey::Pod(name) = &key {
|
if let PanelRowKey::Pod(name) = &key {
|
||||||
self.list.selected_name = Some(name.clone());
|
self.list.selected_name = Some(name.clone());
|
||||||
}
|
}
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
let selected_key = key.clone();
|
let selected_key = key.clone();
|
||||||
self.selected_row = Some(key);
|
self.selected_row = Some(key);
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::emit(
|
crate::e2e_observer::emit(
|
||||||
"panel",
|
"panel",
|
||||||
"selection_changed",
|
"selection_changed",
|
||||||
|
|
@ -1281,6 +1304,7 @@ impl MultiPodApp {
|
||||||
fn clear_panel_selection(&mut self) {
|
fn clear_panel_selection(&mut self) {
|
||||||
self.selected_row = None;
|
self.selected_row = None;
|
||||||
self.list.selected_name = None;
|
self.list.selected_name = None;
|
||||||
|
#[cfg(feature = "e2e-test")]
|
||||||
crate::e2e_observer::emit(
|
crate::e2e_observer::emit(
|
||||||
"panel",
|
"panel",
|
||||||
"selection_changed",
|
"selection_changed",
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user