fix: remove empty array elements to reduce to reduce scope transfer s…

…ize (#570) Happy 🎄 everyone!
ui5-community · Dec 21, 2023 · f2843c1 · f2843c1
1 parent d302620
commit f2843c1
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 4 deletions.
diff --git a/client-side-js/executeControlMethod.cjs b/client-side-js/executeControlMethod.cjs
@@ -80,13 +80,16 @@ async function executeControlMethod(webElement, methodName, browserInstance, arg
                                 const collapsedAndNonCyclic = JSON.parse(
                                     JSON.stringify(collapsed, window.wdi5.getCircularReplacer())
                                 )
+                                // remove all empty Array elements, inlcuding private keys (starting with "_")
+                                const semanticCleanedElements = window.wdi5.removeEmptyElements(collapsedAndNonCyclic)
+
                                 done({
                                     status: 0,
-                                    object: collapsedAndNonCyclic,
+                                    object: semanticCleanedElements,
                                     returnType: "object",
                                     aProtoFunctions: aProtoFunctions,
                                     uuid: uuid,
-                                    nonCircularResultObject: collapsedAndNonCyclic
+                                    nonCircularResultObject: semanticCleanedElements
                                 })
                             } else if (
                                 typeof result === "object" &&

diff --git a/client-side-js/executeObjectMethod.cjs b/client-side-js/executeObjectMethod.cjs
@@ -44,10 +44,12 @@ async function clientSide_executeObjectMethod(uuid, methodName, args) {
                         const collapsedAndNonCyclic = JSON.parse(
                             JSON.stringify(result, window.wdi5.getCircularReplacer())
                         )
+                        // remove all empty Array elements, inlcuding private keys (starting with "_")
+                        const semanticCleanedElements = window.wdi5.removeEmptyElements(collapsedAndNonCyclic)
 
                         done({
                             status: 0,
-                            object: collapsedAndNonCyclic,
+                            object: semanticCleanedElements,
                             uuid: uuid,
                             returnType: "object",
                             aProtoFunctions: aProtoFunctions

diff --git a/client-side-js/getObject.cjs b/client-side-js/getObject.cjs
@@ -28,12 +28,15 @@ async function clientSide_getObject(uuid) {
 
                 const collapsedAndNonCyclic = JSON.parse(JSON.stringify(object, window.wdi5.getCircularReplacer()))
 
+                // remove all empty Array elements, inlcuding private keys (starting with "_")
+                const semanticCleanedElements = window.wdi5.removeEmptyElements(collapsedAndNonCyclic)
+
                 done({
                     status: 0,
                     uuid: uuid,
                     aProtoFunctions: aProtoFunctions,
                     className: className,
-                    object: collapsedAndNonCyclic
+                    object: semanticCleanedElements
                 })
             },
             window.wdi5.errorHandling.bind(this, done)

diff --git a/client-side-js/injectUI5.cjs b/client-side-js/injectUI5.cjs
@@ -319,6 +319,36 @@ async function clientSide_injectUI5(config, waitForUI5Timeout, browserInstance)
                         }
                     }
 
+                    /**
+                     * removes all empty collection members from an object,
+                     * e.g. empty, null, or undefined array elements
+                     *
+                     * @param {object} obj
+                     * @returns {object} obj without empty collection members
+                     */
+                    window.wdi5.removeEmptyElements = (obj, i = 0) => {
+                        for (let key in obj) {
+                            if (obj[key] === null || key.startsWith("_")) {
+                                delete obj[key]
+                            } else if (Array.isArray(obj[key])) {
+                                obj[key] = obj[key].filter(
+                                    (element) =>
+                                        element !== null &&
+                                        element !== undefined &&
+                                        element !== "" &&
+                                        Object.keys(element).length > 0
+                                )
+                                if (obj[key].length > 0) {
+                                    i++
+                                    window.wdi5.removeEmptyElements(obj[key], i)
+                                }
+                            } else if (typeof obj[key] === "object") {
+                                i++
+                                window.wdi5.removeEmptyElements(obj[key], i)
+                            }
+                        }
+                        return obj
+                    }
                     /**
                      * if parameter is JS primitive type
                      * returns {boolean}