add support for underscores in addonIds

[seanbudd]

Summary by CodeRabbit

• Bug Fixes

  • Updated validation rules to allow underscores in add-on IDs, in addition to letters, numbers, and hyphens.
  • Improved error messages to reflect the inclusion of underscores as valid characters.

• Tests

  • Added a new test to confirm that add-on IDs with underscores are accepted.
  • Updated existing tests and error messages to align with the new validation rules.

[coderabbitai]

Walkthrough

The validation logic for add-on IDs was updated to permit underscores in addition to letters, numbers, and hyphens. Corresponding tests were added and updated to verify this new rule, including changes to error messages and the validation regular expression.

Changes

File(s)	Change Summary
_validate/validate.py	Updated regex to allow underscores in add-on IDs and modified error messages accordingly.
_tests/test_validate.py	Added a test for valid IDs with underscores; updated existing tests and error messages.

Sequence Diagram(s)

sequenceDiagram
    participant Tester as Test Suite
    participant Validator as checkAddonId

    Tester->>Validator: checkAddonId("valid1-Addon_id")
    Validator-->>Tester: returns no error

    Tester->>Validator: checkAddonId("invalid-addon-id!")
    Validator-->>Tester: returns error (invalid character)

Loading

Possibly related PRs

• Validate add-on ID format #44: Extended add-on ID validation regex and tests, directly related to the changes in validation logic and test structure.

Poem

In the warren, code hops anew,
Add-on IDs with underscores now pass through!
Regex lines shift, tests leap in delight,
Hyphens and numbers, all still in sight.
A bunny’s approval: “Hop on, code, you’re right!”
🐇

---

📜 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 79731a7 and d01618d.

📒 Files selected for processing (2)

• _tests/test_validate.py (3 hunks)
• _validate/validate.py (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

_tests/test_validate.py (1)

_validate/validate.py (1)

• checkAddonId (164-189)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: testCode (3.11)

🔇 Additional comments (5)

_validate/validate.py (2)

183-183: LGTM! Regex correctly allows underscores in addon IDs.

The regex pattern ^[A-Za-z][A-Za-z0-9\-_]*[A-Za-z0-9]$ properly implements the requirement to allow underscores by adding _ to the character class for the middle portion, while maintaining the constraint that IDs must start with a letter and end with an alphanumeric character.

---

187-187: LGTM! Error message accurately reflects the expanded character set.

The error message correctly includes "underscores" in the list of allowed characters, maintaining consistency with the updated regex pattern.

_tests/test_validate.py (3)

227-241: LGTM! New test properly validates underscore support.

The test test_valid_withSymbols correctly verifies that addon IDs containing underscores (e.g., "valid1-Addon_id") are accepted as valid. The test properly mocks the path extraction and sets up the test data to ensure the validation passes with no errors.

---

315-315: LGTM! Error message updated to reflect expanded character set.

The error message correctly includes "underscores" in the list of allowed characters, maintaining consistency with the validation logic changes.

---

335-335: LGTM! Error message updated to reflect expanded character set.

The error message correctly includes "underscores" in the list of allowed characters, maintaining consistency with the validation logic changes.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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.