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/05/07 03:03:40 UTC
[GitHub] [apisix] tzssangglass commented on a diff in pull request #6968: feat: support hook response body for ext-plugin
tzssangglass commented on code in PR #6968:
URL: https://github.com/apache/apisix/pull/6968#discussion_r867292653
##########
apisix/plugins/ext-plugin-post-resp.lua:
##########
@@ -0,0 +1,168 @@
+--
+-- 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 core = require("apisix.core")
+local ext = require("apisix.plugins.ext-plugin.init")
+local constants = require("apisix.constants")
+local http = require("resty.http")
+
+local ngx = ngx
+local ngx_print = ngx.print
+local ngx_flush = ngx.flush
+local string = string
+local str_sub = string.sub
+
+
+local name = "ext-plugin-post-resp"
+local _M = {
+ version = 0.1,
+ priority = -4000,
+ name = name,
+ schema = ext.schema,
+}
+
+
+local function include_req_headers(ctx)
+ -- TODO: handle proxy_set_header
+ return core.request.headers(ctx)
+end
+
+
+local function get_http_obj(ctx)
+ return http.new()
+end
+
+
+local function close(ctx, http_obj)
Review Comment:
`ctx` is not used
##########
apisix/plugins/ext-plugin-post-resp.lua:
##########
@@ -0,0 +1,168 @@
+--
+-- 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 core = require("apisix.core")
+local ext = require("apisix.plugins.ext-plugin.init")
+local constants = require("apisix.constants")
+local http = require("resty.http")
+
+local ngx = ngx
+local ngx_print = ngx.print
+local ngx_flush = ngx.flush
+local string = string
+local str_sub = string.sub
+
+
+local name = "ext-plugin-post-resp"
+local _M = {
+ version = 0.1,
+ priority = -4000,
+ name = name,
+ schema = ext.schema,
+}
+
+
+local function include_req_headers(ctx)
+ -- TODO: handle proxy_set_header
+ return core.request.headers(ctx)
+end
+
+
+local function get_http_obj(ctx)
+ return http.new()
+end
+
+
+local function close(ctx, http_obj)
+ -- TODO: keepalive
+ local ok, err = http_obj:close()
+ if not ok then
+ core.log.error("close http object failed: ", err)
+ end
+end
+
+
+local function get_response(ctx, http_obj)
+ local ok, err = http_obj:connect({
+ scheme = ctx.upstream_scheme,
+ host = ctx.picked_server.host,
+ port = ctx.picked_server.port,
+ })
+
+ if not ok then
+ return nil, err
+ end
+ -- TODO: set timeout
+ local uri, args
+ if ctx.var.upstream_uri == "" then
+ -- use original uri instead of rewritten one
+ uri = ctx.var.uri
+ else
+ uri = ctx.var.upstream_uri
+
+ -- the rewritten one may contain new args
+ local index = core.string.find(uri, "?")
+ if index then
+ local raw_uri = uri
+ uri = str_sub(raw_uri, 1, index - 1)
+ args = str_sub(raw_uri, index + 1)
+ end
+ end
+ local params = {
+ path = uri,
+ query = args or ctx.var.args,
+ headers = include_req_headers(ctx),
+ method = core.request.get_method(),
+ }
+
+ local body, err = core.request.get_body()
+ if err then
+ return nil, err
+ end
+
+ if body then
+ params["body"] = body
+ end
+
+ local res, err = http_obj:request(params)
+ if not res then
+ return nil, err
+ end
+
+ return res, err
+end
+
+
+function _M.check_schema(conf)
+ return core.schema.check(_M.schema, conf)
+end
+
+
+function _M.before_proxy(conf, ctx)
+ local http_obj = get_http_obj(ctx)
+ local res, err = get_response(ctx, http_obj)
+ if not res or err then
Review Comment:
Line 100 has judgment that res is nil?
##########
apisix/plugins/ext-plugin-post-resp.lua:
##########
@@ -0,0 +1,168 @@
+--
+-- 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 core = require("apisix.core")
+local ext = require("apisix.plugins.ext-plugin.init")
+local constants = require("apisix.constants")
+local http = require("resty.http")
+
+local ngx = ngx
+local ngx_print = ngx.print
+local ngx_flush = ngx.flush
+local string = string
+local str_sub = string.sub
+
+
+local name = "ext-plugin-post-resp"
+local _M = {
+ version = 0.1,
+ priority = -4000,
+ name = name,
+ schema = ext.schema,
+}
+
+
+local function include_req_headers(ctx)
+ -- TODO: handle proxy_set_header
+ return core.request.headers(ctx)
+end
+
+
+local function get_http_obj(ctx)
+ return http.new()
+end
+
+
+local function close(ctx, http_obj)
+ -- TODO: keepalive
+ local ok, err = http_obj:close()
+ if not ok then
+ core.log.error("close http object failed: ", err)
+ end
+end
+
+
+local function get_response(ctx, http_obj)
+ local ok, err = http_obj:connect({
+ scheme = ctx.upstream_scheme,
+ host = ctx.picked_server.host,
+ port = ctx.picked_server.port,
+ })
+
+ if not ok then
+ return nil, err
+ end
+ -- TODO: set timeout
+ local uri, args
+ if ctx.var.upstream_uri == "" then
+ -- use original uri instead of rewritten one
+ uri = ctx.var.uri
+ else
+ uri = ctx.var.upstream_uri
+
+ -- the rewritten one may contain new args
+ local index = core.string.find(uri, "?")
+ if index then
+ local raw_uri = uri
+ uri = str_sub(raw_uri, 1, index - 1)
+ args = str_sub(raw_uri, index + 1)
+ end
+ end
+ local params = {
+ path = uri,
+ query = args or ctx.var.args,
+ headers = include_req_headers(ctx),
+ method = core.request.get_method(),
+ }
+
+ local body, err = core.request.get_body()
+ if err then
+ return nil, err
+ end
+
+ if body then
+ params["body"] = body
+ end
+
+ local res, err = http_obj:request(params)
+ if not res then
+ return nil, err
+ end
+
+ return res, err
+end
+
+
+function _M.check_schema(conf)
+ return core.schema.check(_M.schema, conf)
+end
+
+
+function _M.before_proxy(conf, ctx)
+ local http_obj = get_http_obj(ctx)
+ local res, err = get_response(ctx, http_obj)
+ if not res or err then
+ core.log.error("failed to request: ", err or "")
+ close(ctx, http_obj)
+ return 502
+ end
+ ctx.runner_ext_response = res
+
+ core.log.info("response info, status: ", res.status)
+ core.log.info("response info, headers: ", core.json.delay_encode(res.headers))
+
+ local code, body = ext.communicate(conf, ctx, name, constants.RPC_HTTP_RESP_CALL)
+ if body then
+ -- if body the body is changed, the code will be setc
Review Comment:
The meaning of this comment is unclear?
##########
apisix/plugins/ext-plugin-post-resp.lua:
##########
@@ -0,0 +1,168 @@
+--
+-- 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 core = require("apisix.core")
+local ext = require("apisix.plugins.ext-plugin.init")
+local constants = require("apisix.constants")
+local http = require("resty.http")
+
+local ngx = ngx
+local ngx_print = ngx.print
+local ngx_flush = ngx.flush
+local string = string
+local str_sub = string.sub
+
+
+local name = "ext-plugin-post-resp"
+local _M = {
+ version = 0.1,
+ priority = -4000,
+ name = name,
+ schema = ext.schema,
+}
+
+
+local function include_req_headers(ctx)
+ -- TODO: handle proxy_set_header
+ return core.request.headers(ctx)
+end
+
+
+local function get_http_obj(ctx)
+ return http.new()
+end
+
+
+local function close(ctx, http_obj)
+ -- TODO: keepalive
+ local ok, err = http_obj:close()
+ if not ok then
+ core.log.error("close http object failed: ", err)
+ end
+end
+
+
+local function get_response(ctx, http_obj)
+ local ok, err = http_obj:connect({
+ scheme = ctx.upstream_scheme,
+ host = ctx.picked_server.host,
+ port = ctx.picked_server.port,
+ })
+
+ if not ok then
+ return nil, err
+ end
+ -- TODO: set timeout
+ local uri, args
+ if ctx.var.upstream_uri == "" then
+ -- use original uri instead of rewritten one
+ uri = ctx.var.uri
+ else
+ uri = ctx.var.upstream_uri
+
+ -- the rewritten one may contain new args
+ local index = core.string.find(uri, "?")
+ if index then
+ local raw_uri = uri
+ uri = str_sub(raw_uri, 1, index - 1)
+ args = str_sub(raw_uri, index + 1)
+ end
+ end
+ local params = {
+ path = uri,
+ query = args or ctx.var.args,
+ headers = include_req_headers(ctx),
+ method = core.request.get_method(),
+ }
+
+ local body, err = core.request.get_body()
+ if err then
+ return nil, err
+ end
+
+ if body then
+ params["body"] = body
+ end
+
+ local res, err = http_obj:request(params)
+ if not res then
+ return nil, err
+ end
+
+ return res, err
+end
+
+
+function _M.check_schema(conf)
+ return core.schema.check(_M.schema, conf)
+end
+
+
+function _M.before_proxy(conf, ctx)
+ local http_obj = get_http_obj(ctx)
Review Comment:
Why is there a separate function here, and it doesn't seem to use ctx in the function
--
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