Skip to content

feat(mcptest): Change Server.Start to accept a context.Context. #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

octo
Copy link
Contributor

@octo octo commented May 26, 2025

Description

Previously, mcptest used context.TODO() as the context with this server code was executed (with a comment to upgrade to testing.T.Context() eventually.

This effectively prevents tests from preparing a context to be used with server code. This is imporant, because WithHTTPContextFunc and friends appear to be the intended way to extract things like authentication information from the raw HTTP request and pass it to the server code. Without this change, such code is effectively untestable, at least with this package.

The NewServer convenience method has been left unchanged (i.e. it does not accept a context) to avoid breaking users taking the happy path. Changing the signature of Start() is however a breaking change.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • MCP spec compatibility implementation
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactoring (no functional changes)
  • Performance improvement
  • Tests only (no functional changes)
  • Other (please describe):

Checklist

  • My code follows the code style of this project

  • I have performed a self-review of my own code

  • I have added tests that prove my fix is effective or that my feature works

    Covered by existing tests.

  • I have updated the documentation accordingly

Additional Information

Let me know if you'd prefer to either

  • also update NewServer to accept a context, or
  • avoid the breaking change by introducing a new method, like StartContext.

Summary by CodeRabbit

  • Refactor
    • Updated server start method to accept an external context for improved control and cancellation.
    • Adjusted related functionality to align with the new context management approach.

Previously, `mcptest` used `context.TODO()` as the context with this server
code was executed (with a comment to upgrade to `testing.T.Context()`
eventually.

This effectively prevents tests from preparing a context to be used with server
code. This is imporant, because `WithHTTPContextFunc` and friends appear to be
the intended way to extract things like authentication information from the raw
HTTP request and pass it to the server code. Without this change, such code is
effectively untestable, at least with this package.

The `NewServer` convenience method has been left unchanged (i.e. it does not
accept a context) to avoid breaking users taking the happy path. Chaning the
signature of `Start()` is however a breaking change.
Copy link
Contributor

coderabbitai bot commented May 26, 2025

Walkthrough

The Server struct in the mcptest package has been refactored to remove its internal context.Context field, retaining only the cancellation function. The Start method now requires a context.Context argument, shifting context management responsibility to the caller. Related constructors and internal context usage have been updated accordingly.

Changes

File(s) Change Summary
mcptest/mcptest.go Removed context.Context field from Server; updated Start method to accept a context.Context parameter; adjusted constructors and internal calls to use passed or derived contexts.
mcptest/mcptest_test.go Updated test functions to pass a context.Context argument to Server.Start instead of calling it without arguments.

Possibly related PRs

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

Error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2
Failed executing command with error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2


📜 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 ff6820d and 09d85df.

📒 Files selected for processing (1)
  • mcptest/mcptest_test.go (2 hunks)
🔇 Additional comments (2)
mcptest/mcptest_test.go (2)

112-112: LGTM! Correct adaptation to the new API.

The change properly passes the context to the Start method, aligning with the updated method signature that now requires a context.Context parameter.


167-167: LGTM! Consistent adaptation to the new API.

The change correctly passes the context to the Start method, maintaining consistency with the updated method signature and following the same pattern as other tests in the file.

✨ 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
🪧 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 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.

@pottekkat
Copy link
Collaborator

@octo I think this change is good but there might be some change around the same files recently which could have caused the CI to fail. I have merged the master branch to this branch. Can you check and fix these issues and we can get this merged.

@octo
Copy link
Contributor Author

octo commented Jun 3, 2025

@pottekkat Thanks for taking a look! I have updated the test cases that had been committed to main in the mean time. With these changes, tests build and pass again.

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