Validate add-on ID format

[seanbudd]

add-ons have been submitted to the store with invalid formats for add-on IDs such as containing spaces

Summary by CodeRabbit

• New Features

  • Improved validation for add-on identifiers to ensure they start and end with a letter and contain only letters, numbers, and hyphens. Users will now receive clearer error messages if the format requirements are not met.

• Tests

  • Added tests to verify that invalid add-on identifier formats are correctly detected and reported.

[coderabbitai]

Walkthrough

The changes introduce stricter validation for the addonId field in add-on submissions, ensuring it starts and ends with a letter and contains only letters, numbers, and hyphens. Two new tests were added to verify this validation logic, and the core validation function was updated to enforce the format requirement and yield errors when violated.

Changes

File(s)	Change Summary
_tests/test_validate.py	Added two test methods to check invalid addonId formats: one with spaces, one with invalid start.
_validate/validate.py	Enhanced checkAddonId to validate addonId format using a regular expression and yield errors.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Method
    participant Validate as validate.checkAddonId
    participant Manifest as Manifest Data

    Test->>Validate: Call checkAddonId(manifest, path, submission_data)
    Validate->>Manifest: Retrieve addonId from submission_data
    Validate->>Validate: Check addonId format (regex)
    alt Format invalid
        Validate-->>Test: Yield validation error
    else Format valid
        Validate-->>Test: Continue (no error)
    end

Loading

Poem

In the land of code, a rule was spun,
Add-on IDs must start and end with one—
A letter, not a space or dash,
No sneaky digits in the stash!
With tests to check and code to guide,
Our validation hops with pride.
🐇✨

✨ 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.

[coderabbitai]

Actionable comments posted: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a29f649 and ca2bba4.

📒 Files selected for processing (2)

• _tests/test_validate.py (1 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)

🪛 GitHub Actions: Test code

_tests/test_validate.py

[error] 310-310: Unit test failure in test_invalidAddonIdFormat_invalidStartChar: AssertionError due to mismatch in expected vs actual 'addonId' field format in submission data.

---

[error] 293-293: Unit test failure in test_invalidAddonIdFormat_spaces: AssertionError due to mismatch in expected vs actual 'addonId' field format in submission data.