From 256cdd50ff45206832199de58f53be2da8230f1e Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Tue, 5 Jul 2022 10:15:22 +0200 Subject: [PATCH 01/38] chore: delete unused schema module --- .../src/emqx_management_schema.erl | 32 ------------------- 1 file changed, 32 deletions(-) delete mode 100644 apps/emqx_management/src/emqx_management_schema.erl diff --git a/apps/emqx_management/src/emqx_management_schema.erl b/apps/emqx_management/src/emqx_management_schema.erl deleted file mode 100644 index 90c05781d..000000000 --- a/apps/emqx_management/src/emqx_management_schema.erl +++ /dev/null @@ -1,32 +0,0 @@ -%%-------------------------------------------------------------------- -%% Copyright (c) 2020-2022 EMQ Technologies Co., Ltd. All Rights Reserved. -%% -%% Licensed 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. -%%-------------------------------------------------------------------- --module(emqx_management_schema). - --include_lib("typerefl/include/types.hrl"). - --behaviour(hocon_schema). - --export([ - namespace/0, - roots/0, - fields/1 -]). - -namespace() -> management. - -roots() -> []. - -fields(_) -> []. From 050f68cf5df486a632a73ccc5f1d5a907187a114 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Tue, 19 Jul 2022 20:13:54 +0200 Subject: [PATCH 02/38] test: allow missing schema for app in tests --- apps/emqx/test/emqx_common_test_helpers.erl | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/apps/emqx/test/emqx_common_test_helpers.erl b/apps/emqx/test/emqx_common_test_helpers.erl index b3292ded3..ce998656a 100644 --- a/apps/emqx/test/emqx_common_test_helpers.erl +++ b/apps/emqx/test/emqx_common_test_helpers.erl @@ -181,11 +181,15 @@ start_app(App, Handler) -> app_conf_file(emqx_conf) -> "emqx.conf.all"; app_conf_file(App) -> atom_to_list(App) ++ ".conf". -%% TODO: get rid of cuttlefish app_schema(App) -> Mod = list_to_atom(atom_to_list(App) ++ "_schema"), - true = is_list(Mod:roots()), - Mod. + try + true = is_list(Mod:roots()), + Mod + catch + error:undef -> + no_schema + end. mustache_vars(App) -> [ @@ -221,6 +225,8 @@ render_config_file(ConfigFile, Vars0) -> ok = file:write_file(NewName, Targ), NewName. +read_schema_configs(no_schema, _ConfigFile) -> + ok; read_schema_configs(Schema, ConfigFile) -> NewConfig = generate_config(Schema, ConfigFile), lists:foreach( From 7451351c42111ec2f9e6bb6032553b58726d2b29 Mon Sep 17 00:00:00 2001 From: William Yang Date: Mon, 29 Aug 2022 14:46:47 +0200 Subject: [PATCH 03/38] fix: quic listener idle_timeout type err --- CHANGES-5.0.md | 1 + apps/emqx/src/emqx_schema.erl | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGES-5.0.md b/CHANGES-5.0.md index 66529953a..210a5c5ad 100644 --- a/CHANGES-5.0.md +++ b/CHANGES-5.0.md @@ -5,6 +5,7 @@ * Remove the needless `will_msg` field from the client API. [#8721](https://github.com/emqx/emqx/pull/8721) * Fix `$queue` topic name error in management API return. [#8728](https://github.com/emqx/emqx/pull/8728) * Fix sometimes `client.connected` and `client.disconnected` could be in wrong order. [#8625](https://github.com/emqx/emqx/pull/8625) +* Fix quic listener default idle timeout's type. [#8826](https://github.com/emqx/emqx/pull/8826) ## Enhancements diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl index 75818ab2b..b2c7723d0 100644 --- a/apps/emqx/src/emqx_schema.erl +++ b/apps/emqx/src/emqx_schema.erl @@ -869,7 +869,7 @@ fields("mqtt_quic_listener") -> sc( duration_ms(), #{ - default => "0", + default => 0, desc => ?DESC(fields_mqtt_quic_listener_idle_timeout) } )}, From dceb93dc2ae850c4c52d3e85419054cf16b8255c Mon Sep 17 00:00:00 2001 From: zhouzb Date: Tue, 30 Aug 2022 09:33:52 +0800 Subject: [PATCH 04/38] chore: bump helm chart version to 5.0.7 --- deploy/charts/emqx/Chart.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/deploy/charts/emqx/Chart.yaml b/deploy/charts/emqx/Chart.yaml index e18bac2b8..544d848fd 100644 --- a/deploy/charts/emqx/Chart.yaml +++ b/deploy/charts/emqx/Chart.yaml @@ -14,8 +14,8 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. -version: 5 +version: 5.0.7 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. -appVersion: latest +appVersion: 5.0.7 From 80bdc2b8e8b4cd37453747ac294381e23edc8fb4 Mon Sep 17 00:00:00 2001 From: zhouzb Date: Tue, 30 Aug 2022 15:42:08 +0800 Subject: [PATCH 05/38] docs(changes): add changes for bootstrap users --- CHANGES-5.0.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES-5.0.md b/CHANGES-5.0.md index 3bd74e00b..5eca6a9a3 100644 --- a/CHANGES-5.0.md +++ b/CHANGES-5.0.md @@ -27,6 +27,7 @@ ## Enhancements +* Add `bootstrap_users_file` configuration to add default Dashboard username list, which is only added when EMQX is first started. * The license is now copied to all nodes in the cluster when it's reloaded. [#8598](https://github.com/emqx/emqx/pull/8598) * Added a HTTP API to manage licenses. [#8610](https://github.com/emqx/emqx/pull/8610) * Updated `/nodes` API node_status from `Running/Stopped` to `running/stopped`. [#8642](https://github.com/emqx/emqx/pull/8642) From 168f44e45bb96c5f6f39a018b93b5d75d7c1b135 Mon Sep 17 00:00:00 2001 From: JianBo He Date: Tue, 23 Aug 2022 15:26:05 +0800 Subject: [PATCH 06/38] fix: exhook client.authorize never be execauted see: https://github.com/emqx/emqx/issues/8779 --- apps/emqx/src/emqx_access_control.erl | 24 +++++++++++++++++--- apps/emqx_authz/src/emqx_authz.erl | 22 ++++-------------- apps/emqx_exhook/src/emqx_exhook_handler.erl | 4 ++-- 3 files changed, 28 insertions(+), 22 deletions(-) diff --git a/apps/emqx/src/emqx_access_control.erl b/apps/emqx/src/emqx_access_control.erl index 1b864cda9..1345c78e0 100644 --- a/apps/emqx/src/emqx_access_control.erl +++ b/apps/emqx/src/emqx_access_control.erl @@ -17,6 +17,7 @@ -module(emqx_access_control). -include("emqx.hrl"). +-include("logger.hrl"). -export([ authenticate/1, @@ -70,9 +71,26 @@ check_authorization_cache(ClientInfo, PubSub, Topic) -> do_authorize(ClientInfo, PubSub, Topic) -> NoMatch = emqx:get_config([authorization, no_match], allow), - case run_hooks('client.authorize', [ClientInfo, PubSub, Topic], NoMatch) of - allow -> allow; - _Other -> deny + Default = #{result => NoMatch, from => default}, + case run_hooks('client.authorize', [ClientInfo, PubSub, Topic], Default) of + AuthzResult = #{result := Result} when Result == allow; Result == deny -> + From = maps:get(from, AuthzResult, unknown), + emqx:run_hook( + 'client.check_authz_complete', + [ClientInfo, PubSub, Topic, Result, From] + ), + Result; + Other -> + ?SLOG(error, #{ + msg => "unknown_authorization_return_format", + expected_example => "#{result => allow, from => default}", + got => Other + }), + emqx:run_hook( + 'client.check_authz_complete', + [ClientInfo, PubSub, Topic, deny, unknown_return_format] + ), + deny end. -compile({inline, [run_hooks/3]}). diff --git a/apps/emqx_authz/src/emqx_authz.erl b/apps/emqx_authz/src/emqx_authz.erl index 8eb3c6eae..c5b08e70c 100644 --- a/apps/emqx_authz/src/emqx_authz.erl +++ b/apps/emqx_authz/src/emqx_authz.erl @@ -319,7 +319,7 @@ authorize( is_superuser => true }), emqx_metrics:inc(?METRIC_SUPERUSER), - {stop, allow}; + {stop, #{result => allow, from => superuser}}; false -> authorize_non_superuser(Client, PubSub, Topic, DefaultResult, Sources) end. @@ -331,15 +331,11 @@ authorize_non_superuser( } = Client, PubSub, Topic, - DefaultResult, + _DefaultResult, Sources ) -> case do_authorize(Client, PubSub, Topic, sources_with_defaults(Sources)) of {{matched, allow}, AuthzSource} -> - emqx:run_hook( - 'client.check_authz_complete', - [Client, PubSub, Topic, allow, AuthzSource] - ), log_allowed(#{ username => Username, ipaddr => IpAddress, @@ -348,12 +344,8 @@ authorize_non_superuser( }), emqx_metrics_worker:inc(authz_metrics, AuthzSource, allow), emqx_metrics:inc(?METRIC_ALLOW), - {stop, allow}; + {stop, #{result => allow, from => AuthzSource}}; {{matched, deny}, AuthzSource} -> - emqx:run_hook( - 'client.check_authz_complete', - [Client, PubSub, Topic, deny, AuthzSource] - ), ?SLOG(warning, #{ msg => "authorization_permission_denied", username => Username, @@ -363,12 +355,8 @@ authorize_non_superuser( }), emqx_metrics_worker:inc(authz_metrics, AuthzSource, deny), emqx_metrics:inc(?METRIC_DENY), - {stop, deny}; + {stop, #{result => deny, from => AuthzSource}}; nomatch -> - emqx:run_hook( - 'client.check_authz_complete', - [Client, PubSub, Topic, DefaultResult, default] - ), ?SLOG(info, #{ msg => "authorization_failed_nomatch", username => Username, @@ -377,7 +365,7 @@ authorize_non_superuser( reason => "no-match rule" }), emqx_metrics:inc(?METRIC_NOMATCH), - {stop, DefaultResult} + ignore end. log_allowed(Meta) -> diff --git a/apps/emqx_exhook/src/emqx_exhook_handler.erl b/apps/emqx_exhook/src/emqx_exhook_handler.erl index eace7a52f..ddf25cfdf 100644 --- a/apps/emqx_exhook/src/emqx_exhook_handler.erl +++ b/apps/emqx_exhook/src/emqx_exhook_handler.erl @@ -133,7 +133,7 @@ on_client_authenticate(ClientInfo, AuthResult) -> end. on_client_authorize(ClientInfo, PubSub, Topic, Result) -> - Bool = Result == allow, + Bool = maps:get(result, Result, deny) == allow, Type = case PubSub of publish -> 'PUBLISH'; @@ -158,7 +158,7 @@ on_client_authorize(ClientInfo, PubSub, Topic, Result) -> true -> allow; _ -> deny end, - {StopOrOk, NResult}; + {StopOrOk, #{result => NResult, from => exhook}}; _ -> {ok, Result} end. From 1cb281fbc4aa0832fb24051c23ecece949e0d51b Mon Sep 17 00:00:00 2001 From: Zhongwen Deng Date: Wed, 31 Aug 2022 15:42:39 +0800 Subject: [PATCH 07/38] fix: return 503 if dashboard's router not ready --- .../src/emqx_dashboard_middleware.erl | 2 +- .../src/emqx_mgmt_api_status.erl | 38 +++++++++++-------- 2 files changed, 24 insertions(+), 16 deletions(-) diff --git a/apps/emqx_dashboard/src/emqx_dashboard_middleware.erl b/apps/emqx_dashboard/src/emqx_dashboard_middleware.erl index 67f907bbb..4188950a6 100644 --- a/apps/emqx_dashboard/src/emqx_dashboard_middleware.erl +++ b/apps/emqx_dashboard/src/emqx_dashboard_middleware.erl @@ -23,7 +23,7 @@ execute(Req, Env) -> case check_dispatch_ready(Env) of true -> add_cors_flag(Req, Env); - false -> {stop, cowboy_req:reply(503, Req)} + false -> {stop, cowboy_req:reply(503, #{<<"retry-after">> => <<"15">>}, Req)} end. add_cors_flag(Req, Env) -> diff --git a/apps/emqx_management/src/emqx_mgmt_api_status.erl b/apps/emqx_management/src/emqx_mgmt_api_status.erl index 70ff98988..e38ccfd69 100644 --- a/apps/emqx_management/src/emqx_mgmt_api_status.erl +++ b/apps/emqx_management/src/emqx_mgmt_api_status.erl @@ -33,18 +33,26 @@ init(Req0, State) -> %%-------------------------------------------------------------------- running_status() -> - BrokerStatus = - case emqx:is_running() of - true -> - started; - false -> - stopped - end, - AppStatus = - case lists:keysearch(emqx, 1, application:which_applications()) of - false -> not_running; - {value, _Val} -> running - end, - Status = io_lib:format("Node ~ts is ~ts~nemqx is ~ts", [node(), BrokerStatus, AppStatus]), - Body = list_to_binary(Status), - {200, #{<<"content-type">> => <<"text/plain">>}, Body}. + case emqx_dashboard_listener:is_ready(timer:seconds(20)) of + true -> + BrokerStatus = broker_status(), + AppStatus = application_status(), + Body = io_lib:format("Node ~ts is ~ts~nemqx is ~ts", [node(), BrokerStatus, AppStatus]), + {200, #{<<"content-type">> => <<"text/plain">>}, list_to_binary(Body)}; + false -> + {503, #{<<"retry-after">> => <<"15">>}, <<>>} + end. + +broker_status() -> + case emqx:is_running() of + true -> + started; + false -> + stopped + end. + +application_status() -> + case lists:keysearch(emqx, 1, application:which_applications()) of + false -> not_running; + {value, _Val} -> running + end. From 71aaf5c5381bf9cdfc588714388a5761ac73e7c2 Mon Sep 17 00:00:00 2001 From: firest Date: Wed, 31 Aug 2022 16:49:27 +0800 Subject: [PATCH 08/38] fix(authz): fix dialyzer && test case && proper error --- apps/emqx/test/emqx_proper_types.erl | 1 + apps/emqx_authz/src/emqx_authz.erl | 3 ++- apps/emqx_exhook/test/emqx_exhook_SUITE.erl | 6 ++++-- .../test/props/prop_exhook_hooks.erl | 17 ++++++++++++----- 4 files changed, 19 insertions(+), 8 deletions(-) diff --git a/apps/emqx/test/emqx_proper_types.erl b/apps/emqx/test/emqx_proper_types.erl index b56140288..78fab0b38 100644 --- a/apps/emqx/test/emqx_proper_types.erl +++ b/apps/emqx/test/emqx_proper_types.erl @@ -69,6 +69,7 @@ conninfo() -> {conn_props, properties()}, {connected, boolean()}, {connected_at, timestamp()}, + {disconnected_at, timestamp()}, {keepalive, range(0, 16#ffff)}, {receive_maximum, non_neg_integer()}, {expiry_interval, non_neg_integer()} diff --git a/apps/emqx_authz/src/emqx_authz.erl b/apps/emqx_authz/src/emqx_authz.erl index c5b08e70c..3b175fc31 100644 --- a/apps/emqx_authz/src/emqx_authz.erl +++ b/apps/emqx_authz/src/emqx_authz.erl @@ -49,7 +49,8 @@ -type default_result() :: allow | deny. --type authz_result() :: {stop, allow} | {ok, deny}. +-type authz_result_value() :: #{result := allow | deny, from => _}. +-type authz_result() :: {stop, authz_result_value()} | {ok, authz_result_value()} | ignore. -type sources() :: [source()]. diff --git a/apps/emqx_exhook/test/emqx_exhook_SUITE.erl b/apps/emqx_exhook/test/emqx_exhook_SUITE.erl index 74ec6c1ae..fb2a04cc0 100644 --- a/apps/emqx_exhook/test/emqx_exhook_SUITE.erl +++ b/apps/emqx_exhook/test/emqx_exhook_SUITE.erl @@ -120,8 +120,10 @@ t_access_failed_if_no_server_running(Config) -> ), ?assertMatch( - {stop, deny}, - emqx_exhook_handler:on_client_authorize(ClientInfo, publish, <<"t/1">>, allow) + {stop, #{result := deny, from := exhook}}, + emqx_exhook_handler:on_client_authorize(ClientInfo, publish, <<"t/1">>, #{ + result => allow, from => exhookk + }) ), Message = emqx_message:make(<<"t/1">>, <<"abc">>), diff --git a/apps/emqx_exhook/test/props/prop_exhook_hooks.erl b/apps/emqx_exhook/test/props/prop_exhook_hooks.erl index 5c169f72f..c42791f7a 100644 --- a/apps/emqx_exhook/test/props/prop_exhook_hooks.erl +++ b/apps/emqx_exhook/test/props/prop_exhook_hooks.erl @@ -133,9 +133,16 @@ prop_client_authenticate() -> ). prop_client_authorize() -> + MkResult = fun(Result) -> #{result => Result, from => exhook} end, ?ALL( {ClientInfo0, PubSub, Topic, Result, Meta}, - {clientinfo(), oneof([publish, subscribe]), topic(), oneof([allow, deny]), request_meta()}, + { + clientinfo(), + oneof([publish, subscribe]), + topic(), + oneof([MkResult(allow), MkResult(deny)]), + request_meta() + }, begin ClientInfo = inject_magic_into(username, ClientInfo0), OutResult = emqx_hooks:run_fold( @@ -145,9 +152,9 @@ prop_client_authorize() -> ), ExpectedOutResult = case maps:get(username, ClientInfo) of - <<"baduser">> -> deny; - <<"gooduser">> -> allow; - <<"normaluser">> -> allow; + <<"baduser">> -> MkResult(deny); + <<"gooduser">> -> MkResult(allow); + <<"normaluser">> -> MkResult(allow); _ -> Result end, ?assertEqual(ExpectedOutResult, OutResult), @@ -544,7 +551,7 @@ subopts(SubOpts) -> authresult_to_bool(AuthResult) -> AuthResult == ok. -aclresult_to_bool(Result) -> +aclresult_to_bool(#{result := Result}) -> Result == allow. pubsub_to_enum(publish) -> 'PUBLISH'; From 63a6cd15c1463fbd505bdb6dbb5c0e2b8e27652f Mon Sep 17 00:00:00 2001 From: firest Date: Wed, 31 Aug 2022 21:14:40 +0800 Subject: [PATCH 09/38] test: add emqx_access_control:authorize case for exhook --- apps/emqx_exhook/test/emqx_exhook_SUITE.erl | 28 +++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/apps/emqx_exhook/test/emqx_exhook_SUITE.erl b/apps/emqx_exhook/test/emqx_exhook_SUITE.erl index fb2a04cc0..62606cf18 100644 --- a/apps/emqx_exhook/test/emqx_exhook_SUITE.erl +++ b/apps/emqx_exhook/test/emqx_exhook_SUITE.erl @@ -23,6 +23,7 @@ -include_lib("eunit/include/eunit.hrl"). -include_lib("common_test/include/ct.hrl"). +-include_lib("emqx/include/emqx_hooks.hrl"). -define(DEFAULT_CLUSTER_NAME_ATOM, emqxcl). @@ -105,7 +106,10 @@ load_cfg(Cfg) -> %%-------------------------------------------------------------------- t_access_failed_if_no_server_running(Config) -> - emqx_exhook_mgr:disable(<<"default">>), + meck:expect(emqx_metrics_worker, inc, fun(_, _, _) -> ok end), + meck:expect(emqx_metrics, inc, fun(_) -> ok end), + emqx_hooks:add('client.authorize', {emqx_authz, authorize, [[]]}, ?HP_AUTHZ), + ClientInfo = #{ clientid => <<"user-id-1">>, username => <<"usera">>, @@ -114,6 +118,25 @@ t_access_failed_if_no_server_running(Config) -> protocol => mqtt, mountpoint => undefined }, + ?assertMatch( + allow, + emqx_access_control:authorize( + ClientInfo#{username => <<"gooduser">>}, + publish, + <<"acl/1">> + ) + ), + + ?assertMatch( + deny, + emqx_access_control:authorize( + ClientInfo#{username => <<"baduser">>}, + publish, + <<"acl/2">> + ) + ), + + emqx_exhook_mgr:disable(<<"default">>), ?assertMatch( {stop, {error, not_authorized}}, emqx_exhook_handler:on_client_authenticate(ClientInfo, #{auth_result => success}) @@ -122,7 +145,7 @@ t_access_failed_if_no_server_running(Config) -> ?assertMatch( {stop, #{result := deny, from := exhook}}, emqx_exhook_handler:on_client_authorize(ClientInfo, publish, <<"t/1">>, #{ - result => allow, from => exhookk + result => allow, from => exhook }) ), @@ -132,6 +155,7 @@ t_access_failed_if_no_server_running(Config) -> emqx_exhook_handler:on_message_publish(Message) ), emqx_exhook_mgr:enable(<<"default">>), + emqx_hooks:del('client.authorize', {emqx_authz, authorize}), assert_get_basic_usage_info(Config). t_lookup(_) -> From 05bbadc8c554950e2baedf160b9c8dcaa06473a9 Mon Sep 17 00:00:00 2001 From: firest Date: Wed, 31 Aug 2022 21:15:55 +0800 Subject: [PATCH 10/38] chore: bump ahutz version && update CHANGES-5.0.md --- CHANGES-5.0.md | 4 ++++ apps/emqx_authz/src/emqx_authz.app.src | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGES-5.0.md b/CHANGES-5.0.md index 742883e27..1c6c5dc64 100644 --- a/CHANGES-5.0.md +++ b/CHANGES-5.0.md @@ -1,5 +1,9 @@ # 5.0.8 +## Bug fixes + +* Fix exhook `client.authorize` never being execauted. [#8780](https://github.com/emqx/emqx/pull/8780) + ## Enhancements * change the `/gateway` API path to plural form. [#8823](https://github.com/emqx/emqx/pull/8823) diff --git a/apps/emqx_authz/src/emqx_authz.app.src b/apps/emqx_authz/src/emqx_authz.app.src index e40b5e64c..4a2186066 100644 --- a/apps/emqx_authz/src/emqx_authz.app.src +++ b/apps/emqx_authz/src/emqx_authz.app.src @@ -1,7 +1,7 @@ %% -*- mode: erlang -*- {application, emqx_authz, [ {description, "An OTP application"}, - {vsn, "0.1.4"}, + {vsn, "0.1.5"}, {registered, []}, {mod, {emqx_authz_app, []}}, {applications, [ From 13c0c7956781a96542b4c4100b8056564a8b9f2f Mon Sep 17 00:00:00 2001 From: Zhongwen Deng Date: Thu, 1 Sep 2022 09:39:15 +0800 Subject: [PATCH 11/38] chore: bump up emqx_dashboard --- apps/emqx_dashboard/src/emqx_dashboard.app.src | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/emqx_dashboard/src/emqx_dashboard.app.src b/apps/emqx_dashboard/src/emqx_dashboard.app.src index 4e1a3518f..adf974243 100644 --- a/apps/emqx_dashboard/src/emqx_dashboard.app.src +++ b/apps/emqx_dashboard/src/emqx_dashboard.app.src @@ -2,7 +2,7 @@ {application, emqx_dashboard, [ {description, "EMQX Web Dashboard"}, % strict semver, bump manually! - {vsn, "5.0.4"}, + {vsn, "5.0.5"}, {modules, []}, {registered, [emqx_dashboard_sup]}, {applications, [kernel, stdlib, mnesia, minirest, emqx]}, From ee91128cef5c9f7f258d2c061df8fb334ae8548d Mon Sep 17 00:00:00 2001 From: zhouzb Date: Thu, 1 Sep 2022 15:05:18 +0800 Subject: [PATCH 12/38] chore: bump vsn --- apps/emqx/include/emqx_release.hrl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/emqx/include/emqx_release.hrl b/apps/emqx/include/emqx_release.hrl index eb8b08c03..bc14ef209 100644 --- a/apps/emqx/include/emqx_release.hrl +++ b/apps/emqx/include/emqx_release.hrl @@ -32,7 +32,7 @@ %% `apps/emqx/src/bpapi/README.md' %% Community edition --define(EMQX_RELEASE_CE, "5.0.6"). +-define(EMQX_RELEASE_CE, "5.0.7"). %% Enterprise edition -define(EMQX_RELEASE_EE, "5.0.0-alpha.1"). From 7302fbc2a54385caba08eedfa1baa387dbd03b96 Mon Sep 17 00:00:00 2001 From: Ivan Dyachkov Date: Thu, 1 Sep 2022 09:50:19 +0200 Subject: [PATCH 13/38] docs: add build instructions for apple silicon in readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 2a9a7320a..8eb618acf 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,27 @@ make _build/emqx/rel/emqx/bin/emqx console ``` +### Building on Apple silicon (M1, M2) + +Homebrew on Apple silicon [changed default location of it's home directory](https://github.com/Homebrew/brew/issues/9177) from `/usr/local` to `/opt/homebrew` and as a result a few things broke in the process. + +Concerning EMQX, when you install `unixodbc` package (one of the dependencies) via Homebrew, and build Erlang/OTP with [kerl](https://github.com/kerl/kerl), kerl will not be able to find `unixodbc`. + +Here is how to solve it: + +```bash +brew install unixodbc kerl +sudo ln -s $(realpath $(brew --prefix unixodbc)) /usr/local/odbc +export CC="/usr/bin/gcc -I$(brew --prefix unixodbc)/include" +export LDFLAGS="-L$(brew --prefix unixodbc)/lib" +kerl build 24.3 +mkdir ~/.kerl/installations +kerl install 24.3 ~/.kerl/installations/24.3 +. ~/.kerl/installations/24.3/activate +``` + +Then you can proceed with `make`. + ## License See [LICENSE](./LICENSE). From 512e1571adee523f82e53e1ac2abb886de86b4b8 Mon Sep 17 00:00:00 2001 From: JimMoen Date: Fri, 26 Aug 2022 15:04:23 +0800 Subject: [PATCH 14/38] chore: update dashboard vsn --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 89f91ee4a..be56da973 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ export EMQX_DEFAULT_BUILDER = ghcr.io/emqx/emqx-builder/5.0-17:1.13.4-24.2.1-1-d export EMQX_DEFAULT_RUNNER = debian:11-slim export OTP_VSN ?= $(shell $(CURDIR)/scripts/get-otp-vsn.sh) export ELIXIR_VSN ?= $(shell $(CURDIR)/scripts/get-elixir-vsn.sh) -export EMQX_DASHBOARD_VERSION ?= v1.0.7 +export EMQX_DASHBOARD_VERSION ?= v1.0.8 export EMQX_EE_DASHBOARD_VERSION ?= e1.0.0 export EMQX_REL_FORM ?= tgz export QUICER_DOWNLOAD_FROM_RELEASE = 1 From d8ebc1f640044ff3ec70c033e70b45c2aada04c6 Mon Sep 17 00:00:00 2001 From: yyb Date: Fri, 2 Sep 2022 09:48:17 +0800 Subject: [PATCH 15/38] docs: add kubernetes deployment introduction --- README-CN.md | 4 ++++ README.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/README-CN.md b/README-CN.md index 205a038da..71767869d 100644 --- a/README-CN.md +++ b/README-CN.md @@ -40,6 +40,10 @@ docker run -d --name emqx-ee -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8084:8084 接下来请参考 [入门指南](https://www.emqx.io/docs/zh/v5.0/getting-started/getting-started.html#启动-emqx) 开启您的 EMQX 之旅。 +#### 在 Kubernetes 上运行 EMQX 集群 + +请参考 [EMQX Operator 文档](https://github.com/emqx/emqx-operator/blob/main/docs/zh_CN/getting-started/getting-started.md)。 + #### 更多安装方式 您可以从 [www.emqx.io/zh/downloads](https://www.emqx.io/zh/downloads) 下载不同格式的 EMQX 安装包进行手动安装。 diff --git a/README.md b/README.md index 8eb618acf..4461f70c6 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,10 @@ docker run -d --name emqx-ee -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8084:8084 Next, please follow the [getting started guide](https://www.emqx.io/docs/en/v5.0/getting-started/getting-started.html#start-emqx) to tour the EMQX features. +#### Run EMQX cluster on kubernetes + +For details: [EMQX Operator](https://github.com/emqx/emqx-operator/blob/main/docs/en_US/getting-started/getting-started.md). + #### More installation options If you prefer to install and manage EMQX yourself, you can download the latest version from [www.emqx.io/downloads](https://www.emqx.io/downloads). From 8b9494cf4b50bf1420882db48e2e37bd2acada89 Mon Sep 17 00:00:00 2001 From: firest Date: Thu, 1 Sep 2022 18:53:52 +0800 Subject: [PATCH 16/38] fix(jwt): support non-integer timestamp claims fix #8825 --- .../src/simple_authn/emqx_authn_jwt.erl | 43 ++++++++++++------- apps/emqx_authn/test/emqx_authn_jwt_SUITE.erl | 14 +++++- 2 files changed, 41 insertions(+), 16 deletions(-) diff --git a/apps/emqx_authn/src/simple_authn/emqx_authn_jwt.erl b/apps/emqx_authn/src/simple_authn/emqx_authn_jwt.erl index c6f2069ae..c450d838c 100644 --- a/apps/emqx_authn/src/simple_authn/emqx_authn_jwt.erl +++ b/apps/emqx_authn/src/simple_authn/emqx_authn_jwt.erl @@ -1,4 +1,4 @@ -%%-------------------------------------------------------------------- +%-------------------------------------------------------------------- %% Copyright (c) 2021-2022 EMQ Technologies Co., Ltd. All Rights Reserved. %% %% Licensed under the Apache License, Version 2.0 (the "License"); @@ -383,7 +383,7 @@ do_verify(JWT, [JWK | More], VerifyClaims) -> try jose_jws:verify(JWK, JWT) of {true, Payload, _JWT} -> Claims0 = emqx_json:decode(Payload, [return_maps]), - Claims = try_convert_to_int(Claims0, [<<"exp">>, <<"iat">>, <<"nbf">>]), + Claims = try_convert_to_num(Claims0, [<<"exp">>, <<"iat">>, <<"nbf">>]), case verify_claims(Claims, VerifyClaims) of ok -> {ok, Claims}; @@ -403,37 +403,37 @@ verify_claims(Claims, VerifyClaims0) -> VerifyClaims = [ {<<"exp">>, fun(ExpireTime) -> - is_integer(ExpireTime) andalso Now < ExpireTime + is_number(ExpireTime) andalso Now < ExpireTime end}, {<<"iat">>, fun(IssueAt) -> - is_integer(IssueAt) andalso IssueAt =< Now + is_number(IssueAt) andalso IssueAt =< Now end}, {<<"nbf">>, fun(NotBefore) -> - is_integer(NotBefore) andalso NotBefore =< Now + is_number(NotBefore) andalso NotBefore =< Now end} ] ++ VerifyClaims0, do_verify_claims(Claims, VerifyClaims). -try_convert_to_int(Claims, [Name | Names]) -> +try_convert_to_num(Claims, [Name | Names]) -> case Claims of #{Name := Value} -> case Value of - Int when is_integer(Int) -> - try_convert_to_int(Claims#{Name => Int}, Names); + Int when is_number(Int) -> + try_convert_to_num(Claims#{Name => Int}, Names); Bin when is_binary(Bin) -> - case string:to_integer(Bin) of - {Int, <<>>} -> - try_convert_to_int(Claims#{Name => Int}, Names); + case binary_to_number(Bin) of + {ok, Num} -> + try_convert_to_num(Claims#{Name => Num}, Names); _ -> - try_convert_to_int(Claims, Names) + try_convert_to_num(Claims, Names) end; _ -> - try_convert_to_int(Claims, Names) + try_convert_to_num(Claims, Names) end; _ -> - try_convert_to_int(Claims, Names) + try_convert_to_num(Claims, Names) end; -try_convert_to_int(Claims, []) -> +try_convert_to_num(Claims, []) -> Claims. do_verify_claims(_Claims, []) -> @@ -519,3 +519,16 @@ to_binary(B) when is_binary(B) -> B. sc(Type, Meta) -> hoconsc:mk(Type, Meta). + +binary_to_number(Bin) -> + try + {ok, erlang:binary_to_integer(Bin)} + catch + _:_ -> + try + {ok, erlang:binary_to_float(Bin)} + catch + _:_ -> + false + end + end. diff --git a/apps/emqx_authn/test/emqx_authn_jwt_SUITE.erl b/apps/emqx_authn/test/emqx_authn_jwt_SUITE.erl index db62775cd..e84f87f0b 100644 --- a/apps/emqx_authn/test/emqx_authn_jwt_SUITE.erl +++ b/apps/emqx_authn/test/emqx_authn_jwt_SUITE.erl @@ -408,7 +408,19 @@ t_verify_claims(_) -> }, ?assertMatch( {ok, #{is_superuser := false}}, emqx_authn_jwt:authenticate(Credential4, State1) - ). + ), + + Payload5 = #{ + <<"username">> => <<"myuser">>, + <<"foo">> => <<"myuser">>, + <<"exp">> => erlang:system_time(second) + 10.5 + }, + JWS5 = generate_jws('hmac-based', Payload5, Secret), + Credential5 = #{ + username => <<"myuser">>, + password => JWS5 + }, + ?assertMatch({ok, #{is_superuser := false}}, emqx_authn_jwt:authenticate(Credential5, State1)). t_jwt_not_allow_empty_claim_name(_) -> Request = #{ From 4583d4c0b90d7d637806de70fc0e506fa7c2ec32 Mon Sep 17 00:00:00 2001 From: firest Date: Fri, 2 Sep 2022 10:19:04 +0800 Subject: [PATCH 17/38] chore: update CHANGES-5.0.md --- CHANGES-5.0.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES-5.0.md b/CHANGES-5.0.md index 1c6c5dc64..e9a9282db 100644 --- a/CHANGES-5.0.md +++ b/CHANGES-5.0.md @@ -3,6 +3,7 @@ ## Bug fixes * Fix exhook `client.authorize` never being execauted. [#8780](https://github.com/emqx/emqx/pull/8780) +* Fix JWT plugin don't support non-integer timestamp claims. [#8867](https://github.com/emqx/emqx/pull/8867) ## Enhancements From 74659bb86486aad2b3838a0c8b9d6a6ee09e5a3a Mon Sep 17 00:00:00 2001 From: JimMoen Date: Thu, 1 Sep 2022 18:18:26 +0800 Subject: [PATCH 18/38] fix(bridge): rm mqtt bridge default `username` and `password` --- apps/emqx_connector/src/mqtt/emqx_connector_mqtt_schema.erl | 2 -- 1 file changed, 2 deletions(-) diff --git a/apps/emqx_connector/src/mqtt/emqx_connector_mqtt_schema.erl b/apps/emqx_connector/src/mqtt/emqx_connector_mqtt_schema.erl index 8b6994dd4..b06d00884 100644 --- a/apps/emqx_connector/src/mqtt/emqx_connector_mqtt_schema.erl +++ b/apps/emqx_connector/src/mqtt/emqx_connector_mqtt_schema.erl @@ -87,7 +87,6 @@ fields("connector") -> sc( binary(), #{ - default => "emqx", desc => ?DESC("username") } )}, @@ -95,7 +94,6 @@ fields("connector") -> sc( binary(), #{ - default => "emqx", desc => ?DESC("password") } )}, From 2693fc263d06ac0111e2d59ea02953eb595788f9 Mon Sep 17 00:00:00 2001 From: JimMoen Date: Thu, 1 Sep 2022 18:20:30 +0800 Subject: [PATCH 19/38] fix(bridge): show file paths for SSL certs in dashboard for bridge --- apps/emqx_bridge/src/emqx_bridge_api.erl | 3 +- .../emqx_connector/src/emqx_connector_ssl.erl | 90 ++++++++++++++++--- 2 files changed, 78 insertions(+), 15 deletions(-) diff --git a/apps/emqx_bridge/src/emqx_bridge_api.erl b/apps/emqx_bridge/src/emqx_bridge_api.erl index 37a42ab3d..e28df9176 100644 --- a/apps/emqx_bridge/src/emqx_bridge_api.erl +++ b/apps/emqx_bridge/src/emqx_bridge_api.erl @@ -584,9 +584,10 @@ pick_bridges_by_id(Type, Name, BridgesAllNodes) -> format_bridge_info([FirstBridge | _] = Bridges) -> Res = maps:remove(node, FirstBridge), + NRes = emqx_connector_ssl:drop_invalid_certs(Res), NodeStatus = collect_status(Bridges), NodeMetrics = collect_metrics(Bridges), - Res#{ + NRes#{ status => aggregate_status(NodeStatus), node_status => NodeStatus, metrics => aggregate_metrics(NodeMetrics), diff --git a/apps/emqx_connector/src/emqx_connector_ssl.erl b/apps/emqx_connector/src/emqx_connector_ssl.erl index c08defc29..929ffe82e 100644 --- a/apps/emqx_connector/src/emqx_connector_ssl.erl +++ b/apps/emqx_connector/src/emqx_connector_ssl.erl @@ -18,27 +18,89 @@ -export([ convert_certs/2, + drop_invalid_certs/1, clear_certs/2 ]). -convert_certs(RltvDir, NewConfig) -> - NewSSL = map_get_oneof([<<"ssl">>, ssl], NewConfig, undefined), - case emqx_tls_lib:ensure_ssl_files(RltvDir, NewSSL) of - {ok, NewSSL1} -> - {ok, new_ssl_config(NewConfig, NewSSL1)}; +%% TODO: rm `connector` case after `dev/ee5.0` merged into `master`. +%% The `connector` config layer will be removed. +%% for bridges with `connector` field. i.e. `mqtt_source` and `mqtt_sink` +convert_certs(RltvDir, #{<<"connector">> := Connector} = Config) when + is_map(Connector) +-> + SSL = map_get_oneof([<<"ssl">>, ssl], Connector, undefined), + new_ssl_config(RltvDir, Config, SSL); +convert_certs(RltvDir, #{connector := Connector} = Config) when + is_map(Connector) +-> + SSL = map_get_oneof([<<"ssl">>, ssl], Connector, undefined), + new_ssl_config(RltvDir, Config, SSL); +%% for bridges without `connector` field. i.e. webhook +convert_certs(RltvDir, #{<<"ssl">> := SSL} = Config) -> + new_ssl_config(RltvDir, Config, SSL); +convert_certs(RltvDir, #{ssl := SSL} = Config) -> + new_ssl_config(RltvDir, Config, SSL); +%% for bridges use connector name +convert_certs(_RltvDir, Config) -> + {ok, Config}. + +clear_certs(RltvDir, #{<<"connector">> := Connector} = _Config) when + is_map(Connector) +-> + OldSSL = map_get_oneof([<<"ssl">>, ssl], Connector, undefined), + ok = emqx_tls_lib:delete_ssl_files(RltvDir, undefined, OldSSL); +clear_certs(RltvDir, #{connector := Connector} = _Config) when + is_map(Connector) +-> + OldSSL = map_get_oneof([<<"ssl">>, ssl], Connector, undefined), + ok = emqx_tls_lib:delete_ssl_files(RltvDir, undefined, OldSSL); +clear_certs(RltvDir, #{<<"ssl">> := OldSSL} = _Config) -> + ok = emqx_tls_lib:delete_ssl_files(RltvDir, undefined, OldSSL); +clear_certs(RltvDir, #{ssl := OldSSL} = _Config) -> + ok = emqx_tls_lib:delete_ssl_files(RltvDir, undefined, OldSSL); +clear_certs(_RltvDir, _) -> + ok. + +drop_invalid_certs(#{<<"connector">> := Connector} = Config) when + is_map(Connector) +-> + SSL = map_get_oneof([<<"ssl">>, ssl], Connector, undefined), + NewSSL = emqx_tls_lib:drop_invalid_certs(SSL), + new_ssl_config(Config, NewSSL); +drop_invalid_certs(#{connector := Connector} = Config) when + is_map(Connector) +-> + SSL = map_get_oneof([<<"ssl">>, ssl], Connector, undefined), + NewSSL = emqx_tls_lib:drop_invalid_certs(SSL), + new_ssl_config(Config, NewSSL); +drop_invalid_certs(#{<<"ssl">> := SSL} = Config) -> + NewSSL = emqx_tls_lib:drop_invalid_certs(SSL), + new_ssl_config(Config, NewSSL); +drop_invalid_certs(#{ssl := SSL} = Config) -> + NewSSL = emqx_tls_lib:drop_invalid_certs(SSL), + new_ssl_config(Config, NewSSL); +%% for bridges use connector name +drop_invalid_certs(Config) -> + Config. + +new_ssl_config(RltvDir, Config, SSL) -> + case emqx_tls_lib:ensure_ssl_files(RltvDir, SSL) of + {ok, NewSSL} -> + {ok, new_ssl_config(Config, NewSSL)}; {error, Reason} -> {error, {bad_ssl_config, Reason}} end. -clear_certs(_RltvDir, undefined) -> - ok; -clear_certs(RltvDir, Config) -> - OldSSL = map_get_oneof([<<"ssl">>, ssl], Config, undefined), - ok = emqx_tls_lib:delete_ssl_files(RltvDir, undefined, OldSSL). - -new_ssl_config(Config, undefined) -> Config; -new_ssl_config(Config, #{<<"enable">> := _} = SSL) -> Config#{<<"ssl">> => SSL}; -new_ssl_config(Config, #{enable := _} = SSL) -> Config#{ssl => SSL}. +new_ssl_config(#{connector := Connector} = Config, NewSSL) -> + Config#{connector => Connector#{ssl => NewSSL}}; +new_ssl_config(#{<<"connector">> := Connector} = Config, NewSSL) -> + Config#{<<"connector">> => Connector#{<<"ssl">> => NewSSL}}; +new_ssl_config(#{ssl := _} = Config, NewSSL) -> + Config#{ssl => NewSSL}; +new_ssl_config(#{<<"ssl">> := _} = Config, NewSSL) -> + Config#{<<"ssl">> => NewSSL}; +new_ssl_config(Config, _NewSSL) -> + Config. map_get_oneof([], _Map, Default) -> Default; From 16618131adf2d4ecdc2e9700b887e2f2330cfceb Mon Sep 17 00:00:00 2001 From: JimMoen Date: Fri, 2 Sep 2022 14:44:38 +0800 Subject: [PATCH 20/38] fix(bridge): mqtt source/sink bridge use empty payload template --- apps/emqx_connector/src/mqtt/emqx_connector_mqtt_schema.erl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/emqx_connector/src/mqtt/emqx_connector_mqtt_schema.erl b/apps/emqx_connector/src/mqtt/emqx_connector_mqtt_schema.erl index b06d00884..438f33b5d 100644 --- a/apps/emqx_connector/src/mqtt/emqx_connector_mqtt_schema.erl +++ b/apps/emqx_connector/src/mqtt/emqx_connector_mqtt_schema.erl @@ -224,7 +224,7 @@ fields("egress") -> sc( binary(), #{ - required => true, + default => <<"${payload}">>, desc => ?DESC("payload") } )} From a41461ac930a22c4ef515304f5c2e81f87a7ed7b Mon Sep 17 00:00:00 2001 From: JianBo He Date: Fri, 2 Sep 2022 16:17:25 +0800 Subject: [PATCH 21/38] chore: update apps/emqx_authn/src/simple_authn/emqx_authn_jwt.erl --- apps/emqx_authn/src/simple_authn/emqx_authn_jwt.erl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/emqx_authn/src/simple_authn/emqx_authn_jwt.erl b/apps/emqx_authn/src/simple_authn/emqx_authn_jwt.erl index c450d838c..d41a7fc69 100644 --- a/apps/emqx_authn/src/simple_authn/emqx_authn_jwt.erl +++ b/apps/emqx_authn/src/simple_authn/emqx_authn_jwt.erl @@ -1,4 +1,4 @@ -%-------------------------------------------------------------------- +%%-------------------------------------------------------------------- %% Copyright (c) 2021-2022 EMQ Technologies Co., Ltd. All Rights Reserved. %% %% Licensed under the Apache License, Version 2.0 (the "License"); From a7128dc997483f8eaa96ba9b56c9632c7557f94c Mon Sep 17 00:00:00 2001 From: Ivan Dyachkov Date: Fri, 2 Sep 2022 13:41:54 +0200 Subject: [PATCH 22/38] build: make clean --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 89f91ee4a..6ee60cc34 100644 --- a/Makefile +++ b/Makefile @@ -132,7 +132,7 @@ $(REL_PROFILES:%=%): $(COMMON_DEPS) clean: $(PROFILES:%=clean-%) $(PROFILES:%=clean-%): @if [ -d _build/$(@:clean-%=%) ]; then \ - rm rebar.lock \ + rm -f rebar.lock; \ rm -rf _build/$(@:clean-%=%)/rel; \ $(FIND) _build/$(@:clean-%=%) -name '*.beam' -o -name '*.so' -o -name '*.app' -o -name '*.appup' -o -name '*.o' -o -name '*.d' -type f | xargs rm -f; \ $(FIND) _build/$(@:clean-%=%) -type l -delete; \ From d533e35df072805f9fdc6d3f4c5c39aeb56c390d Mon Sep 17 00:00:00 2001 From: JimMoen Date: Fri, 2 Sep 2022 18:45:14 +0800 Subject: [PATCH 23/38] chore: update app vsn --- apps/emqx/src/emqx.app.src | 2 +- apps/emqx_authn/src/emqx_authn.app.src | 2 +- apps/emqx_bridge/src/emqx_bridge.app.src | 2 +- apps/emqx_connector/src/emqx_connector.app.src | 2 +- apps/emqx_exhook/src/emqx_exhook.app.src | 2 +- apps/emqx_gateway/src/emqx_gateway.app.src | 2 +- apps/emqx_management/src/emqx_management.app.src | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/apps/emqx/src/emqx.app.src b/apps/emqx/src/emqx.app.src index 9941a1a6a..edf632740 100644 --- a/apps/emqx/src/emqx.app.src +++ b/apps/emqx/src/emqx.app.src @@ -3,7 +3,7 @@ {id, "emqx"}, {description, "EMQX Core"}, % strict semver, bump manually! - {vsn, "5.0.7"}, + {vsn, "5.0.8"}, {modules, []}, {registered, []}, {applications, [ diff --git a/apps/emqx_authn/src/emqx_authn.app.src b/apps/emqx_authn/src/emqx_authn.app.src index 4360a784d..c4c59bd4a 100644 --- a/apps/emqx_authn/src/emqx_authn.app.src +++ b/apps/emqx_authn/src/emqx_authn.app.src @@ -1,7 +1,7 @@ %% -*- mode: erlang -*- {application, emqx_authn, [ {description, "EMQX Authentication"}, - {vsn, "0.1.5"}, + {vsn, "0.1.6"}, {modules, []}, {registered, [emqx_authn_sup, emqx_authn_registry]}, {applications, [kernel, stdlib, emqx_resource, ehttpc, epgsql, mysql, jose]}, diff --git a/apps/emqx_bridge/src/emqx_bridge.app.src b/apps/emqx_bridge/src/emqx_bridge.app.src index 3be8d38fd..8e1c60c29 100644 --- a/apps/emqx_bridge/src/emqx_bridge.app.src +++ b/apps/emqx_bridge/src/emqx_bridge.app.src @@ -1,7 +1,7 @@ %% -*- mode: erlang -*- {application, emqx_bridge, [ {description, "An OTP application"}, - {vsn, "0.1.2"}, + {vsn, "0.1.3"}, {registered, []}, {mod, {emqx_bridge_app, []}}, {applications, [ diff --git a/apps/emqx_connector/src/emqx_connector.app.src b/apps/emqx_connector/src/emqx_connector.app.src index 1e66b8442..0734d47b8 100644 --- a/apps/emqx_connector/src/emqx_connector.app.src +++ b/apps/emqx_connector/src/emqx_connector.app.src @@ -1,7 +1,7 @@ %% -*- mode: erlang -*- {application, emqx_connector, [ {description, "An OTP application"}, - {vsn, "0.1.4"}, + {vsn, "0.1.5"}, {registered, []}, {mod, {emqx_connector_app, []}}, {applications, [ diff --git a/apps/emqx_exhook/src/emqx_exhook.app.src b/apps/emqx_exhook/src/emqx_exhook.app.src index f10155f0e..c4a43d846 100644 --- a/apps/emqx_exhook/src/emqx_exhook.app.src +++ b/apps/emqx_exhook/src/emqx_exhook.app.src @@ -1,7 +1,7 @@ %% -*- mode: erlang -*- {application, emqx_exhook, [ {description, "EMQX Extension for Hook"}, - {vsn, "5.0.3"}, + {vsn, "5.0.4"}, {modules, []}, {registered, []}, {mod, {emqx_exhook_app, []}}, diff --git a/apps/emqx_gateway/src/emqx_gateway.app.src b/apps/emqx_gateway/src/emqx_gateway.app.src index 9fb78c825..47245c0a2 100644 --- a/apps/emqx_gateway/src/emqx_gateway.app.src +++ b/apps/emqx_gateway/src/emqx_gateway.app.src @@ -1,7 +1,7 @@ %% -*- mode: erlang -*- {application, emqx_gateway, [ {description, "The Gateway management application"}, - {vsn, "0.1.4"}, + {vsn, "0.1.5"}, {registered, []}, {mod, {emqx_gateway_app, []}}, {applications, [kernel, stdlib, grpc, emqx, emqx_authn]}, diff --git a/apps/emqx_management/src/emqx_management.app.src b/apps/emqx_management/src/emqx_management.app.src index df7aa36ec..d9f09f00e 100644 --- a/apps/emqx_management/src/emqx_management.app.src +++ b/apps/emqx_management/src/emqx_management.app.src @@ -2,7 +2,7 @@ {application, emqx_management, [ {description, "EMQX Management API and CLI"}, % strict semver, bump manually! - {vsn, "5.0.4"}, + {vsn, "5.0.5"}, {modules, []}, {registered, [emqx_management_sup]}, {applications, [kernel, stdlib, emqx_plugins, minirest, emqx]}, From 63281e5491d24e1a2c89646d9f067c27625dd712 Mon Sep 17 00:00:00 2001 From: Zhongwen Deng Date: Mon, 5 Sep 2022 15:29:04 +0800 Subject: [PATCH 24/38] feat: don't override env RUNNER_LOG_DIR in emqx_vars --- rel/emqx_vars | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/rel/emqx_vars b/rel/emqx_vars index cd484a023..9498fa73d 100644 --- a/rel/emqx_vars +++ b/rel/emqx_vars @@ -7,11 +7,15 @@ REL_VSN="{{ release_version }}" ERTS_VSN="{{ erts_vsn }}" ERL_OPTS="{{ erl_opts }}" RUNNER_BIN_DIR="{{ runner_bin_dir }}" -RUNNER_LOG_DIR="{{ runner_log_dir }}" RUNNER_LIB_DIR="{{ runner_lib_dir }}" +IS_ELIXIR="${IS_ELIXIR:-{{ is_elixir }}}" + +if [ -z "${RUNNER_LOG_DIR:-}" ]; then + RUNNER_LOG_DIR="{{ runner_log_dir }}" +fi + EMQX_ETC_DIR="{{ emqx_etc_dir }}" RUNNER_USER="{{ runner_user }}" -IS_ELIXIR="${IS_ELIXIR:-{{ is_elixir }}}" SCHEMA_MOD="{{ emqx_schema_mod }}" IS_ENTERPRISE="{{ is_enterprise }}" From 6de78815695810bbbb727a51c2c7ca9fd3e3c5ae Mon Sep 17 00:00:00 2001 From: Zhongwen Deng Date: Mon, 5 Sep 2022 16:11:11 +0800 Subject: [PATCH 25/38] feat: remove node.etc_dir config --- CHANGES-5.0.md | 3 ++- apps/emqx_conf/etc/emqx_conf.conf | 1 - apps/emqx_conf/src/emqx_conf_schema.erl | 8 -------- 3 files changed, 2 insertions(+), 10 deletions(-) diff --git a/CHANGES-5.0.md b/CHANGES-5.0.md index b29bfe4a5..b102c9702 100644 --- a/CHANGES-5.0.md +++ b/CHANGES-5.0.md @@ -7,7 +7,8 @@ ## Enhancements -* change the `/gateway` API path to plural form. [#8823](https://github.com/emqx/emqx/pull/8823) +* Change the `/gateway` API path to plural form. [#8823](https://github.com/emqx/emqx/pull/8823) +* Remove `node.etc_dir` from emqx.conf. [#8892](https://github.com/emqx/emqx/pull/8892) # 5.0.7 diff --git a/apps/emqx_conf/etc/emqx_conf.conf b/apps/emqx_conf/etc/emqx_conf.conf index 42479ac94..fe1b7ab91 100644 --- a/apps/emqx_conf/etc/emqx_conf.conf +++ b/apps/emqx_conf/etc/emqx_conf.conf @@ -12,7 +12,6 @@ node { name = "emqx@127.0.0.1" cookie = emqxsecretcookie data_dir = "{{ platform_data_dir }}" - etc_dir = "{{ platform_etc_dir }}" } log { diff --git a/apps/emqx_conf/src/emqx_conf_schema.erl b/apps/emqx_conf/src/emqx_conf_schema.erl index 1b24a0a38..8c4cddbc3 100644 --- a/apps/emqx_conf/src/emqx_conf_schema.erl +++ b/apps/emqx_conf/src/emqx_conf_schema.erl @@ -536,14 +536,6 @@ fields("node") -> desc => ?DESC(node_applications) } )}, - {"etc_dir", - sc( - string(), - #{ - desc => ?DESC(node_etc_dir), - 'readOnly' => true - } - )}, {"cluster_call", sc( ?R_REF("cluster_call"), From e35957af0b06b1593a6cdc978cae0fc191ce260c Mon Sep 17 00:00:00 2001 From: Zhongwen Deng Date: Mon, 5 Sep 2022 16:12:40 +0800 Subject: [PATCH 26/38] chore: add some warning to emqx_vars --- rel/emqx_vars | 2 ++ 1 file changed, 2 insertions(+) diff --git a/rel/emqx_vars b/rel/emqx_vars index 9498fa73d..255777f9a 100644 --- a/rel/emqx_vars +++ b/rel/emqx_vars @@ -10,6 +10,8 @@ RUNNER_BIN_DIR="{{ runner_bin_dir }}" RUNNER_LIB_DIR="{{ runner_lib_dir }}" IS_ELIXIR="${IS_ELIXIR:-{{ is_elixir }}}" +## Allow users to pre-set `RUNNER_LOG_DIR` because it only affects boot commands like `start` and `console`, +## but not other commands such as `ping` and `ctl`. if [ -z "${RUNNER_LOG_DIR:-}" ]; then RUNNER_LOG_DIR="{{ runner_log_dir }}" fi From f5f30be2de3295e91c5c54737d553ab3aa76f0eb Mon Sep 17 00:00:00 2001 From: Ivan Dyachkov Date: Mon, 5 Sep 2022 09:16:00 +0200 Subject: [PATCH 27/38] docs: sync russian version of readme up to 'Build from source' --- README-RU.md | 75 +++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 60 insertions(+), 15 deletions(-) diff --git a/README-RU.md b/README-RU.md index f047c90a1..2217313fe 100644 --- a/README-RU.md +++ b/README-RU.md @@ -7,39 +7,84 @@ [![Slack](https://img.shields.io/badge/Slack-EMQ-39AE85?logo=slack)](https://slack-invite.emqx.io/) [![Discord](https://img.shields.io/discord/931086341838622751?label=Discord&logo=discord)](https://discord.gg/xYGf3fQnES) [![Twitter](https://img.shields.io/badge/Follow-EMQ-1DA1F2?logo=twitter)](https://twitter.com/EMQTech) -[![Community](https://img.shields.io/badge/Community-EMQX-yellow?logo=github)](https://github.com/emqx/emqx/discussions) [![YouTube](https://img.shields.io/badge/Subscribe-EMQ-FF0000?logo=youtube)](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q) -[![The best IoT MQTT open source team looks forward to your joining](https://assets.emqx.com/images/github_readme_en_bg.png)](https://www.emqx.com/en/careers) - [English](./README.md) | [简体中文](./README-CN.md) | [日本語](./README-JP.md) | русский -*EMQX* — это масштабируемый, высоко доступный, распределённый MQTT брокер с полностью открытым кодом для интернета вещей, межмашинного взаимодействия и мобильных приложений, который поддерживает миллионы одновременных подключений. +*EMQX* — это самый масштабируемый и популярный высокопроизводительный MQTT брокер с полностью открытым кодом для интернета вещей, межмашинного взаимодействия и мобильных приложений. EMQX может поддерживать более чем 100 миллионов одновременных соединенией на одном кластере с задержкой в 1 миллисекунду, а также принимать и обрабабывать миллионы MQTT сообщений в секунду. -Начиная с релиза 3.0, брокер *EMQX* полностью поддерживает протокол MQTT версии 5.0, и обратно совместим с версиями 3.1 и 3.1.1, а также протоколами MQTT-SN, CoAP, LwM2M, WebSocket и STOMP. Начиная с релиза 3.0, брокер *EMQX* может масштабироваться до более чем 10 миллионов одновременных MQTT соединений на один кластер. +Мы [протестировали масштабируемость](https://www.emqx.com/en/blog/reaching-100m-mqtt-connections-with-emqx-5-0) EMQX v5.0 и подтвердили что брокер может поддерживать до 100 миллионов одновременных подключений устройств. Это является критически важной вехой для разработчиков IoT. EMQX 5.0 также поставляется с множеством интересных новых функций и значительными улучшениями производительности, включая более мощный [механизм правил](https://www.emqx.com/en/solutions/iot-rule-engine), улучшенное управление безопасностью, расширение базы данных Mria и многое другое для повышения масштабируемости приложений IoT. -- Полный список возможностей доступен по ссылке: [EMQX Release Notes](https://github.com/emqx/emqx/releases). -- Более подробная информация доступна на нашем сайте: [EMQX homepage](https://www.emqx.io/). +За последние несколько лет EMQX приобрел популярность среди IoT-компаний и используется более чем 20 000 пользователей по всему миру из более чем 50 стран, при этом по всему миру поддерживается более 100 миллионов подключений к IoT-устройствам. -## Установка +Для получения дополнительной информации, пожалуйста, посетите [домашнюю страницу EMQX](https://www.emqx.io/). -Брокер *EMQX* кросплатформенный, и поддерживает Linux, Unix, macOS и Windows. Он может работать на серверах с архитектурой x86_64 и устройствах на архитектуре ARM, таких как Raspberry Pi. +## Начало работы -Более подробная информация о запуске на Windows по ссылке: [Windows.md](./Windows.md) +#### EMQX Cloud -#### Установка EMQX с помощью Docker-образа +Самый простой способ запустить EMQX это развернуть его с помощью EMQX Cloud. Вы можете [попробовать EMQX Cloud бесплатно](https://www.emqx.com/en/signup?utm_source=github.com&utm_medium=referral&utm_campaign=emqx-readme-to-cloud&continue=https://cloud-intl.emqx.com/console/deployments/0?oper=new), данные кредитной карточки не требуются. + +#### Установка EMQX с помощью Docker ``` docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx ``` -#### Установка бинарного пакета +Или запустите EMQX Enterprise со встроенной бессрочной лицензией на 10 соединений. -Сборки для различных операционных систем: [Загрузить EMQX](https://www.emqx.com/en/downloads). +``` +docker run -d --name emqx-ee -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8084:8084 -p 8883:8883 -p 18083:18083 emqx/emqx-ee:latest +``` -- [Установка на одном сервере](https://www.emqx.io/docs/en/latest/getting-started/install.html) -- [Установка на кластере](https://www.emqx.io/docs/en/latest/advanced/cluster.html) +Чтобы ознакомиться с функциональностью EMQX, пожалуйста, следуйте [руководству по началу работы](https://www.emqx.io/docs/en/v5.0/getting-started/getting-started.html#start-emqx). +#### Запуск кластера EMQX на kubernetes + +[Документация по EMQX Operator](https://github.com/emqx/emqx-operator/blob/main/docs/en_US/getting-started/getting-started.md). + +#### Дополнительные опции установки + +Если вы предпочитаете устанавливать и управлять EMQX самостоятельно, вы можете загрузить последнюю версию с [www.emqx.io/downloads](https://www.emqx.io/downloads). + +Смотрите также [EMQX installation documentation](https://www.emqx.io/docs/en/v5.0/deploy/install.html). + +## Документация + +[Документация EMQX](https://www.emqx.io/docs/en/latest/). + +[Документация EMQX Enterprise](https://docs.emqx.com/en/). + +## Участие в разработке + +Пожалуйста, прочитайте [contributing.md](./CONTRIBUTING.md). + +Для более организованных предложений по улучшению вы можете отправить pull requests в [EIP](https://github.com/emqx/eip). + +## Присоединяйтесь к коммьюнити + +- Подпишитесь на [@EMQTech on Twitter](https://twitter.com/EMQTech). +- Подключайтесь к [обсуждениям](https://github.com/emqx/emqx/discussions) на Github, если у вас есть какой-то вопрос. +- Присоединяйтесь к нашему [официальному Discord](https://discord.gg/xYGf3fQnES), чтобы поговорить с командой разработки. +- Подписывайтесь на канал [EMQX YouTube](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q). + +## Дополнительные ресурсы + +- [MQTT client programming](https://www.emqx.com/en/blog/tag/mqtt-client-programming) + + Коллекция блогов, чтобы помочь разработчикам быстро начать работу с MQTT на PHP, Node.js, Python, Golang, и других языках программирования. + +- [MQTT SDKs](https://www.emqx.com/en/mqtt-client-sdk) + + Мы выбрали популярные SDK клиентов MQTT на различных языках программирования и предоставили примеры кода, которые помогут вам быстро понять, как использовать клиенты MQTT. + +- [MQTT X](https://mqttx.app/) + + Элегантный кроссплатформенный клиент MQTT 5.0, в виде десктопного приложения, приложения для командной строки и веб-приложения, чтобы помочь вам быстрее разрабатывать и отлаживать службы и приложения MQTT. + +- [Internet of Vehicles](https://www.emqx.com/en/blog/category/internet-of-vehicles) + + Создайте надежную, эффективную и специализированную для вашей индустрии платформу IoV на основе практического опыта EMQ, от теоретических знаний, таких как выбор протокола, до практических операций, таких как проектирование архитектуры платформы. ## Сборка из исходного кода From ed4e890db99f075613dff15eeb3b5a15249bc9a8 Mon Sep 17 00:00:00 2001 From: Zhongwen Deng Date: Mon, 5 Sep 2022 16:15:31 +0800 Subject: [PATCH 28/38] chore: bump emqx_conf to 0.1.4 --- apps/emqx_conf/src/emqx_conf.app.src | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/emqx_conf/src/emqx_conf.app.src b/apps/emqx_conf/src/emqx_conf.app.src index 854fdac07..a8707025a 100644 --- a/apps/emqx_conf/src/emqx_conf.app.src +++ b/apps/emqx_conf/src/emqx_conf.app.src @@ -1,6 +1,6 @@ {application, emqx_conf, [ {description, "EMQX configuration management"}, - {vsn, "0.1.3"}, + {vsn, "0.1.4"}, {registered, []}, {mod, {emqx_conf_app, []}}, {applications, [kernel, stdlib]}, From 1819b7e2244f2ef0ed2a2900be01a9eeb6484a52 Mon Sep 17 00:00:00 2001 From: zhongwencool Date: Mon, 5 Sep 2022 17:34:29 +0800 Subject: [PATCH 29/38] chore: update rel/emqx_vars Co-authored-by: Zaiming (Stone) Shi --- rel/emqx_vars | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rel/emqx_vars b/rel/emqx_vars index 255777f9a..58d20515a 100644 --- a/rel/emqx_vars +++ b/rel/emqx_vars @@ -12,7 +12,7 @@ IS_ELIXIR="${IS_ELIXIR:-{{ is_elixir }}}" ## Allow users to pre-set `RUNNER_LOG_DIR` because it only affects boot commands like `start` and `console`, ## but not other commands such as `ping` and `ctl`. -if [ -z "${RUNNER_LOG_DIR:-}" ]; then +RUNNER_LOG_DIR="${RUNNER_LOG_DIR:-{{ runner_log_dir }}}" RUNNER_LOG_DIR="{{ runner_log_dir }}" fi From ade232214a0a6eed89277a8aa6ea125f179f7dca Mon Sep 17 00:00:00 2001 From: zhongwencool Date: Mon, 5 Sep 2022 17:34:54 +0800 Subject: [PATCH 30/38] chore: update CHANGES-5.0.md Co-authored-by: Zaiming (Stone) Shi --- CHANGES-5.0.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGES-5.0.md b/CHANGES-5.0.md index b102c9702..725add9c8 100644 --- a/CHANGES-5.0.md +++ b/CHANGES-5.0.md @@ -8,7 +8,8 @@ ## Enhancements * Change the `/gateway` API path to plural form. [#8823](https://github.com/emqx/emqx/pull/8823) -* Remove `node.etc_dir` from emqx.conf. [#8892](https://github.com/emqx/emqx/pull/8892) +* Remove `node.etc_dir` from emqx.conf, because it is never used. + Also allow user to customize the logging directory [#8892](https://github.com/emqx/emqx/pull/8892) # 5.0.7 From 29f9258595266fc2b0737400abc1226d453cd9c4 Mon Sep 17 00:00:00 2001 From: Zhongwen Deng Date: Mon, 5 Sep 2022 17:36:35 +0800 Subject: [PATCH 31/38] chore: update RUNNER_LOG_DIR --- rel/emqx_vars | 2 -- 1 file changed, 2 deletions(-) diff --git a/rel/emqx_vars b/rel/emqx_vars index 58d20515a..27de79e0d 100644 --- a/rel/emqx_vars +++ b/rel/emqx_vars @@ -13,8 +13,6 @@ IS_ELIXIR="${IS_ELIXIR:-{{ is_elixir }}}" ## Allow users to pre-set `RUNNER_LOG_DIR` because it only affects boot commands like `start` and `console`, ## but not other commands such as `ping` and `ctl`. RUNNER_LOG_DIR="${RUNNER_LOG_DIR:-{{ runner_log_dir }}}" - RUNNER_LOG_DIR="{{ runner_log_dir }}" -fi EMQX_ETC_DIR="{{ emqx_etc_dir }}" RUNNER_USER="{{ runner_user }}" From c2d03838e22497add369fec014e45d4a6f165487 Mon Sep 17 00:00:00 2001 From: ieQu1 <99872536+ieQu1@users.noreply.github.com> Date: Mon, 5 Sep 2022 12:28:19 +0200 Subject: [PATCH 32/38] fix(bpapi): Return undefined for unknown API on the node --- apps/emqx/src/bpapi/emqx_bpapi.erl | 7 +++++-- apps/emqx/test/emqx_bpapi_SUITE.erl | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/apps/emqx/src/bpapi/emqx_bpapi.erl b/apps/emqx/src/bpapi/emqx_bpapi.erl index 07f12a2db..ce6ad5cb1 100644 --- a/apps/emqx/src/bpapi/emqx_bpapi.erl +++ b/apps/emqx/src/bpapi/emqx_bpapi.erl @@ -69,9 +69,12 @@ start() -> announce(emqx). %% @doc Get maximum version of the backplane API supported by the node --spec supported_version(node(), api()) -> api_version(). +-spec supported_version(node(), api()) -> api_version() | undefined. supported_version(Node, API) -> - ets:lookup_element(?TAB, {Node, API}, #?TAB.version). + case ets:lookup(?TAB, {Node, API}) of + [#?TAB{version = V}] -> V; + [] -> undefined + end. %% @doc Get maximum version of the backplane API supported by the %% entire cluster diff --git a/apps/emqx/test/emqx_bpapi_SUITE.erl b/apps/emqx/test/emqx_bpapi_SUITE.erl index b48d8ff2e..c1af0046c 100644 --- a/apps/emqx/test/emqx_bpapi_SUITE.erl +++ b/apps/emqx/test/emqx_bpapi_SUITE.erl @@ -40,7 +40,7 @@ end_per_suite(_Config) -> t_max_supported_version(_Config) -> ?assertMatch(3, emqx_bpapi:supported_version('fake-node2@localhost', api2)), ?assertMatch(2, emqx_bpapi:supported_version(api2)), - ?assertError(_, emqx_bpapi:supported_version('fake-node2@localhost', nonexistent_api)), + ?assertMatch(undefined, emqx_bpapi:supported_version('fake-node2@localhost', nonexistent_api)), ?assertError(_, emqx_bpapi:supported_version(nonexistent_api)). t_announce(Config) -> From 03766d54ccce4c7d2f4036ce1b728f6760214576 Mon Sep 17 00:00:00 2001 From: ieQu1 <99872536+ieQu1@users.noreply.github.com> Date: Mon, 5 Sep 2022 13:38:34 +0200 Subject: [PATCH 33/38] feat(emqx_rpc): call with timeout --- apps/emqx/src/bpapi/emqx_bpapi_trans.erl | 2 ++ apps/emqx/src/emqx_rpc.erl | 5 +++++ 2 files changed, 7 insertions(+) diff --git a/apps/emqx/src/bpapi/emqx_bpapi_trans.erl b/apps/emqx/src/bpapi/emqx_bpapi_trans.erl index 48a32a904..b1e9fb5f2 100644 --- a/apps/emqx/src/bpapi/emqx_bpapi_trans.erl +++ b/apps/emqx/src/bpapi/emqx_bpapi_trans.erl @@ -153,6 +153,8 @@ extract_mfa(?BACKEND(emqx_rpc, CallOrCast), [_Node, M, F, A]) -> {call_or_cast(CallOrCast), M, F, A}; extract_mfa(?BACKEND(emqx_rpc, CallOrCast), [_Tag, _Node, M, F, A]) -> {call_or_cast(CallOrCast), M, F, A}; +extract_mfa(?BACKEND(emqx_rpc, call), [_Tag, _Node, M, F, A, _Timeout]) -> + {call_or_cast(call), M, F, A}; %% (e)rpc: extract_mfa(?BACKEND(rpc, multicall), [M, F, A]) -> {call_or_cast(multicall), M, F, A}; diff --git a/apps/emqx/src/emqx_rpc.erl b/apps/emqx/src/emqx_rpc.erl index 590730e66..939b5395d 100644 --- a/apps/emqx/src/emqx_rpc.erl +++ b/apps/emqx/src/emqx_rpc.erl @@ -22,6 +22,7 @@ -export([ call/4, call/5, + call/6, cast/4, cast/5, multicall/4, @@ -78,6 +79,10 @@ call(Node, Mod, Fun, Args) -> call(Key, Node, Mod, Fun, Args) -> filter_result(gen_rpc:call(rpc_node({Key, Node}), Mod, Fun, Args)). +-spec call(term(), node(), module(), atom(), list(), timeout()) -> call_result(). +call(Key, Node, Mod, Fun, Args, Timeout) -> + filter_result(gen_rpc:call(rpc_node({Key, Node}), Mod, Fun, Args, Timeout)). + -spec multicall([node()], module(), atom(), list()) -> multicall_result(). multicall(Nodes, Mod, Fun, Args) -> gen_rpc:multicall(rpc_nodes(Nodes), Mod, Fun, Args). From e0fcf07cf908cd0fd74b65fa8548e284779048d0 Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Fri, 2 Sep 2022 16:57:43 -0300 Subject: [PATCH 34/38] fix: do not publish last will when authentication failed fixes #8886 --- CHANGES-5.0.md | 1 + apps/emqx/src/emqx_channel.erl | 14 ++- apps/emqx_authn/test/emqx_authn_SUITE.erl | 117 ++++++++++++++++++++++ 3 files changed, 128 insertions(+), 4 deletions(-) create mode 100644 apps/emqx_authn/test/emqx_authn_SUITE.erl diff --git a/CHANGES-5.0.md b/CHANGES-5.0.md index e9a9282db..8b59bd0dc 100644 --- a/CHANGES-5.0.md +++ b/CHANGES-5.0.md @@ -4,6 +4,7 @@ * Fix exhook `client.authorize` never being execauted. [#8780](https://github.com/emqx/emqx/pull/8780) * Fix JWT plugin don't support non-integer timestamp claims. [#8867](https://github.com/emqx/emqx/pull/8867) +* Avoid publishing will message when client fails to auhtenticate. [#8887](https://github.com/emqx/emqx/pull/8887) ## Enhancements diff --git a/apps/emqx/src/emqx_channel.erl b/apps/emqx/src/emqx_channel.erl index eff03e8ed..686833c45 100644 --- a/apps/emqx/src/emqx_channel.erl +++ b/apps/emqx/src/emqx_channel.erl @@ -22,6 +22,8 @@ -include("logger.hrl"). -include("types.hrl"). +-include_lib("snabbkaffe/include/snabbkaffe.hrl"). + -ifdef(TEST). -compile(export_all). -compile(nowarn_export_all). @@ -1423,7 +1425,8 @@ interval(will_timer, #channel{will_msg = WillMsg}) -> %%-------------------------------------------------------------------- -spec terminate(any(), channel()) -> ok. -terminate(_, #channel{conn_state = idle}) -> +terminate(_, #channel{conn_state = idle} = _Channel) -> + ?tp(channel_terminated, #{channel => _Channel}), ok; terminate(normal, Channel) -> run_terminate_hook(normal, Channel); @@ -1431,7 +1434,8 @@ terminate({shutdown, kicked}, Channel) -> run_terminate_hook(kicked, Channel); terminate({shutdown, Reason}, Channel) when Reason =:= discarded; - Reason =:= takenover + Reason =:= takenover; + Reason =:= not_authorized -> run_terminate_hook(Reason, Channel); terminate(Reason, Channel = #channel{will_msg = WillMsg}) -> @@ -1452,9 +1456,11 @@ persist_if_session(#channel{session = Session} = Channel) -> ok end. -run_terminate_hook(_Reason, #channel{session = undefined}) -> +run_terminate_hook(_Reason, #channel{session = undefined} = _Channel) -> + ?tp(channel_terminated, #{channel => _Channel}), ok; -run_terminate_hook(Reason, #channel{clientinfo = ClientInfo, session = Session}) -> +run_terminate_hook(Reason, #channel{clientinfo = ClientInfo, session = Session} = _Channel) -> + ?tp(channel_terminated, #{channel => _Channel}), emqx_session:terminate(ClientInfo, Reason, Session). %%-------------------------------------------------------------------- diff --git a/apps/emqx_authn/test/emqx_authn_SUITE.erl b/apps/emqx_authn/test/emqx_authn_SUITE.erl new file mode 100644 index 000000000..4c07489c8 --- /dev/null +++ b/apps/emqx_authn/test/emqx_authn_SUITE.erl @@ -0,0 +1,117 @@ +%%-------------------------------------------------------------------- +%% Copyright (c) 2022 EMQ Technologies Co., Ltd. All Rights Reserved. +%% +%% Licensed 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. +%%-------------------------------------------------------------------- + +-module(emqx_authn_SUITE). + +-compile(export_all). +-compile(nowarn_export_all). + +-include_lib("eunit/include/eunit.hrl"). +-include_lib("common_test/include/ct.hrl"). +-include_lib("snabbkaffe/include/snabbkaffe.hrl"). + +-include_lib("emqx/include/emqx.hrl"). +-include_lib("emqx/include/emqx_mqtt.hrl"). + +%%================================================================================= +%% CT boilerplate +%%================================================================================= + +all() -> + emqx_common_test_helpers:all(?MODULE). + +init_per_suite(Config) -> + Config. + +end_per_suite(_Config) -> + ok. + +init_per_testcase(Case, Config) -> + ?MODULE:Case({init, Config}). + +end_per_testcase(Case, Config) -> + ?MODULE:Case({'end', Config}). + +%%================================================================================= +%% Helpers fns +%%================================================================================= + +%%================================================================================= +%% Testcases +%%================================================================================= + +t_will_message_connection_denied({init, Config}) -> + emqx_common_test_helpers:start_apps([emqx_conf, emqx_authn]), + mria:clear_table(emqx_authn_mnesia), + AuthnConfig = #{ + <<"mechanism">> => <<"password_based">>, + <<"backend">> => <<"built_in_database">>, + <<"user_id_type">> => <<"clientid">> + }, + Chain = 'mqtt:global', + emqx:update_config( + [authentication], + {create_authenticator, Chain, AuthnConfig} + ), + User = #{user_id => <<"subscriber">>, password => <<"p">>}, + AuthenticatorID = <<"password_based:built_in_database">>, + {ok, _} = emqx_authentication:add_user( + Chain, + AuthenticatorID, + User + ), + Config; +t_will_message_connection_denied({'end', _Config}) -> + emqx:update_config( + [authentication], + {delete_authenticator, 'mqtt:global', <<"password_based:built_in_database">>} + ), + emqx_common_test_helpers:stop_apps([emqx_authn, emqx_conf]), + mria:clear_table(emqx_authn_mnesia), + ok; +t_will_message_connection_denied(Config) when is_list(Config) -> + {ok, Subscriber} = emqtt:start_link([ + {clientid, <<"subscriber">>}, + {password, <<"p">>} + ]), + {ok, _} = emqtt:connect(Subscriber), + {ok, _, [?RC_SUCCESS]} = emqtt:subscribe(Subscriber, <<"lwt">>), + + process_flag(trap_exit, true), + + {ok, Publisher} = emqtt:start_link([ + {clientid, <<"publisher">>}, + {will_topic, <<"lwt">>}, + {will_payload, <<"should not be published">>} + ]), + snabbkaffe:start_trace(), + ?wait_async_action( + {error, _} = emqtt:connect(Publisher), + #{?snk_kind := channel_terminated} + ), + snabbkaffe:stop(), + + receive + {publish, #{ + topic := <<"lwt">>, + payload := <<"should not be published">> + }} -> + ct:fail("should not publish will message") + after 0 -> + ok + end, + + ok. From 9dfa82b4484e79ba6f84541a4e5710e4e9fdb9d2 Mon Sep 17 00:00:00 2001 From: ieQu1 <99872536+ieQu1@users.noreply.github.com> Date: Mon, 5 Sep 2022 13:38:54 +0200 Subject: [PATCH 35/38] fix(shared_sub): Dispatch shared messages via gen_rpc --- apps/emqx/priv/bpapi.versions | 1 + apps/emqx/src/emqx_shared_sub.erl | 37 ++++++++----- .../src/proto/emqx_shared_sub_proto_v1.erl | 50 +++++++++++++++++ apps/emqx/test/emqx_shared_sub_SUITE.erl | 53 +++++++++++++++++++ 4 files changed, 129 insertions(+), 12 deletions(-) create mode 100644 apps/emqx/src/proto/emqx_shared_sub_proto_v1.erl diff --git a/apps/emqx/priv/bpapi.versions b/apps/emqx/priv/bpapi.versions index d1176e7ac..e224e6425 100644 --- a/apps/emqx/priv/bpapi.versions +++ b/apps/emqx/priv/bpapi.versions @@ -26,6 +26,7 @@ {emqx_resource,1}. {emqx_retainer,1}. {emqx_rule_engine,1}. +{emqx_shared_sub,1}. {emqx_slow_subs,1}. {emqx_statsd,1}. {emqx_telemetry,1}. diff --git a/apps/emqx/src/emqx_shared_sub.erl b/apps/emqx/src/emqx_shared_sub.erl index 3d14dddd0..0527cbfe7 100644 --- a/apps/emqx/src/emqx_shared_sub.erl +++ b/apps/emqx/src/emqx_shared_sub.erl @@ -38,7 +38,8 @@ -export([ dispatch/3, - dispatch/4 + dispatch/4, + do_dispatch_with_ack/4 ]). -export([ @@ -170,30 +171,31 @@ do_dispatch(SubPid, _Group, Topic, Msg, _Type) when SubPid =:= self() -> %% return either 'ok' (when everything is fine) or 'error' do_dispatch(SubPid, _Group, Topic, #message{qos = ?QOS_0} = Msg, _Type) -> %% For QoS 0 message, send it as regular dispatch - SubPid ! {deliver, Topic, Msg}, - ok; + send(SubPid, Topic, {deliver, Topic, Msg}); do_dispatch(SubPid, _Group, Topic, Msg, retry) -> %% Retry implies all subscribers nack:ed, send again without ack - SubPid ! {deliver, Topic, Msg}, - ok; + send(SubPid, Topic, {deliver, Topic, Msg}); do_dispatch(SubPid, Group, Topic, Msg, fresh) -> case ack_enabled() of true -> - dispatch_with_ack(SubPid, Group, Topic, Msg); + %% FIXME: replace with `emqx_shared_sub_proto:dispatch_with_ack' in 5.2 + do_dispatch_with_ack(SubPid, Group, Topic, Msg); false -> - SubPid ! {deliver, Topic, Msg}, - ok + send(SubPid, Topic, {deliver, Topic, Msg}) end. -dispatch_with_ack(SubPid, Group, Topic, Msg) -> +-spec do_dispatch_with_ack(pid(), emqx_types:group(), emqx_types:topic(), emqx_types:message()) -> + ok | {error, _}. +do_dispatch_with_ack(SubPid, Group, Topic, Msg) -> %% For QoS 1/2 message, expect an ack Ref = erlang:monitor(process, SubPid), Sender = self(), - SubPid ! {deliver, Topic, with_group_ack(Msg, Group, Sender, Ref)}, + %% FIXME: replace with regular send in 5.2 + send(SubPid, Topic, {deliver, Topic, with_group_ack(Msg, Group, Sender, Ref)}), Timeout = case Msg#message.qos of - ?QOS_1 -> timer:seconds(?SHARED_SUB_QOS1_DISPATCH_TIMEOUT_SECONDS); - ?QOS_2 -> infinity + ?QOS_2 -> infinity; + _ -> timer:seconds(?SHARED_SUB_QOS1_DISPATCH_TIMEOUT_SECONDS) end, try receive @@ -412,6 +414,17 @@ code_change(_OldVsn, State, _Extra) -> %% Internal functions %%-------------------------------------------------------------------- +send(Pid, Topic, Msg) -> + Node = node(Pid), + _ = + case Node =:= node() of + true -> + Pid ! Msg; + false -> + emqx_shared_sub_proto_v1:send(Node, Pid, Topic, Msg) + end, + ok. + maybe_insert_round_robin_count({Group, _Topic} = GroupTopic) -> strategy(Group) =:= round_robin_per_group andalso ets:insert(?SHARED_SUBS_ROUND_ROBIN_COUNTER, {GroupTopic, 0}), diff --git a/apps/emqx/src/proto/emqx_shared_sub_proto_v1.erl b/apps/emqx/src/proto/emqx_shared_sub_proto_v1.erl new file mode 100644 index 000000000..b224bf705 --- /dev/null +++ b/apps/emqx/src/proto/emqx_shared_sub_proto_v1.erl @@ -0,0 +1,50 @@ +%%-------------------------------------------------------------------- +%% Copyright (c) 2022 EMQ Technologies Co., Ltd. All Rights Reserved. +%% +%% Licensed 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. +%%-------------------------------------------------------------------- +-module(emqx_shared_sub_proto_v1). + +-behaviour(emqx_bpapi). + +-export([ + introduced_in/0, + send/4, + dispatch_with_ack/5 +]). + +-include("bpapi.hrl"). + +%%================================================================================ +%% behavior callbacks +%%================================================================================ + +introduced_in() -> + "5.0.8". + +%%================================================================================ +%% API funcions +%%================================================================================ + +-spec send(node(), pid(), emqx_types:topic(), term()) -> true. +send(Node, Pid, Topic, Msg) -> + emqx_rpc:cast(Topic, Node, erlang, send, [Pid, Msg]). + +-spec dispatch_with_ack( + pid(), emqx_types:group(), emqx_types:topic(), emqx_types:message(), timeout() +) -> + ok | {error, _}. +dispatch_with_ack(Pid, Group, Topic, Msg, Timeout) -> + emqx_rpc:call( + Topic, node(Pid), emqx_shared_sub, do_dispatch_with_ack, [Pid, Group, Topic, Msg], Timeout + ). diff --git a/apps/emqx/test/emqx_shared_sub_SUITE.erl b/apps/emqx/test/emqx_shared_sub_SUITE.erl index aeb44d529..f53e8f374 100644 --- a/apps/emqx/test/emqx_shared_sub_SUITE.erl +++ b/apps/emqx/test/emqx_shared_sub_SUITE.erl @@ -567,6 +567,59 @@ t_local(_) -> ?assertNotEqual(UsedSubPid1, UsedSubPid2), ok. +t_remote(_) -> + %% This testcase verifies dispatching of shared messages to the remote nodes via backplane API. + %% + %% In this testcase we start two EMQX nodes: local and remote. + %% A subscriber connects to the remote node. + %% A publisher connects to the local node and sends three messages with different QoS. + %% The test verifies that the remote side received all three messages. + ok = ensure_config(sticky, true), + GroupConfig = #{ + <<"local_group">> => local, + <<"round_robin_group">> => round_robin, + <<"sticky_group">> => sticky + }, + + Node = start_slave('remote_shared_sub_testtesttest', 21999), + ok = ensure_group_config(GroupConfig), + ok = ensure_group_config(Node, GroupConfig), + + Topic = <<"foo/bar">>, + ClientIdLocal = <<"ClientId1">>, + ClientIdRemote = <<"ClientId2">>, + + {ok, ConnPidLocal} = emqtt:start_link([{clientid, ClientIdLocal}]), + {ok, ConnPidRemote} = emqtt:start_link([{clientid, ClientIdRemote}, {port, 21999}]), + + try + {ok, ClientPidLocal} = emqtt:connect(ConnPidLocal), + {ok, ClientPidRemote} = emqtt:connect(ConnPidRemote), + + emqtt:subscribe(ConnPidRemote, {<<"$share/remote_group/", Topic/binary>>, 0}), + + ct:sleep(100), + + Message1 = emqx_message:make(ClientPidLocal, 0, Topic, <<"hello1">>), + Message2 = emqx_message:make(ClientPidLocal, 1, Topic, <<"hello2">>), + Message3 = emqx_message:make(ClientPidLocal, 2, Topic, <<"hello3">>), + + emqx:publish(Message1), + {true, UsedSubPid1} = last_message(<<"hello1">>, [ConnPidRemote]), + + emqx:publish(Message2), + {true, UsedSubPid1} = last_message(<<"hello2">>, [ConnPidRemote]), + + emqx:publish(Message3), + {true, UsedSubPid1} = last_message(<<"hello3">>, [ConnPidRemote]), + + ok + after + emqtt:stop(ConnPidLocal), + emqtt:stop(ConnPidRemote), + stop_slave(Node) + end. + t_local_fallback(_) -> ok = ensure_group_config(#{ <<"local_group">> => local, From 47de105b6cb0aae8bf539eaff5ce6e188fcf9321 Mon Sep 17 00:00:00 2001 From: ieQu1 <99872536+ieQu1@users.noreply.github.com> Date: Mon, 5 Sep 2022 17:35:03 +0200 Subject: [PATCH 36/38] docs(changes): Add missing change --- CHANGES-5.0.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGES-5.0.md b/CHANGES-5.0.md index be0acafa8..82d907458 100644 --- a/CHANGES-5.0.md +++ b/CHANGES-5.0.md @@ -5,6 +5,7 @@ * Fix exhook `client.authorize` never being execauted. [#8780](https://github.com/emqx/emqx/pull/8780) * Fix JWT plugin don't support non-integer timestamp claims. [#8867](https://github.com/emqx/emqx/pull/8867) * Avoid publishing will message when client fails to auhtenticate. [#8887](https://github.com/emqx/emqx/pull/8887) +* Speed up dispatching of shared subscription messages in a cluster [#8893](https://github.com/emqx/emqx/pull/8893) ## Enhancements From 3f758ca36f3c4201d04ced0b71a67361c3242838 Mon Sep 17 00:00:00 2001 From: firest Date: Tue, 6 Sep 2022 16:42:02 +0800 Subject: [PATCH 37/38] fix(tls): fix ciphers cache return `ok` at the first time call --- apps/emqx/src/emqx_tls_lib.erl | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/apps/emqx/src/emqx_tls_lib.erl b/apps/emqx/src/emqx_tls_lib.erl index 28bda5cfa..4bc18f1e0 100644 --- a/apps/emqx/src/emqx_tls_lib.erl +++ b/apps/emqx/src/emqx_tls_lib.erl @@ -145,7 +145,8 @@ all_ciphers_set_cached() -> case persistent_term:get(?FUNCTION_NAME, false) of false -> S = sets:from_list(all_ciphers()), - persistent_term:put(?FUNCTION_NAME, S); + persistent_term:put(?FUNCTION_NAME, S), + S; Set -> Set end. From f785da075b38be82a7e1a05e2a4f4eb495ba3b63 Mon Sep 17 00:00:00 2001 From: "Zaiming (Stone) Shi" Date: Sun, 4 Sep 2022 22:01:42 +0200 Subject: [PATCH 38/38] ci: only start required docker for integration tests --- .github/workflows/run_test_cases.yaml | 21 +---- Makefile | 1 - apps/emqx_authn/docker-ct | 4 + apps/emqx_authz/docker-ct | 4 + apps/emqx_connector/docker-ct | 4 + scripts/apps-version-check.sh | 5 +- scripts/ct/run.sh | 112 ++++++++++++++++++++++++++ scripts/docker-ct-apps | 4 - scripts/find-apps.sh | 31 +++---- 9 files changed, 144 insertions(+), 42 deletions(-) create mode 100644 apps/emqx_authn/docker-ct create mode 100644 apps/emqx_authz/docker-ct create mode 100644 apps/emqx_connector/docker-ct create mode 100755 scripts/ct/run.sh delete mode 100644 scripts/docker-ct-apps diff --git a/.github/workflows/run_test_cases.yaml b/.github/workflows/run_test_cases.yaml index b4b797621..540383ed6 100644 --- a/.github/workflows/run_test_cases.yaml +++ b/.github/workflows/run_test_cases.yaml @@ -121,27 +121,8 @@ jobs: PGSQL_TAG: 13 REDIS_TAG: 6 run: | - docker-compose \ - -f .ci/docker-compose-file/docker-compose-mongo-single-tcp.yaml \ - -f .ci/docker-compose-file/docker-compose-mongo-single-tls.yaml \ - -f .ci/docker-compose-file/docker-compose-mysql-tcp.yaml \ - -f .ci/docker-compose-file/docker-compose-mysql-tls.yaml \ - -f .ci/docker-compose-file/docker-compose-pgsql-tcp.yaml \ - -f .ci/docker-compose-file/docker-compose-pgsql-tls.yaml \ - -f .ci/docker-compose-file/docker-compose-redis-single-tcp.yaml \ - -f .ci/docker-compose-file/docker-compose-redis-single-tls.yaml \ - -f .ci/docker-compose-file/docker-compose-redis-sentinel-tcp.yaml \ - -f .ci/docker-compose-file/docker-compose-redis-sentinel-tls.yaml \ - -f .ci/docker-compose-file/docker-compose.yaml \ - up -d --build - - # produces .coverdata - - name: run common test - working-directory: source - run: | - docker exec -i ${{ matrix.otp_release }} bash -c "git config --global --add safe.directory \"$GITHUB_WORKSPACE\" && make ${{ matrix.app_name }}-ct" + ./scripts/ct/run.sh --app ${{ matrix.app_name }} - uses: actions/upload-artifact@v1 - if: matrix.otp_release == 'erlang24' with: name: coverdata path: source/_build/test/cover diff --git a/Makefile b/Makefile index 87404325e..ead7847f8 100644 --- a/Makefile +++ b/Makefile @@ -80,7 +80,6 @@ static_checks: APPS=$(shell $(SCRIPTS)/find-apps.sh) -## app/name-ct targets are intended for local tests hence cover is not enabled .PHONY: $(APPS:%=%-ct) define gen-app-ct-target $1-ct: $(REBAR) diff --git a/apps/emqx_authn/docker-ct b/apps/emqx_authn/docker-ct new file mode 100644 index 000000000..7b9a4c068 --- /dev/null +++ b/apps/emqx_authn/docker-ct @@ -0,0 +1,4 @@ +mongo +redis +mysql +pgsql diff --git a/apps/emqx_authz/docker-ct b/apps/emqx_authz/docker-ct new file mode 100644 index 000000000..7b9a4c068 --- /dev/null +++ b/apps/emqx_authz/docker-ct @@ -0,0 +1,4 @@ +mongo +redis +mysql +pgsql diff --git a/apps/emqx_connector/docker-ct b/apps/emqx_connector/docker-ct new file mode 100644 index 000000000..7b9a4c068 --- /dev/null +++ b/apps/emqx_connector/docker-ct @@ -0,0 +1,4 @@ +mongo +redis +mysql +pgsql diff --git a/scripts/apps-version-check.sh b/scripts/apps-version-check.sh index 72ddd5dc3..f760c18b3 100755 --- a/scripts/apps-version-check.sh +++ b/scripts/apps-version-check.sh @@ -12,7 +12,8 @@ parse_semver() { echo "$1" | tr '.|-' ' ' } -while read -r app; do +APPS="$(./scripts/find-apps.sh)" +for app in ${APPS}; do if [ "$app" != "emqx" ]; then app_path="$app" else @@ -46,7 +47,7 @@ while read -r app; do bad_app_count=$(( bad_app_count + 1)) fi fi -done < <(./scripts/find-apps.sh) +done if [ $bad_app_count -gt 0 ]; then exit 1 diff --git a/scripts/ct/run.sh b/scripts/ct/run.sh new file mode 100755 index 000000000..879efc434 --- /dev/null +++ b/scripts/ct/run.sh @@ -0,0 +1,112 @@ +#!/usr/bin/env bash + +## This script runs CT (and necessary dependencies) in docker container(s) + +set -euo pipefail + +# ensure dir +cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")/../.." + +help() { + echo + echo "-h|--help: To display this usage info" + echo "--app lib_dir/app_name: Print apps in json" + echo "--console: Start EMQX in console mode" +} + +WHICH_APP='novalue' +CONSOLE='no' +while [ "$#" -gt 0 ]; do + case $1 in + -h|--help) + help + exit 0 + ;; + --app) + WHICH_APP="$2" + shift 2 + ;; + --console) + CONSOLE='yes' + shift 1 + ;; + *) + echo "unknown option $1" + exit 1 + ;; + esac +done + +if [ "${WHICH_APP}" = 'novalue' ]; then + echo "must provide --app arg" + exit 1 +fi + +ERLANG_CONTAINER='erlang24' +DOCKER_CT_ENVS_FILE="${WHICH_APP}/docker-ct" + +if [ -f "$DOCKER_CT_ENVS_FILE" ]; then + # shellcheck disable=SC2002 + CT_DEPS="$(cat "$DOCKER_CT_ENVS_FILE" | xargs)" +fi +CT_DEPS="${ERLANG_CONTAINER} ${CT_DEPS}" + +FILES=( ) + +for dep in ${CT_DEPS}; do + case "${dep}" in + erlang24) + FILES+=( '.ci/docker-compose-file/docker-compose.yaml' ) + ;; + mongo) + FILES+=( '.ci/docker-compose-file/docker-compose-mongo-single-tcp.yaml' + '.ci/docker-compose-file/docker-compose-mongo-single-tls.yaml' ) + ;; + redis) + FILES+=( '.ci/docker-compose-file/docker-compose-redis-single-tcp.yaml' + '.ci/docker-compose-file/docker-compose-redis-single-tls.yaml' + '.ci/docker-compose-file/docker-compose-redis-sentinel-tcp.yaml' + '.ci/docker-compose-file/docker-compose-redis-sentinel-tls.yaml' ) + ;; + mysql) + FILES+=( '.ci/docker-compose-file/docker-compose-mysql-tcp.yaml' + '.ci/docker-compose-file/docker-compose-mysql-tls.yaml' ) + ;; + pgsql) + FILES+=( '.ci/docker-compose-file/docker-compose-pgsql-tcp.yaml' + '.ci/docker-compose-file/docker-compose-pgsql-tls.yaml' ) + ;; + *) + echo "unknown_ct_dependency $dep" + exit 1 + ;; + esac +done + +F_OPTIONS="" + +for file in "${FILES[@]}"; do + F_OPTIONS="$F_OPTIONS -f $file" +done + +# shellcheck disable=2086 # no quotes for F_OPTIONS +docker-compose $F_OPTIONS up -d --build + +# /emqx is where the source dir is mounted to the Erlang container +# in .ci/docker-compose-file/docker-compose.yaml +TTY='' +if [[ -t 1 ]]; then + TTY='-t' +fi +docker exec -i $TTY "$ERLANG_CONTAINER" bash -c 'git config --global --add safe.directory /emqx' + +if [ "$CONSOLE" = 'yes' ]; then + docker exec -i $TTY "$ERLANG_CONTAINER" bash -c "make run" +else + set +e + docker exec -i $TTY "$ERLANG_CONTAINER" bash -c "make ${WHICH_APP}-ct" + RESULT=$? + # shellcheck disable=2086 # no quotes for F_OPTIONS + docker-compose $F_OPTIONS down + exit $RESULT +fi diff --git a/scripts/docker-ct-apps b/scripts/docker-ct-apps deleted file mode 100644 index 882a68285..000000000 --- a/scripts/docker-ct-apps +++ /dev/null @@ -1,4 +0,0 @@ -# apps need docker-compose to run CT -apps/emqx_authn -apps/emqx_authz -apps/emqx_connector diff --git a/scripts/find-apps.sh b/scripts/find-apps.sh index f888eaa22..8c41fecbf 100755 --- a/scripts/find-apps.sh +++ b/scripts/find-apps.sh @@ -50,24 +50,25 @@ find_app() { CE="$(find_app 'apps')" EE="$(find_app 'lib-ee')" +APPS_ALL="$(echo -e "${CE}\n${EE}")" if [ "$CT" = 'novalue' ]; then - echo -e "${CE}\n${EE}" - exit 0 -fi - -APPS_ALL="$(echo -e "${CE}\n${EE}")" -APPS_DOCKER_CT="$(grep -v -E '^#.*' scripts/docker-ct-apps)" - -# shellcheck disable=SC2068 -for app in ${APPS_DOCKER_CT[@]}; do - APPS_ALL=("${APPS_ALL[@]/$app}") -done - -if [ "$CT" = 'docker' ]; then - RESULT="${APPS_DOCKER_CT}" + RESULT="${APPS_ALL}" else - RESULT="${APPS_ALL[*]}" + APPS_NORMAL_CT=( ) + APPS_DOCKER_CT=( ) + for app in ${APPS_ALL}; do + if [ -f "${app}/docker-ct" ]; then + APPS_DOCKER_CT+=("$app") + else + APPS_NORMAL_CT+=("$app") + fi + done + if [ "$CT" = 'docker' ]; then + RESULT="${APPS_DOCKER_CT[*]}" + else + RESULT="${APPS_NORMAL_CT[*]}" + fi fi if [ "$WANT_JSON" = 'yes' ]; then