Skip to content

Conversation

@ajtmccarty
Copy link
Contributor

@ajtmccarty ajtmccarty commented Jul 22, 2025

always sorting the files alphabetically will cause a problem if a file a_objects.yml is dependent on z_objects.yml
this update is to only sort files alphabetically if they are in a directory, in which case I think we can assume that order does not matter.
I'm not exactly sure why we need to order files alphabetically at all actually, so maybe the added line is unecessary

Summary by CodeRabbit

  • Refactor
    • Updated the order in which files are processed when loading from directories, ensuring subdirectory contents are sorted by filename while leaving the initial input order unchanged. This may affect the sequence in which files are loaded from disk.

@coderabbitai
Copy link

coderabbitai bot commented Jul 22, 2025

Walkthrough

The update modifies the load_from_disk class method in infrahub_sdk/yaml.py by removing the initial sorting of the input paths list and instead applying sorting only to sub_paths when recursively processing directories. No changes are made to public APIs or method signatures.

Changes

File(s) Change Summary
infrahub_sdk/yaml.py Adjusted load_from_disk to remove initial sorting of paths and sort only sub_paths during recursion.

Estimated code review effort

1 (~2 minutes)


📜 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 ef7fc07 and d227402.

📒 Files selected for processing (1)
  • infrahub_sdk/yaml.py (1 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). (7)
  • GitHub Check: unit-tests (3.13)
  • GitHub Check: unit-tests (3.9)
  • GitHub Check: unit-tests (3.11)
  • GitHub Check: unit-tests (3.12)
  • GitHub Check: unit-tests (3.10)
  • GitHub Check: integration-tests-latest-infrahub
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
infrahub_sdk/yaml.py (2)

136-136: LGTM! This change correctly addresses the file dependency ordering issue.

The addition of sorting only for subdirectory contents is a well-targeted fix that preserves user-specified ordering for top-level paths while maintaining consistent behavior within directories.


121-140: No dependent ordering on initial paths

All searches across tests and documentation found no reliance on alphabetical sorting of the paths parameter itself:

  • The only ordering‐sensitive test is test_load_nested_folders_order (tests/integration/test_spec_object.py), which verifies sorting of sub_paths via the existing sorted(..., key=lambda p: p.name) logic—unchanged by removing initial sorting.
  • CLI output in infrahub_sdk/ctl/utils.py explicitly sorts loaded files by x.location, decoupling downstream behavior from load order.
  • No tests or docs reference sorting of the input paths list.

Removal of the initial paths sort does not impact existing functionality.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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 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
Copy link

codecov bot commented Jul 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

@@            Coverage Diff             @@
##           stable     #478      +/-   ##
==========================================
- Coverage   75.74%   75.65%   -0.09%     
==========================================
  Files         100      100              
  Lines        8841     8792      -49     
  Branches     1736     1723      -13     
==========================================
- Hits         6697     6652      -45     
+ Misses       1665     1662       -3     
+ Partials      479      478       -1     
Flag Coverage Δ
integration-tests 34.86% <100.00%> (-0.06%) ⬇️
python-3.10 47.95% <0.00%> (-0.26%) ⬇️
python-3.11 47.92% <0.00%> (-0.28%) ⬇️
python-3.12 47.92% <0.00%> (-0.26%) ⬇️
python-3.13 47.90% <0.00%> (-0.28%) ⬇️
python-3.9 46.59% <0.00%> (-0.19%) ⬇️
python-filler-3.12 25.21% <0.00%> (+0.13%) ⬆️

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

Files with missing lines Coverage Δ
infrahub_sdk/yaml.py 84.54% <100.00%> (ø)

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

@ajtmccarty
Copy link
Contributor Author

please feel free to update and/or merge without me if necessary

Copy link
Contributor

@dgarros dgarros left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch

@dgarros dgarros merged commit e12cc84 into stable Jul 23, 2025
20 checks passed
@dgarros dgarros deleted the ajtm-07222025-respect-file-order branch July 23, 2025 04:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants