You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/01/07 09:39:20 UTC
[GitHub] [apisix] tzssangglass commented on a change in pull request #5964: feat(grpc-web): support gRPC-Web Proxy
tzssangglass commented on a change in pull request #5964:
URL: https://github.com/apache/apisix/pull/5964#discussion_r780129106
##########
File path: apisix/plugins/grpc-web.lua
##########
@@ -0,0 +1,146 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+
+local ngx = ngx
+local ngx_arg = ngx.arg
+local core = require("apisix.core")
+local req_set_uri = ngx.req.set_uri
+local req_set_body_data = ngx.req.set_body_data
+local decode_base64 = ngx.decode_base64
+local encode_base64 = ngx.encode_base64
+
+
+local ALLOW_METHOD_OPTIONS = "OPTIONS"
+local ALLOW_METHOD_POST = "POST"
+local CONTENT_ENCODING_BASE64 = "base64"
+local CONTENT_ENCODING_BINARY = "binary"
+local DEFAULT_CORS_CONTENT_TYPE = "application/grpc-web-text+proto"
+local DEFAULT_CORS_ALLOW_ORIGIN = "*"
+local DEFAULT_CORS_ALLOW_METHODS = ALLOW_METHOD_POST
+local DEFAULT_CORS_ALLOW_HEADERS = "content-type,x-grpc-web,x-user-agent"
+local DEFAULT_PROXY_CONTENT_TYPE = "application/grpc"
+
+
+local plugin_name = "grpc-web"
+
+local schema = {
+ type = "object",
+ properties = {},
+}
+
+local grpc_web_content_encoding = {
+ ["application/grpc-web"] = CONTENT_ENCODING_BINARY,
+ ["application/grpc-web-text"] = CONTENT_ENCODING_BASE64,
+ ["application/grpc-web+proto"] = CONTENT_ENCODING_BINARY,
+ ["application/grpc-web-text+proto"] = CONTENT_ENCODING_BASE64,
+}
+
+local _M = {
+ version = 0.1,
+ priority = 505,
+ name = plugin_name,
+ schema = schema,
+}
+
+function _M.check_schema(conf)
+ return core.schema.check(schema, conf)
+end
+
+function _M.access(conf, ctx)
+ local method = core.request.get_method()
+ if method == ALLOW_METHOD_OPTIONS then
+ return 204
+ end
+
+ if method ~= ALLOW_METHOD_POST then
+ -- https://github.com/grpc/grpc-web/blob/master/doc/browser-features.md#cors-support
+ core.log.error("request method: `", method, "` invalid")
+ return 400
+ end
+
+ local mimetype = core.request.header(ctx, "Content-Type")
+ local encoding = grpc_web_content_encoding[mimetype]
+ if not encoding then
+ core.log.error("request Content-Type: `", mimetype, "` invalid")
+ return 400
+ end
+
+ -- set grpc path
+ if not (ctx.curr_req_matched and ctx.curr_req_matched[":ext"]) then
+ core.log.error("please use matching pattern for routing URI, for example: /* or /grpc/*")
+ return 400
+ end
+
+ local path = ctx.curr_req_matched[":ext"]
+ if path:byte(1) ~= core.string.byte("/") then
+ path = "/" .. path
+ end
+
+ req_set_uri(path)
+
+ -- set grpc body
+ local body, err = core.request.get_body()
+ if err then
+ core.log.error("reading body err, ", err)
Review comment:
```suggestion
core.log.error("failed to read request body: ", err)
```
is better?
##########
File path: apisix/plugins/grpc-web.lua
##########
@@ -0,0 +1,146 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+
+local ngx = ngx
+local ngx_arg = ngx.arg
+local core = require("apisix.core")
+local req_set_uri = ngx.req.set_uri
+local req_set_body_data = ngx.req.set_body_data
+local decode_base64 = ngx.decode_base64
+local encode_base64 = ngx.encode_base64
+
+
+local ALLOW_METHOD_OPTIONS = "OPTIONS"
+local ALLOW_METHOD_POST = "POST"
+local CONTENT_ENCODING_BASE64 = "base64"
+local CONTENT_ENCODING_BINARY = "binary"
+local DEFAULT_CORS_CONTENT_TYPE = "application/grpc-web-text+proto"
+local DEFAULT_CORS_ALLOW_ORIGIN = "*"
+local DEFAULT_CORS_ALLOW_METHODS = ALLOW_METHOD_POST
+local DEFAULT_CORS_ALLOW_HEADERS = "content-type,x-grpc-web,x-user-agent"
+local DEFAULT_PROXY_CONTENT_TYPE = "application/grpc"
+
+
+local plugin_name = "grpc-web"
+
+local schema = {
+ type = "object",
+ properties = {},
+}
+
+local grpc_web_content_encoding = {
+ ["application/grpc-web"] = CONTENT_ENCODING_BINARY,
+ ["application/grpc-web-text"] = CONTENT_ENCODING_BASE64,
+ ["application/grpc-web+proto"] = CONTENT_ENCODING_BINARY,
+ ["application/grpc-web-text+proto"] = CONTENT_ENCODING_BASE64,
+}
+
+local _M = {
+ version = 0.1,
+ priority = 505,
+ name = plugin_name,
+ schema = schema,
+}
+
+function _M.check_schema(conf)
+ return core.schema.check(schema, conf)
+end
+
+function _M.access(conf, ctx)
+ local method = core.request.get_method()
+ if method == ALLOW_METHOD_OPTIONS then
+ return 204
+ end
+
+ if method ~= ALLOW_METHOD_POST then
+ -- https://github.com/grpc/grpc-web/blob/master/doc/browser-features.md#cors-support
+ core.log.error("request method: `", method, "` invalid")
+ return 400
+ end
+
+ local mimetype = core.request.header(ctx, "Content-Type")
+ local encoding = grpc_web_content_encoding[mimetype]
+ if not encoding then
+ core.log.error("request Content-Type: `", mimetype, "` invalid")
+ return 400
+ end
+
+ -- set grpc path
+ if not (ctx.curr_req_matched and ctx.curr_req_matched[":ext"]) then
+ core.log.error("please use matching pattern for routing URI, for example: /* or /grpc/*")
Review comment:
This log looks more like it is being returned to the client.
##########
File path: docs/zh/latest/plugins/grpc-web.md
##########
@@ -0,0 +1,84 @@
+---
+title: grpc-web
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+## 摘要
+
+- [**定义**](#定义)
+- [**如何开启**](#如何开启)
+- [**测试插件**](#测试插件)
+- [**禁用插件**](#禁用插件)
+
+## 定义
+
+`grpc-web` 插件是一个代理插件，用于转换 [gRPC Web](https://github.com/grpc/grpc-web) 客户端到 `gRPC Server` 的请求。
+
+gRPC Web Client -> APISIX -> gRPC server
+
+## 如何开启
+
+启用 `gRPC Web` 代理插件，路由必须使用 `前缀匹配` 模式（例如：`/*` 或 `/grpc/example/*`），
+因为 `gRPC Web` 客户端会在 URI 中传递 `proto` 中声明的`包名称`、`服务接口名称`、`方法名称`等信息（例如：`/path/a6.RouteService/Insert`）,
+使用 `绝对匹配` 时将无法命中插件和提取 `proto` 信息。
+
+```bash
+curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
+{
+ "uri":"/grpc/web/*",
+ "plugins":{
+ "grpc-web":{}
+ },
+ "upstream":{
+ "scheme":"grpc",
+ "type":"roundrobin",
+ "nodes":{
+ "127.0.0.1:1980":1
+ }
+ }
+}'
+```
+
+## 测试插件
+
+- 请求方式仅支持 `POST` 和 `OPTIONS`，参考：[CORS support](https://github.com/grpc/grpc-web/blob/master/doc/browser-features.md#cors-support) 。
+- 内容类型支持 `application/grpc-web`、`application/grpc-web-text`、`application/grpc-web+proto`、`application/grpc-web-text+proto`，参考：[Protocol differences vs gRPC over HTTP2](https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-WEB.md#protocol-differences-vs-grpc-over-http2) 。
+- 客户端部署，参考：[gRPC-Web Client Runtime Library](https://www.npmjs.com/package/grpc-web) 或 [Apache APISIX gRPC Web 测试框架](https://github.com/apache/apisix/tree/master/t/plugin/grpc-web) 。
+- 完成 `gRPC Web` 客户端部署后，即可通过 `浏览器` 或 `node` 向 `APISIX` 发起 `gRPC Web` 代理请求。
+
+## 禁用插件
+
+只需删除插件配置中`grpc-web`的JSON配置即可。 APISIX 插件是热加载的，所以不需要重启 APISIX。
Review comment:
```suggestion
只需删除插件配置中 `grpc-web` 的JSON配置即可。 APISIX 插件是热加载的，所以不需要重启 APISIX。
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org