Add source info to Name and EntityUID

Signed-off-by: John Kastner <[email protected]>

Author: john-h-kastner-aws

cedar-policy-core/src/ast/entity.rs

@@ -18,6 +18,7 @@ use crate::ast::*;
 use crate::evaluator::{EvaluationError, RestrictedEvaluator};
 use crate::extensions::Extensions;
 use crate::parser::err::ParseErrors;
+use crate::parser::Loc;
 use crate::transitive_closure::TCNode;
 use crate::FromNormalizedStr;
 use itertools::Itertools;
@@ -62,13 +63,44 @@ impl std::fmt::Display for EntityType {
 }
 
 /// Unique ID for an entity. These represent entities in the AST.
-#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone, Hash, PartialOrd, Ord)]
+#[derive(Serialize, Deserialize, Debug, Clone)]
 #[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
 pub struct EntityUID {
     /// Typename of the entity
     ty: EntityType,
     /// EID of the entity
     eid: Eid,
+    /// Location of the entity in policy source
+    #[serde(skip)]
+    loc: Option<Loc>,
+}
+
+/// `PartialEq` implementation ignores the `loc`.
+impl PartialEq for EntityUID {
+    fn eq(&self, other: &Self) -> bool {
+        self.ty == other.ty && self.eid == other.eid
+    }
+}
+impl Eq for EntityUID {}
+
+impl std::hash::Hash for EntityUID {
+    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
+        // hash the ty and eid, in line with the `PartialEq` impl which compares
+        // the ty and eid.
+        self.ty.hash(state);
+        self.eid.hash(state);
+    }
+}
+
+impl PartialOrd for EntityUID {
+    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
+        Some(self.cmp(other))
+    }
+}
+impl Ord for EntityUID {
+    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
+        self.ty.cmp(&other.ty).then(self.eid.cmp(&other.eid))
+    }
 }
 
 impl StaticallyTyped for EntityUID {
@@ -87,6 +119,7 @@ impl EntityUID {
         Self {
             ty: Self::test_entity_type(),
             eid: Eid(eid.into()),
+            loc: None,
         }
     }
     // by default, Coverlay does not track coverage for lines after a line
@@ -113,6 +146,7 @@ impl EntityUID {
         Ok(Self {
             ty: EntityType::Specified(Name::parse_unqualified_name(typename)?),
             eid: Eid(eid.into()),
+            loc: None,
         })
     }
 
@@ -122,11 +156,17 @@ impl EntityUID {
         (self.ty, self.eid)
     }
 
+    /// Get the source location for this `EntityUID`.
+    pub fn loc(&self) -> &Option<Loc> {
+        &self.loc
+    }
+
     /// Create a nominally-typed `EntityUID` with the given typename and EID
-    pub fn from_components(name: Name, eid: Eid) -> Self {
+    pub fn from_components(name: Name, eid: Eid, loc: Option<Loc>) -> Self {
         Self {
             ty: EntityType::Specified(name),
             eid,
+            loc,
         }
     }
 
@@ -135,6 +175,7 @@ impl EntityUID {
         Self {
             ty: EntityType::Unspecified,
             eid,
+            loc: None,
         }
     }
 
@@ -497,12 +538,14 @@ mod test {
         let e2 = EntityUID::from_components(
             Name::parse_unqualified_name("test_entity_type").expect("should be a valid identifier"),
             Eid("foo".into()),
+            None,
         );
         let e3 = EntityUID::unspecified_from_eid(Eid("foo".into()));
         let e4 = EntityUID::unspecified_from_eid(Eid("bar".into()));
         let e5 = EntityUID::from_components(
             Name::parse_unqualified_name("Unspecified").expect("should be a valid identifier"),
             Eid("foo".into()),
+            None,
         );
 
         // an EUID is equal to itself

cedar-policy-core/src/ast/name.rs

@@ -29,13 +29,43 @@ use super::PrincipalOrResource;
 /// This is the `Name` type used to name types, functions, etc.
 /// The name can include namespaces.
 /// Clone is O(1).
-#[derive(Debug, PartialEq, Eq, Clone, Hash, PartialOrd, Ord)]
+#[derive(Debug, Clone)]
 #[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
 pub struct Name {
     /// Basename
     pub(crate) id: Id,
     /// Namespaces
     pub(crate) path: Arc<Vec<Id>>,
+    /// Location of the name in source
+    pub(crate) loc: Option<Loc>,
+}
+
+/// `PartialEq` implementation ignores the `loc`.
+impl PartialEq for Name {
+    fn eq(&self, other: &Self) -> bool {
+        self.id == other.id && self.path == other.path
+    }
+}
+impl Eq for Name {}
+
+impl std::hash::Hash for Name {
+    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
+        // hash the ty and eid, in line with the `PartialEq` impl which compares
+        // the ty and eid.
+        self.id.hash(state);
+        self.path.hash(state);
+    }
+}
+
+impl PartialOrd for Name {
+    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
+        Some(self.cmp(other))
+    }
+}
+impl Ord for Name {
+    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
+        self.id.cmp(&other.id).then(self.path.cmp(&other.path))
+    }
 }
 
 /// A shortcut for `Name::unqualified_name`
@@ -61,10 +91,11 @@ impl TryFrom<Name> for Id {
 
 impl Name {
     /// A full constructor for `Name`
-    pub fn new(basename: Id, path: impl IntoIterator<Item = Id>) -> Self {
+    pub fn new(basename: Id, path: impl IntoIterator<Item = Id>, loc: Option<Loc>) -> Self {
         Self {
             id: basename,
             path: Arc::new(path.into_iter().collect()),
+            loc,
         }
     }
 
@@ -73,6 +104,7 @@ impl Name {
         Self {
             id,
             path: Arc::new(vec![]),
+            loc: None,
         }
     }
 
@@ -82,15 +114,21 @@ impl Name {
         Ok(Self {
             id: s.parse()?,
             path: Arc::new(vec![]),
+            loc: None,
         })
     }
 
     /// Given a type basename and a namespace (as a `Name` itself),
     /// return a `Name` representing the type's fully qualified name
-    pub fn type_in_namespace(basename: Id, namespace: Name) -> Name {
+    pub fn type_in_namespace(basename: Id, namespace: Name, loc: Option<Loc>) -> Name {
         let mut path = Arc::unwrap_or_clone(namespace.path);
         path.push(namespace.id);
-        Name::new(basename, path)
+        Name::new(basename, path, loc)
+    }
+
+    /// Get the source location
+    pub fn loc(&self) -> &Option<Loc> {
+        &self.loc
     }
 
     /// Get the basename of the `Name` (ie, with namespaces stripped).
@@ -129,6 +167,7 @@ impl Name {
                         .namespace_components()
                         .chain(std::iter::once(namespace.basename()))
                         .cloned(),
+                    self.loc.clone(),
                 ),
                 None => self.clone(),
             }

cedar-policy-core/src/ast/policy.rs

@@ -2099,6 +2099,7 @@ mod test {
         let id = EntityUID::from_components(
             name::Name::unqualified_name(id::Id::new_unchecked("s")),
             entity::Eid::new("eid"),
+            None,
         );
         let mut i = EntityIterator::One(&id);
         assert_eq!(i.next(), Some(&id));
@@ -2110,10 +2111,12 @@ mod test {
         let id1 = EntityUID::from_components(
             name::Name::unqualified_name(id::Id::new_unchecked("s")),
             entity::Eid::new("eid1"),
+            None,
         );
         let id2 = EntityUID::from_components(
             name::Name::unqualified_name(id::Id::new_unchecked("s")),
             entity::Eid::new("eid2"),
+            None,
         );
         let v = vec![&id1, &id2];
         let mut i = EntityIterator::Bunch(v);

cedar-policy-core/src/entities/json/value.rs

@@ -198,6 +198,7 @@ impl TryFrom<TypeAndId> for EntityUID {
         Ok(EntityUID::from_components(
             Name::from_normalized_str(&e.entity_type)?,
             Eid::new(e.id),
+            None,
         ))
     }
 }

cedar-policy-core/src/est/expr.rs

@@ -1108,6 +1108,7 @@ fn interpret_primary(
                             __entity: TypeAndId::from(ast::EntityUID::from_components(
                                 name,
                                 ast::Eid::new(eid),
+                                None,
                             )),
                         }))),
                         Err(unescape_errs) => {
@@ -1143,6 +1144,7 @@ fn interpret_primary(
                                 .and_then(|id| id.to_string().parse().map_err(Into::into))
                         })
                         .collect::<Result<Vec<ast::Id>, ParseErrors>>()?,
+                    Some(node.loc.clone()),
                 ))),
                 (path, id) => {
                     let (l, r, src) = match (path.first(), path.last()) {

cedar-policy-core/src/parser/cst_to_ast.rs

@@ -2122,7 +2122,9 @@ impl Node<Option<cst::Name>> {
 
         // computation and error generation is complete, so fail or construct
         match (maybe_name, path.len()) {
-            (Some(r), len) if len == name.path.len() => Some(construct_name(path, r)),
+            (Some(r), len) if len == name.path.len() => {
+                Some(construct_name(path, r, self.loc.clone()))
+            }
             _ => None,
         }
     }
@@ -2231,7 +2233,7 @@ impl Node<Option<cst::Ref>> {
                 };
 
                 match (maybe_path, maybe_eid) {
-                    (Some(p), Some(e)) => Some(construct_refr(p, e)),
+                    (Some(p), Some(e)) => Some(construct_refr(p, e, self.loc.clone())),
                     _ => None,
                 }
             }
@@ -2346,15 +2348,16 @@ fn construct_string_from_var(v: ast::Var) -> SmolStr {
         ast::Var::Context => "context".into(),
     }
 }
-fn construct_name(path: Vec<ast::Id>, id: ast::Id) -> ast::Name {
+fn construct_name(path: Vec<ast::Id>, id: ast::Id, loc: Loc) -> ast::Name {
     ast::Name {
         id,
         path: Arc::new(path),
+        loc: Some(loc),
     }
 }
-fn construct_refr(p: ast::Name, n: SmolStr) -> ast::EntityUID {
+fn construct_refr(p: ast::Name, n: SmolStr, loc: Loc) -> ast::EntityUID {
     let eid = ast::Eid::new(n);
-    ast::EntityUID::from_components(p, eid)
+    ast::EntityUID::from_components(p, eid, Some(loc))
 }
 fn construct_expr_ref(r: ast::EntityUID, loc: Loc) -> ast::Expr {
     ast::ExprBuilder::new().with_source_loc(loc).val(r)

cedar-policy-validator/Cargo.toml

@@ -47,6 +47,7 @@ wasm = ["serde-wasm-bindgen", "tsify", "wasm-bindgen"]
 
 [dev-dependencies]
 cool_asserts = "2.0"
+cedar-policy-core = { version = "=4.0.0", path = "../cedar-policy-core", features = ["test-util"] }
 
 [build-dependencies]
 lalrpop = "0.20.0"

cedar-policy-validator/src/human_schema/ast.rs

@@ -113,7 +113,11 @@ impl std::fmt::Display for Path {
 
 impl From<Path> for Name {
     fn from(value: Path) -> Self {
-        value.0.node.into()
+        Self::new(
+            value.0.node.basename,
+            value.0.node.namespace,
+            Some(value.0.loc),
+        )
     }
 }
 
@@ -123,12 +127,6 @@ struct PathInternal {
     namespace: Vec<Id>,
 }
 
-impl From<PathInternal> for Name {
-    fn from(value: PathInternal) -> Self {
-        Self::new(value.basename, value.namespace)
-    }
-}
-
 impl PathInternal {
     fn iter(&self) -> impl Iterator<Item = &Id> {
         self.namespace.iter().chain(once(&self.basename))

cedar-policy-validator/src/human_schema/to_json_schema.rs

@@ -434,6 +434,7 @@ impl<'a> ConversionContext<'a> {
                 &Some(Name::new(
                     prefix_base.clone(),
                     prefix_prefix.into_iter().cloned(),
+                    None,
                 )),
             ),
             None =>