feat: better qos support #323

sudoshreyansh · 2022-07-28T16:42:22Z

Description

inbound QoS > 0 messages now get processed before sending the ACK response.
support for persistent sessions in MQTT using the sessionExpiryInterval property of the MQTT server binding.

MQTT versions before 5.0 cannot be supported due to the limitations in the protocol and the MQTT.js client library.

Related issue(s)
See also #27

sonarcloud · 2022-07-28T16:43:09Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
2 Code Smells

No Coverage information
0.0% Duplication

coveralls · 2022-07-28T16:43:40Z

Pull Request Test Coverage Report for Build 4003324759

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

3 of 5 (60.0%) changed or added relevant lines in 2 files are covered.
1 unchanged line in 1 file lost coverage.
Overall coverage decreased (-0.02%) to 61.89%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/lib/glee.ts	2	3	66.67%
src/lib/message.ts	1	2	50.0%

Files with Coverage Reduction	New Missed Lines	%
src/lib/glee.ts	1	90.12%

Totals
Change from base Build 3988887327:	-0.02%
Covered Lines:	319
Relevant Lines:	441

💛 - Coveralls

fmvilas

Left a bunch of comments. Great start! 🚀

fmvilas · 2022-07-29T12:26:38Z

src/adapters/mqtt/index.ts

@@ -48,6 +48,9 @@ class MqttAdapter extends Adapter {
        protocol: url.protocol.substr(0, url.protocol.length - 1),
        clientId: serverBinding && serverBinding.clientId,
        clean: serverBinding && serverBinding.cleanSession,
+        properties: {
+          sessionExpiryInterval: serverBinding && serverBinding.sessionExpiryInterval


The MQTT bindings (mqtt and mqtt5) don't have a sessionExpiryInterval property. We have to evaluate if that's something the MQTT5 binding should have, otherwise, we can't make a reference to it here.

Session expiry interval is specified in the MQTT spec. I think we should add it. It's required to have persistent sessions, and utilize QoS in MQTT.

fmvilas · 2022-07-29T12:28:30Z

src/adapters/mqtt/index.ts

@@ -58,15 +61,19 @@ class MqttAdapter extends Adapter {
        username: userAndPasswordSecurityReq ? process.env.GLEE_USERNAME : undefined,
        password: userAndPasswordSecurityReq ? process.env.GLEE_PASSWORD : undefined,
        ca: X509SecurityReq ? certs : undefined,
+        protocolVersion: 5,


If we do this, this adapter is always going to use MQTT 5. This must be a conditional value. Maybe based on the bindings. If the mqtt bindings exist then it's version 3.x, if the mqtt5 binding exists then it's version 5. Or maybe a configuration in the glee.config.js file.

MQTT specifies 3 for version 3.1 and 4 for version 3.1.1. So for the mqtt binding, which version will be used?

I'd go for version 4 given it's the latest for 3.x (that's really weird 😅)

src/adapters/mqtt/index.ts

src/lib/message.ts

sonarcloud · 2022-09-15T16:39:15Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

fmvilas · 2022-11-08T17:44:45Z

src/adapters/mqtt/index.ts

+      const serverBinding = mqttServerBinding
+      const protocolVersion = mqtt5ServerBinding ? 5 : 4


You should get protocolVersion from the server object instead:

Suggested change

const serverBinding = mqttServerBinding

const protocolVersion = mqtt5ServerBinding ? 5 : 4

const protocolVersion = parseInt(this.AsyncAPIServer.protocolVersion() || 4)

const serverBinding = protocolVersion === 5 ? mqtt5ServerBinding : mqttServerBinding

Just because the mqtt5 exists in the AsyncAPI document it doesn't mean it should be used.

fmvilas · 2022-11-08T17:55:20Z

src/lib/message.ts

+   * Indicates successfully processed the message
+   */
+  notifySuccessfulProcessing() {
+    this.emit('successfullyProcessed')


Let's follow the structure we're using everywhere else in the code base:

Suggested change

this.emit('successfullyProcessed')

this.emit('processing:successful')

fmvilas · 2022-11-08T17:55:40Z

src/lib/message.ts

+   * Indicates failure in processing the message
+   */
+  notifyFailedProcessing() {
+    this.emit('failedProcessing')


Suggested change

this.emit('failedProcessing')

this.emit('processing:failed')

fmvilas · 2023-01-23T10:09:25Z

@sudoshreyansh you've got some conflicts. It looks good to me already but you need to solve them before we can merge.

sonarcloud · 2023-01-25T06:05:00Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

sudoshreyansh · 2023-01-25T06:12:46Z

@fmvilas I have fixed the conflicts. Can you please re-review?

fmvilas

🚀 LET'S GOOOO!

fmvilas · 2023-01-25T12:16:24Z

/rtm

fmvilas · 2023-01-25T12:18:14Z

Congratulations on finishing your mentorship program, @sudoshreyansh 🎉 💰 😄

asyncapi-bot · 2023-01-25T12:21:07Z

🎉 This PR is included in version 0.16.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

sudoshreyansh added 3 commits July 28, 2022 17:18

added qos support for mqtt subscriptions

97d8bfb

added support for persistent sessions

59507be

fixed lint issues

3ace245

sudoshreyansh requested review from fmvilas, jonaslagoni and asyncapi-bot-eve as code owners July 28, 2022 16:42

fmvilas requested changes Jul 29, 2022

View reviewed changes

made mqtt protocol flexible and improved code quality

a673d25

sudoshreyansh mentioned this pull request Oct 11, 2022

feat: session expiry interval to mqtt5 bindings asyncapi/bindings#157

Merged

fmvilas requested changes Nov 8, 2022

View reviewed changes

changed event name, mqtt protocolVersion and serverBinding

2d9441f

Merge branch 'master' into better-qos-support

f425f24

sudoshreyansh requested a review from fmvilas January 25, 2023 06:11

fmvilas approved these changes Jan 25, 2023

View reviewed changes

asyncapi-bot added the ready-to-merge label Jan 25, 2023

asyncapi-bot merged commit d07d74e into asyncapi:master Jan 25, 2023

asyncapi-bot added the released label Jan 25, 2023

KhudaDad414 mentioned this pull request Feb 6, 2023

Add support for retries, backpressure, and at-most-once, at-least-once, and exactly-once semantics #27

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: better qos support #323

feat: better qos support #323

sudoshreyansh commented Jul 28, 2022

sonarcloud bot commented Jul 28, 2022

coveralls commented Jul 28, 2022 •

edited

Loading

fmvilas left a comment

fmvilas Jul 29, 2022

sudoshreyansh Aug 24, 2022

fmvilas Jul 29, 2022

sudoshreyansh Aug 24, 2022

fmvilas Aug 25, 2022

sudoshreyansh Aug 30, 2022

sonarcloud bot commented Sep 15, 2022

fmvilas Nov 8, 2022

fmvilas Nov 8, 2022

fmvilas Nov 8, 2022

fmvilas commented Jan 23, 2023

sonarcloud bot commented Jan 25, 2023

sudoshreyansh commented Jan 25, 2023

fmvilas left a comment

fmvilas commented Jan 25, 2023

fmvilas commented Jan 25, 2023

asyncapi-bot commented Jan 25, 2023

		const serverBinding = mqttServerBinding
		const protocolVersion = mqtt5ServerBinding ? 5 : 4

	this.emit('successfullyProcessed')
	this.emit('processing:successful')

feat: better qos support #323

feat: better qos support #323

Conversation

sudoshreyansh commented Jul 28, 2022

sonarcloud bot commented Jul 28, 2022

coveralls commented Jul 28, 2022 • edited Loading

Pull Request Test Coverage Report for Build 4003324759

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

fmvilas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Sep 15, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fmvilas commented Jan 23, 2023

sonarcloud bot commented Jan 25, 2023

sudoshreyansh commented Jan 25, 2023

fmvilas left a comment

Choose a reason for hiding this comment

fmvilas commented Jan 25, 2023

fmvilas commented Jan 25, 2023

asyncapi-bot commented Jan 25, 2023

coveralls commented Jul 28, 2022 •

edited

Loading