Create batch directly instead of using create_batch while fetching relationships #483

dgarros · 2025-07-24T12:31:32Z

Without this change the latest release (1.3.5) wouldn't work in Infrahub

Summary by CodeRabbit

Documentation
- Updated the changelog to note that a new batch is created when fetching relationships, instead of reusing an existing batch.

…lationships

coderabbitai · 2025-07-24T12:31:40Z

Walkthrough

This change updates the logic for creating and managing batches during relationship fetching in both asynchronous and synchronous methods. It also streamlines the aggregation of peer IDs into a dictionary, removes unnecessary conditional checks, and documents the behavioral change in the changelog.

Changes

File(s)	Change Summary
changelog/+batch.fixed.md	Added changelog entry documenting the creation of a new batch when fetching relationships.
infrahub_sdk/node/relationship.py	Unified peer ID aggregation logic and modified batch instantiation in async fetch; clarified sync logic.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant RelationshipManager
    participant Batch

    Client->>RelationshipManager: fetch()
    RelationshipManager->>Batch: create new Batch (async or sync)
    RelationshipManager->>Batch: Add peer IDs to batch
    Batch-->>RelationshipManager: Ready for execution
    RelationshipManager-->>Client: Return fetched relationships

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

fix: improve cardinality many relationship fetch #476: Refactors fetch methods to use batched filtering and adds validation and ordering controls, addressing related functionality in relationship fetching.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 64a7957 and de6cfbf.

📒 Files selected for processing (2)

changelog/+batch.fixed.md (1 hunks)
infrahub_sdk/node/relationship.py (3 hunks)

⏰ 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). (6)

GitHub Check: unit-tests (3.12)
GitHub Check: unit-tests (3.11)
GitHub Check: unit-tests (3.10)
GitHub Check: unit-tests (3.13)
GitHub Check: integration-tests-latest-infrahub
GitHub Check: Cloudflare Pages

🔇 Additional comments (6)

infrahub_sdk/node/relationship.py (5)

7-7: LGTM: Required import for direct batch instantiation.

The import is necessary to support the direct batch creation in the async fetch method.

167-167: LGTM: Clean simplification using defaultdict.

The direct append operation leverages the defaultdict(list) initialized on line 163, eliminating the need for conditional key existence checks. This is a clean improvement.

169-169: LGTM: Direct batch creation fixes compatibility issue.

This change addresses the core issue mentioned in the PR objectives. Creating a fresh InfrahubBatch directly instead of using self.client.create_batch() ensures each fetch operation has its own batch context, preventing potential issues with batch reuse that caused compatibility problems in version 1.3.5.

290-290: LGTM: Consistent ID aggregation simplification.

Same beneficial simplification as in the async version, leveraging defaultdict(list) for cleaner code.

292-292: LGTM: Helpful comment explaining sync/async difference.

The comment clarifies why the sync version doesn't need the same batch creation approach as the async version, providing valuable context for future maintainers.

changelog/+batch.fixed.md (1)

1-1: LGTM: Accurate changelog entry.

The changelog entry correctly documents the fix, explaining that a new batch is created for relationship fetching instead of reusing an existing batch.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch dga-20250724-create-batch

🪧 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 generate unit tests to generate unit tests for 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 or 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.

codecov · 2025-07-24T12:33:20Z

Codecov Report

All modified and coverable lines are covered by tests ✅

@@            Coverage Diff             @@
##           stable     #483      +/-   ##
==========================================
- Coverage   75.74%   75.67%   -0.08%     
==========================================
  Files         100      100              
  Lines        8841     8789      -52     
  Branches     1736     1721      -15     
==========================================
- Hits         6697     6651      -46     
+ Misses       1665     1661       -4     
+ Partials      479      477       -2

Flag	Coverage Δ
integration-tests	`34.83% <50.00%> (-0.08%)`	⬇️
python-3.10	`47.94% <75.00%> (-0.23%)`	⬇️
python-3.11	`47.96% <75.00%> (-0.23%)`	⬇️
python-3.12	`47.94% <75.00%> (-0.21%)`	⬇️
python-3.13	`47.92% <75.00%> (-0.25%)`	⬇️
python-3.9	`46.63% <75.00%> (-0.16%)`	⬇️
python-filler-3.12	`25.23% <25.00%> (+0.15%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
infrahub_sdk/node/relationship.py	`72.41% <100.00%> (+0.66%)`	⬆️

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Create batch directly instead of using create_batch while fetching re…

de6cfbf

…lationships

dgarros requested a review from fatih-acar July 24, 2025 12:31

dgarros requested a review from a team July 24, 2025 12:31

fatih-acar approved these changes Jul 24, 2025

View reviewed changes

ajtmccarty approved these changes Jul 24, 2025

View reviewed changes

dgarros merged commit 21def0a into stable Jul 24, 2025
20 checks passed

dgarros deleted the dga-20250724-create-batch branch July 24, 2025 13:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Create batch directly instead of using create_batch while fetching relationships #483

Create batch directly instead of using create_batch while fetching relationships #483

Uh oh!

dgarros commented Jul 24, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 24, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Jul 24, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Create batch directly instead of using create_batch while fetching relationships #483

Create batch directly instead of using create_batch while fetching relationships #483

Uh oh!

Conversation

dgarros commented Jul 24, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Jul 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dgarros commented Jul 24, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 24, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jul 24, 2025 •

edited

Loading