Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions qa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ lowercase, and specific, for example `qa/telephony-deeplink/`.

## Pack Structure

| Path | Required | Purpose |
| --- | --- | --- |
| `README.md` | Yes | Entry point, prerequisites, smoke order, result format |
| `flows/` | Yes | One Markdown file per scenario |
| `test-links.html` | When useful | Static browser page for protocol/deep-link/manual click targets |
| `scripts/` | Optional | Small helper scripts for repeatable environment checks |
| `results/` | Optional | Local evidence notes; do not commit run-specific artifacts by default |
| Path | Required | Purpose |
| ----------------- | ----------- | --------------------------------------------------------------------- |
| `README.md` | Yes | Entry point, prerequisites, smoke order, result format |
| `flows/` | Yes | One Markdown file per scenario |
| `test-links.html` | When useful | Static browser page for protocol/deep-link/manual click targets |
| `scripts/` | Optional | Small helper scripts for repeatable environment checks |
| `results/` | Optional | Local evidence notes; do not commit run-specific artifacts by default |

## Flow Files

Expand Down Expand Up @@ -167,3 +167,8 @@ unless a release owner explicitly asks for them.

- `qa/telephony-deeplink/` covers telephony `tel:` / `callto:` links, settings,
diagnostics, workspace selection, default handlers, and installer policy.
- `qa/supported-versions/` covers supported-version exception matching and the
unsupported-version block.
- `qa/macos-fullscreen-escape/` covers the macOS native fullscreen behavior of the
Escape key, including video HTML5 fullscreen, and the Windows/Linux regression
check.
63 changes: 63 additions & 0 deletions qa/macos-fullscreen-escape/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# macOS Fullscreen Escape QA Pack

This folder contains manual and agent-readable QA flows for the macOS native
fullscreen behavior of the Escape key. It covers the case where the app window is
in native fullscreen and the Escape key must not drop the window out of
fullscreen, whether or not a video is playing in HTML5 fullscreen.

This behavior cannot be proven by the Jest suite. The bug lives in how macOS
AppKit reacts to a real key event coming from the operating system, and any test
generated key event is synthetic and never reaches AppKit. Automated tests only
protect the desktop-side wiring, so these flows are the coverage for the OS half
and must be run on real macOS hardware.

The flows are intentionally written for testers without implementation context.

## Quick Start

From the repo root:

```sh
node qa/scripts/validate-flows.mjs qa/macos-fullscreen-escape
node qa/scripts/export-qase-csv.mjs qa/macos-fullscreen-escape
```
Comment on lines +16 to +23

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add explicit prerequisites to the pack README.

List the required setup for an installed branch build, a logged-in workspace, a local video file, and network access for the embedded-player case. Do not require testers to infer these prerequisites from individual flows.

As per coding guidelines, each QA pack README.md must include prerequisites, smoke order, evidence format, and a folder map.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@qa/macos-fullscreen-escape/README.md` around lines 16 - 23, Update the
macos-fullscreen-escape pack README to add an explicit prerequisites section
covering an installed branch build, a logged-in workspace, a local video file,
and network access for the embedded-player case. Ensure the README also includes
the required smoke order, evidence format, and folder map alongside the existing
Quick Start instructions.

Source: Coding guidelines


## Smoke Order

1. Run `flows/01-video-fullscreen-escape.md`.
2. Run `flows/02-plain-escape-keeps-fullscreen.md`.
3. Run `flows/03-escape-and-shortcut-regressions.md`.
4. Run `flows/04-windows-linux-escape-unchanged.md` on Windows and Linux.

## Flow Result Format

```text
Flow ID:
Platform:
Build:
Review range:
Coverage: Full requested range | Partial surface review
Result: Pass | Fail | Blocked
Finding status: confirmed | suspected | blocked | none
Evidence:
Notes:
```

## Folder Map

| Path | Purpose |
| ---------- | ----------------------------------------------------------------- |
| `flows/` | Structured QA flows |
| `exports/` | Generated Qase CSV exports |
| `results/` | Optional local evidence area; do not commit run-specific evidence |

## Source Of Truth

When updating this pack, derive expected behavior from:

- `src/ui/main/escapeFullscreenGuard.ts`
- `src/ui/main/escapeFullscreenGuard.main.spec.ts`
- `src/ui/main/serverView/index.ts` (`before-input-event` handling for guest views)
- `src/ui/main/rootWindow.ts` (`before-input-event` handling for the app chrome)
- `src/ui/main/menuBar.ts` (macOS `Full screen` item, `Control+Command+F`)
- `src/ui/components/TabBar/styles.tsx` (`TrafficLightSpacer` collapses in fullscreen)
15 changes: 15 additions & 0 deletions qa/macos-fullscreen-escape/exports/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Qase Exports

This directory is for generated Qase import files.

Run:

```sh
node qa/scripts/export-qase-csv.mjs qa/macos-fullscreen-escape
```

The script writes `qase-import.csv`. Import it in Qase with source type
`Qase.io`.

Do not hand-edit generated CSV files. Edit the Markdown flows, validate them,
and export again.
Loading
Loading