Merge pull request #35 from neuroglia-io/fix-jq-string-interpolation

Handled string interpolation in JQ expression evaluator
neuroglia-io · Nov 7, 2022 · 89e660e · 89e660e
2 parents 1e415fd + e088fe8
commit 89e660e
Show file tree

Hide file tree

Showing 8 changed files with 61 additions and 8 deletions.
diff --git a/src/Data/Neuroglia.Data.Expressions.JQ/JQExpressionEvaluator.cs b/src/Data/Neuroglia.Data.Expressions.JQ/JQExpressionEvaluator.cs
@@ -92,10 +92,10 @@ public virtual bool Supports(string language)
                 .ToDictionary(a => a.Key, a => JsonConvert.SerializeObject(JToken.FromObject(a.Value), Formatting.None, serializerSettings))
                 .Aggregate(
                     new StringBuilder(),
-                    (accumulator, source) => accumulator.Append(@$"--argjson ""{source.Key}"" ""{this.EscapeDoubleQuotes(source.Value)}"" "),
+                    (accumulator, source) => accumulator.Append(@$"--argjson ""{source.Key}"" ""{this.EscapeArgs(source.Value)}"" "),
                     sb => sb.ToString()
                 );
-            var processArguments = $"\"{this.EscapeDoubleQuotes(expression)}\" {serializedArgs} -c";
+            var processArguments = @$"""{this.EscapeArgs(expression)}"" {serializedArgs} -c";
             var files = new List<string>();
             var maxLength = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? 8000 : 200000;
             if (processArguments.Length >= maxLength)
@@ -160,11 +160,11 @@ public virtual bool Supports(string language)
         }
 
         /// <summary>
-        /// Escapes double quotes in the specified string
+        /// Escapes double quotes (") or backslashes (\) in the provided string
         /// </summary>
-        /// <param name="input">The string for which to escape double quotes</param>
-        /// <returns>The string with escaped double quotes</returns>
-        protected virtual string EscapeDoubleQuotes(string input) => Regex.Replace(input, "([\"\\\\])", @"\$1", RegexOptions.Compiled);
+        /// <param name="input">The string to escape</param>
+        /// <returns>The escaped string</returns>
+        protected virtual string EscapeArgs(string input) => Regex.Replace(input, @"(\\(?!\()|"")", @"\$1", RegexOptions.Compiled);
 
 
     }

diff --git a/src/Data/Neuroglia.Data.Expressions.JQ/Neuroglia.Data.Expressions.JQ.xml b/src/Data/Neuroglia.Data.Expressions.JQ/Neuroglia.Data.Expressions.JQ.xml
diff --git a/test/Neuroglia.UnitTests/Assets/string-concat.expression.txt b/test/Neuroglia.UnitTests/Assets/string-concat.expression.txt
@@ -0,0 +1 @@
+${ .foo + " " + .bar }
diff --git a/test/Neuroglia.UnitTests/Assets/string-concat.input.json b/test/Neuroglia.UnitTests/Assets/string-concat.input.json
@@ -0,0 +1,4 @@
+{
+  "foo": "hello",
+  "bar": "world"
+}
diff --git a/test/Neuroglia.UnitTests/Assets/string-interpolation.expression.txt b/test/Neuroglia.UnitTests/Assets/string-interpolation.expression.txt
@@ -0,0 +1 @@
+${ "\(.foo.bar) is a greeting" }
diff --git a/test/Neuroglia.UnitTests/Assets/string-interpolation.input.json b/test/Neuroglia.UnitTests/Assets/string-interpolation.input.json
@@ -0,0 +1,5 @@
+{
+  "foo": {
+    "bar": "hello world"
+  }
+}
diff --git a/test/Neuroglia.UnitTests/Cases/Data/Expressions/JQExpressionEvaluatorTests.cs b/test/Neuroglia.UnitTests/Cases/Data/Expressions/JQExpressionEvaluatorTests.cs
@@ -179,6 +179,36 @@ public void Evaluate_EscapedJsonInput_UsingNewtonsoft_ShouldWork()
             Assert.NotEmpty(result.name);
         }
 
+        [Fact]
+        public void Evaluate_String_Concatenation_ShouldWork()
+        {
+            //arrange
+            var evaluator = BuildExpressionEvaluatorWithSystemTextJsonSerializer();
+            var data = Newtonsoft.Json.JsonConvert.DeserializeObject<ExpandoObject>(File.ReadAllText(Path.Combine("Assets", "string-concat.input.json")));
+            var expression = File.ReadAllText(Path.Combine("Assets", "string-concat.expression.txt"));
+
+            //act
+            string result = (string)evaluator.Evaluate(expression, data, typeof(string), null);
+
+            //assert
+            result.Should().Be("hello world");
+        }
+
+        [Fact]
+        public void Evaluate_String_Interpolation_ShouldWork()
+        {
+            //arrange
+            var evaluator = BuildExpressionEvaluatorWithSystemTextJsonSerializer();
+            var data = Newtonsoft.Json.JsonConvert.DeserializeObject<ExpandoObject>(File.ReadAllText(Path.Combine("Assets", "string-interpolation.input.json")));
+            var expression = File.ReadAllText(Path.Combine("Assets", "string-interpolation.expression.txt"));
+
+            //act
+            string result = (string)evaluator.Evaluate(expression, data, typeof(string), null);
+
+            //assert
+            result.Should().Be("hello world is a greeting");
+        }
+
         static IExpressionEvaluator BuildExpressionEvaluatorWithNewtonsoftJsonSerializer()
         {
             var services = new ServiceCollection();

diff --git a/test/Neuroglia.UnitTests/Neuroglia.UnitTests.csproj b/test/Neuroglia.UnitTests/Neuroglia.UnitTests.csproj
@@ -63,6 +63,18 @@
     <None Update="Assets\openapi.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Update="Assets\string-concat.expression.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="Assets\string-concat.input.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="Assets\string-interpolation.input.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="Assets\string-interpolation.expression.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="Assets\pets.expression.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>