Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[APP] MQTTX #3480

Closed
wants to merge 21 commits into from
Closed

[APP] MQTTX #3480

wants to merge 21 commits into from

Conversation

Wraithers
Copy link
Contributor

@Wraithers Wraithers commented May 13, 2024

The Cedalo Management Center included in the Eclipse Mosquitto app doesn't seem to come with a publish message option to debug MQTT topics etc., so I'm making this pull request so that MQTTX can be used for that purpose. Worked well for me over the last few months 😊

If you think this should be merged with Eclipse Mosquitto along with/to replace Cedalo Management Center, I'm happy to revise the pull request 👍

Summary by CodeRabbit

  • New Features

    • Updated configuration for the MQTTX Web MQTT browser client to enhance user settings and connectivity options.
    • Introduced Docker configurations for easier deployment and management of the MQTTX service.
    • Added comprehensive documentation providing an overview of MQTTX, usage instructions, and development insights.
  • Documentation

    • Detailed description and contribution guidelines for MQTTX now available to assist users and developers.

Copy link
Contributor

coderabbitai bot commented May 13, 2024

Walkthrough

The recent updates to MQTTX bring improvements to configuration, deployment, and descriptive content, enhancing the MQTTX Web MQTT browser client's usability and accessibility for users.

Changes

File Path Summary
apps/mqttx/config.json Updated with comprehensive details including name, port, version, and supported architectures.
apps/mqttx/docker-compose.yml Added configurations for the mqttx service using the emqx/mqttx-web:v1.9.10 image.
apps/mqttx/.../description.md New file offering an overview of MQTTX, usage instructions, and development details.

🐰🌟✨
Oh hark! A change does gleam and glow,
In MQTTX's land, where data streams flow.
Configs aligned, with ports a-bind,
A docker's tale, in lines entwined.
Rejoice in code, where bytes do roam,
In MQTTX, our digital home.
🌟✨🐰


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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 222a396 and d640d87.
Files ignored due to path filters (1)
  • apps/mqttx/metadata/logo.jpg is excluded by !**/*.jpg
Files selected for processing (3)
  • apps/mqttx/config.json (1 hunks)
  • apps/mqttx/docker-compose.yml (1 hunks)
  • apps/mqttx/metadata/description.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • apps/mqttx/config.json
  • apps/mqttx/docker-compose.yml
Additional Context Used
LanguageTool (7)
apps/mqttx/metadata/description.md (7)

Near line 3: Unpaired symbol: ‘[’ seems to be missing
Context: ...upports formatting MQTT payload. MQTTX simplifies test oper...


Near line 5: Unpaired symbol: ‘[’ seems to be missing
Context: ...s other MQTT protocol features. > [MQTT](https://www.emqx.com/en/blog/the-easies...


Near line 5: Did you mean the noun “publishing”?
Context: ...nds for MQ Telemetry Transport. It is a publish/subscribe, extremely simple and lightwe...


Near line 5: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...y Transport. It is a publish/subscribe, extremely simple and lightweight messaging protocol, des...


Near line 29: Consider adding a hyphen.
Context: ...ured, click the Connect button in the upper right corner to create a connection and conne...


Near line 85: Unpaired symbol: ‘’ seems to be missing
Context: ...lectron
- Vue + [Element](https:/...


Near line 85: Unpaired symbol: ‘]’ seems to be missing
Context: ...njs.org/) - Vue + Element - [Ty...

Additional comments not posted (8)
apps/mqttx/metadata/description.md (8)

1-3: Introduction section looks clear and concise.


9-9: Preview image link is correctly formatted.


11-31: Usage instructions are clear and well-structured.


35-41: Community involvement links are correctly formatted and appropriate.


44-61: Development setup commands are correctly formatted and standard.


79-80: Contributing guide link is correctly formatted and relevant.


82-89: Technology stack links are correctly formatted.


91-99: Resource links are relevant and correctly formatted.

apps/mqttx/metadata/description.md Show resolved Hide resolved
The Google Doc listing ports (https://docs.google.com/spreadsheets/d/13U8MNCOiQjR4XohNCl9-CrmqS8_CA-oFEy3wrnJBJks/edit?usp=sharing) was outdated.

The new table view in the Tipi Appstore helped me find the port clash.
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between d640d87 and 741d078.
Files selected for processing (1)
  • apps/mqttx/config.json (1 hunks)
Files skipped from review due to trivial changes (1)
  • apps/mqttx/config.json

@meienberger meienberger mentioned this pull request Jun 9, 2024
@meienberger
Copy link
Collaborator

Hello @Wraithers thank you for your PR. I made some changes and merged #3715 instead. Because you merged master so many times in this branch I preferred to open a new one to avoid users pulling unnecessary commit

@meienberger meienberger closed this Jun 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants