Implement `ignore_overwritten_missing_references` kapicorp-reclass config option by simu · Pull Request #185 · projectsyn/reclass-rs

simu · 2025-09-25T14:09:45Z

This PR changes reclass-rs to allow missing overwritten references in scalar target values by default to match kapicorp-reclass behavior.

Additionally, this PR implements the kapicorp-reclass config option ignore_overwritten_missing_reference which allows users to tune the behavior (and restore the previous reclass-rs behavior of aborting on missing references in scalar target values).

Fixes #184

TODO

Implement config option to tune this behavior
Add test cases for this behavior -- simple case works, but I'd like to test some more complex scenarios
Decide whether to default to stay compatible with kapicorp-reclass or whether to default to making missing overwritten references an error.
Check if we can have a mode where we collect all render errors and return them at the end
Update README

Checklist

The PR has a meaningful title. The title will be used to auto generate the changelog
PR contains a single logical change (to build a better changelog).
Update the documentation.
Update tests.
Categorize the PR by setting a good title and adding one of the labels:
bug, enhancement, documentation, change, breaking, dependency, internal
as they show up in the changelog
Link this PR to related PRs or issues.

…e()` This addresses the `clippy::implicit_clone` lint.

The helper returns true for all Value variants other than Mapping, Sequence and ValueList.

We default the option to `true` to retain the kapicorp-reclass default behavior. In contrast to kapicorp-reclass, we can't currently collect all resolution errors but instead hard-fail on the first non-ignored error we encounter. Technically this is a breaking change for existing reclass-rs inventories. The implementation introduces a new Value variant `ResolveError` which is used by the Value implementation to decide which resolve errors are always errors and which can be downgraded to warnings when Reclass option `ignore_overwritten_missing_references` is set to `true`. Fixes #184

github-actions · 2025-11-24T19:04:43Z

Benchmark for `d6be1b2` (Without new node in inventory)

Click to view benchmark

Test	Base	PR	%
Reclass::inventory() multi-threaded	1450.1±39.78µs	1463.9±113.91µs	+0.95%
Reclass::inventory() single-threaded	2.6±0.04ms	2.6±0.12ms	0.00%

simu · 2025-11-25T12:42:23Z

Performance overhead for a real Commodore inventory (APPUiO Lab) is negligible:

# kapitan inventory --inventory-backend=reclass-rs --inventory-path /path/to/inventory -v >/dev/null
[ ... snipped ... ]
Inventory rendering with reclass-rs took 0:00:03.214301
[ ... snipped ... ]
# ./inv.py /path/to/inventory > /dev/null
inventory took 0:00:03.216774
[ ... snipped ... ]

simu · 2025-11-25T12:45:28Z

Check if we can have a mode where we collect all render errors and return them at the end

We could do this, but we'd need to refactor a bunch of state tracking to make it actually work properly, so we leave it for now.

simu · 2025-11-25T12:46:43Z

PyO3 deprecation warnings are addressed in #191

github-actions · 2025-11-25T13:10:35Z

Benchmark for `514013a` (With new node in bench inventory)

Same implementation as benchmark results in #185 (comment) but with a new inventory node n26 which has a bunch of overwritten missing references in the classes it includes.

Click to view benchmark

Test	Base	PR	%
Reclass::inventory() multi-threaded	1740.0±136.85µs	2.3±0.19ms	+32.18%
Reclass::inventory() single-threaded	3.6±0.10ms	4.6±0.04ms	+27.78%

…ing override mapping keys We also add some diagnostic error messages when dropping unrendered mapping values.

…tests

Users can opt in to those warnings by setting `verbose_warnings: true` in their inventory's `reclass-config.yml`.

github-actions · 2025-11-25T15:58:54Z

Benchmark for `38f7e84`

Click to view benchmark

Test	Base	PR	%
Reclass::inventory() multi-threaded	1726.5±135.52µs	2.3±0.18ms	+33.22%
Reclass::inventory() single-threaded	3.5±0.03ms	4.5±0.05ms	+28.57%

simu · 2025-11-25T16:00:55Z

macOS 13 EOL handled in #193

simu added the enhancement New feature or request label Sep 25, 2025

This comment was marked as outdated.

Sign in to view

simu force-pushed the feat/ignore-missing-overwritten-references branch from 7a70f9a to aae4c56 Compare October 3, 2025 09:06

This comment was marked as outdated.

Sign in to view

simu changed the title ~~Add support for allowing missing overwritten references in scalar target values~~ Add support for ignore_overwritten_missing_references kapicorp-reclass config option Oct 3, 2025

simu changed the title ~~Add support for ignore_overwritten_missing_references kapicorp-reclass config option~~ Implement ignore_overwritten_missing_references kapicorp-reclass config option Oct 3, 2025

simu force-pushed the feat/ignore-missing-overwritten-references branch from aae4c56 to a4819e4 Compare November 24, 2025 18:55

simu added 4 commits November 24, 2025 19:57

Convert to_string() calls which clone the value into explicit `clon…

e463fe8

…e()` This addresses the `clippy::implicit_clone` lint.

Add Value::is_scalar() helper

70b8820

The helper returns true for all Value variants other than Mapping, Sequence and ValueList.

Add support for passing render options to merging and interpolation

c10e016

This comment was marked as outdated.

Sign in to view

simu force-pushed the feat/ignore-missing-overwritten-references branch from a4819e4 to 0c7b42c Compare November 24, 2025 19:02

simu force-pushed the feat/ignore-missing-overwritten-references branch 2 times, most recently from 6427844 to 6cc3baa Compare November 24, 2025 19:08

This comment was marked as outdated.

Sign in to view

simu marked this pull request as ready for review November 25, 2025 12:45

simu requested a review from a team November 25, 2025 12:46

simu force-pushed the feat/ignore-missing-overwritten-references branch from 686fd2d to ded03b2 Compare November 25, 2025 12:48

This comment was marked as outdated.

Sign in to view

simu force-pushed the feat/ignore-missing-overwritten-references branch from ded03b2 to 974108a Compare November 25, 2025 13:04

This comment was marked as outdated.

Sign in to view

bastjan approved these changes Nov 25, 2025

View reviewed changes

simu added 6 commits November 25, 2025 16:55

Cover ignore_overwritten_missing_references option in tests

67f973b

Update README

f1f2c7f

Correctly handle ignore_overwritten_missing_references when process…

f9f3885

…ing override mapping keys We also add some diagnostic error messages when dropping unrendered mapping values.

Cover missing reference in lists that get overridden with ~list in …

1db67c7

…tests

Disable warnings when dropping potentially unrendered values by default

e967ac6

Users can opt in to those warnings by setting `verbose_warnings: true` in their inventory's `reclass-config.yml`.

Address clippy lints for Path variable printing

de64609

simu force-pushed the feat/ignore-missing-overwritten-references branch from 5e7bb80 to de64609 Compare November 25, 2025 15:56

simu merged commit 01a46e3 into main Nov 25, 2025
21 of 22 checks passed

simu deleted the feat/ignore-missing-overwritten-references branch November 25, 2025 16:03

Conversation

simu commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TODO

Checklist

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

github-actions Bot commented Nov 24, 2025 • edited by simu Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchmark for d6be1b2 (Without new node in inventory)

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

simu commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

simu commented Nov 25, 2025

Uh oh!

simu commented Nov 25, 2025

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

github-actions Bot commented Nov 25, 2025 • edited by simu Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchmark for 514013a (With new node in bench inventory)

Uh oh!

github-actions Bot commented Nov 25, 2025

Benchmark for 38f7e84

Uh oh!

simu commented Nov 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

simu commented Sep 25, 2025 •

edited

Loading

github-actions Bot commented Nov 24, 2025 •

edited by simu

Loading

Benchmark for `d6be1b2` (Without new node in inventory)

simu commented Nov 25, 2025 •

edited

Loading

github-actions Bot commented Nov 25, 2025 •

edited by simu

Loading

Benchmark for `514013a` (With new node in bench inventory)

Benchmark for `38f7e84`