From 4f2fd656c5f5a7318b50fa3f8cc4dcaa19b21cc8 Mon Sep 17 00:00:00 2001
From: mike12345567 <me@michaeldrury.co.uk>
Date: Wed, 3 Feb 2021 12:10:39 +0000
Subject: [PATCH] Fixing an issue with the new validity checking being too
 lenient.

---
 packages/string-templates/src/index.js        | 37 +++++++++++++------
 .../string-templates/test/helpers.spec.js     | 11 ++++++
 2 files changed, 37 insertions(+), 11 deletions(-)

diff --git a/packages/string-templates/src/index.js b/packages/string-templates/src/index.js
index 6992eb839e..fb5c13be26 100644
--- a/packages/string-templates/src/index.js
+++ b/packages/string-templates/src/index.js
@@ -83,18 +83,25 @@ module.exports.processObjectSync = (object, context) => {
  * @returns {string} The enriched string, all templates should have been replaced if they can be.
  */
 module.exports.processStringSync = (string, context) => {
+  const input = cloneDeep(string)
   let clonedContext = removeNull(cloneDeep(context))
   clonedContext = addConstants(clonedContext)
   // remove any null/undefined properties
   if (typeof string !== "string") {
     throw "Cannot process non-string types."
   }
-  string = processors.preprocess(string)
-  // this does not throw an error when template can't be fulfilled, have to try correct beforehand
-  const template = hbsInstance.compile(string, {
-    strict: false,
-  })
-  return processors.postprocess(template(clonedContext))
+  try {
+    string = processors.preprocess(string)
+    // this does not throw an error when template can't be fulfilled, have to try correct beforehand
+    const template = hbsInstance.compile(string, {
+      strict: false,
+    })
+    return processors.postprocess(template(clonedContext))
+  } catch (err) {
+    // suggested that we should always return input if an error occurs, incase string wasn't supposed to
+    // contain any handlebars statements
+    return input
+  }
 }
 
 /**
@@ -112,19 +119,27 @@ module.exports.makePropSafe = property => {
  * @returns {boolean} Whether or not the input string is valid.
  */
 module.exports.isValid = string => {
-  const specialCases = ["string", "number", "object", "array"]
+  const validCases = ["string", "number", "object", "array"]
+  // this is a portion of a specific string always output by handlebars in the case of a syntax error
+  const invalidCases = [`expecting 'id', 'string', 'number'`]
   // don't really need a real context to check if its valid
   const context = {}
   try {
     hbsInstance.compile(processors.preprocess(string, false))(context)
     return true
   } catch (err) {
-    const msg = err ? err.message : ""
-    const foundCase = specialCases.find(spCase =>
-      msg.toLowerCase().includes(spCase)
+    const msg = err && err.message ? err.message : err
+    if (!msg) {
+      return false
+    }
+    const invalidCase = invalidCases.some(invalidCase =>
+      msg.toLowerCase().includes(invalidCase)
+    )
+    const validCase = validCases.some(validCase =>
+      msg.toLowerCase().includes(validCase)
     )
     // special case for maths functions - don't have inputs yet
-    return !!foundCase
+    return validCase && !invalidCase
   }
 }
 
diff --git a/packages/string-templates/test/helpers.spec.js b/packages/string-templates/test/helpers.spec.js
index 4a4ed6592a..438a9047c3 100644
--- a/packages/string-templates/test/helpers.spec.js
+++ b/packages/string-templates/test/helpers.spec.js
@@ -316,4 +316,15 @@ describe("Cover a few complex use cases", () => {
     const validity = isValid("{{ subtract [c390c23a7f1b6441c98d2fe2a51248ef3].[total profit] [c390c23a7f1b6441c98d2fe2a51248ef3].[total revenue]  }}")
     expect(validity).toBe(true)
   })
+
+  it("should confirm an invalid string", () => {
+    const validity = isValid("{{ awdd () ")
+    expect(validity).toBe(false)
+  })
+
+  it("input a garbage string, expect it to be returned", async () => {
+    const input = `{{{{{{ } {{ ]] ] ] }}} {{ ] {{ {   } { dsa { dddddd }}}}}}} }DDD`
+    const output = await processString(input, {})
+    expect(output).toBe(input)
+  })
 })
\ No newline at end of file