From a8c9d0287151049a839df065feeae0a080d8ee09 Mon Sep 17 00:00:00 2001 From: Erik Timan Date: Sat, 3 Dec 2022 08:00:14 +0100 Subject: [PATCH 1/5] fix(emqx_gateway): return 204 for lwm2m client posts Change the return for lwm2m client API posts from 200 to 204 since they contain no content. --- apps/emqx_gateway/src/lwm2m/emqx_lwm2m_api.erl | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/apps/emqx_gateway/src/lwm2m/emqx_lwm2m_api.erl b/apps/emqx_gateway/src/lwm2m/emqx_lwm2m_api.erl index 9a6468455..9bf1d77ea 100644 --- a/apps/emqx_gateway/src/lwm2m/emqx_lwm2m_api.erl +++ b/apps/emqx_gateway/src/lwm2m/emqx_lwm2m_api.erl @@ -81,7 +81,7 @@ schema(?PATH("/observe")) -> ], 'requestBody' => [], responses => #{ - 200 => <<"No Content">>, + 204 => <<"No Content">>, 404 => error_codes(['CLIENT_NOT_FOUND'], <<"Clientid not found">>) } } @@ -98,7 +98,7 @@ schema(?PATH("/read")) -> {path, mk(binary(), #{in => query, required => true, example => "/3/0/7"})} ], responses => #{ - 200 => <<"No Content">>, + 204 => <<"No Content">>, 404 => error_codes(['CLIENT_NOT_FOUND'], <<"clientid not found">>) } } @@ -121,7 +121,7 @@ schema(?PATH("/write")) -> {value, mk(binary(), #{in => query, required => true, example => 123})} ], responses => #{ - 200 => <<"No Content">>, + 204 => <<"No Content">>, 404 => error_codes(['CLIENT_NOT_FOUND'], <<"Clientid not found">>) } } @@ -275,7 +275,7 @@ send_cmd(ClientId, Cmd) -> case emqx_gateway_cm_registry:lookup_channels(lwm2m, ClientId) of [Channel | _] -> ok = emqx_lwm2m_channel:send_cmd(Channel, Cmd), - {200}; + {204}; _ -> {404, #{code => 'CLIENT_NOT_FOUND'}} end. From 8009f0a3a8f643e8028927783537359efdbbd0ec Mon Sep 17 00:00:00 2001 From: Erik Timan Date: Mon, 5 Dec 2022 15:30:03 +0100 Subject: [PATCH 2/5] test: api returns for lwm2m client posts Add test coverage for HTTP 204 returns from lwm2m client API posts. This includes a small refactoring of the request functionality in emqx_mgmt_api_test_util. --- apps/emqx_gateway/test/emqx_lwm2m_api_SUITE.erl | 13 ++++++++----- .../test/emqx_mgmt_api_configs_SUITE.erl | 1 + .../test/emqx_mgmt_api_test_util.erl | 8 ++++++-- 3 files changed, 15 insertions(+), 7 deletions(-) diff --git a/apps/emqx_gateway/test/emqx_lwm2m_api_SUITE.erl b/apps/emqx_gateway/test/emqx_lwm2m_api_SUITE.erl index 6128b9b62..736acfa09 100644 --- a/apps/emqx_gateway/test/emqx_lwm2m_api_SUITE.erl +++ b/apps/emqx_gateway/test/emqx_lwm2m_api_SUITE.erl @@ -253,7 +253,7 @@ t_read(Config) -> test_recv_mqtt_response(RespTopic), %% step2, call Read API - call_send_api(Epn, "read", "path=/3/0/0"), + ?assertMatch({204, []}, call_send_api(Epn, "read", "path=/3/0/0")), timer:sleep(100), #coap_message{type = Type, method = Method, options = Opts} = test_recv_coap_request(UdpSock), ?assertEqual(con, Type), @@ -289,7 +289,7 @@ t_write(Config) -> test_recv_mqtt_response(RespTopic), %% step2, call write API - call_send_api(Epn, "write", "path=/3/0/13&type=Integer&value=123"), + ?assertMatch({204, []}, call_send_api(Epn, "write", "path=/3/0/13&type=Integer&value=123")), timer:sleep(100), #coap_message{type = Type, method = Method, options = Opts} = test_recv_coap_request(UdpSock), ?assertEqual(con, Type), @@ -326,7 +326,7 @@ t_observe(Config) -> test_recv_mqtt_response(RespTopic), %% step2, call observe API - call_deprecated_send_api(Epn, "observe", "path=/3/0/1&enable=false"), + ?assertMatch({204, []}, call_deprecated_send_api(Epn, "observe", "path=/3/0/1&enable=false")), timer:sleep(100), #coap_message{type = Type, method = Method, options = Opts} = test_recv_coap_request(UdpSock), ?assertEqual(con, Type), @@ -354,9 +354,12 @@ call_deprecated_send_api(ClientId, Cmd, Query) -> call_send_api(ClientId, Cmd, Query, API) -> ApiPath = emqx_mgmt_api_test_util:api_path([API, ClientId, Cmd]), Auth = emqx_mgmt_api_test_util:auth_header_(), - {ok, Response} = emqx_mgmt_api_test_util:request_api(post, ApiPath, Query, Auth), + Opts = #{return_body => true}, + {ok, {{"HTTP/1.1", StatusCode, _}, _Headers, Response}} = emqx_mgmt_api_test_util:request_api( + post, ApiPath, Query, Auth, [], Opts + ), ?LOGT("rest api response:~ts~n", [Response]), - Response. + {StatusCode, Response}. no_received_request(ClientId, Path, Action) -> Response = call_lookup_api(ClientId, Path, Action), diff --git a/apps/emqx_management/test/emqx_mgmt_api_configs_SUITE.erl b/apps/emqx_management/test/emqx_mgmt_api_configs_SUITE.erl index adea70af6..956014668 100644 --- a/apps/emqx_management/test/emqx_mgmt_api_configs_SUITE.erl +++ b/apps/emqx_management/test/emqx_mgmt_api_configs_SUITE.erl @@ -264,6 +264,7 @@ get_configs(Node, Opts) -> end, URI = emqx_mgmt_api_test_util:api_path(Path), case emqx_mgmt_api_test_util:request_api(get, URI, [], [], [], Opts) of + {ok, {_, _, Res}} -> {ok, emqx_json:decode(Res, [return_maps])}; {ok, Res} -> {ok, emqx_json:decode(Res, [return_maps])}; Error -> Error end. diff --git a/apps/emqx_management/test/emqx_mgmt_api_test_util.erl b/apps/emqx_management/test/emqx_mgmt_api_test_util.erl index aed28930b..00f932a3a 100644 --- a/apps/emqx_management/test/emqx_mgmt_api_test_util.erl +++ b/apps/emqx_management/test/emqx_mgmt_api_test_util.erl @@ -94,10 +94,14 @@ do_request_api(Method, Request, Opts) -> case httpc:request(Method, Request, [], []) of {error, socket_closed_remotely} -> {error, socket_closed_remotely}; - {ok, {{"HTTP/1.1", Code, _}, _, Return}} when + {ok, {{"HTTP/1.1", Code, _} = Reason, Headers, Body}} when + Code >= 200 andalso Code =< 299 andalso ReturnBody + -> + {ok, {Reason, Headers, Body}}; + {ok, {{"HTTP/1.1", Code, _}, _, Body}} when Code >= 200 andalso Code =< 299 -> - {ok, Return}; + {ok, Body}; {ok, {Reason, Headers, Body}} when ReturnBody -> {error, {Reason, Headers, Body}}; {ok, {Reason, _Headers, _Body}} -> From d22756d99e2908f39f44265e3f8b2cf612bf4d22 Mon Sep 17 00:00:00 2001 From: Erik Timan Date: Mon, 5 Dec 2022 16:25:00 +0100 Subject: [PATCH 3/5] chore: update changes --- changes/v5.0.12-en.md | 2 ++ changes/v5.0.12-zh.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/changes/v5.0.12-en.md b/changes/v5.0.12-en.md index 19a9ab9f1..d1c09fd57 100644 --- a/changes/v5.0.12-en.md +++ b/changes/v5.0.12-en.md @@ -34,6 +34,8 @@ Please note, the request body of `/bridges` API to configure MQTT brdige is chan - Users can define the `externalTrafficPolicy` of service in EMQX Helm Chart [#9527](https://github.com/emqx/emqx/pull/9527). +- Return `204` instead of `200` for `POST /gateway/lwm2m/clients/{clientid}/{read,write,observe}` [#9480](https://github.com/emqx/emqx/pull/9480). + ## Bug fixes - Fix that the obsolete SSL files aren't deleted after the ExHook config update [#9432](https://github.com/emqx/emqx/pull/9432). diff --git a/changes/v5.0.12-zh.md b/changes/v5.0.12-zh.md index e0efcdf8a..1bf22c813 100644 --- a/changes/v5.0.12-zh.md +++ b/changes/v5.0.12-zh.md @@ -33,6 +33,8 @@ v5.0.11 或更早版本创建的配置文件，在新版本中会被自动转换 - 用户可以在 EMQX Helm Chart 中自定义 service 资源的 `externalTrafficPolicy` [#9527](https://github.com/emqx/emqx/pull/9527)。 +- Return `204` instead of `200` for `POST /gateway/lwm2m/clients/{clientid}/{read,write,observe}` [#9480](https://github.com/emqx/emqx/pull/9480). + ## 修复 - 修复 ExHook 更新 SSL 相关配置后，过时的 SSL 文件没有被删除的问题 [#9432](https://github.com/emqx/emqx/pull/9432)。 From 0242d5f3606f11b74146a2faa9552f128cb713fc Mon Sep 17 00:00:00 2001 From: Erik Timan Date: Wed, 7 Dec 2022 11:32:05 +0100 Subject: [PATCH 4/5] test: rename return_body to return_all in emqx_mgmt api test util --- apps/emqx_gateway/test/emqx_lwm2m_api_SUITE.erl | 2 +- apps/emqx_management/test/emqx_mgmt_api_configs_SUITE.erl | 6 +++--- apps/emqx_management/test/emqx_mgmt_api_publish_SUITE.erl | 6 +++--- apps/emqx_management/test/emqx_mgmt_api_test_util.erl | 6 +++--- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/apps/emqx_gateway/test/emqx_lwm2m_api_SUITE.erl b/apps/emqx_gateway/test/emqx_lwm2m_api_SUITE.erl index 736acfa09..5b206dffb 100644 --- a/apps/emqx_gateway/test/emqx_lwm2m_api_SUITE.erl +++ b/apps/emqx_gateway/test/emqx_lwm2m_api_SUITE.erl @@ -354,7 +354,7 @@ call_deprecated_send_api(ClientId, Cmd, Query) -> call_send_api(ClientId, Cmd, Query, API) -> ApiPath = emqx_mgmt_api_test_util:api_path([API, ClientId, Cmd]), Auth = emqx_mgmt_api_test_util:auth_header_(), - Opts = #{return_body => true}, + Opts = #{return_all => true}, {ok, {{"HTTP/1.1", StatusCode, _}, _Headers, Response}} = emqx_mgmt_api_test_util:request_api( post, ApiPath, Query, Auth, [], Opts ), diff --git a/apps/emqx_management/test/emqx_mgmt_api_configs_SUITE.erl b/apps/emqx_management/test/emqx_mgmt_api_configs_SUITE.erl index 956014668..067fe312f 100644 --- a/apps/emqx_management/test/emqx_mgmt_api_configs_SUITE.erl +++ b/apps/emqx_management/test/emqx_mgmt_api_configs_SUITE.erl @@ -228,10 +228,10 @@ t_configs_node({'end', _}) -> t_configs_node(_) -> Node = atom_to_list(node()), - ?assertEqual({ok, <<"self">>}, get_configs(Node, #{return_body => true})), - ?assertEqual({ok, <<"other">>}, get_configs("other_node", #{return_body => true})), + ?assertEqual({ok, <<"self">>}, get_configs(Node, #{return_all => true})), + ?assertEqual({ok, <<"other">>}, get_configs("other_node", #{return_all => true})), - {ExpType, ExpRes} = get_configs("unknown_node", #{return_body => true}), + {ExpType, ExpRes} = get_configs("unknown_node", #{return_all => true}), ?assertEqual(error, ExpType), ?assertMatch({{_, 404, _}, _, _}, ExpRes), {_, _, Body} = ExpRes, diff --git a/apps/emqx_management/test/emqx_mgmt_api_publish_SUITE.erl b/apps/emqx_management/test/emqx_mgmt_api_publish_SUITE.erl index 7622b0d17..783a90185 100644 --- a/apps/emqx_management/test/emqx_mgmt_api_publish_SUITE.erl +++ b/apps/emqx_management/test/emqx_mgmt_api_publish_SUITE.erl @@ -163,7 +163,7 @@ t_publish_too_large(Config) -> "", Auth, Body, - #{return_body => true} + #{return_all => true} ), ?assertMatch({_, 400, _}, Summary), ?assertMatch( @@ -286,7 +286,7 @@ t_publish_bulk_dispatch_one_message_invalid_topic(Config) when is_list(Config) - "", Auth, Body, - #{return_body => true} + #{return_all => true} ), ?assertMatch({_, 400, _}, Summary), ?assertMatch( @@ -325,7 +325,7 @@ t_publish_bulk_dispatch_failure(Config) when is_list(Config) -> "", Auth, Body, - #{return_body => true} + #{return_all => true} ), ?assertMatch({_, 503, _}, Summary), ?assertMatch( diff --git a/apps/emqx_management/test/emqx_mgmt_api_test_util.erl b/apps/emqx_management/test/emqx_mgmt_api_test_util.erl index 00f932a3a..ec40e3cc2 100644 --- a/apps/emqx_management/test/emqx_mgmt_api_test_util.erl +++ b/apps/emqx_management/test/emqx_mgmt_api_test_util.erl @@ -89,20 +89,20 @@ request_api(Method, Url, QueryParams, AuthOrHeaders, Body, Opts) when ). do_request_api(Method, Request, Opts) -> - ReturnBody = maps:get(return_body, Opts, false), + ReturnAll = maps:get(return_all, Opts, false), ct:pal("Method: ~p, Request: ~p", [Method, Request]), case httpc:request(Method, Request, [], []) of {error, socket_closed_remotely} -> {error, socket_closed_remotely}; {ok, {{"HTTP/1.1", Code, _} = Reason, Headers, Body}} when - Code >= 200 andalso Code =< 299 andalso ReturnBody + Code >= 200 andalso Code =< 299 andalso ReturnAll -> {ok, {Reason, Headers, Body}}; {ok, {{"HTTP/1.1", Code, _}, _, Body}} when Code >= 200 andalso Code =< 299 -> {ok, Body}; - {ok, {Reason, Headers, Body}} when ReturnBody -> + {ok, {Reason, Headers, Body}} when ReturnAll -> {error, {Reason, Headers, Body}}; {ok, {Reason, _Headers, _Body}} -> {error, Reason} From 272337cceb03e02465f9da554b2f8a83274d266c Mon Sep 17 00:00:00 2001 From: Erik Timan Date: Fri, 9 Dec 2022 10:35:41 +0100 Subject: [PATCH 5/5] chore: update changes --- changes/v5.0.12-zh.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changes/v5.0.12-zh.md b/changes/v5.0.12-zh.md index 1bf22c813..61ab2e0e8 100644 --- a/changes/v5.0.12-zh.md +++ b/changes/v5.0.12-zh.md @@ -33,7 +33,7 @@ v5.0.11 或更早版本创建的配置文件，在新版本中会被自动转换 - 用户可以在 EMQX Helm Chart 中自定义 service 资源的 `externalTrafficPolicy` [#9527](https://github.com/emqx/emqx/pull/9527)。 -- Return `204` instead of `200` for `POST /gateway/lwm2m/clients/{clientid}/{read,write,observe}` [#9480](https://github.com/emqx/emqx/pull/9480). +- 现在调用 `POST /gateway/lwm2m/clients/{clientid}/{read,write,observe}` 时，将会返回 204，而不再是 200 [#9480](https://github.com/emqx/emqx/pull/9480)。 ## 修复