fix: proper deprecation messaging for WithHTTPContextFunc

[aotarola]

1. Proper deprecation messaging
2. use WithHTTPContextFunc in testing code

Summary by CodeRabbit

• Refactor
  • Updated context function usage in server configuration to use a more general HTTP context function instead of an SSE-specific one.
• Documentation
  • Clarified deprecation guidance in comments to recommend the correct replacement function.

[coderabbitai]

Walkthrough

This change replaces the use of the SSE-specific context function option with the more general HTTP context function option in both example and test server setups. It also updates the deprecation comment for the old SSE context function option to recommend the new HTTP context function alternative.

Changes

Files	Change Summary
examples/custom_context/main.go	Replaced server.WithSSEContextFunc(authFromRequest) with server.WithHTTPContextFunc(authFromRequest) in ServeSSE.
server/sse.go	Updated the deprecation comment on WithSSEContextFunc to recommend WithHTTPContextFunc instead.
server/sse_test.go	Changed test setup to use WithHTTPContextFunc(setTestValFromRequest) instead of the SSE-specific option.

Possibly related PRs

• refactor(server): extract common HTTP transport configuration options #253: Refactored to deprecate WithSSEContextFunc in favor of WithHTTPContextFunc and introduced a common HTTP context function option for SSEServer.
• feat: allow customising context via callback on transport servers #32: Introduced the original WithSSEContextFunc option and context customization capability for SSE servers, which is now being updated in this PR.

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35f8a89 and 3c5595b.

📒 Files selected for processing (3)

• examples/custom_context/main.go (1 hunks)
• server/sse.go (1 hunks)
• server/sse_test.go (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

examples/custom_context/main.go (1)

server/http_transport_options.go (1)

• WithHTTPContextFunc (148-154)

server/sse_test.go (2)

server/sse.go (1)

• NewTestServer (217-222)

server/http_transport_options.go (1)

• WithHTTPContextFunc (148-154)

🔇 Additional comments (3)

server/sse.go (1)

188-188: Improved deprecation message for WithSSEContextFunc

The deprecation message now correctly recommends using WithHTTPContextFunc instead of the previously mentioned WithContextFunc, which aligns with the actual implementation in line 193 where it delegates to WithHTTPContextFunc(HTTPContextFunc(fn)).

server/sse_test.go (1)

582-582: Updated test to use the recommended non-deprecated function

Good change that aligns with the updated deprecation message. The test now directly uses WithHTTPContextFunc instead of the deprecated WithSSEContextFunc, demonstrating the proper way to use the API.

examples/custom_context/main.go (1)

128-128: Updated example to use the recommended non-deprecated function

This change correctly updates the example to use WithHTTPContextFunc instead of the deprecated WithSSEContextFunc, which matches the updated deprecation message guidance. Since both functions have the same signature for the callback (func(ctx context.Context, r *http.Request) context.Context), the existing authFromRequest function works seamlessly with the new API.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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 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.