Refactoring in api.rs #830
Merged
Conversation
This file contains 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
khieta
commented
May 2, 2024
Comment on lines
+130
to
+134
| /// Construct an [`EntityTypeName`] from the internal type. | ||
| /// This function is only intended to be used internally. | ||
| pub(crate) fn new(ty: ast::Name) -> Self { | ||
| Self(ty) | ||
| } |
There was a problem hiding this comment.
New function added by this PR
cedar-policy/src/api/id.rs
Outdated
Comment on lines
210
to
226
| /// Construct an [`EntityUid`] from the internal type. | ||
| /// This function is only intended to be used internally. | ||
| pub(crate) fn new(uid: ast::EntityUID) -> Self { | ||
| Self(uid) | ||
| } | ||
|
|
||
| /// Deconstruct an [`EntityUid`] to get the internal type. | ||
| /// This function is only intended to be used internally. | ||
| pub(crate) fn into_inner(self) -> ast::EntityUID { | ||
| self.0 | ||
| } | ||
|
|
||
| /// Deconstruct an [`EntityUid`] to get the internal type. | ||
| /// This function is only intended to be used internally. | ||
| pub(crate) fn as_inner(&self) -> &ast::EntityUID { | ||
| &self.0 | ||
| } |
There was a problem hiding this comment.
New functions added by this PR
cedar-policy/src/api/id.rs
Outdated
Comment on lines
252
to
267
| /// Construct a [`PolicyId`] from a source string | ||
| pub fn new(id: impl AsRef<str>) -> Self { | ||
| Self(ast::PolicyID::from_string(id.as_ref())) | ||
| } | ||
|
|
||
| /// Deconstruct an [`PolicyId`] to get the internal type. | ||
| /// This function is only intended to be used internally. | ||
| pub(crate) fn into_inner(self) -> ast::PolicyID { | ||
| self.0 | ||
| } | ||
|
|
||
| /// Deconstruct an [`PolicyId`] to get the internal type. | ||
| /// This function is only intended to be used internally. | ||
| pub(crate) fn as_inner(&self) -> &ast::PolicyID { | ||
| &self.0 | ||
| } |
There was a problem hiding this comment.
New functions added by this PR
Comment on lines
+2843
to
+2848
| /// Deconstruct an [`Expression`] to get the internal type. | ||
| /// This function is only intended to be used internally. | ||
| #[cfg(test)] | ||
| pub(crate) fn into_inner(self) -> ast::Expr { | ||
| self.0 | ||
| } |
There was a problem hiding this comment.
New function added by this PR
Comment on lines
+2938
to
+2943
| /// Deconstruct an [`RestrictedExpression`] to get the internal type. | ||
| /// This function is only intended to be used internally. | ||
| #[cfg(test)] | ||
| pub(crate) fn into_inner(self) -> ast::RestrictedExpr { | ||
| self.0 | ||
| } |
There was a problem hiding this comment.
New function added by this PR
|
Marking this as ready for review now that (most of) the CI has passed. I don't think the Java failures are the fault of this PR -- I think we just need to review & merge cedar-java#133. Will re-run CI once that PR is merged. |
cdisselkoen
approved these changes
May 2, 2024
john-h-kastner-aws
approved these changes
May 2, 2024
|
Latest updates:
The only potentially contentious change is this last one. Because |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of changes
This PR performs some refactoring to reduce the size of our api.rs file. For the most part, the changes are just copy-and-paste, but I did need to add some new
pub(crate)functions to handle the new layer of indirection. I’ll add review comments to any new functions added.EntityUidandPolicyIdto a separate api/id.rs file.The new files are included in api.rs using:
I believe this leaves the API unchanged from a user's perspective. Lmk if I'm wrong about that.
The changes in this PR introduce two new clippy warnings:
PolicyIdandEntityIdsince these types end with "id" (the name of the containing module). I think we can safely ignore these because the types arepub used in api.rs, so users should writecedar_policy::PolicyIdinstead ofcedar_policy::id::PolicyId.fold_partitionfunction. The reason I made itpub(crate)instead of private is that it's also used in testing code. I think it is still effectively private with the current setting.Issue #, if available
Checklist for requesting a review
The change in this PR is (choose one, and delete the other options):
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):