BAF-1021 Deadlock fix

[MarioIvancik]

Paho mqtt client has undefined behavior if the client is disconnected while waiting for a message with the try_consume_message_for function. This most likely caused deadlocks when the mqtt broker went offline.

Summary by CodeRabbit

• Chores

  • Bumped the module version from 1.3.1 to 1.3.2, ensuring alignment with the latest release standards.

• Bug Fixes

  • Enhanced the communication handling workflow to boost stability and prevent potential concurrency issues during message processing and connection management, thereby improving overall reliability.

[coderabbitai]

Walkthrough

This pull request updates the BRINGAUTO_MODULE_GATEWAY_VERSION in the CMake configuration from 1.3.1 to 1.3.2. Additionally, the changes enhance thread safety in the MqttCommunication class by introducing a new mutex member in the header file and applying mutex locking via std::lock_guard in the receiveMessage and closeConnection methods.

Changes

File(s)	Change Summary
CMakeLists.txt	Updated the version number of BRINGAUTO_MODULE_GATEWAY_VERSION from 1.3.1 to 1.3.2.
include/…/MqttCommunication.hpp source/…/MqttCommunication.cpp	Added a new mutex member (receiveMessageMutex_) to the MqttCommunication class and applied std::lock_guard in the receiveMessage and closeConnection methods for thread safety.

Sequence Diagram(s)

sequenceDiagram
    participant Thread
    participant MqttCommunication
    participant Client

    Thread->>MqttCommunication: receiveMessage()
    MqttCommunication->>MqttCommunication: Lock receiveMessageMutex_
    MqttCommunication->>Client: Process message reception
    Client-->>MqttCommunication: Return message data / status
    MqttCommunication->>MqttCommunication: Unlock receiveMessageMutex_

Loading

sequenceDiagram
    participant Thread
    participant MqttCommunication
    participant Client

    Thread->>MqttCommunication: closeConnection()
    MqttCommunication->>MqttCommunication: Lock receiveMessageMutex_
    MqttCommunication->>Client: Disconnect client
    Client-->>MqttCommunication: Confirm disconnection
    MqttCommunication->>MqttCommunication: Unlock receiveMessageMutex_

Loading

Possibly related PRs

• Baf 921/refactor usage of buffer #29: Updates version in CMakeLists.txt, similar to the changes in this PR.
• BAF-939 Integration test failing #31: Modifies the BRINGAUTO_MODULE_GATEWAY_VERSION variable, directly related to the version update.
• Baf 967/ignore empty commands and statuses #35: Involves a version number change in the same file, showing a direct code-level connection.

Suggested reviewers

• koudis

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3496061 and 9249670.

📒 Files selected for processing (3)

• CMakeLists.txt (1 hunks)
• include/bringauto/external_client/connection/communication/MqttCommunication.hpp (1 hunks)
• source/bringauto/external_client/connection/communication/MqttCommunication.cpp (2 hunks)

✅ Files skipped from review due to trivial changes (1)

• CMakeLists.txt

🔇 Additional comments (3)

include/bringauto/external_client/connection/communication/MqttCommunication.hpp (1)

75-76: LGTM! Well-documented mutex addition.

The mutex is correctly declared and documented, providing thread safety for message reception and connection closure operations.

source/bringauto/external_client/connection/communication/MqttCommunication.cpp (2)

100-120: LGTM! Thread-safe message reception.

The mutex lock correctly protects all operations involving the MQTT client during message reception.

---

122-132: LGTM! Thread-safe connection closure.

The mutex lock correctly protects all operations involving the MQTT client during connection closure.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[koudis]

Approved. Please release new version.