yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(api-topics): respond with `count` when it's cheap to compute

This commit is contained in:
Andrew Mayorov 2024-02-28 11:28:33 +01:00
parent bd578a799e
commit c3b044a37b
No known key found for this signature in database
GPG Key ID: 2837C62ACFBFED5D
2 changed files with 30 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
apps/emqx_management/src/emqx_mgmt_api_topics.erl
View File

@ -115,7 +115,7 @@ do_list(Params) ->
{_, Query} = emqx_mgmt_api:parse_qstring(Params, ?TOPICS_QUERY_SCHEMA),
QState = Pager#{continuation => undefined},
QResult = eval_topic_query(qs2ms(Query), QState),
{200, format_list_response(Pager, QResult)}
{200, format_list_response(Pager, Query, QResult)}
catch
throw:{error, page_limit_invalid} ->
{400, #{code => <<"INVALID_PARAMETER">>, message => <<"page_limit_invalid">>}};
@ -186,15 +186,22 @@ finalize_query(QResult = #{overflow := Overflow, complete := Complete}) ->
HasNext = Overflow orelse not Complete,
QResult#{hasnext => HasNext}.
format_list_response(Meta, _QResult = #{hasnext := HasNext, rows := RowsAcc, cursor := Cursor}) ->
format_list_response(Meta, Query, QResult = #{rows := RowsAcc}) ->
#{
meta => Meta#{hasnext => HasNext, count => Cursor},
meta => format_response_meta(Meta, Query, QResult),
data => lists:flatmap(
fun({_Node, Rows}) -> [format(R) || R <- Rows] end,
RowsAcc
)
}.
format_response_meta(Meta, _Query, #{hasnext := HasNext, complete := true, cursor := Cursor}) ->
Meta#{hasnext => HasNext, count => Cursor};
format_response_meta(Meta, _Query = {[], []}, #{hasnext := HasNext}) ->
Meta#{hasnext => HasNext, count => emqx_router:stats(n_routes)};
format_response_meta(Meta, _Query, #{hasnext := HasNext}) ->
Meta#{hasnext => HasNext}.
format(#route{topic = Topic, dest = {Group, Node}}) ->
#{topic => ?SHARE(Group, Topic), node => Node};
format(#route{topic = Topic, dest = Node}) when is_atom(Node) ->

38
apps/emqx_management/test/emqx_mgmt_api_topics_SUITE.erl
View File

@ -64,12 +64,11 @@ t_nodes_api(Config) ->
{"node", atom_to_list(node())}
]),
?assertMatch(
#{<<"count">> := 1, <<"page">> := 1, <<"limit">> := 100},
maps:get(<<"meta">>, MatchData)
),
?assertMatch(
[#{<<"topic">> := Topic2, <<"node">> := Node}],
maps:get(<<"data">>, MatchData)
#{
<<"data">> := [#{<<"topic">> := Topic2, <<"node">> := Node}],
<<"meta">> := #{<<"page">> := 1, <<"limit">> := 100, <<"count">> := 1}
},
MatchData
),
%% get topics/:topic
@ -114,6 +113,11 @@ t_paging(_Config) ->
Matched,
request_json(get, ["topics"], [{"node", Node}])
),
?assertEqual(
%% NOTE: No `count` in this case.
#{<<"hasnext">> => true, <<"page">> => 1, <<"limit">> => 3},
maps:get(<<"meta">>, request_json(get, ["topics"], [{"node", Node}, {"limit", "3"}]))
),
R1 = #{<<"data">> := Data1} = request_json(get, ["topics"], [{"page", "1"}, {"limit", "5"}]),
R2 = #{<<"data">> := Data2} = request_json(get, ["topics"], [{"page", "2"}, {"limit", "5"}]),
?assertMatch(
@ -150,12 +154,11 @@ t_percent_topics(_Config) ->
{"node", atom_to_list(node())}
]),
?assertMatch(
#{<<"count">> := 1, <<"page">> := 1, <<"limit">> := 100},
maps:get(<<"meta">>, MatchData)
),
?assertMatch(
[#{<<"topic">> := Topic, <<"node">> := Node}],
maps:get(<<"data">>, MatchData)
#{
<<"data">> := [#{<<"topic">> := Topic, <<"node">> := Node}],
<<"meta">> := #{<<"page">> := 1, <<"limit">> := 100, <<"count">> := 1}
},
MatchData
),
ok = emqtt:stop(Client).
@ -175,12 +178,11 @@ t_shared_topics(_Configs) ->
{"node", atom_to_list(node())}
]),
?assertMatch(
#{<<"count">> := 1, <<"page">> := 1, <<"limit">> := 100},
maps:get(<<"meta">>, MatchData)
),
?assertMatch(
[#{<<"topic">> := Topic, <<"node">> := Node}],
maps:get(<<"data">>, MatchData)
#{
<<"data">> := [#{<<"topic">> := Topic, <<"node">> := Node}],
<<"meta">> := #{<<"page">> := 1, <<"limit">> := 100, <<"count">> := 1}
},
MatchData
),
ok = emqtt:stop(Client).