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/05 02:05:41 UTC
[GitHub] [apisix] spacewander commented on a change in pull request #5964: feat(grpc-web): support gRPC-Web Proxy
spacewander commented on a change in pull request #5964:
URL: https://github.com/apache/apisix/pull/5964#discussion_r778494905
##########
File path: apisix/plugins/grpc-web.lua
##########
@@ -0,0 +1,145 @@
+--
+-- 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_read_body = ngx.req.read_body
+local req_set_body_data = ngx.req.set_body_data
+local req_set_uri = ngx.req.set_uri
+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)
+ local ok, err = core.schema.check(schema, conf)
Review comment:
```suggestion
return core.schema.check(schema, conf)
```
is enough?
##########
File path: apisix/plugins/grpc-web.lua
##########
@@ -0,0 +1,145 @@
+--
+-- 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_read_body = ngx.req.read_body
+local req_set_body_data = ngx.req.set_body_data
+local req_set_uri = ngx.req.set_uri
+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)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ return true
+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)
+ return 400
+ end
+
+ if encoding == CONTENT_ENCODING_BASE64 then
+ body = decode_base64(body)
+ end
+
+ req_read_body()
+ req_set_body_data(body)
+
+ -- set grpc content-type
+ core.request.set_header(ctx, "Content-Type", DEFAULT_PROXY_CONTENT_TYPE)
+
+ -- set context variable
+ ctx.var.grpc_web_mime = mimetype
+ ctx.var.grpc_web_encoding = encoding
+end
+
+function _M.header_filter(conf, ctx)
+ local method = core.request.get_method()
+ if method == ALLOW_METHOD_OPTIONS then
+ core.response.set_header("Access-Control-Allow-Methods", DEFAULT_CORS_ALLOW_METHODS)
+ core.response.set_header("Access-Control-Allow-Headers", DEFAULT_CORS_ALLOW_HEADERS)
+ end
+ core.response.set_header("Access-Control-Allow-Origin", DEFAULT_CORS_ALLOW_ORIGIN)
+ core.response.set_header("Content-Type", ctx.var.grpc_web_mime or DEFAULT_CORS_CONTENT_TYPE)
+end
+
+function _M.body_filter(conf, ctx)
+ local method = core.request.get_method()
+ if method ~= ALLOW_METHOD_POST then
+ return
+ end
Review comment:
The readability would be improved if we can check whether grpc_web is applied via some fields like `grpc_web_mime`, instead of the method.
##########
File path: apisix/plugins/grpc-web.lua
##########
@@ -0,0 +1,145 @@
+--
+-- 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_read_body = ngx.req.read_body
+local req_set_body_data = ngx.req.set_body_data
+local req_set_uri = ngx.req.set_uri
+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)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ return true
+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)
+ return 400
+ end
+
+ if encoding == CONTENT_ENCODING_BASE64 then
+ body = decode_base64(body)
+ end
+
+ req_read_body()
+ req_set_body_data(body)
+
+ -- set grpc content-type
+ core.request.set_header(ctx, "Content-Type", DEFAULT_PROXY_CONTENT_TYPE)
+
+ -- set context variable
+ ctx.var.grpc_web_mime = mimetype
+ ctx.var.grpc_web_encoding = encoding
+end
+
+function _M.header_filter(conf, ctx)
+ local method = core.request.get_method()
+ if method == ALLOW_METHOD_OPTIONS then
+ core.response.set_header("Access-Control-Allow-Methods", DEFAULT_CORS_ALLOW_METHODS)
+ core.response.set_header("Access-Control-Allow-Headers", DEFAULT_CORS_ALLOW_HEADERS)
+ end
+ core.response.set_header("Access-Control-Allow-Origin", DEFAULT_CORS_ALLOW_ORIGIN)
+ core.response.set_header("Content-Type", ctx.var.grpc_web_mime or DEFAULT_CORS_CONTENT_TYPE)
+end
+
+function _M.body_filter(conf, ctx)
+ local method = core.request.get_method()
+ if method ~= ALLOW_METHOD_POST then
+ return
+ end
+
+ local chunk = ngx_arg[1]
+
+ if ctx.var.grpc_web_encoding == CONTENT_ENCODING_BASE64 then
+ chunk = encode_base64(chunk)
Review comment:
We can only reset `ngx_arg[1]` when encoding is applied.
##########
File path: t/plugin/grpc-web/setup.sh
##########
@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+#
+# 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.
+#
+
+set -ex
+
+npm install || exit 1
+
+CGO_ENABLED=0 go build -o grpc-web-server server.go || exit 1
+
+./grpc-web-server -listen :50001 \
Review comment:
Why not use the default port?
##########
File path: t/plugin/grpc-web/setup.sh
##########
@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+#
+# 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.
+#
+
+set -ex
+
+npm install || exit 1
Review comment:
We already use `set -e`. There is no need to use `exit 1`.
##########
File path: apisix/plugins/grpc-web.lua
##########
@@ -0,0 +1,145 @@
+--
+-- 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_read_body = ngx.req.read_body
+local req_set_body_data = ngx.req.set_body_data
+local req_set_uri = ngx.req.set_uri
+local decode_base64 = ngx.decode_base64
+local encode_base64 = ngx.encode_base64
+
Review comment:
Let's use two blank lines between localized functions and constants
##########
File path: apisix/plugins/grpc-web.lua
##########
@@ -0,0 +1,145 @@
+--
+-- 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_read_body = ngx.req.read_body
+local req_set_body_data = ngx.req.set_body_data
+local req_set_uri = ngx.req.set_uri
+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)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ return true
+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)
+ return 400
+ end
+
+ if encoding == CONTENT_ENCODING_BASE64 then
+ body = decode_base64(body)
+ end
+
+ req_read_body()
+ req_set_body_data(body)
+
+ -- set grpc content-type
+ core.request.set_header(ctx, "Content-Type", DEFAULT_PROXY_CONTENT_TYPE)
+
+ -- set context variable
+ ctx.var.grpc_web_mime = mimetype
Review comment:
```suggestion
ctx.grpc_web_mime = mimetype
```
is enough?
##########
File path: apisix/plugins/grpc-web.lua
##########
@@ -0,0 +1,145 @@
+--
+-- 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_read_body = ngx.req.read_body
+local req_set_body_data = ngx.req.set_body_data
+local req_set_uri = ngx.req.set_uri
+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)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ return true
+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)
+ return 400
+ end
+
+ if encoding == CONTENT_ENCODING_BASE64 then
+ body = decode_base64(body)
Review comment:
Better to check if the body isn't nil. The decode can fail.
##########
File path: apisix/plugins/grpc-web.lua
##########
@@ -0,0 +1,145 @@
+--
+-- 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_read_body = ngx.req.read_body
+local req_set_body_data = ngx.req.set_body_data
+local req_set_uri = ngx.req.set_uri
+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)
+ local ok, err = core.schema.check(schema, conf)
+ if not ok then
+ return false, err
+ end
+
+ return true
+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)
+ return 400
+ end
+
+ if encoding == CONTENT_ENCODING_BASE64 then
+ body = decode_base64(body)
+ end
+
+ req_read_body()
Review comment:
This function is called in `core.request.get_body()`?
##########
File path: docs/en/latest/plugins/grpc-web.md
##########
@@ -0,0 +1,90 @@
+---
+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.
+#
+-->
+
+## Summary
+
+- [**Name**](#name)
+- [**Attributes**](#attributes)
+- [**How To Enable**](#how-to-enable)
+- [**Test Plugin**](#test-plugin)
+- [**Disable Plugin**](#disable-plugin)
+
+## Name
+
+The `grpc-web` plugin is a proxy plugin used to process [gRPC Web](https://github.com/grpc/grpc-web) client requests to `gRPC Server`.
+
+gRPC Web Client -> APISIX -> gRPC server
+
+## Attributes
+
+- None
Review comment:
We don't need to use list for one word?
--
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