feat(types): add hook contracts and policies - #1153
Open
taltas wants to merge 1 commit into
Open
Conversation
taltas
requested review from
JamesRobert20,
edelauna,
hannesrudolph and
navedmerchant
as code owners
August 5, 2026 06:44
Contributor
📝 WalkthroughWalkthroughAdded hook schemas and public types, phase and tool matching, exit classification, UTF-8-safe output handling, sanitization, top-level exports, hook message support, and comprehensive contract tests. ChangesHook support
Estimated code review effort: 3 (Moderate) | ~25 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This was referenced Aug 5, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with 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.
Inline comments:
In `@packages/types/src/hooks.ts`:
- Around line 261-264: Update sanitizeHookOutput so its non-printable-character
regex excludes the C1 control range U+0080–U+009F while continuing to preserve
valid Unicode characters above it. Add regression coverage verifying that an
8-bit CSI sequence such as \u009b31m is removed from sanitized output.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: ca8ee0f6-9e93-412a-8d18-43342c6d2f93
📒 Files selected for processing (4)
packages/types/src/__tests__/hooks.test.tspackages/types/src/hooks.tspackages/types/src/index.tspackages/types/src/message.ts
Comment on lines
+261
to
+264
| export function sanitizeHookOutput(output: string): string { | ||
| // ANSI control sequences are removed before other non-printable characters. | ||
| // eslint-disable-next-line no-control-regex | ||
| return output.replace(/\u001B\[[0-?]*[ -/]*[@-~]/g, "").replace(/[^\t\n\r\x20-\x7E\u0080-\uFFFF]/g, "") |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Remove C1 control characters from sanitized output.
The second regex preserves U+0080 through U+009F. These are C1 control characters. For example, sanitizeHookOutput("\u009b31mred") retains an 8-bit CSI sequence. Exclude this range and add regression coverage.
Proposed fix
- return output.replace(/\u001B\[[0-?]*[ -/]*[`@-`~]/g, "").replace(/[^\t\n\r\x20-\x7E\u0080-\uFFFF]/g, "")
+ return output.replace(/\u001B\[[0-?]*[ -/]*[`@-`~]/g, "").replace(/[^\t\n\r\x20-\x7E\u00A0-\uFFFF]/g, "")📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| export function sanitizeHookOutput(output: string): string { | |
| // ANSI control sequences are removed before other non-printable characters. | |
| // eslint-disable-next-line no-control-regex | |
| return output.replace(/\u001B\[[0-?]*[ -/]*[@-~]/g, "").replace(/[^\t\n\r\x20-\x7E\u0080-\uFFFF]/g, "") | |
| export function sanitizeHookOutput(output: string): string { | |
| // ANSI control sequences are removed before other non-printable characters. | |
| // eslint-disable-next-line no-control-regex | |
| return output.replace(/\u001B\[[0-?]*[ -/]*[`@-`~]/g, "").replace(/[^\t\n\r\x20-\x7E\u00A0-\uFFFF]/g, "") | |
| } |
🤖 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 `@packages/types/src/hooks.ts` around lines 261 - 264, Update
sanitizeHookOutput so its non-printable-character regex excludes the C1 control
range U+0080–U+009F while continuing to preserve valid Unicode characters above
it. Add regression coverage verifying that an 8-bit CSI sequence such as
\u009b31m is removed from sanitized output.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
github-actions
Bot
added
the
awaiting-review
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
1 participant
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.
Stack
This is 1 of 4 in the Zoo Code hooks MVP stack. Review and merge from the bottom upward. Do not merge a later PR before its predecessor.
mainfm/zoo-hooks-contractsfm/zoo-hooks-settingssessionStartintegrationfm/zoo-hooks-session-startpreToolUse, E2E, and documentationSummary
Define the shared, runtime-validated contract for the hooks MVP without executing hooks or exposing settings yet.
Scope
sessionStartandpreToolUsephases with exact tool-name matching.say: "hook"chat-message data to the shared message contract.@roo-code/types.Data Flow
flowchart LR A[Hook definition] --> B[Schema validation] B --> C{Phase} C -->|sessionStart| D[Lifecycle match] C -->|preToolUse| E[Exact tool-name match] D --> F[Invocation contract] E --> F F --> G[Exit and output policy] G --> H[Structured hook result]Tests
packages/types/src/__tests__/hooks.test.tspnpm --dir src exec eslint --prune-suppressions --max-warnings=0on all subsequently touched core test files, with no suppression-count increase.pnpm test(437 files passed, 7,356 tests passed, 39 skipped).pnpm check-types,pnpm lint, andpnpm buildpassed.USE_MOCK=true TEST_FILE=hooks.test pnpm --filter @roo-code/vscode-e2e test:runpassed.Risks
Review Notes
main.#1153->#1154->#1156->#1155.