fix(template): fix template string escaping (#6705)

A follow-up for #6685. Replays #6408 on top of #6685. Co-authored-by: Steffen Neubauer <[email protected]>
garden-io · Dec 10, 2024 · 32f8ec6 · 32f8ec6
1 parent 3c65e49
commit 32f8ec6
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 1 deletion.
diff --git a/core/src/template-string/parser.pegjs b/core/src/template-string/parser.pegjs
@@ -208,7 +208,7 @@ TemplateStrings
   }
 
 FormatString
-  = EscapeStart SourceCharacter* FormatEndWithOptional {
+  = EscapeStart (!FormatEndWithOptional SourceCharacter)* FormatEndWithOptional {
     if (options.unescape) {
       return new ast.LiteralExpression(location(), text().slice(1))
     } else {

diff --git a/core/test/unit/src/template-string.ts b/core/test/unit/src/template-string.ts
@@ -128,6 +128,60 @@ describe("resolveTemplateString", () => {
     expect(res).to.equal("${bar}")
   })
 
+  it("should resolve other template variables after escaped one with unescape=false", () => {
+    const res = resolveTemplateString({
+      string: "foo $${} ${bar}",
+      context: new GenericContext({ bar: "bar" }),
+      contextOpts: { unescape: false },
+    })
+    expect(res).to.equal("foo $${} bar")
+  })
+
+  it("should resolve other template variables after escaped one with unescape=true", () => {
+    const res = resolveTemplateString({
+      string: "foo $${} ${bar}",
+      context: new GenericContext({ bar: "bar" }),
+      contextOpts: { unescape: true },
+    })
+    expect(res).to.equal("foo ${} bar")
+  })
+
+  it("should not unescape inner template variables with unescape=false", () => {
+    const res = resolveTemplateString({
+      string: 'foo ${"$${}"} ${bar}',
+      context: new GenericContext({ bar: "bar" }),
+      contextOpts: { unescape: false },
+    })
+    expect(res).to.equal("foo $${} bar")
+  })
+
+  it("should unescape inner template variables with unescape=true", () => {
+    const res = resolveTemplateString({
+      string: 'foo ${"$${}"} ${bar}',
+      context: new GenericContext({ bar: "bar" }),
+      contextOpts: { unescape: true },
+    })
+    expect(res).to.equal("foo ${} bar")
+  })
+
+  it("should not unescape outer template variables with unescape=false", () => {
+    const res = resolveTemplateString({
+      string: 'foo $${"${}"} ${bar}',
+      context: new GenericContext({ bar: "bar" }),
+      contextOpts: { unescape: false },
+    })
+    expect(res).to.equal('foo $${"${}"} bar')
+  })
+
+  it("should unescape outer template variables with unescape=true", () => {
+    const res = resolveTemplateString({
+      string: 'foo $${"${}"} ${bar}',
+      context: new GenericContext({ bar: "bar" }),
+      contextOpts: { unescape: true },
+    })
+    expect(res).to.equal('foo ${"${}"} bar')
+  })
+
   it("should unescape a template string with a double $$ prefix if allowPartial=false", () => {
     const res = resolveTemplateString({
       string: "$${bar}",