java-0.9.4 js-1.3.3 - fix text template url encoding with fallback template

Author: elisherer

docs/package-lock.json

@@ -19,7 +19,7 @@
     "@docusaurus/preset-classic": "3.7.0",
     "@mdx-js/react": "3.1.0",
     "@monaco-editor/react": "4.6.0",
-    "@nlighten/json-transform": "^1.3.2",
+    "@nlighten/json-transform": "^1.3.3",
     "@nlighten/json-transform-core": "^1.3.2",
     "buffer": "^6.0.3",
     "clsx": "2.1.0",

docs/package.json

@@ -9,7 +9,7 @@ plugins {
 }
 
 group 'co.nlighten'
-version = '0.9.3'
+version = '0.9.4'
 
 ext {
     gsonVersion = "2.10.1"

java/json-transform/build.gradle

@@ -103,6 +103,11 @@ private void parse(String template, ParameterDefaultResolveOptions defaultResolv
                             buffer.append("\\{");
                             continue;
                         }
+                        if (nextChar == '}' && state != STATE_TEXT) {
+                            i++; // skip backslash
+                            buffer.append("\\}");
+                            continue;
+                        }
                     }
                     break;
                 case '{':
@@ -179,7 +184,8 @@ String internalRender(ParameterResolver resolver, JsonAdapter<?,?,?> adapter, Bo
                 sb.append(s);
             } else if (value instanceof TemplateParameter param) {
                 var renderedValue = param.getStringValue(resolver, adapter);
-                sb.append(Boolean.TRUE.equals(urlEncodeParameters)
+                sb.append(
+                        Boolean.TRUE.equals(urlEncodeParameters) && !UNESCAPED_OPEN_CURLY_BRACKET.matcher(renderedValue).find()
                         ? URLEncoder.encode(renderedValue, StandardCharsets.UTF_8)
                         : renderedValue);
             }
@@ -201,7 +207,9 @@ public String render(ParameterResolver resolver, JsonAdapter<?,?,?> adapter, Boo
             res = get(res, defaultResolver).internalRender(resolver, adapter, urlEncodeParameters);
         }
         // unescape
-        return res.replace("\\{", "{").replace("\\}", "}");
+        return urlEncodeParameters
+                ? res.replace("%5C%7B", "%7B").replace("%5C%7D", "%7D")
+                : res.replace("\\{", "{").replace("\\}", "}");
     }
 
     public String render(ParameterResolver resolver) {

java/json-transform/src/main/java/co/nlighten/jsontransform/template/TextTemplate.java

@@ -95,8 +95,6 @@ void recursiveWithEscapedTemplateParameterDefaultValue() {
         ));
         var def = new TextTemplate("{b,{a}}").render(resolver);
         Assertions.assertEquals("A", def);
-        def = new TextTemplate("{b,\\{a}}").render(resolver);
-        Assertions.assertEquals("{a}", def);
     }
 
     @Test
@@ -114,7 +112,7 @@ void recursiveWithEscapedTemplateParameterDefaultValue3() {
         var resolver = ParameterResolver.fromMap(Map.of(
                 "a", "A"
         ));
-        var def = new TextTemplate("{b,\\{a}}").render(resolver);
+        var def = new TextTemplate("{b,\\{a\\}}").render(resolver);
         Assertions.assertEquals("{a}", def);
     }
 
@@ -130,4 +128,17 @@ void urlEncode() {
         def = new TextTemplate("href={href}").render(resolver);
         Assertions.assertEquals("href=https://example.com/", def);
     }
+
+    @Test
+    void urlEncodeWithFallback() {
+        var resolver = ParameterResolver.fromMap(Map.of(
+                "href", "https://example.com/"
+        ));
+        // default value is a template
+        var def = new TextTemplate("href={url,{href}}").render(resolver, true);
+        Assertions.assertEquals("href=https%3A%2F%2Fexample.com%2F", def);
+        // default value escaped
+        def = new TextTemplate("href={url,\\{href\\}}").render(resolver, true);
+        Assertions.assertEquals("href=%7Bhref%7D", def);
+    }
 }

java/json-transform/src/test/java/co/nlighten/jsontransform/template/TextTemplateTests.java

@@ -1,7 +1,7 @@
 {
   "name": "@nlighten/json-transform",
   "description": "JSON transformers JavaScript implementation",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "main": "dist/json-transform.js",
   "umd:main": "dist/json-transform.umd.js",
   "module": "dist/json-transform.module.js",

javascript/json-transform/package-lock.json

@@ -70,10 +70,8 @@ describe("TextTemplate", () => {
     const resolver = parameterResolverFromMap({
       a: "A",
     });
-    let def = await new TextTemplate("{b,{a}}").render(resolver);
+    const def = await new TextTemplate("{b,{a}}").render(resolver);
     expect(def).toEqual("A");
-    def = await new TextTemplate("{b,\\{a}}").render(resolver);
-    expect(def).toEqual("{a}");
   });
 
   test("recursiveWithEscapedTemplateParameterDefaultValue2", async () => {
@@ -88,7 +86,7 @@ describe("TextTemplate", () => {
     const resolver = parameterResolverFromMap({
       a: "A",
     });
-    const def = await new TextTemplate("{b,\\{a}}").render(resolver);
+    const def = await new TextTemplate("{b,\\{a\\}}").render(resolver);
     expect(def).toEqual("{a}");
   });
 
@@ -103,4 +101,14 @@ describe("TextTemplate", () => {
     def = await new TextTemplate("href={href}").render(resolver);
     expect(def).toEqual("href=https://example.com/");
   });
+
+  test("urlEncodeWithFallback", async () => {
+    const resolver = parameterResolverFromMap({
+      href: "https://example.com/",
+    });
+    let def = await new TextTemplate("href={url,{href}}").render(resolver, true);
+    expect(def).toEqual("href=https%3A%2F%2Fexample.com%2F");
+    def = await new TextTemplate("href={url,\\{href\\}}").render(resolver, true);
+    expect(def).toEqual("href=%7Bhref%7D");
+  });
 });

javascript/json-transform/package.json

@@ -78,6 +78,11 @@ export default class TextTemplate {
               buffer += "\\{";
               continue;
             }
+            if (nextChar == "}" && state !== STATE_TEXT) {
+              i++; // skip backslash
+              buffer += "\\}";
+              continue;
+            }
           }
           break;
         case "{":
@@ -157,7 +162,10 @@ export default class TextTemplate {
         sb += value;
       } else if (value instanceof TemplateParameter) {
         const renderedValue = await value.getStringValue(resolver);
-        sb += urlEncodeParameters ? encodeURIComponent(renderedValue.replace()) : renderedValue;
+        sb +=
+          urlEncodeParameters && !UNESCAPED_OPEN_CURLY_BRACKET.test(renderedValue)
+            ? encodeURIComponent(renderedValue)
+            : renderedValue;
       }
     }
     return sb;
@@ -177,7 +185,9 @@ export default class TextTemplate {
       res = await TextTemplate.get(res, this.defaultResolver).internalRender(resl, urlEncodeParameters);
     }
     // unescape
-    return res.replace(/\\\{/g, "{").replace(/\\}/g, "}");
+    return urlEncodeParameters
+      ? res.replace(/%5C%7B/g, "%7B").replace(/%5C%7D/g, "%7D")
+      : res.replace(/\\\{/g, "{").replace(/\\}/g, "}");
   }
 
   public static render(

javascript/json-transform/src/__tests__/template/TextTemplate.test.ts

@@ -105,5 +105,21 @@
     "expect": {
       "equal": "href=https%3A%2F%2Fexample.com%2F"
     }
+  },
+  {
+    "name": "object - url encode with fallback",
+    "given": {
+      "input": {
+        "href": "https://example.com/"
+      },
+      "definition": {
+        "$$template": "href={$.url,{$.href}}",
+        "payload": "$",
+        "url_encode": true
+      }
+    },
+    "expect": {
+      "equal": "href=https%3A%2F%2Fexample.com%2F"
+    }
   }
 ]