api-breaker plugin returns default response body #6949

qihaiyan · 2022-04-27T07:47:36Z

Description

When upstream is in the unhealthy state, the api-breaker returns unhealthy.http_statuses only, without a response body.
In order to be more compatible to the client, return a default response body is useful.

Fixes #6923

Checklist

I have explained the need for this PR and the problem it solves
I have explained the changes or the new features added to this PR
I have added tests corresponding to this change
I have updated the documentation to reflect this change
I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

tokers · 2022-04-27T09:08:10Z

apisix/plugins/api-breaker.lua

+        break_response_body = {
+            type = "string"
+        },
+        break_response_content_type = {


Apache APISIX has a few plugins that define the response body but without setting the content type.

I'm thinking about that, if we need to keep the behaviors consistence?

If the body is json, and the content-type is text/html, some APP clients may report error, and the terminal user would be affected.

This problem cannot be solved even if we provide this field. People have to know how to configure it.

For these kinds of returning body, I think we may need a unified way to handle the Content-Type.

This problem cannot be solved even if we provide this field. People have to know how to configure it.

For these kinds of returning body, I think we may need a unified way to handle the Content-Type.

A unified way is good, but it's not that easy. Modern API returns application/json, but some legacy API returns application/soap+xml like SOAP.

I think the API owner should be responsible to configure route on the apigageway correctly , it's part of the developing work, and only the API owner knows what the correct Content-Type should be. If there's no way to config the Content-Type correctly, when break state is open, the client APP used this API may crash because of the unexpected Content-Type.

Ok, i'll browse all the plugins which should be with a content-type field and submit an issue with a checklist.

It is not a good idea, as this check won't fix the non-open-source plugins.

One solution is to guess:

according to the response body:

apisix/apisix/control/router.lua

Line 81 in cc88a8d

if type(body) == "table" and ngx.header["Content-Type"] == nil then

or using https://github.com/spacewander/lua-resty-mime-sniff

according to the Accept header or the ext part of the uri

Another solution is to configure it in the route

As for this plugin, I would suggest adding a field to add any response headers instead of just content-type.

As for this plugin, I would suggest adding a field to add any response headers instead of just content-type.

Is there any other plugin with such a field? I'm not sure of which field is suitable for representing any response headers. @spacewander

As for this plugin, I would suggest adding a field to add any response headers instead of just content-type.

Can we use the headers field to represent any response headers? I found the echo plugin and also the response-rewrite plugin using this attribute. @spacewander

Name Type Requirement Default Valid Description

headers array optional New headers for response. Using an array so multiple response headers with the same name can be used

Yes. And we should use an array so multiple response headers with the same name can be used.

apisix/plugins/api-breaker.lua

tzssangglass · 2022-04-28T13:41:31Z

Hi @qihaiyan , can we add a test cases to cover break_response_content_type ?

Co-authored-by: tzssangglass <tzssangglass@gmail.com>

qihaiyan · 2022-04-28T13:54:00Z

Hi @qihaiyan , can we add a test cases to cover break_response_content_type ?

Sure, i'll add the test cases tomorrow.

qihaiyan · 2022-04-29T05:25:52Z

Can you help to check why the chaos-test failed? @tzssangglass
https://github.com/apache/apisix/runs/6222619168?check_suite_focus=true

spacewander · 2022-04-29T06:24:51Z

Can you help to check why the chaos-test failed? @tzssangglass https://github.com/apache/apisix/runs/6222619168?check_suite_focus=true

The chaos test is not so stable. I have rerun it.

qihaiyan · 2022-04-29T08:23:08Z

The chaos test is not so stable. I have rerun it.
ok, thanks.

docs/en/latest/plugins/api-breaker.md

docs/zh/latest/plugins/api-breaker.md

Co-authored-by: Alex Zhang <tokers@apache.org>

apisix/plugins/api-breaker.lua

qihaiyan · 2022-05-09T01:38:21Z

This PR‘s status is Changes approved current now. Can i still add more commits to this PR to aim at @spacewander 's suggestion? @tzssangglass .

As for this plugin, I would suggest adding a field to add any response headers instead of just content-type.

spacewander

Yes, let's address #6949 (comment)

apisix/plugins/api-breaker.lua

Co-authored-by: 罗泽轩 <spacewanderlzx@gmail.com>

Co-authored-by: qihaiyan <qihaiyan@hisense.com> Co-authored-by: tzssangglass <tzssangglass@gmail.com> Co-authored-by: Alex Zhang <tokers@apache.org> Co-authored-by: 罗泽轩 <spacewanderlzx@gmail.com>

api-breaker plugin returns default response body

7a33476

tokers reviewed Apr 27, 2022

View reviewed changes

qihaiyan added 2 commits April 27, 2022 18:50

fix docs's lint error

367be74

fix error in api-breaker's ut

51a7710

tzssangglass reviewed Apr 28, 2022

View reviewed changes

apisix/plugins/api-breaker.lua Outdated Show resolved Hide resolved

Update apisix/plugins/api-breaker.lua

2c2f937

Co-authored-by: tzssangglass <tzssangglass@gmail.com>

add test case to cover break_response_content_type

80aeb8a

tokers reviewed Apr 29, 2022

View reviewed changes

docs/en/latest/plugins/api-breaker.md Outdated Show resolved Hide resolved

docs/zh/latest/plugins/api-breaker.md Outdated Show resolved Hide resolved

qihaiyan and others added 2 commits April 29, 2022 17:35

Update docs/en/latest/plugins/api-breaker.md

f623360

Co-authored-by: Alex Zhang <tokers@apache.org>

Update docs/zh/latest/plugins/api-breaker.md

e594c34

Co-authored-by: Alex Zhang <tokers@apache.org>

spacewander reviewed May 1, 2022

View reviewed changes

apisix/plugins/api-breaker.lua Outdated Show resolved Hide resolved

tokers previously approved these changes May 2, 2022

View reviewed changes

tzssangglass previously approved these changes May 9, 2022

View reviewed changes

spacewander reviewed May 9, 2022

View reviewed changes

adding the headers field to add any response headers

b345605

qihaiyan dismissed stale reviews from tzssangglass and tokers via b345605 May 9, 2022 13:31

tzssangglass reviewed May 9, 2022

View reviewed changes

apisix/plugins/api-breaker.lua Outdated Show resolved Hide resolved

revert check_schema

f2ff4d3

spacewander reviewed May 10, 2022

View reviewed changes

apisix/plugins/api-breaker.lua Outdated Show resolved Hide resolved

apisix/plugins/api-breaker.lua Outdated Show resolved Hide resolved

apisix/plugins/api-breaker.lua Outdated Show resolved Hide resolved

qihaiyan and others added 2 commits May 10, 2022 11:34

Update apisix/plugins/api-breaker.lua

6325416

Co-authored-by: 罗泽轩 <spacewanderlzx@gmail.com>

change headers attribute to break_response_headers

e207ca0

spacewander approved these changes May 10, 2022

View reviewed changes

tzssangglass approved these changes May 10, 2022

View reviewed changes

spacewander merged commit 01a6ab4 into apache:master May 10, 2022

qihaiyan deleted the feat-6923 branch May 10, 2022 06:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

api-breaker plugin returns default response body #6949

api-breaker plugin returns default response body #6949

qihaiyan commented Apr 27, 2022

tokers Apr 27, 2022

qihaiyan Apr 27, 2022 •

edited

Loading

tokers Apr 28, 2022

qihaiyan Apr 28, 2022

qihaiyan Apr 28, 2022

spacewander May 1, 2022

spacewander May 1, 2022

qihaiyan May 2, 2022 •

edited

Loading

qihaiyan May 8, 2022 •

edited

Loading

spacewander May 8, 2022

tzssangglass commented Apr 28, 2022

qihaiyan commented Apr 28, 2022

qihaiyan commented Apr 29, 2022

spacewander commented Apr 29, 2022

qihaiyan commented Apr 29, 2022

qihaiyan commented May 9, 2022

spacewander left a comment

api-breaker plugin returns default response body #6949

api-breaker plugin returns default response body #6949

Conversation

qihaiyan commented Apr 27, 2022

Description

Checklist

tokers Apr 27, 2022

Choose a reason for hiding this comment

qihaiyan Apr 27, 2022 • edited Loading

Choose a reason for hiding this comment

tokers Apr 28, 2022

Choose a reason for hiding this comment

qihaiyan Apr 28, 2022

Choose a reason for hiding this comment

qihaiyan Apr 28, 2022

Choose a reason for hiding this comment

spacewander May 1, 2022

Choose a reason for hiding this comment

spacewander May 1, 2022

Choose a reason for hiding this comment

qihaiyan May 2, 2022 • edited Loading

Choose a reason for hiding this comment

qihaiyan May 8, 2022 • edited Loading

Choose a reason for hiding this comment

spacewander May 8, 2022

Choose a reason for hiding this comment

tzssangglass commented Apr 28, 2022

qihaiyan commented Apr 28, 2022

qihaiyan commented Apr 29, 2022

spacewander commented Apr 29, 2022

qihaiyan commented Apr 29, 2022

qihaiyan commented May 9, 2022

spacewander left a comment

Choose a reason for hiding this comment

qihaiyan Apr 27, 2022 •

edited

Loading

qihaiyan May 2, 2022 •

edited

Loading

qihaiyan May 8, 2022 •

edited

Loading