This PR implements RFC #74 behind a new feature flag "entity-manifest".
It adds:
A new public function compute_entity_manifest (with experimental warning)
New structsEntityManifest, RootAccessTrie, AccessTrie, EntitySliceError. (with experimental warning)
JSON serialization for the entity manifest, along with tests that use it.
Note that there's a TODO in the compute_entity_manifest function about returning type errors.
Follow up PRs
1105 adds an entity slicing function that produces an Entities store from an existing Entities store. This enables strong corpus testing.
Generalization to all of Cedar
Type annotated entity manifests
Support for a SimpleEntityLoader as described in the RFC.
Support for an easy to use flattened format for the entity manifest, and a human-readable format.
Checklist for requesting a review
The change in this PR is (choose one, and delete the other options):
[ ] A breaking change requiring a major version bump to cedar-policy (e.g., changes to the signature of an existing API).
[x] A backwards-compatible change requiring a minor version bump to cedar-policy (e.g., addition of a new API).
[ ] A bug fix or other functionality change requiring a patch to cedar-policy.
[ ] A change "invisible" to users (e.g., documentation, changes to "internal" crates like cedar-policy-core, cedar-validator, etc.)
[x] A change (breaking or otherwise) that only impacts unreleased or experimental code.
I confirm that this PR (choose one, and delete the other options):
[x] Updates the "Unreleased" section of the CHANGELOG with a description of my change (required for major/minor version bumps).
[ ] Does not update the CHANGELOG because my change does not significantly impact released code.
I confirm that cedar-spec (choose one, and delete the other options):
[ ] Does not require updates because my change does not impact the Cedar formal model or DRT infrastructure.
[ ] Requires updates, and I have made / will make these updates myself. (Please include in your description a timeline or link to the relevant PR in cedar-spec, and how you have tested that your updates are correct.)
[x] Requires updates, but I do not plan to make them in the near future. (Make sure that your changes are hidden behind a feature flag to mark them as experimental.)
[ ] I'm not sure how my change impacts cedar-spec. (Post your PR anyways, and we'll discuss in the comments.)
Description of changes
This PR implements RFC #74 behind a new feature flag "entity-manifest". It adds:
compute_entity_manifest(with experimental warning)EntityManifest, RootAccessTrie, AccessTrie, EntitySliceError. (with experimental warning)Note that there's a TODO in the
compute_entity_manifestfunction about returning type errors.Follow up PRs
1105 adds an entity slicing function that produces an
Entitiesstore from an existingEntitiesstore. This enables strong corpus testing.Checklist for requesting a review
The change in this PR is (choose one, and delete the other options):
cedar-policy(e.g., changes to the signature of an existing API).cedar-policy(e.g., addition of a new API).cedar-policy.cedar-policy-core,cedar-validator, etc.)I confirm that this PR (choose one, and delete the other options):
I confirm that
cedar-spec(choose one, and delete the other options):cedar-spec, and how you have tested that your updates are correct.)cedar-spec. (Post your PR anyways, and we'll discuss in the comments.)