feat(rust): extract reusable terminal-UI primitives into mergify-tui#1379
Conversation
Member
Author
|
This pull request is part of a Mergify stack:
|
This was referenced May 6, 2026
Contributor
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🔴 ⛓️ Depends-On RequirementsWaiting for
This rule is failing.Requirement based on the presence of
🔴 👀 Review RequirementsWaiting for
This rule is failing.
🔴 🔎 ReviewsWaiting for
This rule is failing.
🟢 🤖 Continuous IntegrationWonderful, this rule succeeded.
🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 📕 PR descriptionWonderful, this rule succeeded.
|
bd4d24c to
3697e5a
Compare
Member
Author
Revision history
|
Two queue commands in one PR — both are idempotent one-shot API
calls that share the same auth + repository resolution. Pause
exercises the new PUT method; unpause exercises the new
DELETE-with-status-check method.
PUTs ``{"reason": "..."}`` to
``/v1/repos/<repo>/merge-queue/pause``, prints a confirmation line
with the reason and timestamp.
Safety rails match Python:
- ``--yes-i-am-sure`` skips confirmation outright.
- Interactive (TTY): prompts "Proceed? [y/N]". Anything other than
``y``/``yes`` aborts as a generic error.
- Non-interactive without the flag: refuses with INVALID_STATE
(exit 7), matching Python's
``raise SystemExit(ExitCode.INVALID_STATE)``.
``--reason`` has a 255-char cap enforced by clap's ``value_parser``
— bad input exits 2.
DELETEs the same path. On 404 the API is telling us the queue
wasn't paused, so the command prints "Queue is not currently
paused" and exits MERGIFY_API_ERROR (matches Python). On 2xx it
prints "Queue resumed." and exits 0.
Two new methods on ``mergify_core::HttpClient``:
- ``put<B, T>(path, body) -> Result<T, CliError>`` — mirror of
``post``, different verb.
- ``delete_if_exists(path) -> Result<DeleteOutcome, CliError>`` —
returns ``Deleted`` on 2xx, ``NotFound`` on 404, errors on any
other non-success status. Lets commands like ``unpause`` give
a friendlier 404 message without parsing error strings.
Auth resolution (token / api-url / repository) goes through the
shared ``mergify_core::auth`` module added earlier in the stack —
no per-crate copy of the resolvers in ``mergify-queue``.
5 new unit tests in the queue crate:
- ``parse_reason`` accepts short strings and rejects > 255 chars
- ``run`` pauses and prints the API-returned reason + timestamp
- ``run`` prints "Queue resumed" on 2xx
- ``run`` errors with MERGIFY_API_ERROR on 404 carrying the
"not currently paused" message
End-to-end smoke tested three paths:
``queue pause --reason X -r owner/repo`` → exit 8 (missing token),
``queue unpause -r owner/repo`` → exit 8 (missing token),
``echo n | queue pause --reason X`` → exit 7 (non-TTY, no --sure).
The Python ``queue pause`` / ``queue unpause`` implementations and
their tests are removed in the same PR — the Rust binary now owns
both commands end-to-end. Binary: 8.4 MB → 8.5 MB. 56 Rust tests.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Change-Id: Idba6fa38caf403fd5f4184cda462b5f7c1eb3ebf
Adds `github_event` (GitHub Actions event payload deserialization) and `queue_metadata` (MQ YAML fenced-block extraction) shared modules to the mergify-ci crate, and ports two commands on top of them: - `ci queue-info` — prints MQ batch metadata as pretty JSON; errors INVALID_STATE (exit 7) outside an MQ context. Appends to `$GITHUB_OUTPUT` with the same `ghadelimiter_<uuid>` heredoc the Python version uses. - `ci git-refs` — detects base/head refs from Buildkite env, GitHub event payload, `refs/notes/mergify/<branch>` git notes, MQ PR body, or falls back to `HEAD^..HEAD`. Supports `text`/`shell`/`json` output formats, writes `base`/`head` to `$GITHUB_OUTPUT`, and calls `buildkite-agent meta-data set` when `BUILDKITE=true`. The notes reader is injected as a trait-object callback so unit tests can exercise the note-driven detection path without touching a real git repository; the production path shells out via `real_notes_reader`. The Python implementations of `ci git-refs` and `ci queue-info` are removed in the same PR — the Rust binary now owns both commands end-to-end. The looks-native heuristic in `main.rs` learns the two new subcommand names so argv errors surface as clap exit 2 instead of silently falling through to the Python shim. Adds `serde_yaml_ng` (YAML parser) and `uuid` (ghadelimiter) deps to the mergify-ci crate. Binary grows ~100KB to 8.6MB. 19 new Rust tests (8 event/metadata, 3 queue-info, 12 git-refs + 2 format round-trips merged in). Full workspace: 79 tests green, compat harness 4/4. Change-Id: I8d3f96e6cb4eb51e6cd195951b3e622cee7efdd4
The Rust binary now serves ``mergify queue status`` natively. The Python implementation (``mergify_cli/queue/cli.py:status`` plus the batch/scope/topology helpers it depended on) is removed in the same PR — the port-and-delete rule we adopted in #1322 keeps a single live copy of every command. ``mergify queue status [-r REPO] [-t TOKEN] [-u URL] [-b BRANCH] [--json]``: 1. Resolves repository / token / API URL via the shared ``mergify_queue::auth`` resolver introduced in #1352. 2. Fetches ``GET /v1/repos/<repo>/merge-queue/status``, optionally with ``?branch=<branch>`` (URL-encoded via ``url::form_urlencoded::byte_serialize``). 3. With ``--json``: pretty-prints the raw response. The schema is Mergify's API contract, not this CLI's, so we deserialize into ``serde_json::Value`` and emit verbatim — unknown fields and future schema additions survive the round trip. 4. Without ``--json``: deserializes into a typed ``StatusView`` that uses ``#[serde(default)] Option<…>`` for every field the Mergify API has historically treated as optional/nullable (matches the port checklist from #1357), then renders a header, an optional pause indicator, the batch tree (grouped by scope when there is more than one), and the waiting-PR list. Status icons (``● ◑ ◌ ✓ ✗ ◎ ⏳ ↻ ⏰ ❄``) and relative times (``5m ago`` / ``~1h``) match the Python implementation. Python used Rich's ``Tree`` for batches. The Rust port emits flat indented text instead — same data, simpler rendering. Both are line-oriented and round-trip cleanly through pipes; the fancy box-drawing was visual sugar that didn't survive piping anyway. - ``build_path`` covers no-branch, branch, and URL-encoding of a branch name with slashes + spaces (e.g. ``feature/foo bar`` becomes ``feature%2Ffoo+bar`` in the query). - ``relative_time`` covers seconds / minutes / hours / days, future prefix, and graceful empty-string return on a malformed timestamp (matches Python's "degrade rather than fail"). - ``topological_sort`` covers parents-before-children ordering and tolerance of ``parent_ids`` that reference missing batches. - ``group_by_scope`` covers the ``[]`` → ``"default"`` fallback and multi-scope batches appearing under each scope they claim. - ``status_icon`` covers known + unknown codes. - End-to-end wiremock tests: empty queue, paused queue, batches + waiting PRs, multi-scope grouping, ``?branch=…`` query threading, JSON-passthrough preserving an ``extra_field``, and tolerance of a response that omits all optional fields. - ``crates/mergify-queue/Cargo.toml``: adds ``chrono`` (relative time math), ``indexmap`` (scope groups in insertion order), promotes ``serde_json`` from dev to runtime (used for the ``serde_json::Value`` passthrough). - ``crates/mergify-cli/src/main.rs``: registers the ``status`` subcommand under ``QueueSubcommand``, threads the ``--branch``/``--json`` flags, dispatches to ``mergify_queue::status::run``. Adds ``status`` to ``looks_native``. - ``mergify_cli/queue/api.py``: removes ``QueueStatusResponse``, ``QueueBatch``, ``QueuePause``, ``QueueChecksSummary``, ``QueueBatchStatus``, ``QueuePullRequest``, ``QueuePullRequestAuthor``, and ``get_queue_status`` — all now Rust-native. ``QueuePullResponse`` and friends stay for the still-shimmed ``queue show`` (next phase). - ``mergify_cli/queue/cli.py``: removes the ``@queue.command status`` block and the helpers it owned (``STATUS_STYLES``, ``_status_text``, ``_batch_label``, ``_pr_label``, ``_topological_sort``, ``_group_batches_by_scope``, ``_print_batches``, ``_print_waiting_prs``). ``_relative_time`` stays — ``show`` still uses it. - ``mergify_cli/tests/queue/test_cli.py``: deletes ``TestStatusCommand``, ``TestTopologicalSort``, and the ``_invoke_status`` helper. ``TestRelativeTime`` stays. Workspace: 138 Rust tests green, 590 Python tests green. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Change-Id: I8cebcd325f05173dfa41083da2ec6516a6ec3a3f
Reviewer feedback (#1352): hardcoding the set of Rust-native queue subcommands in ``mergify_cli/tests/queue/test_skill.py`` made the skill-reference validation drift-prone — a port PR that forgot to update ``NATIVE_QUEUE_COMMANDS`` would silently pass even though the skill was referencing a command the binary couldn't handle. Two changes make the binary the single source of truth: 1. ``crates/mergify-cli/src/main.rs`` factors the ``(group, subcommand)`` pairs into a top-level ``NATIVE_COMMANDS`` const. ``looks_native`` iterates that const instead of a `match` arm. A new hidden flag ``--list-native-commands`` (intercepted before clap or the shim) prints one ``<group> <subcommand>`` pair per line and exits ``0``. 2. ``test_skill.py`` queries the installed ``mergify`` binary via ``subprocess.run([…, "--list-native-commands"])`` to discover the native set, replacing the ``NATIVE_QUEUE_COMMANDS`` frozenset. The test skips cleanly when the binary isn't on ``PATH`` (rare; ``uv run pytest`` installs it first). The result: the next port PR adds an entry to ``NATIVE_COMMANDS`` in main.rs as part of its normal wiring, and ``test_skill.py`` picks it up automatically. No parallel list to maintain. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Change-Id: I74502fe8affcc58f26eaaa9d058668eb36fec83b
Reviewer feedback: the colored-tree rendering helpers in ``crates/mergify-queue/src/status.rs`` (Theme + relative-time formatter + box-drawing characters) are general-purpose and will be needed by every command with structured human-readable output (``queue show``, ``freeze list``, future ports). Centralize them in a new ``mergify-tui`` crate so each port consumes the same primitives instead of forking its own copy. The new crate has three modules: - ``theme``: ``Theme`` struct with TTY/``NO_COLOR``-aware enable/disable. Pre-built named styles (``bold``, ``dim``, ``cyan``/``green``/``red``/``yellow``/``magenta``, ``warn``) plus a ``fg(AnsiColor)`` helper for domain-specific palettes. ``Theme::detect`` is the production constructor; ``Theme::new(enabled)`` is for tests that need to exercise the styled or plain branch deterministically. - ``time``: ``relative_time(iso, now, future)`` — coarse ``Ns``/``Nm``/``Nh``/``Nd`` formatter mirroring the Python CLI's ``_relative_time``. Empty string on parse failure so a malformed timestamp doesn't abort the surrounding render. - ``tree``: Unicode box-drawing constants (``BRANCH``, ``LAST_BRANCH``, ``CONTINUATION``, ``LAST_CONTINUATION``) plus ``branch_chars(is_last)`` to pick both prefixes for a row in one call. ``mergify-queue::status`` is refactored to consume from ``mergify-tui``: the local ``Theme`` struct and ``relative_time`` function are deleted, the inline ``├── ``/``└── ``/``│ ``/ `` `` literals are replaced with ``tree::branch_chars`` calls, and the queue-specific ``batch_status_style`` helper now uses ``Theme::fg`` for its per-status color mapping. Tests: 11 new in ``mergify-tui`` (theme on/off, relative-time units + parse failure + future prefix, tree-character pairing). The 6 ``relative_time_*`` tests in ``mergify-queue`` are removed — their coverage moves with the function. Workspace count: queue 24 (was 30), tui 11. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Change-Id: Ibbdbce1e8272ab6d81b2dc8a194d527dd41d8744
41db42a to
ae15b73
Compare
3697e5a to
9839923
Compare
ae15b73 to
4a7622b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reviewer feedback: the colored-tree rendering helpers in
crates/mergify-queue/src/status.rs(Theme + relative-timeformatter + box-drawing characters) are general-purpose and will
be needed by every command with structured human-readable output
(
queue show,freeze list, future ports). Centralize themin a new
mergify-tuicrate so each port consumes the sameprimitives instead of forking its own copy.
The new crate has three modules:
theme:Themestruct with TTY/NO_COLOR-awareenable/disable. Pre-built named styles (
bold,dim,cyan/green/red/yellow/magenta,warn)plus a
fg(AnsiColor)helper for domain-specific palettes.Theme::detectis the production constructor;Theme::new(enabled)is for tests that need to exercise thestyled or plain branch deterministically.
time:relative_time(iso, now, future)— coarseNs/Nm/Nh/Ndformatter mirroring the PythonCLI's
_relative_time. Empty string on parse failure so amalformed timestamp doesn't abort the surrounding render.
tree: Unicode box-drawing constants (BRANCH,LAST_BRANCH,CONTINUATION,LAST_CONTINUATION) plusbranch_chars(is_last)to pick both prefixes for a row inone call.
mergify-queue::statusis refactored to consume frommergify-tui: the localThemestruct andrelative_timefunction are deleted, the inline
├──/└──/│/literals are replaced withtree::branch_charscalls,and the queue-specific
batch_status_stylehelper now usesTheme::fgfor its per-status color mapping.Tests: 11 new in
mergify-tui(theme on/off, relative-timeunits + parse failure + future prefix, tree-character pairing).
The 6
relative_time_*tests inmergify-queueare removed— their coverage moves with the function. Workspace count: queue
24 (was 30), tui 11.
Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com
Depends-On: #1366