Skip to content

refactor(hooks): flatten the hook execution call chain - #3036

Merged
max-sixty merged 1 commit into
mainfrom
flatten-hook-call-chain
Jun 11, 2026
Merged

max-sixty merged 1 commit into
mainfrom
flatten-hook-call-chain

Conversation

@max-sixty

Copy link
Copy Markdown
Owner

A foreground hook run previously passed through four delegation layers (execute_hook → run_hooks_foreground → prepare_and_check → prepare_sourced_steps), with a HookCommandSpec parameter bundle (four lifetime params, constructed in five places, immediately destructured by its consumers), a trivial lookup_hook_configs tuple builder, and a BackgroundPipeline 4-tuple packed and unpacked at every use. This collapses the layering without changing behavior. Net −173 lines.

Foreground path is now execute_hook → run_hooks_foreground → prepare_and_check (the work):

  • prepare_sourced_steps merged into prepare_and_check, which takes explicit parameters; HookCommandSpec is gone. check_name_filter_matched + count_sourced_commands collapsed into a no_matching_commands_error builder: the zero-match condition is !name_filters.is_empty() && result.is_empty(), equivalent because every step surviving the filter keeps at least one command. The dry-run branch of wt hook still shares prepare_and_check, so the "no commands matched" error stays in one place.
  • run_hooks_foreground computes pre_hook_display_path(ctx.worktree_path) internally; every caller passed exactly that expression. That drops display_path from execute_hook (and its three call sites) and deletes run_filtered_hook, which had become a 1:1 forward. Plan-backed hooks (execute_planned_hook) keep their explicit display_path since the remove path genuinely varies between pre/post display logic.

Background path: PendingPipeline (the existing owned struct) is the carrier from registration to spawn. HookAnnouncer::extend becomes add_groups, prepare_background_pipelines inlines into register, and flush no longer rebuilds CommandContexts (spawning needs only repo/path/branch), which makes the announcer's config field dead; HookAnnouncer::new loses that parameter at its nine call sites. lookup_hook_configs is inlined at all seven sites as the two direct .get() expressions.

hook_plan.rs changes are mechanical (import cleanup, inlined lookup, add_groups); the ApprovedHookPlan freezing structure is untouched. Adjacent cleanups: a redundant UserConfig::load() in main.rs's squash arm (handle_squash loads it itself with the identical error context) and a dead emptiness check in run_post_hook's filter path (a filter matching nothing errors in prepare_and_check; prepare_and_check's doc now records that add_groups relies on this).

Covered by the existing suite (3916 tests, no snapshot changes, confirming announcements/errors/hints render identically). No new tests: the refactor adds no behavior.

This was written by Claude Code on behalf of max

A foreground hook run previously passed through four delegation layers
(execute_hook -> run_hooks_foreground -> prepare_and_check ->
prepare_sourced_steps), each doing little independent work. Collapse the
layering:

- Merge prepare_sourced_steps into prepare_and_check (explicit params)
  and delete the HookCommandSpec parameter bundle; collapse
  check_name_filter_matched + count_sourced_commands into a
  no_matching_commands_error builder (an empty result under a non-empty
  filter is the zero-match condition, since every surviving step keeps
  at least one command).
- run_hooks_foreground computes pre_hook_display_path internally (all
  callers passed exactly that expression), dropping display_path from
  execute_hook and deleting the run_filtered_hook 1:1 forward.
- Replace the BackgroundPipeline 4-tuple with PendingPipeline end-to-end:
  HookAnnouncer::extend becomes add_groups, prepare_background_pipelines
  inlines into register, and flush no longer rebuilds CommandContexts,
  removing the announcer's config field and its constructor param.
- Inline lookup_hook_configs at all seven call sites.

Adjacent cleanups: a redundant UserConfig::load() in main.rs's squash
arm (handle_squash loads it itself with the same error context) and a
dead emptiness check in run_post_hook's filter path (a filter matching
nothing errors in prepare_and_check).

Behavior is unchanged: snapshot-tested announcements, errors, and hints
all render identically.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

@worktrunk-bot worktrunk-bot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Reviewed as a behavior-preserving refactor and traced the non-obvious collapses — all hold:

  • The new name-filter check (!name_filters.is_empty() && result.is_empty()) is equivalent to the old count_sourced_commands == 0: filter_step_by_name never returns an empty step, and a non-empty name_filters always yields non-empty parsed_filters, so every surviving step keeps ≥1 command.
  • run_hooks_foreground computing pre_hook_display_path(ctx.worktree_path) internally matches every former caller — the three execute_hook sites (commit self.ctx, squash &ctx, switch &pre_ctx) and both run_filtered_hook sites passed exactly that expression against the same ctx.
  • Background path: pipeline.branch.as_deref().unwrap_or("HEAD") matches CommandContext::branch_or_head, and the dropped config field was unused on the spawn path.
  • run_hooks_background losing its defensive filter(|steps| !steps.is_empty()) is safe: into_source_groups never produces an empty group, and run_post_hook's vec![flat] has flat guaranteed non-empty by the filter error — the debug_assert! in add_groups backstops the invariant.

Not auto-approving: per worktrunk's data-safety review policy, this diff edits files on the deletion surface — step/prune.rs::try_remove, main.rs::handle_remove_command, and picker/mod.rs's removal path. The edits are confined to the HookAnnouncer::new signature change and leave the removal logic untouched, so I don't see a behavior risk — but the call on the removal surface is yours to make.

@max-sixty
max-sixty merged commit a95d170 into main Jun 11, 2026
36 checks passed
@max-sixty
max-sixty deleted the flatten-hook-call-chain branch June 11, 2026 15:10
social4hyq pushed a commit to social4hyq/homebrew-core that referenced this pull request Sep 20, 2026
worktrunk 0.58.0

Created-by: HarmonybrewBot
Commit-by: HarmonybrewBot
Merged-by: HarmonybrewBot
Description: Created by `brew bump`

---

Created with `brew bump-formula-pr`.<details>
  <summary>release notes</summary>
  <pre>## Release Notes

### Improved

- **Table-form `pre-*` hooks run concurrently**: A multi-entry table hook (`[pre-merge]` with several keys) now runs its commands concurrently, completing the cut-over announced in v0.37.0: every hook type has one execution semantic, where table form is concurrent and pipeline form (`[[pre-merge]]` blocks) is serial. Configs that need ordering should use pipeline form; affected configs have warned on every invocation since v0.37.0, with `wt config update` offering a serial-preserving migration. Two adjacent inconsistencies are also gone: `wt hook <post-type>` foreground runs of multi-entry table hooks now run concurrently like their background counterpart, and single-entry table aliases write to stdout like the other alias spellings, so `wt <alias> | …` works for that spelling too. (Breaking: multi-entry table-form `pre-*` hooks no longer run serially) ([#3052](max-sixty/worktrunk#3052))

- **CI column shows the PR/MR number and review state**: The CI column in `wt list --full` and the statusline shows the branch's open PR/MR reference (`#3041` on GitHub/Gitea/Azure DevOps, `!3041` on GitLab) instead of a plain dot: colored by CI status, hyperlinked to the PR, dimmed when stale or draft. Review state folds into the color, with magenta for changes requested and cyan for awaiting review. `wt list --format=json` gains `ci.number` and `ci.review_state`. ([#3041](max-sixty/worktrunk#3041), [#3044](max-sixty/worktrunk#3044))

- **Hook and alias templates render when each step runs**: Templates are syntax-checked before the first step runs and rendered as each step executes, so `{{ vars.* }}` always reads fresh values and hooks and aliases share one expansion model. Two consequences: a pipeline step with an undefined variable fails when that step is reached (earlier steps run first), and a template error in a background hook surfaces in the hook log rather than failing the foreground command. The background runner also labels template errors the way the foreground does. ([#3042](max-sixty/worktrunk#3042), [#3047](max-sixty/worktrunk#3047))

- **`wt config state cache`**: The regenerable caches (CI status, branch summaries, git-command caches, hints, the `wt switch -` target) are consolidated under `wt config state cache`; `cache clear` drops them all without prompting, since everything regenerates. `wt config state clear`, which also wipes hand-authored markers and vars, now asks for confirmation; `--yes` skips, and non-interactive runs without `--yes` cancel. The `ci-status`, `hints`, and `previous-branch` subcommands are deprecated but still work. ([#3027](max-sixty/worktrunk#3027))

- **Statusline rate-limit segment**: Above 90% of the binding window the segment shows the used percentage (`95%(8:30am–1:30pm)`) instead of the pace ratio; near the cap, what's left matters more than the rate. The pace form drops the word "pace" (`2.9×(Tue–Tue 5pm)`), and `-vv` logs each window's inputs and selection to `.git/wt/logs/trace.log` so the binding-window choice can be reconstructed. ([#3057](max-sixty/worktrunk#3057), [#3053](max-sixty/worktrunk#3053), [#3029](max-sixty/worktrunk#3029))

- **`/wt-switch-create` branch name is optional**: The Claude Code plugin command picks a branch name from the task when none is given, and the skill's workflow is one route (create, then enter) with an error-driven fallback instead of three guarded paths. Worktrees created mid-session persist after the session ends. ([#3058](max-sixty/worktrunk#3058))

### Fixed

- **Plugin worktree hooks fail before side effects**: The Claude Code plugin's `WorktreeCreate`/`WorktreeRemove` hooks validate the payload before running `wt`; a malformed payload previously created a branch named `null` or could remove the wrong worktree. `wt remove`'s help now documents that the positional argument accepts a worktree path as well as a branch name. ([#3058](max-sixty/worktrunk#3058), [#3060](max-sixty/worktrunk#3060))

- **Waiting-for-input marker covers questions, permission prompts, and turn end**: The Claude Code plugin sets the 💬 marker on `AskUserQuestion`, permission requests, and turn end. Previously only the `Notification` event set it, which never fires for the built-in question picker (and on some platforms not for permission prompts), so the marker stayed 🤖 while Claude waited. Part of [#2916](max-sixty/worktrunk#2916). ([#3023](max-sixty/worktrunk#3023), thanks @Ismael for reporting)

- **`wt list --help` no longer panics when piped**: With no detectable terminal width (output piped, `COLUMNS` unset), `wt list --help` panicked with a capacity overflow, and the post-commit diffstat truncated filenames to ~10 characters. Both now handle unknown width. ([#3040](max-sixty/worktrunk#3040))

- **Deprecation warnings match `wt config update`**: A config deprecation warning now fires exactly when `wt config update` would change the file. The old detection and migration logic had drifted in several places: `ff` and `no-ff` together silently dropped `no-ff`, a scalar `forge` key was overwritten by the `[ci]` migration, an empty `[ci] platform` migrated without warning, and an empty `approved-commands = []` could be removed by an unrelated update. ([#3055](max-sixty/worktrunk#3055))

- **Migrated `[forge]` keeps `[ci]`'s spot**: The `[ci]` → `[forge]` migration rendered the new section at the end of the file and could drop comments above `[ci]`; it now takes over `[ci]`'s position, comments included, so `wt config show` and `wt config update` diffs stay minimal. ([#3051](max-sixty/worktrunk#3051))

- **`wt config state get` is read-only**: The aggregate dump resolved (and re-cached) the default branch, so running it right after `clear` silently repopulated the cache, and on a cold clone it could hit the network. It now reports the cached value or `(none)`. `wt config state default-branch get` still resolves and caches. ([#3024](max-sixty/worktrunk#3024))

### Documentation

- **Reading vs resolving cached state**: `wt config state default-branch get` resolves and caches; the aggregate `wt config state get` only reports the cache. The help text and module docs now state the split. ([#3028](max-sixty/worktrunk#3028))

### Internal

- `wt switch`/`wt remove` orchestration moved from `main.rs` to their command modules, and the hook execution call chain lost two delegation layers. ([#3049](max-sixty/worktrunk#3049), [#3036](max-sixty/worktrunk#3036))

- Config deprecations are driven by a single rule table; each rule is one function that migrates and reports what it changed. ([#3045](max-sixty/worktrunk#3045), [#3055](max-sixty/worktrunk#3055))

- `terminal_width()` returns `Option<usize>` instead of a `usize::MAX` sentinel, making the no-width case a compile-time concern. ([#3043](max-sixty/worktrunk#3043))

- Snapshot tests regenerate identically across machines: host-specific paths are guarded, host-dependent env-block markers are normalized, and help snapshots share one settings builder. ([#3009](max-sixty/worktrunk#3009), [#3026](max-sixty/worktrunk#3026), [#3037](max-sixty/worktrunk#3037), [#3061](max-sixty/worktrunk#3061))

- Nightly CI runs lib tests across the full feature powerset. ([#3059](max-sixty/worktrunk#3059))

- MSRV bumped from 1.94 to 1.95. ([#2948](max-sixty/worktrunk#2948))

## Install worktrunk 0.58.0

### Install prebuilt binaries via shell script

```sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/max-sixty/worktrunk/releases/download/v0.58.0/worktrunk-installer.sh | sh && wt config shell install
```

### Install prebuilt binaries via powershell script

```sh
powershell -ExecutionPolicy Bypass -c "irm https://github.com/max-sixty/worktrunk/releases/download/v0.58.0/worktrunk-installer.ps1 | iex"; git-wt config shell install
```

### Install prebuilt binaries via Homebrew

```sh
brew install worktrunk && wt config shell install
```

## Download worktrunk 0.58.0

|  File  | Platform | Checksum |
|--------|----------|----------|
| [worktrunk-aarch64-apple-darwin.tar.xz](https://github.com/max-sixty/worktrunk/releases/download/v0.58.0/worktrunk-aarch64-apple-darwin.tar.xz) | Apple Silicon macOS | [checksum](https://github.com/max-sixty/worktrunk/releases/download/v0.58.0/worktrunk-aarch64-apple-darwin.tar.xz.sha256) |
| [worktrunk-x86_64-apple-darwin.tar.xz](https://github.com/max-sixty/worktrunk/releases/download/v0.58.0/worktrunk-x86_64-apple-darwin.tar.xz) | Intel macOS | [checksum](https://github.com/max-sixty/worktrunk/releases/download/v0.58.0/worktrunk-x86_64-apple-darwin.tar.xz.sha256) |
| [worktrunk-x86_64-pc-windows-msvc.zip](https://github.com/max-sixty/worktrunk/releases/download/v0.58.0/worktrunk-x86_64-pc-windows-msvc.zip) | x64 Windows | [checksum](https://github.com/max-sixty/worktrunk/releases/download/v0.58.0/worktrunk-x86_64-pc-windows-msvc.zip.sha256) |
| [worktrunk-aarch64-unknown-linux-musl.tar.xz](https://github.com/max-sixty/worktrunk/releases/download/v0.58.0/worktrunk-aarch64-unknown-linux-musl.tar.xz) | ARM64 MUSL Linux | [checksum](https://github.com/max-sixty/worktrunk/releases/download/v0.58.0/worktrunk-aarch64-unknown-linux-musl.tar.xz.sha256) |

See merge request: Harmonybrew/homebrew-core!11501
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants