|
| 1 | +--- |
| 2 | +layout: post |
| 3 | +title: gRPC-Web is Generally Available |
| 4 | +published: true |
| 5 | +permalink: blog/grpc-web-ga |
| 6 | +author: Luc Perkins - CNCF, Stanley Cheung - Google, Kailash Sethuraman - Google |
| 7 | +--- |
| 8 | + |
| 9 | +We are excited to announce the GA release of |
| 10 | +[gRPC-Web](https://www.npmjs.com/package/grpc-web), a JavaScript client library |
| 11 | +that enables web apps to communicate directly with gRPC backend services, |
| 12 | +without requiring an HTTP server to act as an intermediary. "GA" means that |
| 13 | +gRPC-Web is now Generally Available and stable and qualified for production use. |
| 14 | + |
| 15 | +<!--more--> |
| 16 | + |
| 17 | +With gRPC-Web, you can now easily build truly end-to-end gRPC application |
| 18 | +architectures by defining your client *and* server-side data types and service |
| 19 | +interfaces with Protocol Buffers. This has been a hotly requested feature for a |
| 20 | +while, and we are finally happy to say that it is now ready for production use. |
| 21 | +In addition, being able to access gRPC services opens up new an exciting |
| 22 | +possibilities for [web based |
| 23 | +tooling](https://github.com/grpc/grpc-experiments/tree/master/gdebug) around gRPC. |
| 24 | + |
| 25 | +## The Basics |
| 26 | +gRPC-Web, just like gRPC, lets you define the service "contract" between client |
| 27 | +(web) and backend gRPC services using Protocol Buffers. The client can then be |
| 28 | +auto generated. To do this, you have a choice between the [Closure](https://developers.google.com/closure/compiler/) compiler |
| 29 | +or the more widely used [CommonJS](https://requirejs.org/docs/commonjs.html). |
| 30 | +This development process removes the need to manage concerns such as creating |
| 31 | +custom JSON seralization and deserialization logic, wrangling HTTP status codes |
| 32 | +(which can vary across REST APIs), managing content type negotiation etc. |
| 33 | + |
| 34 | +From a broader architectural perspective, gRPC-Web enables end-to-end gRPC. The diagram below illustrates this: |
| 35 | + |
| 36 | +<img src="/img/grpc-web-arch.png" style="max-width: 947px"> |
| 37 | + |
| 38 | + |
| 39 | +<p style="text-align: center"> Figure 1. |
| 40 | +gRPC with gRPC-Web (left) and gRPC with REST (right)</p> |
| 41 | + |
| 42 | +In the gRPC-Web universe on the left, a client application speaks Protocol Buffers to a gRPC backend server that speaks Protocol Buffers to other gRPC backend services. In the REST universe on the right, the web app speaks HTTP to a backend REST API server that then speaks Protocol Buffers to backend services. |
| 43 | + |
| 44 | +## Advantages of using gRPC-Web |
| 45 | +gRPC-Web will offer an ever-broader feature set over time, but here’s what’s in 1.0 today: |
| 46 | + |
| 47 | +* **End-to-end gRPC** — Enables you to craft your entire RPC pipeline using Protocol Buffers. Imagine a scenario in which a client request goes to an HTTP server, which then interacts with 5 backend gRPC services. There’s a good chance that you’ll spend as much time building the HTTP interaction layer as you will building the entire rest of the pipeline. |
| 48 | +* **Tighter coordination between frontend and backend teams** — With the entire RPC pipeline defined using Protocol Buffers, you no longer need to have your “microservices teams” alongside your “client team.” The client-backend interaction is just one more gRPC layer amongst others. |
| 49 | +* **Easily generate client libraries** — With gRPC-Web, the server that interacts with the “outside” world, i.e. the membrane connecting your backend stack to the internet, is now a gRPC server instead of an HTTP server, that means that all of your service’s client libraries can be gRPC libraries. Need client libraries for Ruby, Python, Java, and 4 other languages? You no longer need to write HTTP clients for all of them. |
| 50 | + |
| 51 | +## A gRPC-Web example |
| 52 | +The previous section illustrated some of the high-level advantages of gRPC-Web for large-scale applications. Now let’s get closer to the metal with an example: a simple TODO app. In gRPC-Web you can start with a simple ``todos.proto`` definition like this: |
| 53 | +```proto |
| 54 | +syntax = "proto3"; |
| 55 | +
|
| 56 | +package todos; |
| 57 | +
|
| 58 | +message Todo { |
| 59 | + string content = 1; |
| 60 | + bool finished = 2; |
| 61 | +} |
| 62 | +
|
| 63 | +message GetTodoRequest { |
| 64 | + int32 id = 1; |
| 65 | +} |
| 66 | +
|
| 67 | +service TodoService { |
| 68 | + rpc GetTodoById (GetTodoRequest) returns (Todo); |
| 69 | +} |
| 70 | +
|
| 71 | +``` |
| 72 | +CommonJS client-side code can be generated from this ``.proto`` definition with the following command: |
| 73 | + |
| 74 | +```proto |
| 75 | +protoc echo.proto \ |
| 76 | + --js_out=import_style=commonjs:./output \ |
| 77 | + --grpc-web_out=import_style=commonjs:./output |
| 78 | +``` |
| 79 | + |
| 80 | +Now, fetching a list of TODOs from a backend gRPC service is as simple as: |
| 81 | + |
| 82 | +```js |
| 83 | +const {GetTodoRequest} = require('./todos_pb.js'); |
| 84 | +const {TodoServiceClient} = require('./todos_grpc_web_pb.js'); |
| 85 | + |
| 86 | +const todoService = new proto.todos.TodoServiceClient('http://localhost:8080'); |
| 87 | +const todoId = 1234; |
| 88 | + |
| 89 | +var getTodoRequest = new proto.todos.GetTodoRequest(); |
| 90 | +getTodoRequest.setId(todoId); |
| 91 | + |
| 92 | +var metadata = {}; |
| 93 | +var getTodo = todoService.getTodoById(getTodoRequest, metadata, (err, response) => { |
| 94 | + if (err) { |
| 95 | + console.log(err); |
| 96 | + } else { |
| 97 | + const todo = response.todo(); |
| 98 | + if (todo == null) { |
| 99 | + console.log(`A TODO with the ID ${todoId} wasn't found`); |
| 100 | + } else { |
| 101 | + console.log(`Fetched TODO with ID ${todoId}: ${todo.content()}`); |
| 102 | + } |
| 103 | + } |
| 104 | +}); |
| 105 | + |
| 106 | +``` |
| 107 | + |
| 108 | +Once you declare the data types and a service interface, gRPC-Web abstracts away all the boilerplate, leaving you with a clean and human-friendly API (essentially the same API as the current [Node.js](https://grpc.io/docs/tutorials/basic/node.html) for gRPC API, just transferred to the client). |
| 109 | + |
| 110 | +On the backend, the gRPC server can be written in any language that supports gRPC, such as Go, Java, C++, Ruby, Node.js, and many others. The last piece of the puzzle is the service proxy. From the get-go, gRPC-Web will support [Envoy](https://envoyproxy.io) as the default service proxy, which has a built-in [envoy.grpc_web filter](https://www.envoyproxy.io/docs/envoy/latest/configuration/http_filters/grpc_web_filter#config-http-filters-grpc-web) that you can apply with just a few lines of copy-and-pastable configuration. |
| 111 | + |
| 112 | +## Next Steps |
| 113 | +Going GA means that the core building blocks are firmly in place and ready for usage in production web applications. But there’s still much more to come for gRPC-Web. Check out the [official roadmap](https://github.com/grpc/grpc-web/blob/master/ROADMAP.md) to see what the core team envisions for the near future. |
| 114 | + |
| 115 | +If you’re interested in contributing to gRPC-Web, there are a few things we would love community help with: |
| 116 | + |
| 117 | +* **Front-end framework integration** — Commonly used front-end frameworks like [React](https://reactjs.org), [Vue](https://vuejs.org) and [Angular](https://angularjs.org) don't yet offer official support for gRPC-Web. But we would love to see these frameworks support it since the integration between these frontend frameworks and gRPC-Web can be a vehicle to deliver user-perceivable performance benefits to applications. If you are interested in building out support for these frontend frameworks, let us know on the [gRPC.io mailing list](https://groups.google.com/forum/#!forum/grpc-io), [filing a feature request on github](https://github.com/grpc/grpc-web/issues) or via the feature survey form below. |
| 118 | + |
| 119 | +* **Language-specific proxy support** — As of the GA release, [Envoy](https://envoyproxy.io) is the default proxy for gRPC-Web, offering support via a special module. NGNIX is also [supported](https://github.com/grpc/grpc-web/tree/master/net/grpc/gateway/nginx). But we’d also love to see development of in-process proxies for specific languages since they obviate the need for special proxies—such as Envoy and nginx—and would make using gRPC-Web even easier. |
| 120 | + |
| 121 | +We’d also love to get feature requests from the community. Currently the best way to make feature requests is to fill out the [gRPC-Web roadmap features survey](https://docs.google.com/forms/d/1NjWpyRviohn5jaPntosBHXRXZYkh_Ffi4GxJZFibylM/viewform?edit_requested=true). When filling up the form, list features you’d like to see and also let us know if you’d like to contribute to the development of those features in the **I’d like to contribute to** section. The gRPC-Web engineers will be sure to take that information to heart over the course of the project’s development. |
| 122 | + |
| 123 | +Most importantly, we want to thank all the Alpha and Beta users who have given us feedback, bug reports and pull requests contributions over the course of the past year. We would certainly hope to maintain this momentum and make sure this project brings tangible benefits to the developer community. |
0 commit comments