Stage 1 review fixes, and Stage 2: the broker, the CLI and the module

The Stage 1 review (docs/reviews/2026-10-04-stage1-review.md, verdict
yes-with-fixes) found a real bug, and it was the kind Stage 2 would have
cemented. All five findings:

(1) HIGH, and reproduced before fixing: `key` resolved the action and
    then used only its `code`. So `keyboard key A` sent a bare code 30
    and the window received `a`; on `de`, `at` lost its level-three mask
    and typed `q`. `type` was the only path that used the mask, which is
    why every `type` test stayed green. `key` now sends
    modifiers(baseline | mask) before the down and restores the baseline
    on the up -- the one-character `type` sequence -- and `Shift_L`
    keeps its key-then-mask order, which is the other path on purpose.

    The same hole aliased two names onto one keycode: `down A` then
    `down a` recorded both and pressed 30 twice, Hyprland dropped the
    second, and the held set lied until the lease ended. A second name
    for a code already down is now refused.

(2) HIGH: the shutdown comment claimed hyprland-conf.nix sets
    input:virtualkeyboard:release_pressed_on_close. It did not. The line
    is there now, with the note that it releases keys and still never
    clears a mask -- which is why release_all zeroes the mask on every
    path we control rather than relying on it.

(3) MEDIUM: nothing would have noticed the keymap upload stopping. A
    `main` that connected and listened without uploading passed every
    test in the tree. Now asserted on the real sink: uploaded once,
    before `listen` (one shared ordering log across both stand-ins), the
    payload NUL-terminated with `size == len(utf8) + 1` read back
    through the fd, format 1, one terminator not two, and modifiers(0)
    straight after.

(4) LOW: `key` up now forgets the name only after a successful send,
    like `button` -- otherwise a raise between the two leaves us
    believing a key is up that the compositor still has down, and
    release_all will not try again.

(5) LOW: `\r` no longer aliases to Return (CRLF would have become two
    newlines silently), and an empty layout is refused -- xkbcommon
    compiles "" as the same keymap as `us`, so `--xkb-layout ''` looked
    configured and typed `us`.

Several of the review's named false passes are closed too: Control's
mask is compared against mod_get_index("Control") rather than merely
"not Shift's"; the keymap text assertion names pc_us_inet/pc_de_inet
instead of substring-matching "us"; the capital-under-Control case
asserts the whole sequence; the exit-code mirror is compared against
hhstreamd.protocol; and the module's defaults are read out of
nix/module.nix rather than asserted against themselves.

Stage 2 proper:

  * broker verbs keyboard.key / keyboard.type, both in the mutation set,
    both through _refresh (so they refresh the lease and, like every
    pointer verb, do NOT count as activity)
  * the driver's `kind` token mapped: a bad keysym or character is
    invalid_argument (exit 2), a missing keyboard global stays
    driver_refused (exit 10). The 4096-scalar cap and the shape checks
    are broker-side, because only a broker-side invalid_argument is 2
  * keys[] on pointer.state, keys_lifted[] on pointer.release and on
    pointer_lease_timeout, one release_all for both halves
  * CLI `session keyboard type|key|down|up`, reusing the pointer lease
    and its cache; `type` takes one raw argument and interprets nothing;
    the audit records a character count and never the text
  * sessions.keyboard.{layout,model,variant,options} on the unit's argv,
    layout defaulting to "us" with a type that refuses a comma. NO
    [keyboard] TOML table: hhstreamd reads that file and the driver is a
    different unit, so it would be a setting with no effect
  * CONTRACT-sessions.md bumped to v3; README.dev.md item 3 and
    vm-pointer.nix's header corrected (both still said the conf ships
    follow_mouse = 0 and that the keyboard work would choose)

And the operator decision that acquire grabs both devices: it now sends
two warps a real pixel apart, because one warp onto an idle cursor moves
the cursor and not keyboard focus. follow_mouse_threshold = 0 is set
explicitly in hyprland-conf.nix since the second warp depends on it,
`dispatch focuswindow` is the fallback when the nudge cannot be sent,
and the reply and audit carry which mechanism ran. The acquire test
asserts the pair and that they floor to different pixels -- a test that
only saw wl_pointer.enter would pass while the first keystroke went to
the wrong window.

  nix develop -c python -m pytest tests/pointer tests/sessions/unit -q
  605 passed in 27.11s

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GhNPM6rGcuzxocM1nATnuM
This commit is contained in:
HermenixandClaude Opus 5 committed 2026-10-04 04:11:24 +00:00
1 parent b1f2744cf0
commit e6f4c3bb3f
24 files changed
+2474 -105

No files matched your search

+70
View File
@@ -105,12 +105,82 @@ def test_every_verb_the_contract_names_is_registered(host_cli):
["session", "pointer", "release", "foo-aaaaaa"],
["session", "pointer", "state"],
["session", "pointer", "state", "--json"],
["session", "keyboard", "type", "foo-aaaaaa", "hello"],
["session", "keyboard", "type", "foo-aaaaaa", "hello", "--lease", "abc"],
["session", "keyboard", "key", "foo-aaaaaa", "Return"],
["session", "keyboard", "down", "foo-aaaaaa", "Control_L"],
["session", "keyboard", "up", "foo-aaaaaa", "Control_L"],
]
for argv in surface:
args = host_cli.parse_args(argv)
assert callable(args.func), argv
def test_the_keyboard_help_says_the_pointer_lease_is_required(host_cli, capsys):
"""Exit 9 until `pointer acquire` is the one fact an agent gets wrong here.
Asserted on the `keyboard` group's own help and on a leaf's, because
`--help` on a leaf is what an agent actually reads -- and the group help is
what a human skims.
"""
for argv in (["session", "keyboard", "--help"], ["session", "keyboard", "type", "--help"]):
with pytest.raises(SystemExit):
host_cli.parse_args(argv)
out = capsys.readouterr().out
assert "pointer acquire" in out
assert "9" in out, "the exit code an agent has to branch on"
def test_the_keyboard_help_warns_that_a_held_key_floods(host_cli, capsys):
"""Unconditionally, and not because a probe saw repeats on the wire.
It did not: the compositor sends one event and the application repeats, so
the flood is real and is not ours to rate-limit.
"""
with pytest.raises(SystemExit):
host_cli.parse_args(["session", "keyboard", "down", "--help"])
out = capsys.readouterr().out.lower()
assert "flood" in out
def test_the_pointer_help_does_not_grow_a_keyboard_tutorial(host_cli, capsys):
"""`pointer --help` stays about the cursor.
Narrow on purpose: `acquire`'s *stderr* had to start mentioning keyboard
verbs (they refresh the lease), so a test that grepped the whole binary's
help for the word would pass for the wrong reason. This reads the pointer
group's description only.
"""
with pytest.raises(SystemExit):
host_cli.parse_args(["session", "pointer", "--help"])
out = capsys.readouterr().out
assert "keysym" not in out
assert "keyboard type" not in out
def test_type_takes_its_text_as_one_argument_and_does_not_interpret_it(host_cli):
r"""A newline is a newline; a backslash-n is a backslash and an n.
Interpreting escapes here would make a literal backslash-n untypeable,
and the shell has already done the quoting.
"""
# A real newline survives as a real newline.
args = host_cli.parse_args(["session", "keyboard", "type", "foo-aaaaaa", "a\nb"])
assert args.text == "a\nb"
assert len(args.text) == 3
# And a backslash followed by an n stays two characters: interpreting it
# would make a literal backslash-n untypeable.
args = host_cli.parse_args(["session", "keyboard", "type", "foo-aaaaaa", r"a\nb"])
assert args.text == r"a\nb"
assert len(args.text) == 4
assert "\n" not in args.text
def test_a_move_needs_exactly_one_target(host_cli):
with pytest.raises(SystemExit):
host_cli.parse_args(["session", "pointer", "move", "x"])