Observation feature hide_bid_if_invisible (#43)

* hide_bid_if_invisible feature

* version bump 0.3.3

* ci tests

core/src/browsergym/core/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.3.3dev"
+__version__ = "0.3.3"
 
 import playwright.sync_api
 

core/src/browsergym/utils/obs.py

@@ -37,6 +37,7 @@ def flatten_dom_to_str(
     filter_with_bid_only: bool = False,
     filter_som_only: bool = False,
     coord_decimals: int = 0,
+    hide_bid_if_invisible: int = False,
 ) -> str:
     """Formats a DOM snapshot into a string text"""
 
@@ -131,7 +132,13 @@ def dfs(node_idx: int, parent_node_skipped: bool) -> str:
                 attributes = extra_attributes_to_print + attributes
 
                 # insert bid as first attribute
-                if bid is not None:
+                if not (
+                    bid is None
+                    or (
+                        hide_bid_if_invisible
+                        and extra_properties.get(bid, {}).get("visibility", 0) < 0.5
+                    )
+                ):
                     attributes.insert(0, f'bid="{bid}"')
 
                 if not skip_node:
@@ -293,6 +300,7 @@ def flatten_axtree_to_str(
     ignored_roles=IGNORED_AXTREE_ROLES,
     ignored_properties=IGNORED_AXTREE_PROPERTIES,
     remove_redundant_static_text: bool = True,
+    hide_bid_if_invisible: bool = False,
 ) -> str:
     """Formats the accessibility tree into a string text"""
     node_id_to_idx = {}
@@ -372,7 +380,13 @@ def dfs(node_idx: int, depth: int, parent_node_filtered: bool) -> str:
             if not skip_node:
                 node_str = f"{node_role} {repr(node_name.strip())}"
 
-                if bid is not None:
+                if not (
+                    bid is None
+                    or (
+                        hide_bid_if_invisible
+                        and extra_properties.get(bid, {}).get("visibility", 0) < 0.5
+                    )
+                ):
                     node_str = f"[{bid}] " + node_str
 
                 if node_value is not None:

core/tests/test_observation.py

@@ -390,6 +390,17 @@ def test_dom_to_text():
     assert "Text within in non-html tag" in dom
     assert "Text that should not be visible" not in dom
 
+    dom = flatten_dom_to_str(
+        obs["dom_object"],
+        extra_properties=obs["extra_element_properties"],
+        hide_bid_if_invisible=True,
+    )
+    assert "<title" in dom
+    assert "<title bid=" not in dom
+    assert 'type="submit" value="Submit"' in dom
+    assert "Text within in non-html tag" in dom
+    assert "Text that should not be visible" in dom
+
     dom = flatten_dom_to_str(
         obs["dom_object"],
         extra_properties=obs["extra_element_properties"],
@@ -449,16 +460,17 @@ def test_axtree_to_text():
     assert 'box="(' in axtree
     assert 'center="(' in axtree
     assert ", clickable, visible, som" in axtree
-    assert "heading 'Simple Form', box=\"(" in axtree
-    assert "textbox 'Email:' value='[email protected]'" in axtree
+    assert "] heading 'Simple Form', box=\"(" in axtree
+    assert "] textbox 'Email:' value='[email protected]'" in axtree
     assert "Text within in non-html tag" in axtree
     assert "Text that should not be visible" in axtree
+    assert "] paragraph" in axtree
 
     axtree = flatten_axtree_to_str(
         obs["axtree_object"], extra_properties=obs["extra_element_properties"], filter_som_only=True
     )
     assert "LabelText" not in axtree
-    assert "button 'Submit'" in axtree
+    assert "] button 'Submit'" in axtree
     assert "Text within in non-html tag" not in axtree
     assert "Text that should not be visible" not in axtree
 
@@ -468,9 +480,22 @@ def test_axtree_to_text():
         filter_visible_only=True,
     )
     assert "RootWebArea" in axtree
-    assert "button 'Submit'" in axtree
+    assert "] button 'Submit'" in axtree
     assert "Text within in non-html tag" in axtree
     assert "Text that should not be visible" not in axtree
+    assert "] paragraph" not in axtree
+
+    axtree = flatten_axtree_to_str(
+        obs["axtree_object"],
+        extra_properties=obs["extra_element_properties"],
+        hide_bid_if_invisible=True,
+    )
+    assert "RootWebArea" in axtree
+    assert "] button 'Submit'" in axtree
+    assert "Text within in non-html tag" in axtree
+    assert "Text that should not be visible" in axtree
+    assert "] paragraph '" not in axtree
+    assert "paragraph '" in axtree
 
     axtree = flatten_axtree_to_str(
         obs["axtree_object"],

experiments/requirements.txt

@@ -1,2 +1,2 @@
-browsergym-core==0.3.3dev
+browsergym-core==0.3.3
 tiktoken>=0.4

miniwob/requirements.txt

@@ -1 +1 @@
-browsergym-core==0.3.3dev
+browsergym-core==0.3.3

pyproject.toml

@@ -25,12 +25,12 @@ classifiers = [
     "Topic :: Scientific/Engineering :: Artificial Intelligence",
     "License :: OSI Approved :: Apache Software License",
 ]
-version="0.3.3dev"
+version="0.3.3"
 dependencies = [
-    "browsergym-core==0.3.3dev",
-    "browsergym-miniwob==0.3.3dev",
-    "browsergym-webarena==0.3.3dev",
-    "browsergym-experiments==0.3.3dev",
+    "browsergym-core==0.3.3",
+    "browsergym-miniwob==0.3.3",
+    "browsergym-webarena==0.3.3",
+    "browsergym-experiments==0.3.3",
     "browsergym-workarena",
 ]
 

webarena/requirements.txt

@@ -1,2 +1,2 @@
-browsergym-core==0.3.3dev
+browsergym-core==0.3.3
 libwebarena==0.0.3