Throw proper exception when TypeNameMatch expression is missing (#176)

microsoft · Mar 14, 2022 · 6dc66d7 · 6dc66d7
1 parent bc2468a
commit 6dc66d7
Show file tree

Hide file tree

Showing 8 changed files with 75 additions and 8 deletions.
diff --git a/src/lib/Microsoft.Health.Fhir.Ingest.Template/IotJsonPathContentTemplateFactory.cs b/src/lib/Microsoft.Health.Fhir.Ingest.Template/IotJsonPathContentTemplateFactory.cs
@@ -4,7 +4,6 @@
 // -------------------------------------------------------------------------------------------------
 
 using EnsureThat;
-using Microsoft.Health.Fhir.Ingest.Template;
 using Newtonsoft.Json.Linq;
 
 namespace Microsoft.Health.Fhir.Ingest.Template

diff --git a/src/lib/Microsoft.Health.Fhir.Ingest.Template/IotJsonPathLegacyMeasurementExtractor.cs b/src/lib/Microsoft.Health.Fhir.Ingest.Template/IotJsonPathLegacyMeasurementExtractor.cs
@@ -11,7 +11,7 @@ namespace Microsoft.Health.Fhir.Ingest.Template
 {
     public class IotJsonPathLegacyMeasurementExtractor : LegacyMeasurementExtractor
     {
-        private IotJsonPathContentTemplate _template;
+        private readonly IotJsonPathContentTemplate _template;
 
         public IotJsonPathLegacyMeasurementExtractor(
             IotJsonPathContentTemplate template)

diff --git a/src/lib/Microsoft.Health.Fhir.Ingest.Template/JsonPathExpressionEvaluatorFactory.cs b/src/lib/Microsoft.Health.Fhir.Ingest.Template/JsonPathExpressionEvaluatorFactory.cs
@@ -14,7 +14,7 @@ public class JsonPathExpressionEvaluatorFactory : IExpressionEvaluatorFactory
     {
         public IExpressionEvaluator Create(TemplateExpression expression)
         {
-            EnsureArg.IsNotEmptyOrWhiteSpace(expression?.Value, nameof(expression.Value));
+            EnsureArg.IsNotNullOrWhiteSpace(expression?.Value, nameof(expression.Value));
 
             var expressionLanguage = expression.Language ?? TemplateExpressionLanguage.JsonPath;
             if (expressionLanguage != TemplateExpressionLanguage.JsonPath)

diff --git a/src/lib/Microsoft.Health.Fhir.Ingest.Template/LegacyMeasurementExtractor.cs b/src/lib/Microsoft.Health.Fhir.Ingest.Template/LegacyMeasurementExtractor.cs
@@ -27,7 +27,7 @@ public LegacyMeasurementExtractor(
         protected override IEnumerable<JToken> MatchTypeTokens(JObject token)
         {
             EnsureArg.IsNotNull(token, nameof(token));
-            var evaluator = ExpressionEvaluatorFactory.Create(Template.TypeMatchExpression);
+            var evaluator = CreateRequiredExpressionEvaluator(Template.TypeMatchExpression, nameof(Template.TypeMatchExpression));
 
             return evaluator.SelectTokens(token);
         }

diff --git a/src/lib/Microsoft.Health.Fhir.Ingest.Template/MeasurementExtractor.cs b/src/lib/Microsoft.Health.Fhir.Ingest.Template/MeasurementExtractor.cs
@@ -121,7 +121,7 @@ protected static bool IsExpressionDefined(params TemplateExpression[] expression
         protected virtual IEnumerable<JToken> MatchTypeTokens(JObject token)
         {
             EnsureArg.IsNotNull(token, nameof(token));
-            var evaluator = ExpressionEvaluatorFactory.Create(Template.TypeMatchExpression);
+            var evaluator = CreateRequiredExpressionEvaluator(Template.TypeMatchExpression, nameof(Template.TypeMatchExpression));
 
             foreach (var extractedToken in evaluator.SelectTokens(token))
             {
@@ -134,6 +134,19 @@ protected virtual IEnumerable<JToken> MatchTypeTokens(JObject token)
             }
         }
 
+        protected IExpressionEvaluator CreateRequiredExpressionEvaluator(TemplateExpression expression, string expressionName)
+        {
+            EnsureArg.IsNotNullOrWhiteSpace(expressionName, nameof(expressionName));
+
+            // If the expression object or its value aren't set, throw a detailed exception
+            if (string.IsNullOrWhiteSpace(expression?.Value))
+            {
+                throw new IncompatibleDataException($"An expression must be set for [{expressionName}]");
+            }
+
+            return ExpressionEvaluatorFactory.Create(Template.TypeMatchExpression);
+        }
+
         private Measurement CreateMeasurementFromToken(JToken token)
         {
             // Current assumption is that the expressions should match a single element and will error otherwise.

diff --git a/src/lib/Microsoft.Health.Fhir.Ingest.Template/TemplateExpressionEvaluatorFactory.cs b/src/lib/Microsoft.Health.Fhir.Ingest.Template/TemplateExpressionEvaluatorFactory.cs
@@ -24,7 +24,7 @@ public TemplateExpressionEvaluatorFactory(JmesPath jmesPath)
 
         public IExpressionEvaluator Create(TemplateExpression expression)
         {
-            EnsureArg.IsNotEmptyOrWhiteSpace(expression?.Value, nameof(expression.Value));
+            EnsureArg.IsNotNullOrWhiteSpace(expression?.Value, nameof(expression.Value));
             EnsureArg.IsNotNull(expression?.Language, nameof(expression.Language));
 
             return expression.Language switch

diff --git a/test/Microsoft.Health.Fhir.Ingest.Template.UnitTests/IotJsonPathContentTemplateTests.cs b/test/Microsoft.Health.Fhir.Ingest.Template.UnitTests/IotJsonPathContentTemplateTests.cs
@@ -5,7 +5,6 @@
 
 using System.Collections.Generic;
 using System.Linq;
-using Microsoft.Health.Fhir.Ingest.Template;
 using Microsoft.Health.Tests.Common;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
@@ -36,6 +35,16 @@ public class IotJsonPathContentTemplateTests
             },
         });
 
+        private static readonly IContentTemplate SingleValueMissingTypeNameTemplate = BuildMeasurementExtractor(new IotJsonPathContentTemplate
+        {
+            TypeName = "heartrate",
+            TypeMatchExpression = "$..[?(@Body.heartrate)]",
+            Values = new List<JsonPathValueExpression>
+            {
+                new JsonPathValueExpression { ValueName = "hr", ValueExpression = "$.Body.heartrate", Required = true },
+            },
+        });
+
         [Theory]
         [FileData(@"TestInput/data_IotHubPayloadExample.json")]
         public void GivenTemplateAndSingleValidToken_WhenGetMeasurements_ThenSingleMeasurementReturned_Test(string eventJson)
@@ -57,6 +66,27 @@ public void GivenTemplateAndSingleValidToken_WhenGetMeasurements_ThenSingleMeasu
             });
         }
 
+        [Theory]
+        [InlineData(null)]
+        [InlineData("")]
+        [InlineData(" ")]
+        public void GivenTemplateAndMissingTypeNameToken_WhenGetMeasurements_ThenExceptionIsThrown_Test(string typeMatchExpression)
+        {
+            var token = JToken.FromObject(new { heartrate = "60", device = "abc" });
+            var template = BuildMeasurementExtractor(new IotJsonPathContentTemplate
+            {
+                TypeName = "heartrate",
+                TypeMatchExpression = typeMatchExpression,
+                Values = new List<JsonPathValueExpression>
+                {
+                    new JsonPathValueExpression { ValueName = "hr", ValueExpression = "$.Body.heartrate", Required = true },
+                },
+            });
+
+            var ex = Assert.Throws<IncompatibleDataException>(() => template.GetMeasurements(token).ToArray());
+            Assert.Equal("An expression must be set for [TypeMatchExpression]", ex.Message);
+        }
+
         [Theory]
         [FileData(@"TestInput/data_IotHubPayloadMultiValueExample.json")]
         public void GivenTemplateAndSingleMultiValueValidToken_WhenGetMeasurements_ThenSingleMeasurementReturned_Test(string eventJson)

diff --git a/test/Microsoft.Health.Fhir.Ingest.Template.UnitTests/JsonPathContentTemplateTests.cs b/test/Microsoft.Health.Fhir.Ingest.Template.UnitTests/JsonPathContentTemplateTests.cs
@@ -412,7 +412,32 @@ public void GivenPropertyWithSpace_WhenGetMeasurements_ThenSingleMeasurementRetu
                     Assert.Equal("data", p.Value);
                 });
             });
-        }
+        }
+
+        [Theory]
+        [InlineData(null)]
+        [InlineData("")]
+        [InlineData("  ")]
+        public void GivenInvalidTypeMatchExpression_WhenGetMeasurements_ThenExceptionIsThrown_Test(string typeMatchExpression)
+        {
+            var time = DateTime.UtcNow;
+            var token = JToken.FromObject(new JsonWidget { MyProperty = "data", Time = time });
+
+            var template = new JsonPathContentTemplate
+            {
+                TypeName = "space",
+                TypeMatchExpression = typeMatchExpression,
+                DeviceIdExpression = "$.['My Property']",
+                TimestampExpression = "$.Time",
+                Values = new List<JsonPathValueExpression>
+                {
+                    new JsonPathValueExpression { ValueName = "prop", ValueExpression = "$.['My Property']", Required = false },
+                },
+            };
+
+            var ex = Assert.Throws<IncompatibleDataException>(() => BuildMeasurementExtractor(template).GetMeasurements(token).ToArray());
+            Assert.Equal("An expression must be set for [TypeMatchExpression]", ex.Message);
+        }
 
         [Fact]
         public void GivenSingleValueCompoundAndTemplateAndPartialToken_WhenGetMeasurements_ThenEmptyIEnumerableReturned_Test()