Class SimBrowserClient

posthog/demo/matrix/models.py:160–284

A browser client for simulating client-side tracking.

class SimBrowserClient(SimClient):
    """A browser client for simulating client-side tracking."""

    LIB_NAME = "web"

    # Parent
    person: "SimPerson"

    # Properties
    device_id: str
    device_type: str
    os: str
    browser: str

    # State
    active_distinct_id: str
    active_session_id: Optional[str]
    super_properties: Properties
    current_url: Optional[str]
    is_logged_in: bool

    def __init__(self, person: "SimPerson"):
        self.person = person
        self.matrix = person.cluster.matrix
        self.device_type, self.os, self.browser = self.person.cluster.properties_provider.device_type_os_browser()
        self.device_id = str(UUID(int=self.person.cluster.random.getrandbits(128)))
        self.active_distinct_id = self.device_id  # Pre-`$identify`, the device ID is used as the distinct ID
        self.active_session_id = None
        self.super_properties = {}
        self.current_url = None
        self.is_logged_in = False

    def __enter__(self):
        """Start session within client."""
        self.active_session_id = str(self.person.cluster.roll_uuidt())

    def __exit__(self, exc_type, exc_value, exc_traceback):
        """End session within client. Handles `$pageleave` event."""
        if self.current_url is not None:
            self.capture(EVENT_PAGELEAVE)
            self.current_url = None

    def _get_person(self, _: str):
        return self.person

    def capture(self, event: str, properties: Optional[Properties] = None):
        """Capture an arbitrary event. Similar to JS `posthog.capture()`."""
        combined_properties: Properties = {
            "$device_type": self.device_type,
            "$os": self.os,
            "$browser": self.browser,
            "$session_id": self.active_session_id,
            "$device_id": self.device_id,
        }
        if self.super_properties:
            combined_properties.update(self.super_properties)
        if self.current_url is not None:
            parsed_current_url = urlparse(self.current_url)