Skip to content

Conversation

@johnlindquist
Copy link
Owner

@johnlindquist johnlindquist commented Aug 1, 2025

Summary

This PR adds support for the SessionStart hook handler to allow users to run custom logic when a Claude session starts.

Changes

  • Added SessionStartPayload interface with session metadata (session_id, transcript_path, hook_event_name, source)
  • Added SessionStartResponse interface for hook responses with optional decision, reason, and hookSpecificOutput
  • Added SessionStartHandler type definition
  • Updated HookHandlers interface to include optional sessionStart property
  • Added SessionStart case in the runHook switch statement
  • Added optional title field to NotificationPayload interface
  • Updated HookPayload union type to include SessionStartPayload

Implementation Details

The SessionStart hook follows the same pattern as other existing hooks:

  • Payload includes session_id, transcript_path, hook_event_name, and source
  • Response extends BaseHookResponse with optional decision, reason, and hookSpecificOutput
  • Handler can be async or sync, returning a SessionStartResponse

This allows users to implement session initialization logic, such as:

  • Loading user preferences
  • Setting up session-specific resources
  • Logging session starts
  • Applying custom context based on the session source

Testing

  • ✅ Build passes
  • ✅ Linting passes
  • ✅ All CI checks pass (Ubuntu, macOS, Windows - Node 18 & 20)
  • ✅ Integration tests pass
  • ✅ Smoke tests pass

Notes

  • Removed external dependencies that were causing CI failures
  • Implementation follows existing patterns in the codebase
  • No breaking changes to existing functionality

Summary by CodeRabbit

  • New Features

    • Added support for a new "SessionStart" event, enabling handling of session start actions and responses.
    • Introduced optional "title" field for notifications, allowing for more descriptive notification messages.
  • Improvements

    • Enhanced control flow for certain event cases to improve reliability and maintainability.

@coderabbitai
Copy link

coderabbitai bot commented Aug 1, 2025

Warning

Rate limit exceeded

@johnlindquist has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 59 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 9f5b628 and d61232d.

📒 Files selected for processing (1)
  • templates/hooks/lib.ts (7 hunks)

Walkthrough

A new SessionStart hook event type and its associated payload and response interfaces are introduced. The runHook function is updated to handle this event, invoking a new optional handler if present. The NotificationPayload interface gains an optional title field, and minor control flow cleanups are made for unreachable code.

Changes

Cohort / File(s) Change Summary
SessionStart Hook Integration
templates/hooks/lib.ts
Added SessionStartPayload, SessionStartResponse, and SessionStartHandler types; extended HookPayload and HookHandlers to support the new hook; updated runHook to handle SessionStart events and invoke the new handler.
Notification Payload Enhancement
templates/hooks/lib.ts
Added optional title field to NotificationPayload interface.
Control Flow Cleanup
templates/hooks/lib.ts
Replaced unreachable return statements with break after process.exit(0) in Stop and SubagentStop cases.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant runHook
    participant HookHandlers
    Caller->>runHook: Call with SessionStart payload
    runHook->>HookHandlers: Check for sessionStart handler
    alt sessionStart handler exists
        runHook->>HookHandlers: Invoke sessionStart(payload)
        HookHandlers-->>runHook: SessionStartResponse
        runHook->>Caller: Log and return response
    else no handler
        runHook->>Caller: Log empty response
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested labels

released

Poem

A brand new hook hops into view,
SessionStart now joins the crew!
With payloads neat and titles bright,
And handlers ready, day or night.
The code flows clean, unreachable gone—
This bunny cheers the work well done! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/add-session-start-handler

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

- Add SessionStartPayload interface with session metadata
- Add SessionStartResponse interface for hook responses
- Add SessionStartHandler type definition
- Update HookHandlers interface to include sessionStart property
- Add SessionStart case in runHook switch statement
- Add optional title field to NotificationPayload

Follows existing hook patterns without external dependencies
@johnlindquist johnlindquist force-pushed the feat/add-session-start-handler branch from 77cd68a to d61232d Compare August 1, 2025 14:14
@johnlindquist johnlindquist merged commit d1d6343 into main Aug 1, 2025
10 checks passed
@github-actions
Copy link
Contributor

github-actions bot commented Aug 1, 2025

🎉 This PR is included in version 2.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants