Fix merge conflict between `develop` and `infrahub-develop` #566

ogenstad · 2025-10-07T07:25:57Z

Replaces #552

Summary by CodeRabbit

New Features
- Convert an object to another type with field mapping.
- Create diffs over a time range and fetch diff summaries with optional filters.
- Range expansion in object files (e.g., [1-5]) with validation.
- Clear optional attributes by setting them to None.
Bug Fixes
- Properly escape special characters in GraphQL strings.
- Include server response content in JSON decode errors.
- More robust schema load error display.
Documentation
- Added videos and docs for range expansion.
Chores
- Pre-commit hooks (lint/format) enabled.
- Switched to tomllib/tomli for TOML parsing; CI updated.

…o times. (#531) * feat: add create_diff method and update get_diff_summary to accept name parameter * feat: enhance get_diff_summary to support time range filtering * fix: update action field in diff summary to reflect correct status * feat: add create_diff method and update get_diff_summary for time range support * feat: add create_diff method and enhance get_diff_summary to support time range filtering * fix: remove unnecessary blank lines in InfrahubClientSync class * feat: update create_diff method to validate time range and change return type

…ables (#536) * Fix branch handling in `_run_transform` and `execute_graphql_query` functions * Add changelog entry for fixing branch handling in `_run_transform` and `execute_graphql_query` functions * Remove unused import of `get_branch` from `utils.py` * Add jinja2 transform and GraphQL query for tags, and implement branch selection test * Update changelog to specify environment variable usage for branch management in `_run_transform` and `execute_graphql_query` functions. * Remove unused `get_branch` import and set default branch in `validate_graphql` function

Remove unnecessary assignments before `return` statement

add livestream to docs

fix improperly escaped special characters in `HFID`

* Replace toml package with tomllib and tomli optionally * fix for mypy errors * update config, add pre-commit config * Make tomli package optional * Add towncrier housekeeping message * update python to uppercase p

Merge 'stable' into 'develop' with resolved conflicts

Co-authored-by: BeArchiTek <1334310+BeArchiTek@users.noreply.github.com>

* add support for clearing optional dropdown attributes and enhance tests for dropdown handling * add changelog entry for clearing optional dropdown attributes * refactor: update branch handling in changelog and allow clearing optional attributes if mutated

* add support for clearing optional dropdown attributes and enhance tests for dropdown handling * add changelog entry for clearing optional dropdown attributes * refactor: update branch handling in changelog and allow clearing optional attributes if mutated Co-authored-by: Alex Gittings <agitting96@gmail.com>

* Fix schema load failure exception * Add towncrier housekeeping message

Co-authored-by: BeArchiTek <1334310+BeArchiTek@users.noreply.github.com>

Merge stable into develop

* Add range expansion feature for object files and update documentation - Implemented range expansion for string fields in object files, allowing patterns like [1-5] to create multiple objects. - Added validation to ensure expanded lists have the same length. - Updated documentation to include usage examples and details on the new feature. - Added unit tests to verify range expansion functionality and error handling for mismatched lengths. * Refactor range expansion tests to clarify expected behavior for edge cases * Refactor range expansion logic to a standalone function for improved reusability and clarity * Rename variable for clarity in data expansion process within InfrahubObjectFileData class * Remove unnecessary range expansion in InfrahubObjectFileData class to streamline data handling

Fixes conflict in infrahub_sdk/client.py

coderabbitai · 2025-10-07T07:26:06Z

Walkthrough

This PR adds object-type conversion (convert_object_type) and diff operations (create_diff, get_diff_summary with optional time range). It introduces range expansion for object files, integrating expansion into validation and processing. TOML handling switches to tomllib with tomli fallback; CI and pyproject are updated accordingly and pre-commit is added. GraphQL string serialization now uses JSON-style escaping. Branch resolution defaults to configuration in CLI utilities, and schema error display logic is adjusted. Error reporting for JSON decode includes server content. Optional mutated attributes can be cleared with None. Docs gain a VideoPlayer component. Multiple minor refactors and comprehensive tests/changelogs are included.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 28.32% 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 succinctly describes the primary action of the pull request—resolving a merge conflict between the develop and infrahub-develop branches—without extraneous detail or ambiguity.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch pog-infrahub-develop-merge-conflict-20251007

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 · 2025-10-07T07:26:51Z

Deploying infrahub-sdk-python with Cloudflare Pages

Latest commit:	`cb4c330`
Status:	✅ Deploy successful!
Preview URL:	https://fbec3c05.infrahub-sdk-python.pages.dev
Branch Preview URL:	https://pog-infrahub-develop-merge-c.infrahub-sdk-python.pages.dev

View logs

codecov · 2025-10-07T07:28:32Z

Codecov Report

❌ Patch coverage is 73.77778% with 59 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
infrahub_sdk/client.py	35.00%	29 Missing and 10 partials ⚠️
infrahub_sdk/spec/range_expansion.py	88.57%	5 Missing and 3 partials ⚠️
infrahub_sdk/convert_object_type.py	84.00%	2 Missing and 2 partials ⚠️
infrahub_sdk/ctl/schema.py	77.77%	0 Missing and 2 partials ⚠️
infrahub_sdk/ctl/validate.py	33.33%	2 Missing ⚠️
infrahub_sdk/spec/object.py	94.44%	2 Missing ⚠️
infrahub_sdk/ctl/config.py	80.00%	1 Missing ⚠️
infrahub_sdk/playback.py	0.00%	1 Missing ⚠️

@@                 Coverage Diff                  @@
##           infrahub-develop     #566      +/-   ##
====================================================
- Coverage             75.97%   75.91%   -0.07%     
====================================================
  Files                   100      102       +2     
  Lines                  9345     9134     -211     
  Branches               1835     1811      -24     
====================================================
- Hits                   7100     6934     -166     
+ Misses                 1754     1706      -48     
- Partials                491      494       +3

Flag	Coverage Δ
integration-tests	`35.05% <23.55%> (-1.13%)`	⬇️
python-3.10	`48.58% <54.66%> (-1.02%)`	⬇️
python-3.11	`48.58% <54.66%> (-0.99%)`	⬇️
python-3.12	`48.54% <54.66%> (-1.04%)`	⬇️
python-3.13	`48.54% <54.66%> (-1.04%)`	⬇️
python-3.9	`47.15% <53.77%> (-0.86%)`	⬇️
python-filler-3.12	`24.79% <12.00%> (+0.48%)`	⬆️

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

Files with missing lines	Coverage Δ
infrahub_sdk/branch.py	`53.90% <100.00%> (-0.65%)`	⬇️
infrahub_sdk/ctl/cli_commands.py	`70.49% <100.00%> (+1.28%)`	⬆️
infrahub_sdk/ctl/utils.py	`68.53% <100.00%> (+0.44%)`	⬆️
infrahub_sdk/diff.py	`95.23% <100.00%> (-0.12%)`	⬇️
infrahub_sdk/exceptions.py	`91.07% <100.00%> (+9.25%)`	⬆️
infrahub_sdk/graphql.py	`99.11% <100.00%> (+<0.01%)`	⬆️
infrahub_sdk/node/attribute.py	`95.00% <100.00%> (+0.12%)`	⬆️
infrahub_sdk/node/node.py	`76.74% <100.00%> (+0.55%)`	⬆️
infrahub_sdk/repository.py	`100.00% <100.00%> (ø)`
infrahub_sdk/timestamp.py	`83.78% <100.00%> (+0.74%)`	⬆️
... and 8 more

... and 9 files with indirect coverage changes

🚀 New features to boost your workflow:

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

coderabbitai

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)

infrahub_sdk/ctl/config.py (1)

20-20: Remove or integrate unused constant
INFRAHUB_REPO_CONFIG_FILE_ALT is defined (config.py:20) but never used; either incorporate it into the config‐file discovery logic or remove it.
infrahub_sdk/ctl/validate.py (1)
77-84: Fix the misleading branch display.

The console print statement at Line 77 displays the branch value before the fallback to default_infrahub_branch is applied at Lines 83-84. If branch is None, users will see "Query 'X' will be validated on branch 'None'." even though the query actually executes on the default branch.

Apply this diff to fix the display:
-    console.print(f"[purple]Query '{query}' will be validated on branch '{branch}'.")
-
     variables_dict = parse_cli_vars(variables)
 
     client = initialize_client_sync()
 
     if not branch:
         branch = client.config.default_infrahub_branch
+
+    console.print(f"[purple]Query '{query}' will be validated on branch '{branch}'.")

🧹 Nitpick comments (13)

docs/src/components/VideoPlayer/index.tsx (1)
9-31: Consider adding accessibility and error handling enhancements.

The component implementation is clean and functional. To improve user experience and accessibility, consider these optional enhancements:

Accessibility: Add descriptive aria-label or title props to help screen reader users understand the video content.

Error handling: Wrap ReactPlayer with error boundaries or add onError callback to handle loading failures gracefully.

Flexible styling: Consider accepting additional ReactPlayer props (e.g., playing, muted, config) to allow callers more control without modifying the component.

Example for accessibility:
 interface VideoPlayerProps {
   url: string;
   light?: boolean;
+  ariaLabel?: string;
 }

-export default function VideoPlayer({ url, light = false }: VideoPlayerProps) {
+export default function VideoPlayer({ url, light = false, ariaLabel = 'Video player' }: VideoPlayerProps) {
   return (
-    <div style={{
+    <div aria-label={ariaLabel} style={{
       border: '3px solid #eee',
docs/docs/python-sdk/introduction.mdx (1)
10-12: Replace deprecated <center> tag with CSS styling.

The <center> tag is deprecated in HTML5. For better maintainability and modern HTML practices, use CSS styling instead.

Apply this diff to use CSS styling:
-<center>
-  <VideoPlayer url='https://www.youtube.com/live/RbRz8_t0FBs?feature=shared' light />
-</center>
+<div style={{ display: 'flex', justifyContent: 'center' }}>
+  <VideoPlayer url='https://www.youtube.com/live/RbRz8_t0FBs?feature=shared' light />
+</div>
infrahub_sdk/repository.py (1)

32-32: LGTM! Good refactor eliminates unnecessary variable.

Directly returning the result improves code conciseness without changing behavior.

infrahub_sdk/timestamp.py (1)

54-54: LGTM! Good refactor eliminates unnecessary variable.

Directly returning the parsed result improves code conciseness without changing behavior.

infrahub_sdk/playback.py (1)

59-59: LGTM! Good refactor eliminates unnecessary variable.

Directly returning the httpx.Response object improves code conciseness without changing behavior.

tests/integration/test_convert_object_type.py (2)

76-81: Consider adding a case for use_default_value

You exercise source_field and data paths. Add one mapping using use_default_value=True to cover the third mutually exclusive option.

83-97: Use the selected client consistently to reduce cross-client mixing

Creation/load steps always use async client. For clarity, consider using client_sync for create/save when client_type is sync so each param set runs fully in its client mode.
tests/unit/ctl/test_render_app.py (1)
90-96: Guard against missing dulwich dependency in tests

monkeypatching dulwich.porcelain.active_branch requires dulwich to be installed. Use importorskip to avoid failures when it’s absent.

Apply this diff:
 def test_render_branch_selection(monkeypatch, httpx_mock: HTTPXMock, cli_branch, env_branch, from_git, expected_branch):
     """Test that the render command uses the correct branch source."""
 
     if from_git:
-        monkeypatch.setattr("dulwich.porcelain.active_branch", lambda _: b"git-branch")
+        pytest.importorskip("dulwich")
+        monkeypatch.setattr("dulwich.porcelain.active_branch", lambda _: b"git-branch")
infrahub_sdk/spec/range_expansion.py (2)
28-56: Preserve brackets on unsupported ranges to avoid silent normalization

When encountering mixed/unsupported tokens (e.g., "1-a"), the function currently appends the raw token without brackets, subtly changing the original pattern. Prefer preserving the original bracketed text to make outcomes explicit.

Apply this diff:
-            else:
-                # Mixed or unsupported range type, append as-is
-                expanded_values.append(value)
+            else:
+                # Mixed or unsupported range type, preserve original bracketed token
+                expanded_values.append(f"[{value}]")
114-118: Micro-optimization: compile regex once

Consider precompiling MATCH_PATTERN at module load to avoid recompiling per call.

Apply this diff:
-MATCH_PATTERN = r"(\[[\w,-]+\])"
+MATCH_PATTERN = r"(\[[\w,-]+\])"
+_RANGE_RE = re.compile(MATCH_PATTERN)
...
-    re_compiled = re.compile(MATCH_PATTERN)
+    re_compiled = _RANGE_RE
tests/unit/sdk/spec/test_object.py (1)

114-148: Range expansion tests are solid; add a couple of edge cases

Consider adding:

Descending ranges (e.g., AMS[5-3]) to ensure reverse order works.

Escaped brackets (e.g., name="AMS[x] [1-2]") to verify literal bracket handling.
infrahub_sdk/client.py (2)
1658-1689: convert_object_type (async): remove deprecated raise_for_error argument

Functionality is correct. To avoid deprecation warnings, drop raise_for_error=True; execute_graphql already raises for HTTP errors by default.

Apply this diff:
         response = await self.execute_graphql(
             query=CONVERT_OBJECT_MUTATION,
             variables={
                 "node_id": node_id,
                 "fields_mapping": mapping_dict,
                 "target_kind": target_kind,
             },
             branch_name=branch_name,
-            raise_for_error=True,
         )
3005-3035: convert_object_type (sync): remove deprecated raise_for_error argument

Same note as async version; drop raise_for_error=True to avoid warnings.

Apply this diff:
         response = self.execute_graphql(
             query=CONVERT_OBJECT_MUTATION,
             variables={
                 "node_id": node_id,
                 "fields_mapping": mapping_dict,
                 "target_kind": target_kind,
             },
             branch_name=branch_name,
-            raise_for_error=True,
         )

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0a1d3eb and cb4c330.

⛔ Files ignored due to path filters (2)

docs/package-lock.json is excluded by !**/package-lock.json
poetry.lock is excluded by !**/*.lock

📒 Files selected for processing (48)

.github/workflows/ci.yml (5 hunks)
.pre-commit-config.yaml (1 hunks)
changelog/+convert-object-type.added.md (1 hunks)
changelog/+escape-hfid.fixed.md (1 hunks)
changelog/464.housekeeping.md (1 hunks)
changelog/473.fixed.md (1 hunks)
changelog/528.housekeeping.md (1 hunks)
changelog/529.added.md (1 hunks)
changelog/535.fixed.md (1 hunks)
changelog/549.fixed.md (1 hunks)
changelog/560.added.md (1 hunks)
docs/docs/python-sdk/introduction.mdx (1 hunks)
docs/docs/python-sdk/topics/object_file.mdx (1 hunks)
docs/docusaurus.config.ts (1 hunks)
docs/package.json (1 hunks)
docs/src/components/VideoPlayer/index.tsx (1 hunks)
infrahub_sdk/branch.py (2 hunks)
infrahub_sdk/client.py (25 hunks)
infrahub_sdk/convert_object_type.py (1 hunks)
infrahub_sdk/ctl/cli_commands.py (1 hunks)
infrahub_sdk/ctl/config.py (2 hunks)
infrahub_sdk/ctl/schema.py (1 hunks)
infrahub_sdk/ctl/utils.py (1 hunks)
infrahub_sdk/ctl/validate.py (2 hunks)
infrahub_sdk/diff.py (2 hunks)
infrahub_sdk/exceptions.py (1 hunks)
infrahub_sdk/graphql.py (2 hunks)
infrahub_sdk/node/attribute.py (1 hunks)
infrahub_sdk/node/node.py (2 hunks)
infrahub_sdk/playback.py (1 hunks)
infrahub_sdk/repository.py (1 hunks)
infrahub_sdk/spec/object.py (6 hunks)
infrahub_sdk/spec/range_expansion.py (1 hunks)
infrahub_sdk/timestamp.py (1 hunks)
pyproject.toml (4 hunks)
tests/constants.py (1 hunks)
tests/fixtures/repos/ctl_integration/.infrahub.yml (1 hunks)
tests/fixtures/repos/ctl_integration/templates/tags.j2 (1 hunks)
tests/fixtures/repos/ctl_integration/templates/tags_query.gql (1 hunks)
tests/integration/test_convert_object_type.py (1 hunks)
tests/unit/ctl/test_render_app.py (1 hunks)
tests/unit/sdk/conftest.py (1 hunks)
tests/unit/sdk/spec/test_object.py (2 hunks)
tests/unit/sdk/test_diff_summary.py (3 hunks)
tests/unit/sdk/test_node.py (1 hunks)
tests/unit/sdk/test_range_expansion.py (1 hunks)
tests/unit/sdk/test_schema.py (1 hunks)
tests/unit/sdk/test_utils.py (2 hunks)

🧰 Additional context used

📓 Path-based instructions (7)

**/*.py