Skip to content

Add gRPC architecture overview - #69216

Open
PureWeen wants to merge 5 commits into
dotnet:mainfrom
PureWeen:shneuvil-grpc-architecture-extraction
Open

PureWeen wants to merge 5 commits into
dotnet:mainfrom
PureWeen:shneuvil-grpc-architecture-extraction

Conversation

@PureWeen

@PureWeen PureWeen commented Sep 11, 2026 •

Copy link
Copy Markdown
Member

Add gRPC architecture overview

  • You've read the Contributor Guide and Code of Conduct.
  • You've included unit or integration tests for your change, where applicable.
  • You've included inline docs for your change, where applicable.
  • There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.

Add an in-area gRPC architecture reference.

Description

Context

#69011 is the wider effort to add expert pull request review guidance. This PR extracts the durable gRPC technical knowledge into an in-area architecture overview that gRPC area owners can validate independently.

The document follows the in-area ARCHITECTURE.md pattern established by @javiercn in #69147. It is a reference for contributors and coding agents that need to understand subsystem ownership and runtime boundaries before making changes.

Summary

  • add src/Grpc/ARCHITECTURE.md
  • document the ownership boundary between ASP.NET Core integration and the external grpc-dotnet implementation
  • describe JSON transcoding endpoint discovery, request binding, invocation, serialization, and error handling
  • distinguish native gRPC, HTTP transport, reflection, health checks, code generation, templates, and validation infrastructure
  • capture lifetime, concurrency, cancellation, security, and verification boundaries
  • map focused documentation and the appropriate subsystem owner for common changes

Documentation only; no runtime or public API changes.

Validation

  • git diff --check origin/main...HEAD passed
  • all local Markdown links and anchors resolve
  • the effective diff contains exactly one new file: src/Grpc/ARCHITECTURE.md
  • Markdownlint was not run locally
  • runtime tests were not run for this documentation-only change

Related to #69011.

@github-actions github-actions Bot added the area-grpc Includes: GRPC wire-up, templates label Sep 11, 2026
Comment thread src/Grpc/ARCHITECTURE.md Outdated
@PureWeen
PureWeen marked this pull request as ready for review September 11, 2026 16:11
@PureWeen
PureWeen requested a review from SamMonoRT as a code owner September 11, 2026 16:11
Copilot AI lite review requested due to automatic review settings September 11, 2026 16:11

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🔵 Needs a closer look

Address the documented accuracy issues in the transcoding flow, option configuration, and startup failure descriptions.

Review tier: Lite
Findings: None

What changed in this PR

Adds an in-area gRPC architecture overview documenting subsystem ownership, JSON transcoding, transport boundaries, and verification infrastructure.

Changes:

  • Documents transcoding discovery, binding, invocation, serialization, and error handling.
  • Maps ownership across gRPC, ASP.NET Core, protobuf, templates, and tests.
  • Describes lifetime, concurrency, cancellation, security, and validation boundaries.
File Description
src/​Grpc/​ARCHITECTURE.md Adds gRPC architecture and ownership documentation.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Looks like this PR hasn't been active for some time and the codebase could have been changed in the meantime.
To make sure no conflicting changes have occurred, please rerun validation before merging. You can do this by leaving an /azp run comment here (requires commit rights), or by simply closing and reopening.

@dotnet-policy-service dotnet-policy-service Bot added the pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun label Sep 26, 2026
Copilot AI added 4 commits October 1, 2026 15:49
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@PureWeen
PureWeen force-pushed the shneuvil-grpc-architecture-extraction branch from 3ed5168 to 852a38e Compare October 1, 2026 21:01
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The documentation accurately reflects the relevant implementation and its local links resolve.

Review effort: Balanced
Findings: None

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-grpc Includes: GRPC wire-up, templates pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants