docs: Polarion and ReqIF export fidelity analysis#169
Merged
Conversation
Field-by-field analysis of rivet's Artifact model against Polarion REST and ReqIF 1.2, with round-trip test strategy and ranked next steps. Highlights ReqIF Debug-form coercion bug for non-string fields and the unconditional loss of provenance on export. Refs: REQ-025, FEAT-001
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
⚠️ Performance Alert ⚠️
Possible performance regression was detected for benchmark 'Rivet Criterion Benchmarks'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.
| Benchmark suite | Current: 49bc395 | Previous: 60d728a | Ratio |
|---|---|---|---|
store_lookup/1000 |
25089 ns/iter (± 63) |
19280 ns/iter (± 48) |
1.30 |
diff/1000 |
716559 ns/iter (± 7087) |
584274 ns/iter (± 2706) |
1.23 |
query/100 |
751 ns/iter (± 3) |
619 ns/iter (± 1) |
1.21 |
query/1000 |
6705 ns/iter (± 38) |
5174 ns/iter (± 14) |
1.30 |
This comment was automatically generated by workflow using github-action-benchmark.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Artifactmodel vs Polarion REST API and ReqIF 1.2.provenanceunconditionally and corrupts non-stringfieldsvalues through RustDebugcoercion.Key findings
rivet-core/src/reqif.rs:968-970writesformat!("{other:?}")for any non-string value infields— silent corruption, not just LOSSY.provenancefield is never emitted by the ReqIF adapter (all export sites setprovenance: None).tagsare joined with,on export and split on,on import with no escaping — any tag containing a comma breaks round-trip.rivet-core/tests/fidelity_*.rsexists today.Recommendation
Support both paths but document the delta. Path 1 (direct Polarion REST) is the audit-grade option once implemented; Path 2 (ReqIF) remains the tool-agnostic interop option (DOORS, Jama, Cameo, StrictDoc). Going rivet → ReqIF → Polarion-import is weird specifically because it runs a file-interchange standard through a proprietary importer when a direct API is one HTTP hop away.
Test plan
reqif.rs:968-970andreqif.rs:953-958reproducefidelity_reqif.rs(feat: AADL integration — schema, adapter, WASM rendering, architecture dogfood #3)Refs: REQ-025, FEAT-001