# microsoft/playwright-java architecture

> Architecture diagram of the GitHub repository microsoft/playwright-java, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/microsoft/playwright-java
- Repository: https://github.com/microsoft/playwright-java

## Overview

##### Main Components

a. Core Components:
- Playwright Engine (Central Controller)
- Browser Drivers Layer
- Chromium Driver
- Firefox Driver
- WebKit Driver
- API Layer
- Transport Layer (for browser communication)

b. Supporting Components:
- Driver Bundle Manager
- Network Interceptor
- Script Evaluator
- Screenshot Manager
- Geolocation Service
- Device Emulator

##### Component Relationships

**[Client Application] → [Playwright API Layer]**
- ↓
**[Driver Bundle Manager] ← [Playwright Engine] → [Transport Layer]**
- ↓
- [Browser Drivers Layer]
- ↓
- [Browser Instances]

##### Key Architectural Elements

a. API Layer (com.microsoft.playwright):
- Main classes: Browser, Page, BrowserContext
- Connections to implementation classes

b. Implementation Layer (com.microsoft.playwright.impl):
- Below API layer
- Connection to core implementations
- Components like:
- Connection Management
- Protocol Handling
- Browser Control

c. Driver Management:
- Driver-bundle component
- Driver download/installation flow
- To browser instantiation

##### Additional Elements

Specialized components for:
- Network Request Interception
- JavaScript Evaluation Pipeline
- Screenshot and Video Capture
- Mobile Emulation
- Geolocation Services

##### Integration Points

Integration with:
- Maven/Gradle build system
- JUnit test framework
- External browser processes
- Native system components

This architecture should be drawn using a professional diagramming tool that supports UML or similar notation, with clear exports to common formats for documentation purposes.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Client Application Layer"
        Client[Client Application]
    end

    subgraph "API Layer"
        API[API Interface]:::api
        Browser["Browser Interface"]:::api
        Page["Page Interface"]:::api
        BrowserContext["Browser Context"]:::api
        Frame["Frame Interface"]:::api
    end

    subgraph "Core Layer"
        PlaywrightEngine["Playwright Engine"]:::core
        TransportLayer["Transport Layer"]:::transport
        Connection["Connection Manager"]:::transport
        PipeTransport["Pipe Transport"]:::transport
    end

    subgraph "Browser Management"
        DriverBundle["Driver Bundle Manager"]:::driver
        BrowserImpl["Browser Implementation"]:::impl
    end

    subgraph "Browser Drivers"
        ChromiumDriver["Chromium Driver"]:::browser
        FirefoxDriver["Firefox Driver"]:::browser
        WebKitDriver["WebKit Driver"]:::browser
    end

    subgraph "Utility Components"
        NetworkInterceptor["Network Interceptor"]:::util
        ScriptEval["Script Evaluator"]:::util
        ScreenshotMgr["Screenshot Manager"]:::util
        GeoLocation["Geolocation Service"]:::util
        DeviceEmulator["Device Emulator"]:::util
    end

    %% Relationships
    Client --> API
    API --> PlaywrightEngine
    API --> Browser
    API --> Page
    API --> BrowserContext
    API --> Frame
    
    PlaywrightEngine --> TransportLayer
    PlaywrightEngine --> DriverBundle
    PlaywrightEngine --> BrowserImpl
    
    TransportLayer --> Connection
    TransportLayer --> PipeTransport
    
    BrowserImpl --> ChromiumDriver
    BrowserImpl --> FirefoxDriver
    BrowserImpl --> WebKitDriver
    
    PlaywrightEngine --> NetworkInterceptor
    PlaywrightEngine --> ScriptEval
    PlaywrightEngine --> ScreenshotMgr
    PlaywrightEngine --> GeoLocation
    PlaywrightEngine --> DeviceEmulator

    %% Click Events
    click PlaywrightEngine "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/impl/PlaywrightImpl.java"
    click API "https://github.com/microsoft/playwright-java/tree/main/playwright/src/main/java/com/microsoft/playwright/"
    click Browser "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/Browser.java"
    click Page "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/Page.java"
    click BrowserContext "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/BrowserContext.java"
    click Frame "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/Frame.java"
    click TransportLayer "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/impl/Transport.java"
    click PipeTransport "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/impl/PipeTransport.java"
    click Connection "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/impl/Connection.java"
    click DriverBundle "https://github.com/microsoft/playwright-java/tree/main/driver-bundle/src/main/java/com/microsoft/playwright/impl/driver/"
    click NetworkInterceptor "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/impl/Router.java"
    click ScriptEval "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/JSHandle.java"
    click ScreenshotMgr "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/options/ScreenshotType.java"
    click GeoLocation "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/options/Geolocation.java"
    click DeviceEmulator "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/impl/junit/DeviceDescriptor.java"
    click BrowserImpl "https://github.com/microsoft/playwright-java/blob/main/playwright/src/main/java/com/microsoft/playwright/impl/BrowserImpl.java"

    %% Styling
    classDef api fill:#90EE90,stroke:#333,stroke-width:2px
    classDef core fill:#ADD8E6,stroke:#333,stroke-width:2px
    classDef transport fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef driver fill:#FFA500,stroke:#333,stroke-width:2px
    classDef browser fill:#FFD700,stroke:#333,stroke-width:2px
    classDef impl fill:#87CEEB,stroke:#333,stroke-width:2px
    classDef util fill:#D3D3D3,stroke:#333,stroke-width:2px
```
