Allow node search with tags

[jschlyter]

Summary by CodeRabbit

• New Features

  • Enhanced node retrieval functionality with tag-based filtering
  • Added ability to query nodes using specific tags

• Tests

  • Introduced new test cases to validate tag-based node filtering
  • Added comprehensive test for tag-based node retrieval scenarios

• API Changes

  • Modified get_all_nodes endpoint to support optional tag filtering
  • Updated response model to include fields with None values

[coderabbitai]

Walkthrough

This pull request introduces enhanced node querying functionality in the nodeman/nodes.py file. The changes focus on adding tag-based filtering for node retrieval, with modifications to the get_all_nodes function. A new optional tags parameter allows filtering nodes based on specific tags, utilizing MongoEngine's Q query capabilities. Additionally, the API response behavior is adjusted to include fields with None values, providing more comprehensive data retrieval.

Changes

File	Changes
nodeman/nodes.py	- Added import for Q from mongoengine - Updated get_all_nodes function signature to include optional tags parameter - Modified query logic to support tag-based filtering - Set response_model_exclude_none to False
tests/test_api.py	- Added ADMIN_TEST_NODE_COUNT_TAGS constant - Introduced test_admin_tags() function to test tag-based node querying

Sequence Diagram

sequenceDiagram
    participant Client
    participant API
    participant Database
    Client->>API: Request nodes with tags
    API->>Database: Query nodes with tag filter
    Database-->>API: Return filtered nodes
    API-->>Client: Respond with node collection

Loading

Possibly related PRs

• Add support for node tags #60: The changes in this PR add support for node tags, which directly relates to the modifications in the main PR that enhance the querying capabilities of nodes based on tags.

Suggested reviewers

• eest
• johanix

Poem

🐰 Nodes hopping through the database maze,
Tags dancing, filtering with grace,
Q's magic weaves a query so bright,
Returning data, a rabbit's delight!
Filter on, little nodes, shine your way! 🌟

---

📜 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 7441503 and 427ecde.

📒 Files selected for processing (2)

• nodeman/nodes.py (2 hunks)
• tests/test_api.py (2 hunks)

🔇 Additional comments (5)

nodeman/nodes.py (3)

12-12: LGTM!

The import of Q from mongoengine is correctly placed with other database-related imports and is necessary for building complex queries.

---

211-220: LGTM! Tag filtering implementation looks good.

The implementation correctly:

1. Accepts an optional tags parameter
2. Uses MongoEngine's Q for query construction
3. Applies tags__all operator to ensure all specified tags are present
4. Maintains the existing deleted=None filter
5. Logs appropriate messages for debugging

---

209-211: Consider documenting the response model behavior change.

Setting response_model_exclude_none=False will include fields with None values in the response. This change might affect clients that expect the previous behavior where None values were excluded.

Run the following script to find potential clients that might be affected:

tests/test_api.py (2)

29-29: LGTM! Test constant is well-defined.

The constant ADMIN_TEST_NODE_COUNT_TAGS is appropriately set to 10, providing a good balance between test coverage and execution time.

---

411-438: LGTM! Comprehensive test coverage for tag filtering.

The test function effectively verifies:

1. Basic tag filtering (even/odd tags)
2. Multiple tag filtering (even,zero)
3. Mutually exclusive tags (even,odd)
4. Edge cases (zero tag)

The assertions correctly validate the expected behavior of the tag filtering implementation.

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.

[jschlyter]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.