Propagate response headers with grpc error metadata

[rauanmayemir]

Q	A
Bugfix?	❌
Breaks BC?	❌
New feature?	✔️

This change propagates response headers as part of grpc error response. This is helpful when your server needs to send certain headers (like X-Correlation-Id, etc) even in case of Exception.

Update: this change also introduces ResponseTrailers which could be used alongside ResponseHeaders. It is expected to send data like this:

{
  "error": "base64_encoded_proto",
  "headers": "{\"header_key_1\": \"header_value_1\", \"header_key_2\": \"header_value_2\"}",
  "trailers": "{\"trailer_key_1\": \"trailer_value_1\", \"trailer_key_2\": \"trailer_value_2\"}"
}

And if it's a successful response, then binary payload headers part will also accordingly change from this:

{"header_key_1": "header_value_1", "header_key_2": "header_value_2"}

to this:

{
  "headers": "{\"header_key_1\": \"header_value_1\", \"header_key_2\": \"header_value_2\"}",
  "trailers": "{\"trailer_key_1\": \"trailer_value_1\", \"trailer_key_2\": \"trailer_value_2\"}"
}

ref: https://github.com/roadrunner-server/roadrunner/issues/2006

@rustatian: Note, this PR should be synced with RR 2024.3 release.

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Introduced a CallContext class for structured representation of gRPC call contexts, enhancing organization and handling of service calls.
  • Added a getHeaders() method to the ResponseHeaders class for improved access to internal headers.
  • Introduced a ResponseTrailers class for managing and manipulating trailer headers in gRPC responses.

• Improvements

  • Streamlined gRPC request handling by removing the tick method and utilizing the new CallContext for better efficiency.
  • Enhanced error handling in the workerError method by allowing a nullable context parameter.

• Configuration Updates

  • Updated composer.json to include a branch-alias for flexible dependency management.

[coderabbitai[bot]]

Walkthrough

The pull request introduces two new classes, CallContext and ResponseTrailers, and refactors the existing Server class in the Spiral RoadRunner GRPC library. The CallContext class is designed for handling request context decoding, while ResponseTrailers manages and serializes response trailers. The Server class has been updated to integrate these new components, enhancing error handling and request processing by streamlining the management of context, headers, and trailers during GRPC interactions. Additionally, the version constraint for the spiral/roadrunner package in composer.json has been modified.

Changes

File	Change Summary
src/Internal/CallContext.php	Added new internal final class with methods for decoding and constructing call context
src/ResponseTrailers.php	Introduced new ResponseTrailers class implementing IteratorAggregate and Countable for managing response trailers
src/Server.php	Refactored error handling, removed tick method, updated serve method to work with new CallContext
composer.json	Updated dependency version for spiral/roadrunner from `^2023.1
tests/ContextTest.php	Added tests for ResponseTrailers functionality in Context
tests/ServerTest.php	Added test for gRPC exception handling in Server
tests/Stub/TestService.php	Enhanced error handling and response header manipulation in service methods
psalm-baseline.xml	Updated psalm-version to a stable release version

Poem

🐰 Hop, hop, through code so bright,
GRPC context now takes flight!
Trailers packed with gentle care,
Errors caught with rabbit flair,
A library that's lean and tight! 🚀

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.

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. (Beta)
• @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.

[rustatian]

@rauanmayemir Feature was released from the RR side.