Skip to content

Conversation

@solababs
Copy link
Contributor

@solababs solababs commented Nov 7, 2025

This PR removes is_visible property from attribute metadata.

Summary by CodeRabbit

  • Refactor
    • Removed the is_visible attribute across the SDK — it no longer appears on attribute instances, in recognized property flags, payload generation, or produced node/relationship outputs.
  • Tests
    • Updated unit tests and fixtures to remove expectations and sample data containing is_visible.
  • Changelog
    • Added entry documenting the removal of the is_visible property.

✏️ Tip: You can customize this high-level summary in your review settings.

This PR removes `is_visible` property from attribute metadata.
@coderabbitai
Copy link

coderabbitai bot commented Nov 7, 2025

Walkthrough

The pull request removes the is_visible field throughout the Infrahub SDK. Changes include: removing the is_visible public attribute from the Attribute class, updating the PROPERTIES_FLAG constant to contain only ["is_protected"] instead of including is_visible, removing the is_visible field from the Attribute Protocol definition, eliminating the is_visible parameter from the generate_payload_create() method signature, and updating test fixtures and test expectations to no longer include is_visible fields in generated payloads and query structures.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 7.14% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: removing the is_visible property from attribute metadata across the codebase.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch sb-20251107-remove-metadata-param-ihs-176

📜 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 58e0d3d and 2bfa7b2.

📒 Files selected for processing (1)
  • changelog/+08aa1a85.removed.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • changelog/+08aa1a85.removed.md
⏰ 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.11)
  • GitHub Check: unit-tests (3.9)
  • GitHub Check: unit-tests (3.12)
  • GitHub Check: unit-tests (3.10)
  • GitHub Check: integration-tests-latest-infrahub
  • GitHub Check: Cloudflare Pages

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Nov 7, 2025

Deploying infrahub-sdk-python with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2bfa7b2
Status: ✅  Deploy successful!
Preview URL: https://c66f498e.infrahub-sdk-python.pages.dev
Branch Preview URL: https://sb-20251107-remove-metadata.infrahub-sdk-python.pages.dev

View logs

@codecov
Copy link

codecov bot commented Nov 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@             Coverage Diff             @@
##           develop     #603      +/-   ##
===========================================
- Coverage    76.44%   75.57%   -0.87%     
===========================================
  Files          112      113       +1     
  Lines        10856     9508    -1348     
  Branches      2335     1447     -888     
===========================================
- Hits          8299     7186    -1113     
+ Misses        1982     1835     -147     
+ Partials       575      487      -88     
Flag Coverage Δ
integration-tests 34.96% <0.00%> (-2.07%) ⬇️
python-3.10 48.88% <0.00%> (-1.83%) ⬇️
python-3.11 48.88% <0.00%> (+0.39%) ⬆️
python-3.12 48.84% <0.00%> (-1.83%) ⬇️
python-3.13 48.84% <0.00%> (-1.85%) ⬇️
python-3.9 47.56% <0.00%> (?)
python-filler-3.12 24.29% <100.00%> (+0.61%) ⬆️

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

Files with missing lines Coverage Δ
infrahub_sdk/node/attribute.py 94.93% <ø> (-0.07%) ⬇️
infrahub_sdk/node/constants.py 100.00% <100.00%> (ø)
infrahub_sdk/protocols_base.py 74.01% <ø> (-0.21%) ⬇️
infrahub_sdk/schema/__init__.py 68.00% <ø> (-4.71%) ⬇️

... and 23 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@solababs solababs requested a review from a team November 7, 2025 10:56
@gmazoyer
Copy link
Contributor

gmazoyer commented Nov 7, 2025

This PR should target infrahub-develop instead of develop.

@ogenstad
Copy link
Contributor

ogenstad commented Nov 7, 2025

This PR should target infrahub-develop instead of develop.

I think either or would be fine in this case as IS_VISIBLE was never really used and even if you update the property it doesn't do anything sensible.

@ogenstad
Copy link
Contributor

@solababs, can we add a news fragment of the "removed" kind and just mention that the SDK will no longer query for the is_visible property as that's being phased out of Infrahub?

@solababs solababs merged commit 0ba9ef2 into develop Nov 27, 2025
20 checks passed
@solababs solababs deleted the sb-20251107-remove-metadata-param-ihs-176 branch November 27, 2025 09:06
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.

5 participants