search

AllYarnsAreBeautiful / ayab-firmware

Contains the Arduino Firmware for the AYAB Shield
GNU General Public License v3.0
23 stars 19 forks source link

Tester: don't send empty message for empty version suffix, and add `-` in front of version suffix #201

Closed jonathanperret closed 1 month ago

jonathanperret commented 1 month ago

The desktop app currently crashes when handling a testRes message with an empty string (see https://github.com/AllYarnsAreBeautiful/ayab-desktop/issues/701).

That bug should be fixed over there, but it turns out there's a bug in the firmware as well (that I introduced in https://github.com/AllYarnsAreBeautiful/ayab-firmware/pull/195), in that the suffix is not prefixed by a - as it should be.

Adding this prefix, and making sure we don't send anything if there is no suffix, fixes that and "accidentally" works around the desktop bug.

How to test

  1. Upload a firmware with a non-suffixed tag: 
    $ git tag 1.2.3
$ pio run -t upload
$ git tag -d 1.2.3
  2. Run ayab-desktop and open the Hardware test dialog (without this PR, the dialog fails to open).
  3. Check that the dialog opens and the displayed version is correct.
  4. Upload a firmware with a suffixed tag: 
    $ git tag 1.2.3-beta456
$ pio run -t upload
$ git tag -d 1.2.3-beta456
  5. Run ayab-desktop and open the Hardware test dialog.
  6. Check that the dialog opens and the displayed version is correct (without this PR, the version is missing its separator, e.g. 1.2.3beta456).

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes made to the setUp method of the Tester class involve the addition of a conditional check for the FW_VERSION_SUFFIX variable. This ensures that the suffix is included in the message only if it is not empty, replacing the previous implementation that sent it unconditionally. This adjustment improves the clarity of the messages generated by the method.

Changes

Files Change Summary
src/ayab/tester.cpp Added a conditional check for FW_VERSION_SUFFIX in the setUp method to prevent sending an empty string.

Sequence Diagram(s)

sequenceDiagram
    participant Tester
    participant Message

    Tester->>Message: Prepare message
    alt FW_VERSION_SUFFIX is not empty
        Tester->>Message: Append FW_VERSION_SUFFIX
    end
    Tester->>Message: Send message

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.