Merge pull request #74 from Exabyte-io/chore/SOF-6955

Chore/sof 6955

Author: timurbazhirov

src/utils/str.js

@@ -97,6 +97,8 @@ export function convertArabicToRoman(num) {
 /**
  * Render name template based on config.
  * Use substitution map to replace a config value with a more readable variant.
+ * NOTE: We currently iterate through the whole object. A more efficient albeit more verbose approach would be
+ * to give the property path in the subsitution map, e.g., `{ "user.name": {"user001": "John Doe"} }`.
  * @param {string|undefined} template - Template for the name property
  * @param {Object} data - Entity config
  * @param {Object} substitutionMap - Maps object value to human-readable string
@@ -115,13 +117,19 @@ export function renderTextWithSubstitutes(template, data, substitutionMap = {})
 
     // Helper function for recursive substitution
     function substituteNested(obj) {
-        lodash.forIn(obj, (value, key) => {
+        if (!lodash.isPlainObject(obj)) {
+            return;
+        }
+        // eslint-disable-next-line no-restricted-syntax
+        for (const [key, value] of Object.entries(obj)) {
             if (lodash.isPlainObject(value)) {
                 substituteNested(value);
+            } else if (Array.isArray(value)) {
+                value.forEach((val) => substituteNested(val));
             } else if (substitutionMap[value]) {
                 obj[key] = substitutionMap[value];
             }
-        });
+        }
     }
 
     substituteNested(renderData);

tests/utils/str.tests.ts

@@ -62,6 +62,19 @@ describe("str: renderTextWithSubstitutes", () => {
 
         expect(result).to.be.equal("Hello !");
     });
+
+    it("should be able to access nested elements in template notation", () => {
+        const template = "Hello {{ user }} of {{ array[1]['planet'] }}!";
+        const data = { user: "user001", array: [{ planet: "A" }, { planet: "B" }] };
+        const substitutionMap = {
+            A: "Earth",
+            B: "Mars",
+        };
+
+        const result = renderTextWithSubstitutes(template, data, substitutionMap);
+
+        expect(result).to.be.equal("Hello user001 of Mars!");
+    });
 });
 
 describe("str: findPreviousVersion", () => {