Improving error messages

cedar-policy · Oct 12, 2023 · 39495e9 · 39495e9
1 parent 85dfca8
commit 39495e9
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/cedar-policy-core/src/entities.rs b/cedar-policy-core/src/entities.rs
@@ -1047,7 +1047,7 @@ mod json_parsing_tests {
             EntityJsonParser::new(None, Extensions::all_available(), TCComputation::ComputeNow);
         let error = eparser.from_json_value(json).err().unwrap().to_string();
         assert!(
-            error.contains("in uid field of <unknown entity>, expected a literal entity reference"),
+            error.contains("in uid field of <unknown entity>, invalid escape. The `__expr` escape is no longer supported"),
             "{}",
             error
         );
@@ -1080,7 +1080,7 @@ mod json_parsing_tests {
             EntityJsonParser::new(None, Extensions::all_available(), TCComputation::ComputeNow);
         let error = eparser.from_json_value(json).err().unwrap().to_string();
         assert!(
-            error.contains("`__expr` tag is no longer supported"),
+            error.contains("`__expr` escape is no longer supported"),
             "Actual error message was: {}",
             error
         );
@@ -1102,7 +1102,7 @@ mod json_parsing_tests {
                 "a b c": { "__extn": { "fn": "ip", "arg": "222.222.222.0/24" } }
             },
             "parents": [
-                { "__expr": { "type" : "test_entity_type", "id" : "bob"} },
+                { "__expr": "test_entity_type::\"Alice\"" },
                 { "__entity": { "type": "test_entity_type", "id": "catherine" } }
             ]
         }
@@ -1111,7 +1111,7 @@ mod json_parsing_tests {
             EntityJsonParser::new(None, Extensions::all_available(), TCComputation::ComputeNow);
         let error = eparser.from_json_value(json).err().unwrap().to_string();
         assert!(
-            error.contains(r#"in parents field of `test_entity_type::"Alice"`, expected a literal entity reference"#),
+            error.contains(r#"in parents field of `test_entity_type::"Alice"`, invalid escape. The `__expr` escape is no longer supported"#),
             "Actual error message was: {}",
             error
         );

diff --git a/cedar-policy-core/src/entities/json/jsonvalue.rs b/cedar-policy-core/src/entities/json/jsonvalue.rs
@@ -511,6 +511,12 @@ impl<'e> ValueParser<'e> {
 #[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
 #[serde(untagged)]
 pub enum EntityUidJSON {
+    /// Explicit `__expr` syntax.
+    /// This is no longer supported deprecated and is only here for generating nice error messages.
+    ExplicitExprEscape {
+        /// Contents are ignored.
+        __expr: String,
+    },
     /// Explicit `__entity` escape; see notes on JSONValue::EntityEscape
     ExplicitEntityEscape {
         /// JSON object containing the entity type and ID
@@ -578,6 +584,9 @@ impl EntityUidJSON {
                 ctx: Box::new(ctx()),
                 got: Box::new(Either::Left(v)),
             }),
+            Self::ExplicitExprEscape { __expr } => {
+                Err(JsonDeserializationError::ExprTag(Box::new(ctx())))
+            }
         }
     }
 }