browsergym-workarena 0.4.2__py3-none-any.whl → 0.4.4__py3-none-any.whl

browsergym/workarena/install.py

@@ -10,6 +10,7 @@ from tenacity import retry, stop_after_attempt, retry_if_exception_type
 from requests import HTTPError
 from time import sleep
 
+from .api.system_properties import get_sys_property, set_sys_property
 from .api.ui_themes import get_workarena_theme_variants
 from .api.user import create_user
 from .api.utils import table_api_call, table_column_info
@@ -38,7 +39,7 @@ from .config import (
     EXPECTED_USER_FORM_FIELDS_PATH,
     # Patch flag for reports
     REPORT_PATCH_FLAG,
-    REPORT_DATE_FILTER,
+    REPORT_FILTER_PROPERTY,
     # Supported ServiceNow releases
     SNOW_SUPPORTED_RELEASES,
     # For workflows setup
@@ -51,51 +52,22 @@ from .instance import SNowInstance
 from .utils import url_login
 
 
-def _set_sys_property(property_name: str, value: str):
+def _is_dev_portal_instance() -> bool:
     """
-    Set a sys_property in the instance.
+    Check if the instance is a ServiceNow Developer Portal instance.
 
-    """
-    instance = SNowInstance()
-
-    property = table_api_call(
-        instance=instance,
-        table="sys_properties",
-        params={"sysparm_query": f"name={property_name}", "sysparm_fields": "sys_id"},
-    )["result"]
-
-    if not property:
-        property_sysid = ""
-        method = "POST"
-    else:
-        property_sysid = "/" + property[0]["sys_id"]
-        method = "PUT"
-
-    property = table_api_call(
-        instance=instance,
-        table=f"sys_properties{property_sysid}",
-        method=method,
-        json={"name": property_name, "value": value},
-    )
-
-    # Verify that the property was updated
-    assert property["result"]["value"] == value, f"Error setting {property_name}."
-
-
-def _get_sys_property(property_name: str) -> str:
-    """
-    Get a sys_property from the instance.
+    Returns:
+    --------
+    bool: True if the instance is a developer portal instance, False otherwise.
 
     """
     instance = SNowInstance()
-
-    property_value = table_api_call(
-        instance=instance,
-        table="sys_properties",
-        params={"sysparm_query": f"name={property_name}", "sysparm_fields": "value"},
-    )["result"][0]["value"]
-
-    return property_value
+    # Check if the instance url has the for devXXXXXX.service-now.com format (where X is a digit)
+    if re.match(r"^https?://dev\d{6}\.service-now\.com", instance.snow_url):
+        logging.info("Detected a developer portal instance...")
+        return True
+    logging.info("Detected an internal instance...")
+    return False
 
 
 def _install_update_set(path: str, name: str):
@@ -797,7 +769,9 @@ def enable_url_login():
     Configure the instance to allow login via URL.
 
     """
-    _set_sys_property(property_name="glide.security.restrict.get.login", value="false")
+    set_sys_property(
+        instance=SNowInstance(), property_name="glide.security.restrict.get.login", value="false"
+    )
     logging.info("URL login enabled.")
 
 
@@ -808,7 +782,21 @@ def disable_password_policies():
     Notes: this is required to allow the creation of users with weak passwords.
 
     """
-    _set_sys_property(property_name="glide.security.password.policy.enabled", value="false")
+    set_sys_property(
+        instance=SNowInstance(),
+        property_name="glide.security.password.policy.enabled",
+        value="false",
+    )
+    set_sys_property(
+        instance=SNowInstance(), property_name="glide.apply.password_policy.on_login", value="false"
+    )
+    # The following is not supported on developer portal instances
+    if not _is_dev_portal_instance():
+        set_sys_property(
+            instance=SNowInstance(),
+            property_name="glide.authenticate.api.user.reset_password.mandatory",
+            value="false",
+        )
     logging.info("Password policies disabled.")
 
 
@@ -817,8 +805,14 @@ def disable_guided_tours():
     Hide guided tour popups
 
     """
-    _set_sys_property(property_name="com.snc.guided_tours.sp.enable", value="false")
-    _set_sys_property(property_name="com.snc.guided_tours.standard_ui.enable", value="false")
+    set_sys_property(
+        instance=SNowInstance(), property_name="com.snc.guided_tours.sp.enable", value="false"
+    )
+    set_sys_property(
+        instance=SNowInstance(),
+        property_name="com.snc.guided_tours.standard_ui.enable",
+        value="false",
+    )
     logging.info("Guided tours disabled.")
 
 
@@ -836,7 +830,9 @@ def disable_analytics_popups():
     Disable analytics popups (needs to be done through UI since Vancouver release)
 
     """
-    _set_sys_property(property_name="glide.analytics.enabled", value="false")
+    set_sys_property(
+        instance=SNowInstance(), property_name="glide.analytics.enabled", value="false"
+    )
     logging.info("Analytics popups disabled.")
 
 
@@ -850,7 +846,8 @@ def setup_ui_themes():
     check_ui_themes_installed()
 
     logging.info("Setting default UI theme")
-    _set_sys_property(
+    set_sys_property(
+        instance=SNowInstance(),
         property_name="glide.ui.polaris.theme.custom",
         value=get_workarena_theme_variants(SNowInstance())[0]["theme.sys_id"],
     )
@@ -894,7 +891,9 @@ def check_ui_themes_installed():
 
 def set_home_page():
     logging.info("Setting default home page")
-    _set_sys_property(property_name="glide.login.home", value="/now/nav/ui/home")
+    set_sys_property(
+        instance=SNowInstance(), property_name="glide.login.home", value="/now/nav/ui/home"
+    )
 
 
 def wipe_system_admin_preferences():
@@ -918,9 +917,9 @@ def wipe_system_admin_preferences():
         )
 
 
-def is_report_filter_using_time(filter):
+def is_report_filter_using_relative_time(filter):
     """
-    Heuristic to check if a report is filtering based on time
+    Heuristic to check if a report is filtering based on relative time
 
     This aims to detect the use of functions like "gs.endOfToday()". To avoid hardcoding all of them,
     we simply check for the use of keywords. Our filter is definitely too wide, but that's ok.
@@ -938,6 +937,32 @@ def patch_report_filters():
     logging.info("Patching reports with date filter...")
 
     instance = SNowInstance()
+    filter_config = instance.report_filter_config
+
+    # If the report date filter is already set, we use the existing values (would be the case on reinstall)
+    if not filter_config:
+        # Set the report date filter to current date as YYYY-MM-DD and time filter to current time as HH:MM:SS
+        now = datetime.now()
+        report_date_filter = now.strftime("%Y-%m-%d")
+        report_time_filter = now.strftime("%H:%M:%S")
+        # ... save the filter config
+        logging.info(
+            f"Setting report date filter to {report_date_filter} and time filter to {report_time_filter} via {REPORT_FILTER_PROPERTY}"
+        )
+        set_sys_property(
+            instance=instance,
+            property_name=REPORT_FILTER_PROPERTY,
+            value=json.dumps(
+                {"report_date_filter": report_date_filter, "report_time_filter": report_time_filter}
+            ),
+        )
+    else:
+        # Use the existing configuration
+        logging.info(
+            f"Using existing report date filter {filter_config['report_date_filter']} and time filter {filter_config['report_time_filter']}"
+        )
+        report_date_filter = filter_config["report_date_filter"]
+        report_time_filter = filter_config["report_time_filter"]
 
     # Get all reports that are not already patched
     reports = table_api_call(
@@ -959,27 +984,31 @@ def patch_report_filters():
                 logging.info(f"Discarding report {report['title']} {report['sys_id']}...")
                 raise NotImplementedError()  # Mark for deletion
 
-            if not is_report_filter_using_time(report["filter"]):
+            if not is_report_filter_using_relative_time(report["filter"]):
                 # That's a report we want to keep (use date cutoff filter)
-                filter_date = REPORT_DATE_FILTER
+                filter_date = report_date_filter
+                filter_time = report_time_filter
                 logging.info(
                     f"Keeping report {report['title']} {report['sys_id']} (columns: {sys_created_on_cols})..."
                 )
             else:
-                # XXX: We do not support reports with filters that rely on time (e.g., last 10 days) because
+                # XXX: We do not support reports with filters that rely on relative time (e.g., last 10 days) because
                 #      there are not stable. In this case, we don't delete them but add a filter to make
                 #      them empty. They will be shown as "No data available".
                 logging.info(
                     f"Disabling report {report['title']} {report['sys_id']} because it uses time filters..."
                 )
                 filter_date = "1900-01-01"
+                filter_time = "00:00:00"
 
+            # Format the filter
             filter = "".join(
                 [
-                    f"^{col}<javascript:gs.dateGenerate('{filter_date}','00:00:00')"
+                    f"^{col}<javascript:gs.dateGenerate('{filter_date}','{filter_time}')"
                     for col in sys_created_on_cols
                 ]
             ) + ("^" if len(report["filter"]) > 0 and not report["filter"].startswith("^") else "")
+            # Patch the report with the new filter
             table_api_call(
                 instance=instance,
                 table=f"sys_report/{report['sys_id']}",
@@ -1055,7 +1084,11 @@ def setup():
 
     # Save installation date
     logging.info("Saving installation date")
-    _set_sys_property(property_name="workarena.installation.date", value=datetime.now().isoformat())
+    set_sys_property(
+        instance=SNowInstance(),
+        property_name="workarena.installation.date",
+        value=datetime.now().isoformat(),
+    )
 
     logging.info("WorkArena setup complete.")
 
@@ -1068,7 +1101,9 @@ def main():
     logging.basicConfig(level=logging.INFO)
 
     try:
-        past_install_date = _get_sys_property("workarena.installation.date")
+        past_install_date = get_sys_property(
+            instance=SNowInstance(), property_name="workarena.installation.date"
+        )
         logging.info(f"Detected previous installation on {past_install_date}. Reinstalling...")
     except:
         past_install_date = "never"

browsergym/workarena/instance.py

@@ -1,3 +1,4 @@
+import json
 import os
 import requests
 import re
@@ -5,7 +6,7 @@ import re
 from playwright.sync_api import sync_playwright
 from typing import Optional
 
-from .config import SNOW_BROWSER_TIMEOUT
+from .config import SNOW_BROWSER_TIMEOUT, REPORT_FILTER_PROPERTY
 
 
 class SNowInstance:
@@ -124,3 +125,25 @@ class SNowInstance:
             browser.close()
 
         return release_info
+
+    @property
+    def report_filter_config(self) -> dict:
+        """
+        Get the report filter configuration from the ServiceNow instance.
+
+        Returns:
+        --------
+        dict
+            The report filter configuration, or an empty dictionary if not found.
+
+        """
+        from .api.system_properties import (
+            get_sys_property,
+        )  # Import here to avoid circular import issues
+
+        try:
+            config = get_sys_property(self, REPORT_FILTER_PROPERTY)
+            config = json.loads(config)
+            return config
+        except Exception:
+            return None

browsergym/workarena/tasks/dashboard.py

@@ -19,7 +19,6 @@ from ..config import (
     DASHBOARD_RETRIEVAL_VALUE_CONFIG_PATH,
     REPORT_RETRIEVAL_MINMAX_CONFIG_PATH,
     REPORT_RETRIEVAL_VALUE_CONFIG_PATH,
-    REPORT_DATE_FILTER,
     REPORT_PATCH_FLAG,
 )
 from ..instance import SNowInstance
@@ -30,6 +29,15 @@ from .utils.utils import check_url_suffix_match
 #      - We currently don't support maps because they are clickable and would require a more evolved cheat function
 SUPPORTED_PLOT_TYPES = ["area", "bar", "column", "line", "pie", "spline"]
 
+# Get report filter config
+config = SNowInstance().report_filter_config
+if config is None:
+    REPORT_DATE_FILTER = REPORT_TIME_FILTER = None
+else:
+    REPORT_DATE_FILTER = config["report_date_filter"]
+    REPORT_TIME_FILTER = config["report_time_filter"]
+del config
+
 
 class DashboardRetrievalTask(AbstractServiceNowTask, ABC):
     """
@@ -298,13 +306,22 @@ class DashboardRetrievalTask(AbstractServiceNowTask, ABC):
     def setup_goal(self, page: playwright.sync_api.Page) -> Tuple[str | dict]:
         super().setup_goal(page=page)
 
+        # Check that the report filters are properly setup
+        if REPORT_DATE_FILTER is None or REPORT_TIME_FILTER is None:
+            raise RuntimeError(
+                "The report date and time filters are not set. Please run the install script to set them."
+            )
+
         # Configure task
         # ... sample a configuration
         self.config = (
             self.fixed_config if self.fixed_config else self.random.choice(self.all_configs())
         )
         # ... set start URL based on config
-        self.start_url = self.instance.snow_url + self.config["url"]
+        # ...... some of the reports have need a date filter to be applied so we do this by patching a placeholder in the URL
+        self.start_url = self.instance.snow_url + self.config["url"].replace(
+            "REPORT_DATE_FILTER", REPORT_DATE_FILTER
+        ).replace("REPORT_TIME_FILTER", REPORT_TIME_FILTER)
 
         # Produce goal string based on question type
         chart_locator = (
@@ -603,6 +620,8 @@ class DashboardRetrievalTask(AbstractServiceNowTask, ABC):
         """
         Generate a random configuration for the task
 
+        This can be used to regenerate configs that are valid under an updated date filter.
+
         Parameters:
         -----------
         page: playwright.sync_api.Page
@@ -613,6 +632,12 @@ class DashboardRetrievalTask(AbstractServiceNowTask, ABC):
             The types of questions to sample from (uniformely)
 
         """
+        # Check that the report filters are properly setup
+        if REPORT_DATE_FILTER is None or REPORT_TIME_FILTER is None:
+            raise RuntimeError(
+                "The report date and time filters are not set. Please run the install script to set them."
+            )
+
         # Generate a bunch of reports based on valid table fields
         ON_THE_FLY_REPORTS = []
         for table in [
@@ -674,7 +699,8 @@ class DashboardRetrievalTask(AbstractServiceNowTask, ABC):
 
             # On the fly generated report
             if not report.get("sys_id", None):
-                url = f"/now/nav/ui/classic/params/target/sys_report_template.do%3Fsysparm_field%3D{report['field']}%26sysparm_type%3D{report['type']}%26sysparm_table%3D{report['table']}%26sysparm_from_list%3Dtrue%26sysparm_chart_size%3Dlarge%26sysparm_manual_labor%3Dtrue%26sysparm_query=sys_created_on<javascript:gs.dateGenerate('{REPORT_DATE_FILTER}','00:00:00')^EQ"
+                # ... these receive a filter that is added through the URL
+                url = f"/now/nav/ui/classic/params/target/sys_report_template.do%3Fsysparm_field%3D{report['field']}%26sysparm_type%3D{report['type']}%26sysparm_table%3D{report['table']}%26sysparm_from_list%3Dtrue%26sysparm_chart_size%3Dlarge%26sysparm_manual_labor%3Dtrue%26sysparm_query=sys_created_on<javascript:gs.dateGenerate('{REPORT_DATE_FILTER}','{REPORT_TIME_FILTER}')^EQ"
             # Report from the database
             else:
                 url = f"/now/nav/ui/classic/params/target/sys_report_template.do%3Fjvar_report_id={report['sys_id']}"

{browsergym_workarena-0.4.2.dist-info → browsergym_workarena-0.4.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: browsergym-workarena
-Version: 0.4.2
+Version: 0.4.4
 Summary: WorkArena benchmark for BrowserGym
 Project-URL: homepage, https://github.com/ServiceNow/WorkArena
 Author: Léo Boisvert, Alex Drouin, Maxime Gasse, Alex Lacoste, Manuel Del Verme, Megh Thakkar

{browsergym_workarena-0.4.2.dist-info → browsergym_workarena-0.4.4.dist-info}/RECORD

@@ -1,7 +1,7 @@
-browsergym/workarena/__init__.py,sha256=4tXIdcxacjmC3AjbzOQBrX2PrM_lEq_1UbmXKCv1_fk,6289
-browsergym/workarena/config.py,sha256=tblmOUpqSoL3qlQHK_TFEDSFbC3o2kuRP_GFpoTNsX4,8522
-browsergym/workarena/install.py,sha256=iEps7IkXFObJaQlE9t78LUFvoqsfKsQbcLLvuFIfBK8,39728
-browsergym/workarena/instance.py,sha256=-w21jT-lnXVWtUolJbuTKsPuULvq-Qa-j9FwdfNJrmE,4343
+browsergym/workarena/__init__.py,sha256=gqvx_SVwq31CU-T1XoNP9EDZsjivUgMCXS7lbH_uc84,6289
+browsergym/workarena/config.py,sha256=Fmx4sl3B1Ee2m2fGnnEYJfsQ0TkCV0VdKhNZ-gNytRU,8608
+browsergym/workarena/install.py,sha256=Dy9cTbT_LMDW0Dhmd2CpVnj4W_aB-xaxPubjGRTThxQ,41493
+browsergym/workarena/instance.py,sha256=pLlYBrKu-GCwYPzfYO2w0BYc2u_n5jMt3HZdpplCD40,4997
 browsergym/workarena/utils.py,sha256=mD6RqVua-m1-mKM1RGGlUEu1s6un0ZI9a5ZTPN7g1hY,3199
 browsergym/workarena/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 browsergym/workarena/api/category.py,sha256=4oiwPnRas0ZWCdky76zhNpu_9PfB_HmhnFa_DJZyGfA,2084
@@ -15,6 +15,7 @@ browsergym/workarena/api/problem.py,sha256=QEr9uwUCOvVZcz7Or9bKkb7aCIrP7LSPulvfO
 browsergym/workarena/api/report.py,sha256=nNSTcM4mKE9GXjlm787iAlK5Q71oQbWdUcVvl0GlpeE,6903
 browsergym/workarena/api/requested_items.py,sha256=g0X0sA1v8bAQzz9jfpATqSctUNNOTD547D6EH5Z4sw0,1678
 browsergym/workarena/api/requests.py,sha256=z2vQTTkm1HR04_d_pce6jopuN--Oh0gUaT-YhrVa9-8,4148
+browsergym/workarena/api/system_properties.py,sha256=-DysHuUTfH82tkQGOalNdtql-2yeGWEH5QBaYTpBKh4,1648
 browsergym/workarena/api/ui_themes.py,sha256=9H8HhnqHWt0CA5X5E1sokkXSCYYxtWZvhNFcXn3e90s,836
 browsergym/workarena/api/user.py,sha256=mLx8r4RFVAuw66514xniv5sn_O4kwjAsVf-iCQC9aJk,4821
 browsergym/workarena/api/utils.py,sha256=sulU1rC6jiCyDVwn5PqPK0AC-6m-GJS_4Crzar6pENU,5000
@@ -63,8 +64,8 @@ browsergym/workarena/data_files/task_configs/order_ipad_pro_task.json,sha256=gR5
 browsergym/workarena/data_files/task_configs/order_loaner_laptop_task.json,sha256=g_BDRnvn5wm7rRcISdmT197-4MDe2QfsWmY5FnCG7Tc,183107
 browsergym/workarena/data_files/task_configs/order_sales_laptop_task.json,sha256=6IGZg5NE2pjrUeDyOajk3Z2F4TCjqBRLS9VPh7lEu5Q,707828
 browsergym/workarena/data_files/task_configs/order_standard_laptop_task.json,sha256=qSh8lM13RgQyaKAzNIwAM0B84iZvSOgY1FQEAGeawaA,516203
-browsergym/workarena/data_files/task_configs/report_retrieval_minmax_task.json,sha256=MnM4iuo9kIQLh2pswgxEhTc0RGWRWxJnMl7afXBiVIc,112107
-browsergym/workarena/data_files/task_configs/report_retrieval_value_task.json,sha256=wDPrRXaF8FtKAD3Y1zWnwsDYEEcbjf1rUkIa5en-gn4,327974
+browsergym/workarena/data_files/task_configs/report_retrieval_minmax_task.json,sha256=RwuWHi8W_cgWGF37-cf4mLx5A7WEr4Io8R8kV-HqjpM,116571
+browsergym/workarena/data_files/task_configs/report_retrieval_value_task.json,sha256=GKAw70L_00SoDSgr4anJmipyulkfy2krdxzC_VsKZig,339350
 browsergym/workarena/data_files/task_configs/sort_asset_list_task.json,sha256=CxGupg15OFAT8z0ddieTJnIOQ1xHqCJJkqPgZI1sJNA,44721
 browsergym/workarena/data_files/task_configs/sort_change_request_list_task.json,sha256=dmYPzs86MGzD-j_h8bEiynH9LWdfm12a2Z5PkSJ7-dc,45862
 browsergym/workarena/data_files/task_configs/sort_hardware_list_task.json,sha256=iE5RmskNfiw-6CajMgmB75oxyJ8qu5JIjJugHf1NNPQ,45127
@@ -76,7 +77,7 @@ browsergym/workarena/human_eval/tool.py,sha256=SwPqArNnvEeOPLRgem6kwl8ho345o-1f3
 browsergym/workarena/tasks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 browsergym/workarena/tasks/base.py,sha256=Ikh_A5I9_9acHFQCcnVMEnlBg3u3QHQD2I_NbGvD6SE,6411
 browsergym/workarena/tasks/comp_building_block.py,sha256=Lg3KbAWrxzAHe5XbPN6L8bvdu7mfJpmBvI7jXeSDwKE,194
-browsergym/workarena/tasks/dashboard.py,sha256=HDGygBVtUM88lWKkUjyd43JvqmGUOPjmGfmRPkTJruE,34199
+browsergym/workarena/tasks/dashboard.py,sha256=LnLRyn6VdQVZyCYJtQl51UKh-aQxuNZIvWcSKVC5WI8,35435
 browsergym/workarena/tasks/form.py,sha256=_s07yZ-zcZbi5v6VK6km1BPzUfIFfMEVWFm56QhoznM,64141
 browsergym/workarena/tasks/knowledge.py,sha256=kANjlC7DpptMbRlUlZGdDjqZeWIwwyJzozV58qEA6KU,13751
 browsergym/workarena/tasks/list.py,sha256=7eb9F1JooLzFGIciul2_E1bCmNyBo5AzOPozO1p1HaM,55778
@@ -131,8 +132,8 @@ browsergym/workarena/tasks/utils/js_utils.js,sha256=n97fmY2Jkr59rEcQSuSbCnn1L2ZN
 browsergym/workarena/tasks/utils/private_tasks.py,sha256=r7Z9SnBMuZdZ2i-tK6eULj0q8hclANXFSzdLl49KYHI,2128
 browsergym/workarena/tasks/utils/string.py,sha256=ir5_ASD9QSFMZ9kuHo2snSXRuSfv_wROH6nxBLOTP4I,330
 browsergym/workarena/tasks/utils/utils.py,sha256=xQD-njEwgN7qxfn1dLBN8MYfd3kl3TuVfpmI1yxML9k,955
-browsergym_workarena-0.4.2.dist-info/METADATA,sha256=SV-hDJ1zdD4tS1ZKbfZCj86F2PphPAgY0X-JEY7w8CY,11698
-browsergym_workarena-0.4.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-browsergym_workarena-0.4.2.dist-info/entry_points.txt,sha256=1lCeAbQFCcU6UTFwS5QIA3TKhT2P9ZabaZKT7sIShKc,137
-browsergym_workarena-0.4.2.dist-info/licenses/LICENSE,sha256=sZLFiZHo_1hcxXRhXUDnQYVATUuWwRCdQjBxqxNnNEs,579
-browsergym_workarena-0.4.2.dist-info/RECORD,,
+browsergym_workarena-0.4.4.dist-info/METADATA,sha256=Oh9OgOSknd_krKVFxUzvq2dtZN70-VBLoINxi31s6co,11698
+browsergym_workarena-0.4.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+browsergym_workarena-0.4.4.dist-info/entry_points.txt,sha256=1lCeAbQFCcU6UTFwS5QIA3TKhT2P9ZabaZKT7sIShKc,137
+browsergym_workarena-0.4.4.dist-info/licenses/LICENSE,sha256=sZLFiZHo_1hcxXRhXUDnQYVATUuWwRCdQjBxqxNnNEs,579
+browsergym_workarena-0.4.4.dist-info/RECORD,,