changes to validators and data files for various tasks

Author: patricebechard

src/browsergym/workarena/__init__.py

@@ -35,6 +35,7 @@
 from .tasks.incident import __TASKS__ as INCIDENT_TASKS
 from .tasks.license import __TASKS__ as LICENSE_TASKS
 from .tasks.ritm import __TASKS__ as RITM_TASKS
+from .tasks.user_group import __TASKS__ as USER_GROUP_TASKS
 from .tasks.compositional.base import CompositionalTask
 
 ALL_WORKARENA_TASKS = [
@@ -68,6 +69,7 @@
     *LICENSE_TASKS,
     *RITM_TASKS,
     *FORM_WORKSPACE_TASKS,
+    *USER_GROUP_TASKS,
 ]
 
 

src/browsergym/workarena/config.py

@@ -304,6 +304,12 @@
 DEACTIVATE_USER_GROUP_CONFIG_PATH = str(
     resources.files(data_files).joinpath("task_configs/deactivate_user_group.json")
 )
+CREATE_USER_GROUP_CONFIG_PATH = str(
+    resources.files(data_files).joinpath("task_configs/create_user_group.json")
+)
+CREATE_USER_GROUP_ADD_USERS_CONFIG_PATH = str(
+    resources.files(data_files).joinpath("task_configs/create_user_group_add_users.json")
+)
 
 # service catalog tasks (dynamic guidance)
 ORDER_IPHONE_TASK_CONFIG_PATH = str(

src/browsergym/workarena/data_files/task_configs/create_user_group.json

@@ -0,0 +1,23 @@
+[
+    {
+        "name": "ITIL User Group",
+        "manager": "Pierre Salera",
+        "type": "itil",
+        "roles": "itil",
+        "goal": "Create an active user group named \"ITIL User Group\". Its manager is Pierre Salera, type is itil, and roles include itil"
+    },
+    {
+        "name": "Survey Admins",
+        "manager": "Alene Rabeck",
+        "type": "survey",
+        "roles": "survey_admin",
+        "goal": "Create an active user group named \"Survey Admins\". Its manager is Alene Rabeck, type is survey, and roles include survey_admin"
+    },
+    {
+        "name": "Catalog Managers",
+        "manager": "Zachary Mockus",
+        "type": "catalog",
+        "roles": "catalog_manager",
+        "goal": "Create an active user group named \"Catalog Managers\". Its manager is Zachary Mockus, type is catalog, and roles include catalog_manager"
+    }
+]

src/browsergym/workarena/data_files/task_configs/create_user_group_add_users.json

@@ -0,0 +1,20 @@
+[
+    {
+        "name": "NYC Coed Soccer",
+        "description": "We play at the Parade Grounds on Saturdays at 10",
+        "members": "Chad Araiza, Eva Seahorn, Floyd Veazey",
+        "goal": "Create an active user group with the name \"NYC Coed Soccer\" and description \"We play at the Parade Grounds on Saturdays at 10\". Add Chad Araiza, Eva Seahorn, Floyd Veazey to the group"
+    },
+    {
+        "name": "NYC Run Club",
+        "description": "We run Monday mornings at 7",
+        "members": "Chad Araiza, Eva Seahorn, Floyd Veazey",
+        "goal": "Create an active user group with the name \"NYC Run Club\" and description \"We run Monday mornings at 7\". Add Chad Araiza, Eva Seahorn, Floyd Veazey to the group"
+    },
+    {
+        "name": "NYC Happy Hour Group",
+        "description": "We get together for happy hour on Thursdays at 4",
+        "members": "Chad Araiza, Eva Seahorn, Floyd Veazey",
+        "goal": "Create an active user group with the name \"NYC Happy Hour Group\" and description \"We get together for happy hour on Thursdays at 4\". Add Chad Araiza, Eva Seahorn, Floyd Veazey to the group"
+    }
+]

src/browsergym/workarena/data_files/task_configs/order_reset_password.json

@@ -1,31 +1,31 @@
 [
     {
         "item": "SAP Payroll",
-        "contact": "Email",
+        "contact": "email",
         "quantity": 1,
         "goal": "Help me reset my password for SAP Payroll by submitting a request through the Service Catalog. Send the reset instructions to Email."
     },
     {
         "item": "PeopleSoft CRM",
-        "contact": "Telephone",
+        "contact": "phone",
         "quantity": 1,
         "goal": "Help me reset my password for PeopleSoft CRM by submitting a request through the Service Catalog. Send the reset instructions to Telephone."
     },
     {
         "item": "Workday Enterprise Services",
-        "contact": "SMS",
+        "contact": "sms",
         "quantity": 1,
         "goal": "Help me reset my password for Workday Enterprise Services by submitting a request through the Service Catalog. Send the reset instructions to SMS."
     },
     {
         "item": "Slack",
-        "contact": "Email",
+        "contact": "email",
         "quantity": 1,
         "goal": "Help me reset my password for Slack by submitting a request through the Service Catalog. Send the reset instructions to Email."
     },
     {
         "item": "Windows Mobile",
-        "contact": "SMS",
+        "contact": "sms",
         "quantity": 1,
         "goal": "Help me reset my password for Windows Mobile by submitting a request through the Service Catalog. Send the reset instructions to SMS."
     }

src/browsergym/workarena/tasks/change_request.py

@@ -123,15 +123,13 @@ def teardown(self) -> None:
         # revert the change request approver state to the initial state
         if self.change_request_approver_sys_id is not None:
             try:
-                table_api_call(
-                    instance=self.instance,
-                    table="sysapproval_approver",
-                    params={
-                        "sysparm_query": f"sys_id={self.change_request_approver_sys_id}",
-                        "sysparm_limit": 1,
+                requests.patch(
+                    f"{self.instance.snow_url}/api/now/table/sysapproval_approver/{self.change_request_approver_sys_id}",
+                    auth=self.instance.snow_credentials,
+                    headers={"Accept": "application/json"},
+                    json={
+                        "state": self.initial_change_request_approver_state,
                     },
-                    method="PUT",
-                    data={"state": self.initial_change_request_approver_state},
                 )
             except HTTPError:
                 pass

src/browsergym/workarena/tasks/incident.py

@@ -113,16 +113,13 @@ def teardown(self):
         # revert the additional_assignee_list to the initial value
         if self.initial_incident_additional_assignee_list is not None and self.config["additional_assignee_list"] != self.initial_incident_additional_assignee_list:
             try:
-                table_api_call(
-                    instance=self.instance,
-                    table="incident",
-                    params={
-                        "sysparm_query": f"number={self.config['incident_number']}",
-                    },
-                    data={
+                requests.patch(
+                    f"{self.instance.snow_url}/api/now/table/incident/{self.config['incident_number']}",
+                    auth=self.instance.snow_credentials,
+                    headers={"Accept": "application/json"},
+                    json={
                         "additional_assignee_list": self.initial_incident_additional_assignee_list,
                     },
-                    method="PUT",
                 )
             except HTTPError:
                 pass
@@ -282,7 +279,7 @@ def _get_initial_incident_info(self):
             headers={"Accept": "application/json"},
             params={
                 "sysparm_query": f"number={incident_number}",
-                "sysparm_fields": "sys_id,number,close_code,close_notes",
+                "sysparm_fields": "sys_id,number,close_code,close_notes,state",
                 "sysparm_limit": 1,
             },
         )
@@ -292,6 +289,7 @@ def _get_initial_incident_info(self):
             raise ValueError(f"Incident {incident_number} not found")
 
         self.incident_sys_id = result[0]["sys_id"]
+        self.initial_incident_state = result[0]["state"]
         self.initial_incident_close_code = result[0]["close_code"]        
 
     def all_configs(self):
@@ -359,6 +357,7 @@ def teardown(self) -> None:
                     json={
                         "close_code": self.initial_incident_close_code,
                         "close_notes": "",
+                        "state": self.initial_incident_state,
                     },
                 )
             except HTTPError:

src/browsergym/workarena/tasks/navigation.py

@@ -182,6 +182,29 @@ def get_pretty_printed_description(self) -> str:
     def cheat(self, page: Page, chat_messages: list[str]) -> None:
         pass
 
+    def validate(
+        self, page: playwright.sync_api.Page, chat_messages: list[str]
+    ) -> Tuple[float, bool, str, dict]:
+        # we're less strict on the validation here.
+        page.wait_for_load_state("domcontentloaded")
+
+        # Get the current URL and the final URL
+        current_url = parse.urlunparse(
+            parse.urlparse(parse.unquote(page.evaluate("() => window.location.href")))
+        )
+        final_url_tmp = self.module.get("url", "INVALID")
+        final_url = parse.urlunparse(parse.urlparse(parse.unquote(final_url_tmp)))
+
+        if final_url in current_url:
+            return (
+                1,
+                True,
+                "Nice work, thank you!",
+                {"message": "Correct module reached."},
+            )
+
+        return 0, False, "", {"message": "Not at expected URL."}
+
 class ImpersonationTask(AbstractServiceNowTask):
     """
     Task to impersonate a user.

src/browsergym/workarena/tasks/ritm.py

@@ -124,24 +124,18 @@ def teardown(self) -> None:
         # revert to previous state
         if self.initial_approval and self.initial_approval != self.config["approval"]:
             try:
-                table_api_call(
-                    instance=self.instance,
-                    table="sc_req_item",
-                    params={
-                        "sysparm_query": f"number={self.config['ritm_number']}",
-                        "sysparm_fields": "sys_id,number,approval",
-                        "sysparm_limit": 1,
-                    },
-                    data={
+                requests.patch(
+                    f"{self.instance.snow_url}/api/now/table/sc_req_item/{self.record_sys_id}",
+                    auth=self.instance.snow_credentials,
+                    headers={"Accept": "application/json"},
+                    json={
                         "approval": self.initial_approval,
                     },
-                    method="PUT",
                 )
             except HTTPError:
                 # sys_id was stored in local storage (for submitted)
                 # but the record is absent from the database (probably invalid form)
-                pass
-            
+                pass            
 
 class UpdateRitmQuantityTask(ServiceNowRitmTask):
 
@@ -215,24 +209,19 @@ def validate(self, page: playwright.sync_api.Page, chat_messages: List[str]) ->
     def teardown(self) -> None:
         if self.initial_quantity and self.initial_quantity != self.config["quantity"]:
             try:
-                table_api_call(
-                    instance=self.instance,
-                    table="sc_req_item",
-                    params={
-                        "sysparm_query": f"number={self.config['ritm_number']}",
-                        "sysparm_fields": "sys_id,number,quantity",
-                        "sysparm_limit": 1,
-                    },
-                    data={
+                requests.patch(
+                    f"{self.instance.snow_url}/api/now/table/sc_req_item/{self.record_sys_id}",
+                    auth=self.instance.snow_credentials,
+                    headers={"Accept": "application/json"},
+                    json={
                         "quantity": self.initial_quantity,
                     },
-                    method="PUT",
                 )
             except HTTPError:
                 # sys_id was stored in local storage (for submitted)
                 # but the record is absent from the database (probably invalid form)
                 pass
-
+    
 __TASKS__ = [
     ChangeRitmStatusTask,
     UpdateRitmQuantityTask,