browsergym-workarena 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

browsergym/workarena/tasks/compositional/filter_and_do.py

@@ -0,0 +1,139 @@
+from faker import Faker
+
+fake = Faker()
+
+from playwright.sync_api._generated import Page
+
+from browsergym.workarena.tasks.knowledge import KnowledgeBaseSearchTask
+from browsergym.workarena.tasks.list import FilterListTask
+from browsergym.workarena.tasks.navigation import AllMenuTask
+
+from .base import CompositionalTask
+
+from ..base import AbstractServiceNowTask
+
+from ...instance import SNowInstance
+
+
+class FilterAndDoTask(CompositionalTask):
+    def __init__(
+        self,
+        seed: int,
+        instance: SNowInstance = None,
+        fixed_config: list[AbstractServiceNowTask] = None,
+        navigation_config: dict = None,
+        protocol_name: str = None,
+        level: int = 2,
+    ) -> None:
+        """
+        Generic task to navigate to a specific page, run a filter and perform a task.
+
+        Parameters:
+        -----------
+        instance: SNowInstance
+            The ServiceNow instance to run the task on.
+        fixed_config: list[AbstractServiceNowTask]
+            A list of tuples, each containing a subtask
+        navigation_config: dict
+            Configuration to use for the navigation to the list that will be filtered. Contains application and module.
+            URL is not necessary as the navigation steps are not validated
+        protocol_name: str
+            The name of the protocol to refer to in the task description for L3.
+        level: int
+            The level of the task; choice between 2 and 3. L2 will have all the info in the the goal and start in the SNOW home page.
+            L3 will start in a private task page describing the information needed to complete the task and the related company protocol
+            to complete it.
+
+        Attributes:
+        -----------
+        filter_config: dict
+            Configuration to use for the filter that will be applied to the list. Contains filter_columns, filter_values and filter_kind in addition to the path to the expected fields in the list.
+            this is set by the _setup_list method.
+        tasks: List[AbstractServiceNowTask]
+            The tasks to perform after having filtered the list. Set by the child setup
+        task_description: str
+            The start of the task description to be completed. Provided by the child class.
+        short_description: str
+            A short description of the task to be completed. "Create a new user". Provided by the child class.
+        """
+        assert level in [2, 3], "Level must be either 2 or 3"
+        self.level = level
+        super().__init__(
+            seed=seed,
+            instance=instance,
+            fixed_config=fixed_config,
+            level=level,
+        )
+        self.used_in_level_2 = self.level == 2
+        self.navigation_config = navigation_config
+        self.filter_config = None
+        self.protocol_name = protocol_name
+        self.task_description = None
+        self.short_description = None
+        self.tasks = []
+
+    def _setup_list(self) -> None:
+        """Used to create the necessary records in the list + setting up the list filter attribute before filtering it."""
+        raise NotImplementedError
+
+    def setup_goal(self, page: Page) -> tuple[str, dict]:
+        self._setup_list()
+        config = self.fixed_config if self.fixed_config else self._get_config()
+
+        goal, info = super().setup_goal(page=page, config=config)
+
+        return goal, info
+
+    def _get_config(self) -> list[AbstractServiceNowTask]:
+        list_url = self.filter_config["list_url"]
+
+        navigate_to_protocol_config = [
+            # Navigate to the KB
+            AllMenuTask(
+                instance=self.instance,
+                fixed_config={
+                    "application": "Self-Service",
+                    "module": "Knowledge",
+                    "url": "/now/nav/ui/classic/params/target/%24knowledge.do",
+                },
+                is_validated=False,
+                used_in_level_2=False,
+            ),
+            # Find the protocol for on-boarding a new user
+            KnowledgeBaseSearchTask(
+                instance=self.instance,
+                fixed_config={
+                    "alternative_answers": [],
+                    "item": f"{self.protocol_name}",
+                    "question": f'Can you find the "{self.protocol_name}" Protocol in the Knowledge Base?',
+                    "value": "",
+                },
+                is_validated=False,
+                used_in_level_2=False,
+            ),
+        ]
+
+        config = [
+            # Navigate to the task start page
+            AllMenuTask(
+                instance=self.instance,
+                fixed_config=self.navigation_config,
+                is_validated=False,
+                used_in_level_2=True,
+            ),
+            # Filter the the list; the config it uses is set by the _setup_list method
+            FilterListTask(
+                instance=self.instance,
+                list_url=list_url,
+                fixed_config=self.filter_config,
+                expected_fields_path=self.filter_config["expected_fields_path"],
+                is_validated=False,
+                used_in_level_2=True,
+            ),
+        ] + self.tasks
+
+        # To support the option of having no protocol
+        if self.protocol_name:
+            config = navigate_to_protocol_config + config
+
+        return config

browsergym/workarena/tasks/compositional/find_and_order_item.py

@@ -0,0 +1,345 @@
+from faker import Faker
+
+fake = Faker()
+
+from browsergym.workarena.tasks.navigation import AllMenuTask
+from browsergym.workarena.tasks.send_chat_message import SendChatMessageGenericTask
+from browsergym.workarena.tasks.service_catalog import (
+    OrderDeveloperLaptopTask,
+    OrderIpadMiniTask,
+    OrderIpadProTask,
+    OrderSalesLaptopTask,
+    OrderStandardLaptopTask,
+    OrderAppleWatchTask,
+    OrderAppleMacBookPro15Task,
+    OrderDevelopmentLaptopPCTask,
+    OrderLoanerLaptopTask,
+)
+
+from .base import HumanEvalTask
+from .filter_and_do import FilterAndDoTask
+
+from ..base import AbstractServiceNowTask
+
+from ...api.requested_items import create_requested_item
+from ...api.user import create_user
+from ...api.utils import db_delete_from_table, table_api_call
+from ...config import (
+    # Expected columns for the different lists
+    EXPECTED_REQUESTED_ITEMS_COLUMNS_PATH,
+)
+from ...instance import SNowInstance
+
+
+class FilterRequestedItemsAndOrderCatalogItemTask(FilterAndDoTask, HumanEvalTask):
+    """Generic task to filter the requested items list to find what a given user has requested and order the same thing.
+    Args:
+    fixed_request_item: str
+        The requested item to find and order.
+    task_class: AbstractServiceNowTask
+        The class of the task to order the item.
+    """
+
+    def __init__(
+        self,
+        seed: int,
+        instance: SNowInstance = None,
+        fixed_config: list[AbstractServiceNowTask] = None,
+        fixed_request_item: str = None,
+        order_task_class: AbstractServiceNowTask = None,
+        level: int = 2,
+    ) -> None:
+        super().__init__(
+            seed=seed,
+            instance=instance,
+            fixed_config=fixed_config,
+            navigation_config={
+                "module": "Requested Items",
+                "application": "Self-Service",
+            },
+            level=level,
+            protocol_name="",
+        )
+        self.fixed_request_item = fixed_request_item
+        self.order_task_class = order_task_class
+        # name of the user the item will be assigned to
+        self.user_full_name = (
+            fake.first_name()
+            + "-"
+            + fake.first_name()
+            + " "
+            + fake.last_name()
+            + "-"
+            + fake.last_name()
+        )
+        self.short_description = f"Order same item as {self.user_full_name}"
+        self.task_description = f'{self.user_full_name} has recently requested an item from the service catalog. You need to order the same. Find what it is from the "Requested Items" list and order it from the service catalog. If possible, set the item\'s configuration to match the following: \n'
+        self.created_user_sys_id = None  # sys_id of the user to assign the item to
+        self.requested_item_sys_id = None  # sys_id of the requested item to order
+        self.tasks = []
+
+    def _setup_list(self) -> None:
+        self.filter_config = {
+            "list_url": "/now/nav/ui/classic/params/target/sc_req_item_list.do",
+            "expected_fields_path": EXPECTED_REQUESTED_ITEMS_COLUMNS_PATH,
+            "filter_columns": [
+                "requested_for",
+            ],
+            "filter_kind": "AND",
+            "filter_operators": ["contains"],
+            "filter_values": [
+                f"{self.user_full_name}",
+            ],
+        }
+        # Create a new user to assign the item to
+        first_name = self.user_full_name.split(" ")[0]
+        last_name = self.user_full_name.split(" ")[1]
+        _, _, self.created_user_sys_id = create_user(
+            self.instance, first_name=first_name, last_name=last_name, random=self.random
+        )
+        # Create a new requested item to order
+        self.requested_item_sys_id, _ = create_requested_item(
+            self.instance,
+            system_name=self.fixed_request_item,
+            user_sys_id=self.created_user_sys_id,
+        )
+        self.tasks.append(
+            # After the filter has been made and the information retrieved, navigate to the catalog
+            AllMenuTask(
+                instance=self.instance,
+                fixed_config={
+                    "module": "Service Catalog",
+                    "application": "Self-Service",
+                },
+                used_in_level_2=True,
+                is_validated=False,
+            )
+        )
+        self.tasks.append(
+            SendChatMessageGenericTask(
+                instance=self.instance,
+                message="a",
+                answer_format="a",
+                level=self.level,
+                description=f"Clear the existing filters on the page. \n",
+                is_validated=False,
+                use_description_in_l3=True,
+                used_in_level_2=True,
+            )
+        )
+        order_task_config = self.random.choice(self.order_task_class.all_configs())
+        # task to order the item
+        item_order_task = self.order_task_class(
+            seed=self.seed,
+            instance=self.instance,
+            fixed_config=order_task_config,
+            used_in_level_2=True,
+            is_validated=True,
+            config_only_in_desc=True,
+        )
+        self.tasks.append(item_order_task)
+
+    def teardown(self) -> None:
+        # Delete the requested item and the user if they exist
+        requested_item_exists = table_api_call(
+            instance=self.instance,
+            table="sc_req_item",
+            params={"sysparm_query": f"sys_id={self.requested_item_sys_id}"},
+        )["result"]
+        if requested_item_exists:
+            db_delete_from_table(
+                instance=self.instance,
+                table="sc_req_item",
+                sys_id=self.requested_item_sys_id,
+            )
+        user_exists = table_api_call(
+            instance=self.instance,
+            table="sys_user",
+            params={"sysparm_query": f"sys_id={self.created_user_sys_id}"},
+        )["result"]
+        if user_exists:
+            db_delete_from_table(
+                instance=self.instance,
+                table="sys_user",
+                sys_id=self.created_user_sys_id,
+            )
+
+        super().teardown()
+
+
+class FilterRequestedItemsAndOrderDeveloperLaptopTask(FilterRequestedItemsAndOrderCatalogItemTask):
+    def __init__(
+        self,
+        seed: int,
+        instance: SNowInstance = None,
+        fixed_config: list[AbstractServiceNowTask] = None,
+        level: int = 2,
+    ) -> None:
+        super().__init__(
+            seed=seed,
+            instance=instance,
+            fixed_config=fixed_config,
+            fixed_request_item="Developer Laptop (Mac)",
+            level=level,
+            order_task_class=OrderDeveloperLaptopTask,
+        )
+
+
+class FilterRequestedItemsAndOrderIpadMiniTask(FilterRequestedItemsAndOrderCatalogItemTask):
+    def __init__(
+        self,
+        seed: int,
+        instance: SNowInstance = None,
+        fixed_config: list[AbstractServiceNowTask] = None,
+        level: int = 2,
+    ) -> None:
+        super().__init__(
+            seed=seed,
+            instance=instance,
+            fixed_config=fixed_config,
+            fixed_request_item="iPad mini",
+            level=level,
+            order_task_class=OrderIpadMiniTask,
+        )
+
+
+class FilterRequestedItemsAndOrderIpadProTask(FilterRequestedItemsAndOrderCatalogItemTask):
+    def __init__(
+        self,
+        seed: int,
+        instance: SNowInstance = None,
+        fixed_config: list[AbstractServiceNowTask] = None,
+        level: int = 2,
+    ) -> None:
+        super().__init__(
+            seed=seed,
+            instance=instance,
+            fixed_config=fixed_config,
+            fixed_request_item="iPad pro",
+            level=level,
+            order_task_class=OrderIpadProTask,
+        )
+
+
+class FilterRequestedItemsAndOrderSalesLaptopTask(FilterRequestedItemsAndOrderCatalogItemTask):
+    def __init__(
+        self,
+        seed: int,
+        instance: SNowInstance = None,
+        fixed_config: list[AbstractServiceNowTask] = None,
+        level: int = 2,
+    ) -> None:
+        super().__init__(
+            seed=seed,
+            instance=instance,
+            fixed_config=fixed_config,
+            fixed_request_item="Sales Laptop",
+            level=level,
+            order_task_class=OrderSalesLaptopTask,
+        )
+
+
+class FilterRequestedItemsAndOrderStandardLaptopTask(FilterRequestedItemsAndOrderCatalogItemTask):
+    def __init__(
+        self,
+        seed: int,
+        instance: SNowInstance = None,
+        fixed_config: list[AbstractServiceNowTask] = None,
+        level: int = 2,
+    ) -> None:
+        super().__init__(
+            seed=seed,
+            instance=instance,
+            fixed_config=fixed_config,
+            fixed_request_item="Standard Laptop",
+            level=level,
+            order_task_class=OrderStandardLaptopTask,
+        )
+
+
+class FilterRequestedItemsAndOrderAppleWatchTask(FilterRequestedItemsAndOrderCatalogItemTask):
+    def __init__(
+        self,
+        seed: int,
+        instance: SNowInstance = None,
+        fixed_config: list[AbstractServiceNowTask] = None,
+        level: int = 2,
+    ) -> None:
+        super().__init__(
+            seed=seed,
+            instance=instance,
+            fixed_config=fixed_config,
+            fixed_request_item="Apple Watch",
+            level=level,
+            order_task_class=OrderAppleWatchTask,
+        )
+
+
+class FilterRequestedItemsAndOrderAppleMacBookPro15Task(
+    FilterRequestedItemsAndOrderCatalogItemTask
+):
+    def __init__(
+        self,
+        seed: int,
+        instance: SNowInstance = None,
+        fixed_config: list[AbstractServiceNowTask] = None,
+        level: int = 2,
+    ) -> None:
+        super().__init__(
+            seed=seed,
+            instance=instance,
+            fixed_config=fixed_config,
+            fixed_request_item='Apple MacBook Pro 15"',
+            level=level,
+            order_task_class=OrderAppleMacBookPro15Task,
+        )
+
+
+class FilterRequestedItemsAndOrderDevelopmentLaptopPCTask(
+    FilterRequestedItemsAndOrderCatalogItemTask
+):
+    def __init__(
+        self,
+        seed: int,
+        instance: SNowInstance = None,
+        fixed_config: list[AbstractServiceNowTask] = None,
+        level: int = 2,
+    ) -> None:
+        super().__init__(
+            seed=seed,
+            instance=instance,
+            fixed_config=fixed_config,
+            fixed_request_item="Development Laptop (PC)",
+            level=level,
+            order_task_class=OrderDevelopmentLaptopPCTask,
+        )
+
+
+class FilterRequestedItemsAndOrderLoanerLaptopTask(FilterRequestedItemsAndOrderCatalogItemTask):
+    def __init__(
+        self,
+        seed: int,
+        instance: SNowInstance = None,
+        fixed_config: list[AbstractServiceNowTask] = None,
+        level: int = 2,
+    ) -> None:
+        super().__init__(
+            seed=seed,
+            instance=instance,
+            fixed_config=fixed_config,
+            fixed_request_item="Notebook Computer Loaner",
+            level=level,
+            order_task_class=OrderLoanerLaptopTask,
+        )
+
+
+local_vars = locals().copy()
+
+__TASKS__ = [
+    var
+    for var in local_vars.values()
+    if isinstance(var, type)
+    and issubclass(var, FilterAndDoTask)
+    and var is not FilterAndDoTask
+    and var is not FilterRequestedItemsAndOrderCatalogItemTask
+]