# web-infra-dev/midscene-example architecture

> Architecture diagram of the GitHub repository web-infra-dev/midscene-example, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/web-infra-dev/midscene-example
- Repository: https://github.com/web-infra-dev/midscene-example

## Overview

Midscene Examples is a collection of runnable integrations and test patterns, not a single application. The main workflow is an engineer choosing a platform example, creating or configuring a Midscene agent, running YAML or scripted actions and queries, then reviewing reports. Separate examples cover cross-platform orchestration, parallel device use, remote desktops, and custom device interfaces. Relationships for documented but unsampled examples are based on the README; source-level links are limited to the excerpts and index evidence provided.

Main entry points: [`playwright-demo/demo.ts`](https://github.com/web-infra-dev/midscene-example/blob/main/playwright-demo/demo.ts) (Playwright SDK), [`midscene-test/collaborate-between-platforms/nodes.ts`](https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/collaborate-between-platforms/nodes.ts) (Handoff workflow), [`vitest-all-platforms-demo/src/context/base.ts`](https://github.com/web-infra-dev/midscene-example/blob/main/vitest-all-platforms-demo/src/context/base.ts) (Test lifecycle base), [`vitest-all-platforms-demo/src/report-helper.ts`](https://github.com/web-infra-dev/midscene-example/blob/main/vitest-all-platforms-demo/src/report-helper.ts) (Report merging)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web automation"]
  node_yaml_web["YAML scripts"]
  node_playwright["Playwright SDK<br/>[demo.ts]"]
  node_puppeteer["Puppeteer SDK<br/>[demo.ts]"]
  node_bridge["Chrome bridge"]
  node_remote_browsers["Remote browsers<br/>[demo.ts]"]
  node_browser_results["Browser results<br/>[extract-data.ts]"]
end

subgraph group_devices["Device integrations"]
  node_android_sdk["Android SDK<br/>[demo.ts]"]
  node_ios_sdk["iOS SDK<br/>[demo.ts]"]
  node_harmony_sdk["Harmony SDK<br/>[demo.ts]"]
  node_computer_sdk["Desktop SDK<br/>[demo.ts]"]
  node_electron["Electron demo<br/>[demo.ts]"]
  node_rdp["RDP control<br/>[demo.ts]"]
end

subgraph group_testing["Test orchestration"]
  node_cross_platform["Cross-platform cases<br/>[setup.ts]"]
  node_large_suites["Parallel suites<br/>[setup.ts]"]
  node_device_pool["Device pools<br/>[devices.ts]"]
  node_collab_setup["Paired sessions<br/>[setup.ts]"]
  node_collab_nodes["Handoff workflow<br/>[nodes.ts]"]
  node_todo_service[("Shared Todo service<br/>[service.ts]")]
  node_vitest_web["Web test context<br/>[web.ts]"]
  node_vitest_android["Android test context<br/>[android.ts]"]
  node_test_base["Test lifecycle base<br/>[base.ts]"]
  node_reporting["Report merging<br/>[report-helper.ts]"]
end

subgraph group_extensions["Connectivity and extensions"]
  node_custom_interface["Custom device<br/>[sample-device.ts]"]
  node_custom_agent["Custom agent<br/>[index.ts]"]
  node_connectivity["LLM connectivity"]
end

node_engineer(("Engineer"))
node_midscene["Midscene.js"]
node_llm_service["LLM service"]

node_engineer -->|"chooses workflow"| node_yaml_web
node_engineer -->|"chooses integration"| node_playwright
node_engineer -->|"chooses integration"| node_puppeteer
node_engineer -->|"chooses mode"| node_bridge
node_engineer -->|"chooses integration"| node_android_sdk
node_engineer -->|"chooses integration"| node_ios_sdk
node_engineer -->|"chooses integration"| node_harmony_sdk
node_engineer -->|"chooses integration"| node_computer_sdk
node_engineer -->|"runs cases"| node_cross_platform
node_engineer -->|"runs suites"| node_large_suites
node_engineer -->|"runs handoff"| node_collab_setup
node_engineer -->|"checks access"| node_connectivity
node_yaml_web -->|"automates with"| node_midscene
node_playwright -->|"integrates"| node_midscene
node_puppeteer -->|"integrates"| node_midscene
node_bridge -->|"enables desktop use"| node_midscene
node_remote_browsers -.->|"integrates"| node_midscene
node_android_sdk -->|"integrates"| node_midscene
node_ios_sdk -->|"integrates"| node_midscene
node_harmony_sdk -.->|"integrates"| node_midscene
node_computer_sdk -->|"integrates"| node_midscene
node_electron -->|"uses"| node_midscene
node_rdp -->|"controls desktop"| node_midscene
node_playwright -->|"extracts data"| node_browser_results
node_custom_agent -->|"constructs device"| node_custom_interface
node_custom_agent -->|"creates agent"| node_midscene
node_large_suites -->|"acquires devices"| node_device_pool
node_collab_setup -.->|"provides context"| node_collab_nodes
node_collab_nodes -->|"calls API"| node_todo_service
node_collab_nodes -->|"creates agent nodes"| node_midscene
node_vitest_web -->|"extends lifecycle"| node_test_base
node_vitest_android -->|"extends lifecycle"| node_test_base
node_test_base -->|"collects reports"| node_reporting
node_vitest_web -->|"builds report metadata"| node_reporting
node_vitest_android -->|"builds report metadata"| node_reporting
node_connectivity -->|"tests connection"| node_llm_service

click node_yaml_web "https://github.com/web-infra-dev/midscene-example/tree/main/yaml-scripts-demo"
click node_playwright "https://github.com/web-infra-dev/midscene-example/blob/main/playwright-demo/demo.ts"
click node_puppeteer "https://github.com/web-infra-dev/midscene-example/blob/main/puppeteer-demo/demo.ts"
click node_bridge "https://github.com/web-infra-dev/midscene-example/tree/main/bridge-mode-demo"
click node_remote_browsers "https://github.com/web-infra-dev/midscene-example/blob/main/remote-playwright-demo/demo.ts"
click node_browser_results "https://github.com/web-infra-dev/midscene-example/blob/main/playwright-demo/extract-data.ts"
click node_android_sdk "https://github.com/web-infra-dev/midscene-example/blob/main/android/javascript-sdk-demo/demo.ts"
click node_ios_sdk "https://github.com/web-infra-dev/midscene-example/blob/main/ios/javascript-sdk-demo/demo.ts"
click node_harmony_sdk "https://github.com/web-infra-dev/midscene-example/blob/main/harmony/javascript-sdk-demo/demo.ts"
click node_computer_sdk "https://github.com/web-infra-dev/midscene-example/blob/main/computer/javascript-sdk-demo/demo.ts"
click node_electron "https://github.com/web-infra-dev/midscene-example/blob/main/computer/electron-demo/demo.ts"
click node_rdp "https://github.com/web-infra-dev/midscene-example/blob/main/computer/rdp-demo/demo.ts"
click node_custom_interface "https://github.com/web-infra-dev/midscene-example/blob/main/custom-interface/src/sample-device.ts"
click node_custom_agent "https://github.com/web-infra-dev/midscene-example/blob/main/custom-interface/src/index.ts"
click node_cross_platform "https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/parallel-cross-platform-tests/setup.ts"
click node_large_suites "https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/run-large-suites-in-parallel/setup.ts"
click node_device_pool "https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/run-large-suites-in-parallel/devices.ts"
click node_collab_setup "https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/collaborate-between-platforms/setup.ts"
click node_collab_nodes "https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/collaborate-between-platforms/nodes.ts"
click node_todo_service "https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/collaborate-between-platforms/server/service.ts"
click node_vitest_web "https://github.com/web-infra-dev/midscene-example/blob/main/playwright-with-vitest-demo/src/context/web.ts"
click node_vitest_android "https://github.com/web-infra-dev/midscene-example/blob/main/vitest-all-platforms-demo/src/context/android.ts"
click node_test_base "https://github.com/web-infra-dev/midscene-example/blob/main/vitest-all-platforms-demo/src/context/base.ts"
click node_reporting "https://github.com/web-infra-dev/midscene-example/blob/main/vitest-all-platforms-demo/src/report-helper.ts"
click node_connectivity "https://github.com/web-infra-dev/midscene-example/tree/main/connectivity-test"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_yaml_web,node_playwright,node_puppeteer,node_bridge,node_remote_browsers,node_browser_results toneBlue
class node_android_sdk,node_ios_sdk,node_harmony_sdk,node_computer_sdk,node_electron,node_rdp toneAmber
class node_cross_platform,node_large_suites,node_device_pool,node_collab_setup,node_collab_nodes,node_todo_service,node_vitest_web,node_vitest_android,node_test_base,node_reporting toneMint
class node_custom_interface,node_custom_agent,node_connectivity toneRose
class node_engineer,node_midscene,node_llm_service toneIndigo
```

## Components

### Web automation

- [YAML scripts](https://github.com/web-infra-dev/midscene-example/tree/main/yaml-scripts-demo): `yaml-scripts-demo`
- [Playwright SDK](https://github.com/web-infra-dev/midscene-example/blob/main/playwright-demo/demo.ts): `playwright-demo/demo.ts`
- [Puppeteer SDK](https://github.com/web-infra-dev/midscene-example/blob/main/puppeteer-demo/demo.ts): `puppeteer-demo/demo.ts`
- [Chrome bridge](https://github.com/web-infra-dev/midscene-example/tree/main/bridge-mode-demo): `bridge-mode-demo`
- [Remote browsers](https://github.com/web-infra-dev/midscene-example/blob/main/remote-playwright-demo/demo.ts): `remote-playwright-demo/demo.ts`
- [Browser results](https://github.com/web-infra-dev/midscene-example/blob/main/playwright-demo/extract-data.ts): `playwright-demo/extract-data.ts`

### Device integrations

- [Android SDK](https://github.com/web-infra-dev/midscene-example/blob/main/android/javascript-sdk-demo/demo.ts): `android/javascript-sdk-demo/demo.ts`
- [iOS SDK](https://github.com/web-infra-dev/midscene-example/blob/main/ios/javascript-sdk-demo/demo.ts): `ios/javascript-sdk-demo/demo.ts`
- [Harmony SDK](https://github.com/web-infra-dev/midscene-example/blob/main/harmony/javascript-sdk-demo/demo.ts): `harmony/javascript-sdk-demo/demo.ts`
- [Desktop SDK](https://github.com/web-infra-dev/midscene-example/blob/main/computer/javascript-sdk-demo/demo.ts): `computer/javascript-sdk-demo/demo.ts`
- [Electron demo](https://github.com/web-infra-dev/midscene-example/blob/main/computer/electron-demo/demo.ts): `computer/electron-demo/demo.ts`
- [RDP control](https://github.com/web-infra-dev/midscene-example/blob/main/computer/rdp-demo/demo.ts): `computer/rdp-demo/demo.ts`

### Test orchestration

- [Cross-platform cases](https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/parallel-cross-platform-tests/setup.ts): `midscene-test/parallel-cross-platform-tests/setup.ts`
- [Parallel suites](https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/run-large-suites-in-parallel/setup.ts): `midscene-test/run-large-suites-in-parallel/setup.ts`
- [Device pools](https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/run-large-suites-in-parallel/devices.ts): `midscene-test/run-large-suites-in-parallel/devices.ts`
- [Paired sessions](https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/collaborate-between-platforms/setup.ts): `midscene-test/collaborate-between-platforms/setup.ts`
- [Handoff workflow](https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/collaborate-between-platforms/nodes.ts): `midscene-test/collaborate-between-platforms/nodes.ts`
- [Shared Todo service](https://github.com/web-infra-dev/midscene-example/blob/main/midscene-test/collaborate-between-platforms/server/service.ts): `midscene-test/collaborate-between-platforms/server/service.ts`
- [Web test context](https://github.com/web-infra-dev/midscene-example/blob/main/playwright-with-vitest-demo/src/context/web.ts): `playwright-with-vitest-demo/src/context/web.ts`
- [Android test context](https://github.com/web-infra-dev/midscene-example/blob/main/vitest-all-platforms-demo/src/context/android.ts): `vitest-all-platforms-demo/src/context/android.ts`
- [Test lifecycle base](https://github.com/web-infra-dev/midscene-example/blob/main/vitest-all-platforms-demo/src/context/base.ts): `vitest-all-platforms-demo/src/context/base.ts`
- [Report merging](https://github.com/web-infra-dev/midscene-example/blob/main/vitest-all-platforms-demo/src/report-helper.ts): `vitest-all-platforms-demo/src/report-helper.ts`

### Connectivity and extensions

- [Custom device](https://github.com/web-infra-dev/midscene-example/blob/main/custom-interface/src/sample-device.ts): `custom-interface/src/sample-device.ts`
- [Custom agent](https://github.com/web-infra-dev/midscene-example/blob/main/custom-interface/src/index.ts): `custom-interface/src/index.ts`
- [LLM connectivity](https://github.com/web-infra-dev/midscene-example/tree/main/connectivity-test): `connectivity-test`

### Other components

- **Engineer**
- **Midscene.js**
- **LLM service**

## Connections

- Engineer → YAML scripts: chooses workflow
- Engineer → Playwright SDK: chooses integration
- Engineer → Puppeteer SDK: chooses integration
- Engineer → Chrome bridge: chooses mode
- Engineer → Android SDK: chooses integration
- Engineer → iOS SDK: chooses integration
- Engineer → Harmony SDK: chooses integration
- Engineer → Desktop SDK: chooses integration
- Engineer → Cross-platform cases: runs cases
- Engineer → Parallel suites: runs suites
- Engineer → Paired sessions: runs handoff
- Engineer → LLM connectivity: checks access
- YAML scripts → Midscene.js: automates with
- Playwright SDK → Midscene.js: integrates
- Puppeteer SDK → Midscene.js: integrates
- Chrome bridge → Midscene.js: enables desktop use
- Remote browsers → Midscene.js: integrates
- Android SDK → Midscene.js: integrates
- iOS SDK → Midscene.js: integrates
- Harmony SDK → Midscene.js: integrates
- Desktop SDK → Midscene.js: integrates
- Electron demo → Midscene.js: uses
- RDP control → Midscene.js: controls desktop
- Playwright SDK → Browser results: extracts data
- Custom agent → Custom device: constructs device (evidence: `custom-interface/src/index.ts`)
- Custom agent → Midscene.js: creates agent (evidence: `custom-interface/src/index.ts`)
- Parallel suites → Device pools: acquires devices (evidence: `midscene-test/run-large-suites-in-parallel/setup.ts`)
- Paired sessions → Handoff workflow: provides context (evidence: `midscene-test/collaborate-between-platforms/nodes.ts`)
- Handoff workflow → Shared Todo service: calls API (evidence: `midscene-test/collaborate-between-platforms/nodes.ts`)
- Handoff workflow → Midscene.js: creates agent nodes (evidence: `midscene-test/collaborate-between-platforms/nodes.ts`)
- Web test context → Test lifecycle base: extends lifecycle (evidence: `playwright-with-vitest-demo/src/context/web.ts`)
- Android test context → Test lifecycle base: extends lifecycle (evidence: `vitest-all-platforms-demo/src/context/android.ts`)
- Test lifecycle base → Report merging: collects reports (evidence: `vitest-all-platforms-demo/src/context/base.ts`)
- Web test context → Report merging: builds report metadata (evidence: `playwright-with-vitest-demo/src/context/web.ts`)
- Android test context → Report merging: builds report metadata (evidence: `vitest-all-platforms-demo/src/context/android.ts`)
- LLM connectivity → LLM service: tests connection
