58ea2e00fc
I'm opening this PR to (hopefully!) stimulate a discussion. In brief, I'd like to amend the gRPC-Web protocol docs to encourage implementations to follow HTTP semantics and compare HTTP field names case-insensitively. The gRPC-Web specification is a nicely-designed way for proxies to expose standard HTTP/2 gRPC servers to clients using less tightly-controlled HTTP stacks, such as web browsers. To serve that goal, it seems valuable to have the gRPC-Web specification follow [RFC 9110 (HTTP Semantics)](https://www.rfc-editor.org/rfc/rfc9110.html#name-field-names). Like previous RFCs, 9110 specifies that "field names are case-insensitive." However, the current gRPC-Web specification requires that servers and proxies "use lower-case header/trailer names" on the wire. In principle, mandating casing on the wire is normal for HTTP/2 and fine (if unusual) for HTTP/1.1; however, it encourages implementations to violate HTTP semantics and require lower-case names when _reading_ headers and trailers. I'd like to loosen the gRPC-Web specification to permit any casing on the wire for HTTP/1.1. I'd also like to emphasize that gRPC-Web implementations ought to follow standard HTTP semantics when _reading_ fields and compare names case-insensitively. Implementations that can't treat names case-insensitively without breaking backward compatibility should instead normalize field names to lowercase. Among the Google-maintained gRPC implementations, at least `grpc-go` and `grpc-java` already compare names case-insensitively (even though they're HTTP/2-only). `grpc-dart` does the opposite and compares names case-sensitively. `grpc-web` is sometimes case-insensitive (when reading `grpc-status` and `grpc-message` from trailers-only responses) and sometimes case-sensitive (when hand-parsing a block of length-prefixed trailers). The proposed amendment does not affect the correctness of Envoy (which may continue to use lower-case field names). It partially affects `grpc-web`, which would require a small patch to always normalize names. (Both patched and unpatched versions of `grpc-web` would work with Envoy.) `grpc-dart` would need to either begin treating field names case-insensitively or normalize names, depending on what's possible in Dart without breaking backward compatibility. Relates to https://github.com/improbable-eng/grpc-web/issues/228, https://github.com/bufbuild/connect-go/issues/453/, and https://github.com/grpc/grpc-dart/issues/594. |
||
|---|---|---|
| .bazelci | ||
| .github | ||
| bazel | ||
| cmake | ||
| doc | ||
| etc | ||
| examples | ||
| include | ||
| spm-core-include | ||
| spm-cpp-include | ||
| src | ||
| summerofcode | ||
| templates | ||
| test | ||
| third_party | ||
| tools | ||
| .bazelignore | ||
| .bazelrc | ||
| .clang-format | ||
| .clang-tidy | ||
| .editorconfig | ||
| .gitallowed | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .istanbul.yml | ||
| .pylintrc | ||
| .pylintrc-examples | ||
| .pylintrc-tests | ||
| .rspec | ||
| .yapfignore | ||
| .yardopts | ||
| AUTHORS | ||
| BUILD | ||
| BUILDING.md | ||
| CMakeLists.txt | ||
| CODE-OF-CONDUCT.md | ||
| CONCEPTS.md | ||
| CONTRIBUTING.md | ||
| GOVERNANCE.md | ||
| Gemfile | ||
| LICENSE | ||
| MAINTAINERS.md | ||
| MANIFEST.md | ||
| Makefile | ||
| NOTICE.txt | ||
| OWNERS | ||
| PYTHON-MANIFEST.in | ||
| Package.swift | ||
| README.md | ||
| Rakefile | ||
| SECURITY.md | ||
| TROUBLESHOOTING.md | ||
| WORKSPACE | ||
| _metadata.py | ||
| build_autogenerated.yaml | ||
| build_config.rb | ||
| build_handwritten.yaml | ||
| composer.json | ||
| config.m4 | ||
| config.w32 | ||
| gRPC-C++.podspec | ||
| gRPC-Core.podspec | ||
| gRPC-ProtoRPC.podspec | ||
| gRPC-RxLibrary.podspec | ||
| gRPC.podspec | ||
| grpc.bzl | ||
| grpc.def | ||
| grpc.gemspec | ||
| grpc.gyp | ||
| package.xml | ||
| requirements.bazel.txt | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
README.md
gRPC – An RPC library and framework
gRPC is a modern, open source, high-performance remote procedure call (RPC) framework that can run anywhere. gRPC enables client and server applications to communicate transparently, and simplifies the building of connected systems.
| Homepage: | grpc.io |
| Mailing List: | grpc-io@googlegroups.com |
To start using gRPC
To maximize usability, gRPC supports the standard method for adding dependencies to a user's chosen language (if there is one). In most languages, the gRPC runtime comes as a package available in a user's language package manager.
For instructions on how to use the language-specific gRPC runtime for a project, please refer to these documents
- C++: follow the instructions under the
src/cppdirectory - C#/.NET: NuGet packages
Grpc.Net.Client,Grpc.AspNetCore.Server - Dart: pub package
grpc - Go:
go get google.golang.org/grpc - Java: Use JARs from Maven Central Repository
- Kotlin: Use JARs from Maven Central Repository
- Node:
npm install @grpc/grpc-js - Objective-C: Add
gRPC-ProtoRPCdependency to podspec - PHP:
pecl install grpc - Python:
pip install grpcio - Ruby:
gem install grpc - WebJS: follow the grpc-web instructions
Per-language quickstart guides and tutorials can be found in the documentation section on the grpc.io website. Code examples are available in the examples directory.
Precompiled bleeding-edge package builds of gRPC master branch's HEAD are
uploaded daily to packages.grpc.io.
To start developing gRPC
Contributions are welcome!
Please read How to contribute which will guide you through the entire workflow of how to build the source code, how to run the tests, and how to contribute changes to the gRPC codebase. The "How to contribute" document also contains info on how the contribution process works and contains best practices for creating contributions.
Troubleshooting
Sometimes things go wrong. Please check out the Troubleshooting guide if you are experiencing issues with gRPC.
Performance
See the Performance dashboard for performance numbers of master branch daily builds.
Concepts
See gRPC Concepts
About This Repository
This repository contains source code for gRPC libraries implemented in multiple languages written on top of a shared C core library src/core.
Libraries in different languages may be in various states of development. We are seeking contributions for all of these libraries:
| Language | Source |
|---|---|
| Shared C [core library] | src/core |
| C++ | src/cpp |
| Ruby | src/ruby |
| Python | src/python |
| PHP | src/php |
| C# (core library based) | src/csharp |
| Objective-C | src/objective-c |
| Language | Source repo |
|---|---|
| Java | grpc-java |
| Kotlin | grpc-kotlin |
| Go | grpc-go |
| NodeJS | grpc-node |
| WebJS | grpc-web |
| Dart | grpc-dart |
| .NET (pure C# impl.) | grpc-dotnet |
| Swift | grpc-swift |