root
/
rabbitmq-server
mirror of https://github.com/rabbitmq/rabbitmq-server.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity
rabbitmq-server/deps/rabbitmq_mqtt/Makefile

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

62 lines
1.9 KiB
Makefile
Raw Normal View History

Initial move to erlang.mk
2015-10-19 18:28:46 +08:00
PROJECT = rabbitmq_mqtt
Move from .app.src to Makefile variables This is the recommended way with Erlang.mk. By default, the version is inherited from rabbitmq-server-release when the source archive is created, or computed from git-describe(1) (see `rabbitmq-components.mk`). One can override the version from the command line by setting the `PROJECT_VERSION` variable. [#130992027]
2016-12-06 23:31:08 +08:00
PROJECT_DESCRIPTION = RabbitMQ MQTT Adapter
PROJECT_MOD = rabbit_mqtt
define PROJECT_ENV
[
{default_user, <<"guest">>},
{default_pass, <<"guest">>},
{ssl_cert_login,false},
%% To satisfy an unfortunate expectation from popular MQTT clients.
{allow_anonymous, true},
{vhost, <<"/">>},
{exchange, <<"amq.topic">>},
Make mqtt.subscription_ttl unsupported Starting with RabbitMQ 3.13 mqtt.max_session_expiry_interval_seconds (set in seconds) will replace the previous setting mqtt.subscription_ttl. MQTT 5.0 introduces the Session Expiry Interval feature which does not only apply to subscribers, but also to publishers. The new config name mqtt.max_session_expiry_interval_seconds makes it clear that it also applies to publishers. Prior to this commit, when mqtt.subscription_ttl was set, a warning got logged and the value was ignored. This is dangerous if an operator does not see the warning but relies for example on `mqtt.subscription = infinity` to not expire non clean session. It's safer to make the boot fail if that unsupported config name is still set. A clear error message will be logged: ``` [error] <0.142.0> Error preparing configuration in phase apply_translations: [error] <0.142.0> - Translation for 'rabbitmq_mqtt.subscription_ttl' found invalid configuration: Since 3.13 mqtt.subscription_ttl (in milliseconds) is unsupported. Use mqtt.max_session_expiry_interval_seconds (in seconds) instead. ``` Alternatively, RabbitMQ could translate mqtt.subscription_ttl to mqtt.max_session_expiry_interval_seconds. However, forcing the new config option sounds the better way to go. Once we write MQTT 5.0 docs, this change must go into the 3.13 release notes. This commit also renames max_session_expiry_interval_secs to max_session_expiry_interval_seconds. The latter is clearer to users.
2023-07-13 22:38:47 +08:00
{max_session_expiry_interval_seconds, 86400}, %% 1 day
Move from .app.src to Makefile variables This is the recommended way with Erlang.mk. By default, the version is inherited from rabbitmq-server-release when the source archive is created, or computed from git-describe(1) (see `rabbitmq-components.mk`). One can override the version from the command line by setting the `PROJECT_VERSION` variable. [#130992027]
2016-12-06 23:31:08 +08:00
{retained_message_store, rabbit_mqtt_retained_msg_store_dets},
%% only used by DETS store
{retained_message_store_dets_sync_interval, 2000},
{prefetch, 10},
{ssl_listeners, []},
{tcp_listeners, [1883]},
{num_tcp_acceptors, 10},
Use 10 TLS connection acceptors by default Part of rabbitmq/rabbitmq-server#1729. [#161136615]
2018-10-11 08:00:39 +08:00
{num_ssl_acceptors, 10},
Move from .app.src to Makefile variables This is the recommended way with Erlang.mk. By default, the version is inherited from rabbitmq-server-release when the source archive is created, or computed from git-describe(1) (see `rabbitmq-components.mk`). One can override the version from the command line by setting the `PROJECT_VERSION` variable. [#130992027]
2016-12-06 23:31:08 +08:00
{tcp_listen_options, [{backlog, 128},
Add overflow drop-head to rabbit_mqtt_qos_queue type Traditionally, queue types implement flow control by keeping state in both sending and receiving Erlang processes (for example credit based flow control keeps the number of credits within the process dictionary). The rabbit_mqtt_qos0_queue cannot keep such state in sending or receiving Erlang process because such state would consume a large amount of memory in case of large fan-ins or large fan-outs. The whole idea of the rabbit_mqtt_qos_queue type is to not keep any state in the rabbit_queue_type client. This makes this new queue type scale so well. Therefore the new queue type cannot (easily) implement flow control throttling individual senders. In this commit, we take a different approach: Instead of implementing flow control throttling individual senders, the receiving MQTT connection process drops QoS 0 messages from the rabbit_mqtt_qos_queue if it is overflowed with messages AND its MQTT client is not capable of receiving messages fast enough. This is a simple and sufficient solution because it's better to drop QoS 0 (at most once) messages instead of causing cluster-wide memory alarms. The user can opt out of dropping messages by setting the new env setting mailbox_soft_limit to 0. Additionally, we reduce the send_timeout from 30 seconds default in Ranch to 15 seconds default in MQTT. This will detect hanging MQTT clients faster causing the MQTT connection to be closed.
2022-12-12 16:57:33 +08:00
{nodelay, true},
{send_timeout, 15000},
{send_timeout_close, true}
]},
Disable Sparkplug support by default References #206
2019-09-06 21:08:57 +08:00
{proxy_protocol, false},
Add overflow drop-head to rabbit_mqtt_qos_queue type Traditionally, queue types implement flow control by keeping state in both sending and receiving Erlang processes (for example credit based flow control keeps the number of credits within the process dictionary). The rabbit_mqtt_qos0_queue cannot keep such state in sending or receiving Erlang process because such state would consume a large amount of memory in case of large fan-ins or large fan-outs. The whole idea of the rabbit_mqtt_qos_queue type is to not keep any state in the rabbit_queue_type client. This makes this new queue type scale so well. Therefore the new queue type cannot (easily) implement flow control throttling individual senders. In this commit, we take a different approach: Instead of implementing flow control throttling individual senders, the receiving MQTT connection process drops QoS 0 messages from the rabbit_mqtt_qos_queue if it is overflowed with messages AND its MQTT client is not capable of receiving messages fast enough. This is a simple and sufficient solution because it's better to drop QoS 0 (at most once) messages instead of causing cluster-wide memory alarms. The user can opt out of dropping messages by setting the new env setting mailbox_soft_limit to 0. Additionally, we reduce the send_timeout from 30 seconds default in Ranch to 15 seconds default in MQTT. This will detect hanging MQTT clients faster causing the MQTT connection to be closed.
2022-12-12 16:57:33 +08:00
{sparkplug, false},
Add MQTT v5 feature Maximum Packet Size set by server "Allow the Client and Server to independently specify the maximum packet size they support. It is an error for the session partner to send a larger packet." This commit implements the part where the Server specifies the maximum packet size. "In the case of an error in a CONNECT packet it MAY send a CONNACK packet containing the Reason Code, before closing the Network Connection. In the case of an error in any other packet it SHOULD send a DISCONNECT packet containing the Reason Code before closing the Network Connection." This commit implements only the "SHOULD" (second) part, not the "MAY" (first) part. There are now 2 different global wide MQTT settings on the server: 1. max_packet_size_unauthenticated which applies to the CONNECT packet (and maybe AUTH packet in the future) 2. max_packet_size_authenticated which applies to all other MQTT packets (that is, after the client successfully authenticated). These two settings will apply to all MQTT versions. In MQTT v5, if a non-CONNECT packet is too large, the server will send a DISCONNECT packet to the client with Reason Code "Packet Too Large" before closing the network connection.
2023-02-25 02:23:41 +08:00
{mailbox_soft_limit, 200},
{max_packet_size_unauthenticated, 65536},
%% 256 MB is upper limit defined by MQTT spec
Make Topic Alias Maximum configurable - default to 20, configurable through cuttlefish config - add test to v5 suite for invalid topic alias in publish
2023-06-05 23:06:44 +08:00
{max_packet_size_authenticated, 268435455},
Add Topic Aliases from server to client Once the server's Topic Alias cache for messages from server to client is full, this commit does not replace any existing aliases. So, the first topics "win" and stay in the cache forever. This matches the behaviour of VerneMQ and EMQX. For now that's good enough. In the future, we can easily change that behaviour to some smarter strategy, for example 1. Hash the TopicName to an Topic Alias and replace the old alias, or 2. For the Topic Alias Cache from server to client, keep 2 Maps: #{TopicName => TopicAlias} and #{TopicAlias => TopicName} and a counter that wraps to 1 once the Topic Alias Maximum is reached and just replace an existing Alias if the TopicName is not cached. Also, refactor Topic Alias Maximum: * Remove code duplication * Allow an operator to prohibit Topic Aliases by allowing value 0 to be configured * Change config name to topic_alias_maximum to that it matches exactly the MQTT feture name * Fix wrong code formatting * Add the invalid or unkown Topic Alias to log message for easier troubleshooting
2023-06-12 22:31:50 +08:00
{topic_alias_maximum, 16}
Move from .app.src to Makefile variables This is the recommended way with Erlang.mk. By default, the version is inherited from rabbitmq-server-release when the source archive is created, or computed from git-describe(1) (see `rabbitmq-components.mk`). One can override the version from the command line by setting the `PROJECT_VERSION` variable. [#130992027]
2016-12-06 23:31:08 +08:00
]
endef
Initial move to erlang.mk
2015-10-19 18:28:46 +08:00
Merge branch 'stable'
2016-12-07 22:48:04 +08:00
define PROJECT_APP_EXTRA_KEYS
{broker_version_requirements, []}
endef
Initial move to erlang.mk
2015-10-19 18:28:46 +08:00
Upgrade MQTT Erlang client The rabbitmq_mqtt tests used an outdated MQTT Erlang client. It was a fork that has not been updated for > 4 years. This commit upgrades the client to the latest version. Therefore, we can delete our fork https://github.com/rabbitmq/emqttc.git
2022-08-30 16:24:40 +08:00
# We do not need QUIC as dependency of emqtt.
BUILD_WITHOUT_QUIC=1
export BUILD_WITHOUT_QUIC
Add a workflow to compare the bazel/erlang.mk output To catch any drift between the builds
2023-05-01 16:32:59 +08:00
LOCAL_DEPS = ssl
Remove amqp_client dep from rabbitmq_mqtt Since Native MQTT in 3.12 the MQTT plugin does not depend on AMQP 0.9.1 client anymore. Such a dependency is only needed for the MQTT tests.
2023-07-20 16:06:05 +08:00
DEPS = ranch rabbit_common rabbit ra
TEST_DEPS = emqtt ct_helper rabbitmq_ct_helpers rabbitmq_ct_client_helpers rabbitmq_management rabbitmq_web_mqtt amqp_client
Tests for mqtt blocking
2016-03-03 00:57:48 +08:00
Makefile: No need to filter out rabbitmq_test from TEST_DEPS anymore [#127356157]
2016-09-02 18:29:41 +08:00
dep_ct_helper = git https://github.com/extend/ct_helper.git master
Point emqtt to rabbitmq/emqtt:master emqtt repos: emqx/emqtt PR #196 is based on rabbitmq:otp-26-compatibility emqx/emqtt PR #198 is based on ansd:master rabbitmq/master contains both of these 2 PRs cherry-picked. rabbitmq-server repos: main branch points emqtt to rabbitmq:otp-26-compatibility mqtt5 branch points emqtt to rabbitmq:master Therefore, the current mqtt5 branch is OTP 26 compatible and can support multiple subscription identifiers.
2023-04-28 21:07:02 +08:00
dep_emqtt = git https://github.com/rabbitmq/emqtt.git master
Initial move to erlang.mk
2015-10-19 18:28:46 +08:00
Makefile: Load the new `rabbitmq-early-plugin.mk` early-stage plugin See the corresponding commit in rabbitmq-common for an explanation. [#144697185]
2017-05-16 23:36:21 +08:00
DEP_EARLY_PLUGINS = rabbit_common/mk/rabbitmq-early-plugin.mk
Initial move to erlang.mk
2015-10-19 18:28:46 +08:00
DEP_PLUGINS = rabbit_common/mk/rabbitmq-plugin.mk
Remove duplicate rabbitmq-components.mk and erlang.mk files Also adjust the references in rabbitmq-components.mk to account for post monorepo locations
2021-03-22 17:38:17 +08:00
include ../../rabbitmq-components.mk
include ../../erlang.mk
Run tests via maven
2016-09-23 23:42:21 +08:00
test dir cleanup
2016-09-24 00:19:03 +08:00
clean::
Makefile: Do not hard-code the supposed name of GNU Make's executable There is the `$(MAKE)` variable populated with the current/appropriate Make executable.
2018-04-05 16:30:46 +08:00
if test -d test/java_SUITE_data; then cd test/java_SUITE_data && $(MAKE) clean; fi