fix: write back error message if the response marshal failed

[ppzqh]

[#163] adds a logic to construct a error message when response marshal failed but return before sending to eventQueue.
This fix writes back the response.

Summary by CodeRabbit

• Bug Fixes

  • Improved error handling to ensure clients always receive an error message if a server-side processing issue occurs.

• Tests

  • Added a new test to verify proper server behavior when response formatting fails.
  • Renamed a test helper function for clarity and consistency.

[coderabbitai]

Walkthrough

This change modifies the error handling logic in the handleMessage method of the SSEServer struct. Specifically, it ensures that even if JSON marshalling of a response fails, a generic error message is still enqueued and sent to the client, rather than exiting early. Corresponding tests are updated to check this behavior, including renaming a utility function for consistency and adding a new test case that simulates a marshal error and verifies the server's response.

Changes

Files	Change Summary
server/sse.go	Modified handleMessage to remove early return on JSON marshal error, ensuring an error message is always enqueued.
server/sse_test.go	Renamed readSeeEvent to readSSEEvent, added a test case for marshal errors, and performed minor whitespace cleanup.

Possibly related PRs

• feat: quick return tool-call request, send response via SSE in goroutine #163: Refactors handleMessage to process requests asynchronously and return HTTP 202, touching the same method but not altering error handling on marshal failure.

Suggested reviewers

• ezynda3

---

📜 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 f3fef81 and 4c89c0a.

📒 Files selected for processing (2)

• server/sse.go (0 hunks)
• server/sse_test.go (8 hunks)

💤 Files with no reviewable changes (1)

• server/sse.go

🔇 Additional comments (3)

server/sse_test.go (3)

65-65: Improved naming consistency by correcting function name

The renaming of readSeeEvent to readSSEEvent across all occurrences provides better consistency and clarity, as "SSE" is the correct acronym for Server-Sent Events.

Also applies to: 198-198, 593-593, 635-635, 683-683, 1156-1156, 1323-1323

---

639-639: Fixed variable naming for consistency

Variable names have been updated from respFromSee to respFromSSE to maintain consistency with the SSE (Server-Sent Events) acronym throughout the code.

Also applies to: 644-644, 688-688, 693-693

---

1244-1320: Well-implemented test case for marshal error handling

This new test case properly validates the fix for issue #163 by:

1. Injecting an unmarshalable value (a function) into the response metadata
2. Verifying that the server returns a 202 status code
3. Confirming the error handling by checking for a null ID in the response

The test ensures that the server correctly writes back an error message when JSON marshalling fails, rather than discarding it.

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