k6-cucumber-steps 1.2.18 → 1.2.19

package/lib/helpers/resolveBody.js

@@ -1,62 +1,74 @@
-/**
- * @module resolveBody
- * @description
- * This module resolves placeholders in a template string using environment variables,
- * Faker templates, and JSON file includes.
- * It supports the following types of placeholders:
- * 1. Environment variables: {{username}} will be replaced with the value of process.env.username.
- * 2. Faker templates: {{faker.internet.email}} will be replaced with a randomly generated email address.
- * 3. JSON file includes: <address.json> will be replaced with the contents of the address.json file.
- * */
 const fs = require("fs");
 const path = require("path");
-const faker = require("@faker-js/faker");
-
-module.exports = function resolveBody(template, env) {
-  let result = template;
-  console.log("Resolving body template:", template);
-  console.log("Resolved body result:", result);
-  // Replace env vars like {{username}}
-  result = result.replace(/{{(\w+)}}/g, (_, key) => {
-    if (!(key in env)) {
-      console.warn(`Missing environment variable for placeholder: {{${key}}}`);
-    }
-    return env[key] || "";
-  });
-
-  // Support faker templates like {{faker.internet.email}}
-  result = result.replace(/{{faker\.([\w.]+)}}/g, (_, methodPath) => {
-    const parts = methodPath.split(".");
-    let fn = faker;
-    for (const part of parts) {
-      fn = fn?.[part]; // Use optional chaining to avoid errors
-      if (!fn) {
-        throw new Error(`Invalid Faker template: {{faker.${methodPath}}}`);
+const faker = require("@faker-js/faker").faker;
+
+/**
+ * Recursively resolves all placeholders in an object.
+ * @param {*} data - The parsed JSON (object, array, string, etc)
+ * @param {object} env - Environment variables + aliases
+ * @returns {*} - Fully resolved structure
+ */
+function resolveDeep(data, env) {
+  if (typeof data === "string") {
+    // 1. Resolve env vars like {{username}}
+    data = data.replace(/{{(\w+)}}/g, (_, key) => {
+      return env[key] || "";
+    });
+
+    // 2. Resolve faker like {{faker.internet.email}}
+    data = data.replace(/{{faker\.([\w.]+)}}/g, (_, methodPath) => {
+      const parts = methodPath.split(".");
+      let fn = faker;
+      for (const part of parts) {
+        fn = fn?.[part];
+        if (!fn) throw new Error(`Invalid Faker method: faker.${methodPath}`);
       }
+      return typeof fn === "function" ? fn() : fn;
+    });
+
+    // 3. Replace JSON file includes like <address.json>
+    data = data.replace(/<([\w-]+\.json)>/g, (_, fileName) => {
+      const filePath = path.join(__dirname, "../payloads", fileName);
+      if (!fs.existsSync(filePath)) {
+        throw new Error(`Payload file not found: ${fileName}`);
+      }
+      const fileContent = fs.readFileSync(filePath, "utf-8");
+      return fileContent.trim();
+    });
+
+    return data;
+  }
+
+  if (Array.isArray(data)) {
+    return data.map((item) => resolveDeep(item, env));
+  }
+
+  if (typeof data === "object" && data !== null) {
+    const resolved = {};
+    for (const key in data) {
+      resolved[key] = resolveDeep(data[key], env);
     }
-    if (typeof fn !== "function") {
-      throw new Error(`Invalid Faker template: {{faker.${methodPath}}}`);
-    }
-    return fn();
-  });
-
-  // Replace JSON file includes like <address.json>
-  result = result.replace(/<([\w.]+\.json)>/g, (_, fileName) => {
-    const filePath = path.join(__dirname, "../payloads", fileName);
-    if (!fs.existsSync(filePath)) {
-      throw new Error(`Payload file not found: ${fileName}`);
-    }
-    try {
-      return JSON.stringify(JSON.parse(fs.readFileSync(filePath, "utf-8")));
-    } catch (error) {
-      throw new Error(`Failed to parse JSON file: ${fileName}`);
-    }
-  });
+    return resolved;
+  }
 
+  return data;
+}
+
+/**
+ * Resolves JSON templates using env vars, Faker, and JSON includes.
+ * @param {string} template - The raw JSON string template
+ * @param {object} env - Object containing environment variables or aliases
+ * @returns {object} - Fully resolved JS object
+ */
+module.exports = function resolveBody(template, env = {}) {
   try {
-    return JSON.parse(result);
-  } catch (error) {
-    console.error("Failed to parse resolved body to JSON:", result);
-    throw new Error("Invalid JSON body after resolving placeholders.");
+    const parsed = JSON.parse(template);
+    return resolveDeep(parsed, env);
+  } catch (err) {
+    console.error(
+      "❌ Failed to parse input JSON before resolving:",
+      err.message
+    );
+    throw new Error("Invalid JSON template provided to resolveBody");
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "k6-cucumber-steps",
-  "version": "1.2.18",
+  "version": "1.2.19",
   "main": "index.js",
   "license": "MIT",
   "repository": {