Merge pull request #624 from GuillaumeGomez/more-bools

Allow to use `boolean` values in more commands
GuillaumeGomez · Oct 25, 2024 · 0f1897d · 0f1897d
2 parents 7289128 + 769aed9
commit 0f1897d
Show file tree

Hide file tree

Showing 16 changed files with 180 additions and 17 deletions.
diff --git a/src/commands/assert.js b/src/commands/assert.js
@@ -171,12 +171,13 @@ function parseAssertObjPropertyInner(parser, assertFalse, objName) {
             'object-path': [],
         },
         valueTypes: {
-            'string': {},
-            'number': {
+            string: {},
+            number: {
                 allowNegative: true,
                 allowFloat: true,
             },
-            'ident': {
+            boolean: {},
+            ident: {
                 allowed: ['null'],
             },
         },

diff --git a/src/commands/general.js b/src/commands/general.js
@@ -125,7 +125,11 @@ function parseObjPropertyInner(parser, objName) {
             },
             valueTypes: {
                 // In case it's an ident, we only want to allow `null`.
+                ident: {
+                    allowed: ['null'],
+                },
                 string: {},
+                boolean: {},
                 number: {
                     allowFloat: true,
                     allowNegative: true,
@@ -142,7 +146,13 @@ function parseObjPropertyInner(parser, objName) {
 
     for (const [key, value] of json) {
         const k_s = value.key.kind === 'object-path' ? key : `["${key}"]`;
-        content.push(`[${k_s}, "${value.value}"]`);
+        if (value.kind === 'string') {
+            content.push(`[${k_s}, "${value.value}"]`);
+        } else if (value.kind === 'ident') {
+            content.push(`[${k_s}, undefined]`);
+        } else {
+            content.push(`[${k_s}, ${value.value}]`);
+        }
     }
 
     if (content.length === 0) {
@@ -169,7 +179,11 @@ await page.evaluate(() => {
             }
             object = object[subPath];
         }
-        object[path[path.length - 1]] = value;
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
     }
     const ${varDict} = [
 ${indentString(content.join(',\n'), 2)}

diff --git a/tests/api-output/parseSetDocumentProperty/basic-1.toml b/tests/api-output/parseSetDocumentProperty/basic-1.toml
@@ -8,10 +8,14 @@ instructions = [
             }
             object = object[subPath];
         }
-        object[path[path.length - 1]] = value;
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
     }
     const parsePropDict = [
-        [[\"a\"], \"2\"]
+        [[\"a\"], 2]
     ];
     for (const [parsePropKey, parsePropValue] of parsePropDict) {
         setObjValue(document, parsePropKey, parsePropValue);

diff --git a/tests/api-output/parseSetDocumentProperty/basic-2.toml b/tests/api-output/parseSetDocumentProperty/basic-2.toml
@@ -0,0 +1,26 @@
+instructions = [
+  """await page.evaluate(() => {
+    function setObjValue(object, path, value) {
+        for (let i = 0; i < path.length - 1; ++i) {
+            const subPath = path[i];
+            if (object[subPath] === undefined || object[subPath] === null) {
+                object[subPath] = {};
+            }
+            object = object[subPath];
+        }
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
+    }
+    const parsePropDict = [
+        [[\"a\"], true]
+    ];
+    for (const [parsePropKey, parsePropValue] of parsePropDict) {
+        setObjValue(document, parsePropKey, parsePropValue);
+    }
+});""",
+]
+wait = false
+checkResult = true
diff --git a/tests/api-output/parseSetDocumentProperty/basic-3.toml b/tests/api-output/parseSetDocumentProperty/basic-3.toml
@@ -0,0 +1,26 @@
+instructions = [
+  """await page.evaluate(() => {
+    function setObjValue(object, path, value) {
+        for (let i = 0; i < path.length - 1; ++i) {
+            const subPath = path[i];
+            if (object[subPath] === undefined || object[subPath] === null) {
+                object[subPath] = {};
+            }
+            object = object[subPath];
+        }
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
+    }
+    const parsePropDict = [
+        [[\"a\"], \"b\"]
+    ];
+    for (const [parsePropKey, parsePropValue] of parsePropDict) {
+        setObjValue(document, parsePropKey, parsePropValue);
+    }
+});""",
+]
+wait = false
+checkResult = true
diff --git a/tests/api-output/parseSetDocumentProperty/escape-1.toml b/tests/api-output/parseSetDocumentProperty/escape-1.toml
@@ -8,7 +8,11 @@ instructions = [
             }
             object = object[subPath];
         }
-        object[path[path.length - 1]] = value;
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
     }
     const parsePropDict = [
         [[\"a\"], \"2\"],

diff --git a/tests/api-output/parseSetDocumentProperty/object-path-1.toml b/tests/api-output/parseSetDocumentProperty/object-path-1.toml
@@ -8,10 +8,14 @@ instructions = [
             }
             object = object[subPath];
         }
-        object[path[path.length - 1]] = value;
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
     }
     const parsePropDict = [
-        [[\"a\",\"b\"], \"2\"]
+        [[\"a\",\"b\"], 2]
     ];
     for (const [parsePropKey, parsePropValue] of parsePropDict) {
         setObjValue(document, parsePropKey, parsePropValue);

diff --git a/tests/api-output/parseSetDocumentProperty/object-path-2.toml b/tests/api-output/parseSetDocumentProperty/object-path-2.toml
@@ -8,7 +8,11 @@ instructions = [
             }
             object = object[subPath];
         }
-        object[path[path.length - 1]] = value;
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
     }
     const parsePropDict = [
         [[\"a\"], \"2\"],

diff --git a/tests/api-output/parseSetWindowProperty/basic-1.toml b/tests/api-output/parseSetWindowProperty/basic-1.toml
@@ -8,10 +8,14 @@ instructions = [
             }
             object = object[subPath];
         }
-        object[path[path.length - 1]] = value;
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
     }
     const parsePropDict = [
-        [[\"a\"], \"2\"]
+        [[\"a\"], 2]
     ];
     for (const [parsePropKey, parsePropValue] of parsePropDict) {
         setObjValue(window, parsePropKey, parsePropValue);

diff --git a/tests/api-output/parseSetWindowProperty/basic-2.toml b/tests/api-output/parseSetWindowProperty/basic-2.toml
@@ -0,0 +1,26 @@
+instructions = [
+  """await page.evaluate(() => {
+    function setObjValue(object, path, value) {
+        for (let i = 0; i < path.length - 1; ++i) {
+            const subPath = path[i];
+            if (object[subPath] === undefined || object[subPath] === null) {
+                object[subPath] = {};
+            }
+            object = object[subPath];
+        }
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
+    }
+    const parsePropDict = [
+        [[\"a\"], true]
+    ];
+    for (const [parsePropKey, parsePropValue] of parsePropDict) {
+        setObjValue(window, parsePropKey, parsePropValue);
+    }
+});""",
+]
+wait = false
+checkResult = true
diff --git a/tests/api-output/parseSetWindowProperty/basic-3.toml b/tests/api-output/parseSetWindowProperty/basic-3.toml
@@ -0,0 +1,26 @@
+instructions = [
+  """await page.evaluate(() => {
+    function setObjValue(object, path, value) {
+        for (let i = 0; i < path.length - 1; ++i) {
+            const subPath = path[i];
+            if (object[subPath] === undefined || object[subPath] === null) {
+                object[subPath] = {};
+            }
+            object = object[subPath];
+        }
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
+    }
+    const parsePropDict = [
+        [[\"a\"], \"b\"]
+    ];
+    for (const [parsePropKey, parsePropValue] of parsePropDict) {
+        setObjValue(window, parsePropKey, parsePropValue);
+    }
+});""",
+]
+wait = false
+checkResult = true
diff --git a/tests/api-output/parseSetWindowProperty/escape-1.toml b/tests/api-output/parseSetWindowProperty/escape-1.toml
@@ -8,7 +8,11 @@ instructions = [
             }
             object = object[subPath];
         }
-        object[path[path.length - 1]] = value;
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
     }
     const parsePropDict = [
         [[\"a\"], \"2\"],

diff --git a/tests/api-output/parseSetWindowProperty/object-path-1.toml b/tests/api-output/parseSetWindowProperty/object-path-1.toml
@@ -8,10 +8,14 @@ instructions = [
             }
             object = object[subPath];
         }
-        object[path[path.length - 1]] = value;
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
     }
     const parsePropDict = [
-        [[\"a\",\"b\"], \"2\"]
+        [[\"a\",\"b\"], 2]
     ];
     for (const [parsePropKey, parsePropValue] of parsePropDict) {
         setObjValue(window, parsePropKey, parsePropValue);

diff --git a/tests/api-output/parseSetWindowProperty/object-path-2.toml b/tests/api-output/parseSetWindowProperty/object-path-2.toml
@@ -8,7 +8,11 @@ instructions = [
             }
             object = object[subPath];
         }
-        object[path[path.length - 1]] = value;
+        if (value === undefined) {
+            delete object[path[path.length - 1]];
+        } else {
+            object[path[path.length - 1]] = value;
+        }
     }
     const parsePropDict = [
         [[\"a\"], \"2\"],

diff --git a/tests/ui/property.goml b/tests/ui/property.goml
@@ -11,10 +11,20 @@ assert-window-property-false: {"wa"."wo": "a"}
 set-window-property: {"wa"."wo": "a"}
 assert-window-property: {"wa"."wo": "a"}
 
+set-window-property: {"size": true}
+assert-window-property: {"size": true}
+set-window-property: {"size": 12}
+assert-window-property: {"size": 12}
+
 assert-document-property-false: {"size": "a"}
 set-document-property: {"size": "a"}
 assert-document-property: {"size": "a"}
 
+set-document-property: {"size": true}
+assert-document-property: {"size": true}
+set-document-property: {"size": 12}
+assert-document-property: {"size": 12}
+
 // object-path
 assert-document-property-false: {"wa"."wo": "a"}
 set-document-property: {"wa"."wo": "a"}

diff --git a/tools/api.js b/tools/api.js
@@ -2311,6 +2311,8 @@ function checkObjProperty(x, func) {
     func('{"a": "2", "a": {"b": 1}}', 'err-5');
 
     func('{"a": 2}', 'basic-1');
+    func('{"a": true}', 'basic-2');
+    func('{"a": "b"}', 'basic-3');
     func('{"a": "2", "\\"b": "\'b"}', 'escape-1');
 
     // object-path