fix: correctly serialize promise objects in history steps (#1105)

* fix: correctly serialize promise objects in history steps

* fix: show object previews in history args when possible

Author: shadowusr

src/browser/history/utils.ts

@@ -1,3 +1,4 @@
+import { inspect } from "util";
 import { isPromise } from "util/types";
 import _ from "lodash";
 import { TestStep, TestStepKey } from "../../types";
@@ -18,15 +19,26 @@ export const normalizeCommandArgs = (commandName: string, args: unknown[] = []):
     }
 
     return args.map(arg => {
-        if (typeof arg === "string") {
-            return _.truncate(arg, { length: MAX_STRING_LENGTH });
+        try {
+            if (typeof arg === "string") {
+                return _.truncate(arg, { length: MAX_STRING_LENGTH });
+            }
+
+            if (isPromise(arg)) {
+                return "promise";
+            }
+
+            if (_.isPlainObject(arg)) {
+                return _.truncate(
+                    inspect(arg, { depth: 0, compact: true, breakLength: Infinity, maxArrayLength: 10 }),
+                    { length: MAX_STRING_LENGTH },
+                );
+            }
+
+            return _.truncate(String(arg), { length: MAX_STRING_LENGTH });
+        } catch (err) {
+            return "unknown";
         }
-
-        if (_.isPlainObject(arg)) {
-            return "obj";
-        }
-
-        return String(arg);
     });
 };
 

test/src/browser/history/utils.js

@@ -7,7 +7,24 @@ describe("commands-history", () => {
     describe("utils", () => {
         describe("normalizeCommandArgs", () => {
             it("should return representation for an object", () => {
-                assert.deepEqual(normalizeCommandArgs("click", [{ some: "data" }]), ["obj"]);
+                assert.deepEqual(normalizeCommandArgs("click", [{ some: "data" }]), ["{ some: 'data' }"]);
+            });
+
+            it("should handle large objects", () => {
+                const largeObject = {
+                    some: {
+                        nested: {
+                            data: "data",
+                        },
+                    },
+                    field: "value",
+                    array: [1, 2, 3, 4, { some: "data" }],
+                    longString: "abc".repeat(100),
+                };
+
+                assert.deepEqual(normalizeCommandArgs("click", [largeObject]), [
+                    "{ some: [Object], field: 'value', array: [Array...",
+                ]);
             });
 
             it('should return truncated representation for the "execute" command', () => {
@@ -25,6 +42,22 @@ describe("commands-history", () => {
             it("should convert argument to string if it is not string or object", () => {
                 assert.deepEqual(normalizeCommandArgs("click", [false, null, 100]), ["false", "null", "100"]);
             });
+
+            it("should return 'promise' for promise arguments", () => {
+                const promiseArg = Promise.resolve("test");
+
+                assert.deepEqual(normalizeCommandArgs("click", [promiseArg]), ["promise"]);
+            });
+
+            it("should return 'unknown' if error occurs during argument normalization", () => {
+                const problematicArg = Object.create({
+                    toString: () => {
+                        throw new Error("Cannot convert to string");
+                    },
+                });
+
+                assert.deepEqual(normalizeCommandArgs("click", [problematicArg]), ["unknown"]);
+            });
         });
 
         describe("runWithHooks", () => {