8000 test: build mockstdio_server with isolated cache to prevent flaky CI by rwjblue-glean · Pull Request #241 · mark3labs/mcp-go · GitHub
[go: up one dir, main page]

Skip to content

test: build mockstdio_server with isolated cache to prevent flaky CI #241

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

Merged
merged 1 commit into from
May 4, 2025

Conversation

rwjblue-glean
Copy link
Collaborator
@rwjblue-glean rwjblue-glean commented May 4, 2025

CI occasionally failed with the linker error:

/link: cannot open file DO NOT USE - main build pseudo-cache built

This is most likely because several parallel go build invocations shared the same $GOCACHE, letting one job evict the object file another job had promised the linker. The placeholder path then leaked through and the build aborted.

This gives each compile its own cache by setting GOCACHE=$(mktemp -d) for the helper’s go build call.


I hadn't seen #240 when I started working on this and it addresses the issue as well. I think these changes are complimentary though and using isolated GOCACHE is probably still a useful change.

Summary by CodeRabbit

  • Chores
    • Updated build process for test servers to use an isolated build cache and removed a specific build flag. No changes to user-facing features.

Copy link
Contributor
coderabbitai bot commented May 4, 2025

Walkthrough

This change updates the Go build process in two test files by removing the -buildmode=pie build flag and introducing the use of an isolated temporary directory for the Go build cache via the GOCACHE environment variable. It also adds explicit verification that the compiled test server binary exists after the build completes. The rest of the build and test logic remains unchanged, with no modifications to exported or public declarations.

Changes

Files Changed Summary
client/stdio_test.go, client/transport/stdio_test.go Removed -buildmode=pie from the Go build command; added creation and use of a temporary GOCACHE directory for isolated build caching; added explicit check for existence of the compiled binary after build.

Possibly related PRs


📜 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 dc624ae and 3d3a7a0.

📒 Files selected for processing (2)
  • client/stdio_test.go (1 hunks)
  • client/transport/stdio_test.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • client/transport/stdio_test.go
  • client/stdio_test.go
✨ 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.
    • 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.

Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
client/transport/stdio_test.go (1)

25-27: Good implementation for isolated build cache.

The change aligns well with the PR objectives by creating a unique temporary directory for each build's cache a 8000 nd setting the GOCACHE environment variable accordingly. This effectively prevents race conditions between parallel builds.

However, there's a minor issue with error handling:

Consider handling the error from os.MkdirTemp rather than discarding it:

-tmpCache, _ := os.MkdirTemp("", "gocache")
+tmpCache, err := os.MkdirTemp("", "gocache")
+if err != nil {
+  return fmt.Errorf("failed to create temporary cache directory: %v", err)
+}

Also, consider cleaning up the temporary directory after the build completes to prevent accumulation of unused directories:

 cmd.Env = append(os.Environ(), "GOCACHE="+tmpCache)
+defer os.RemoveAll(tmpCache)
client/stdio_test.go (1)

26-28: Good implementation for isolated build cache.

The change aligns well with the PR objectives by creating a unique temporary directory for each build's cache and setting the GOCACHE environment variable accordingly. This effectively prevents race conditions between parallel builds.

However, there's a minor issue with error handling:

Consider handling the error from os.MkdirTemp rather than discarding it:

-tmpCache, _ := os.MkdirTemp("", "gocache")
+tmpCache, err := os.MkdirTemp("", "gocache")
+if err != nil {
+  return fmt.Errorf("failed to create temporary cache directory: %v", err)
+}

Also, consider cleaning up the temporary directory after the build completes to prevent accumulation of unused directories:

 cmd.Env = append(os.Environ(), "GOCACHE="+tmpCache)
+defer os.RemoveAll(tmpCache)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5244489 and dc624ae.

📒 Files selected for processing (2)
  • client/stdio_test.go (1 hunks)
  • client/transport/stdio_test.go (1 hunks)

CI occasionally failed with the linker error:

    /link: cannot open file DO NOT USE - main build pseudo-cache built

This is most likely because several parallel `go build` invocations
shared the same `$GOCACHE`, letting one job evict the object file
another job had promised the linker. The placeholder path then leaked
through and the build aborted.

This gives each compile its own cache by setting  `GOCACHE=$(mktemp -d)`
for the helper’s `go build` call.

After these changes `go test ./... -race` passed 100/100 consecutive
runs locally.
@rwjblue-glean rwjblue-glean force-pushed the rwjblue/push-nylvtlmlqyvl branch from dc624ae to 3d3a7a0 Compare May 4, 2025 13:07
@ezynda3 ezynda3 merged commit a999079 into mark3labs:main May 4, 2025
2 checks passed
@rwjblue-glean rwjblue-glean deleted the rwjblue/push-nylvtlmlqyvl branch May 5, 2025 21:35
tendant pushed a commit to tendant/mcp-go that referenced this pull request May 8, 2025
…ark3labs#241)

CI occasionally failed with the linker error:

    /link: cannot open file DO NOT USE - main build pseudo-cache built

This is most likely because several parallel `go build` invocations
shared the same `$GOCACHE`, letting one job evict the object file
another job had promised the linker. The placeholder path then leaked
through and the build aborted.

This gives each compile its own cache by setting  `GOCACHE=$(mktemp -d)`
for the helper’s `go build` call.

After these changes `go test ./... -race` passed 100/100 consecutive
runs locally.
adlternative pushed a commit to adlternative/mcp-go that referenced this pull request May 20, 2025
…ark3labs#241)

CI occasionally failed with the linker error:

    /link: cannot open file DO NOT USE - main build pseudo-cache built

This is most likely because several parallel `go build` invocations
shared the same `$GOCACHE`, letting one job evict the object file
another job had promised the linker. The placeholder path then leaked
through and the build aborted.

This gives each compile its own cache by setting  `GOCACHE=$(mktemp -d)`
for the helper’s `go build` call.

After these changes `go test ./... -race` passed 100/100 consecutive
runs locally.
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
0