update
This commit is contained in:
@@ -2,46 +2,52 @@
|
||||
|
||||
## Decision
|
||||
|
||||
ELY is a Servo-based browser. The page renderer is Servo itself, embedded in the application process and attached to a real platform rendering surface. The browser chrome can stay GPUI, while web content must follow Servo's embedder model:
|
||||
ELY is a Servo-based browser. The page renderer lives in the application process and follows Servo's embedder model:
|
||||
|
||||
```text
|
||||
┌──────────────────────────── ELY App Process ────────────────────────────┐
|
||||
│ │
|
||||
│ GPUI chrome │
|
||||
│ ┌───────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Sidebar Toolbar Tabs Settings │ │
|
||||
│ └───────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
│ Servo content host │
|
||||
│ ┌───────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Servo + WebView + WindowRenderingContext │ │
|
||||
│ │ notify_new_frame_ready -> window repaint -> paint -> present │ │
|
||||
│ └───────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
└─────────────────────────────────────────────────────────────────────────┘
|
||||
│ │
|
||||
│ GPUI chrome │
|
||||
│ ┌────────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Sidebar Toolbar Tabs Settings │ │
|
||||
│ └────────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
│ Servo content host │
|
||||
│ ┌────────────────────────────────────────────────────────────────────┐ │
|
||||
│ │ Servo + WebView + RenderingContext │ │
|
||||
│ │ notify_new_frame_ready -> repaint -> paint -> present │ │
|
||||
│ └────────────────────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
└──────────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
The normal page-display path excludes external rendering sidecars, stdout frame transport, RGBA frame payloads, cross-process IOSurface handoff, and GPUI `RenderImage` uploads for live web content.
|
||||
The app process owns WebView lifecycle, navigation, input, permissions, frame readiness, and rendering context presentation.
|
||||
|
||||
## Root Cause
|
||||
|
||||
The current ELY page path is a remote-frame architecture:
|
||||
## Current Code Boundary
|
||||
|
||||
```text
|
||||
GPUI shell
|
||||
-> WebSurfaceStore
|
||||
WebSurfaceStore
|
||||
-> GPUI NativeSurface
|
||||
-> LiveRuntimeWorker
|
||||
-> ServoLiveClient
|
||||
-> ely_servo_sidecar stdin/stdout JSON
|
||||
-> SoftwareServoHost
|
||||
-> Servo WebView paint
|
||||
-> RGBA payload or IOSurface handle
|
||||
-> GPUI surface/image element
|
||||
-> servo::Servo + servo::WebView + servo::WindowRenderingContext
|
||||
```
|
||||
|
||||
This makes page interaction depend on worker scheduling, IPC, polling cadence, surface import, frame object churn, and GPUI scene refresh. Hardware IOSurface reduces byte volume, while the architecture still behaves like a remote compositor.
|
||||
`ServoLiveClient` is now an in-process adapter over `ely_servo_host::SoftwareServoHost`. It shares one Servo runtime across profile scopes, creates multiple WebViews inside that runtime, and routes scroll, hover, click, keyboard, resize, zoom, navigation, and permissions through the `ServoHost` API.
|
||||
|
||||
Servo's own embedder route is direct:
|
||||
Normal page display now enters GPUI through `native_surface(...)`. GPUI creates a platform child surface for the content bounds, passes that raw handle into Servo's `WindowRenderingContext`, and presents with `paint_without_readback_with_completion`. The RGBA readback path remains inside `ely_servo_host` for low-level tests.
|
||||
|
||||
Current platform child surfaces:
|
||||
|
||||
- macOS: child `NSView` with an AppKit raw window handle.
|
||||
- Windows: child `HWND` with a Win32 raw window handle.
|
||||
- Linux/X11: child XCB window with XCB display/window handles.
|
||||
- Linux/Wayland: child `wl_surface` attached as a `wl_subsurface` with Wayland display/surface handles.
|
||||
|
||||
## Upstream Servo Route
|
||||
|
||||
Servo's own shell route is the model for the final ELY rendering path:
|
||||
|
||||
```text
|
||||
Window event
|
||||
@@ -57,7 +63,7 @@ Relevant upstream evidence from Servo `7c48af7`:
|
||||
- `ports/servoshell/window.rs` creates `WebViewBuilder::new(state.servo(), platform_window.rendering_context())`.
|
||||
- `ports/servoshell/window.rs` repaints with `webview.paint()` and `rendering_context().present()`.
|
||||
- `ports/servoshell/running_app_state.rs` handles `notify_new_frame_ready` by marking the owning window for repaint.
|
||||
- `components/paint/paint.rs` owns one WebRender painter per `RenderingContext` and explicitly avoids blocking paint on the constellation.
|
||||
- `components/paint/paint.rs` owns one WebRender painter per `RenderingContext` and keeps paint coordination inside Servo's rendering pipeline.
|
||||
|
||||
## Target Boundaries
|
||||
|
||||
@@ -73,11 +79,11 @@ crates/ely_app/src/servo_embed
|
||||
WebView lifecycle, repaint dispatch, and web input routing.
|
||||
|
||||
crates/ely_servo_host
|
||||
Transitional compatibility surface for explicit screenshots and isolated
|
||||
compatibility tools. Normal live page display leaves this crate.
|
||||
Owns the current in-process compatibility adapter while the native
|
||||
platform rendering surface lands.
|
||||
```
|
||||
|
||||
Each production source file in the new embedding path stays below 500 lines. Large responsibilities split by ownership:
|
||||
Each production source file in the final embedding path stays below 500 lines. Large responsibilities split by ownership:
|
||||
|
||||
- `runtime.rs`: `Servo`, wake handling, webview registry.
|
||||
- `platform_view.rs`: platform content surface attachment.
|
||||
@@ -88,36 +94,33 @@ Each production source file in the new embedding path stays below 500 lines. Lar
|
||||
|
||||
## Migration Slices
|
||||
|
||||
1. Create `servo_embed` as an in-process module behind the existing tab/domain model.
|
||||
2. Add a macOS platform content view using the GPUI window's raw AppKit handle.
|
||||
3. Build Servo `WindowRenderingContext` or child context against the platform content view.
|
||||
4. Move one active tab to in-process `Servo + WebView + RenderingContext`.
|
||||
5. Route scroll, mouse, keyboard, resize, zoom, and navigation directly into the active `WebView`.
|
||||
6. Replace `WebSurfaceStore` for normal web pages with the in-process host.
|
||||
7. Delete sidecar spawning from normal page display.
|
||||
8. Keep explicit page screenshot capture as a user-command path only.
|
||||
1. App process owns the Servo runtime and WebView registry.
|
||||
2. App process routes web input and navigation directly into Servo.
|
||||
3. GPUI exposes one `NativeSurfaceHandle` element contract for platform child surfaces.
|
||||
4. macOS creates a child `NSView` and hands the AppKit raw handle to Servo.
|
||||
5. Windows creates a child `HWND` and hands the Win32 raw handle to Servo.
|
||||
6. Linux/X11 creates a child XCB window and hands the XCB raw handle to Servo.
|
||||
7. Linux/Wayland creates a child `wl_surface`/subsurface and hands the Wayland raw handle to Servo.
|
||||
8. GPUI web page display uses native content surface presentation for every platform target.
|
||||
|
||||
## Acceptance Gates
|
||||
|
||||
- `cargo run` opens a normal web page without starting `ely_servo_sidecar`.
|
||||
- `cargo run` opens a normal web page with Servo inside the ELY app process.
|
||||
- Scrolling a live web page uses Servo input events and Servo repaint callbacks.
|
||||
- The page display path contains no RGBA frame payload transport.
|
||||
- The page display path contains no stdout JSON frame loop.
|
||||
- The page display path contains no GPUI `RenderImage` upload for live web content.
|
||||
- Address/search, tabs, spaces, profiles, settings, permissions, sync, and explicit screenshots continue to compile and behave through existing domain APIs.
|
||||
- Page display presents through a Servo rendering context.
|
||||
- macOS, Windows, Linux/X11, and Linux/Wayland each have a platform child surface implementation under the same `NativeSurfaceHandle` contract.
|
||||
- Address/search, tabs, spaces, profiles, settings, permissions, and sync compile through existing domain APIs.
|
||||
- Every new source file stays below 500 lines.
|
||||
- No user-facing frontend status, logs, debug panels, or explanatory clutter are added.
|
||||
- User-facing chrome stays clean.
|
||||
|
||||
## First Implementation Target
|
||||
|
||||
The first code slice is macOS content-view attachment:
|
||||
## First Platform Surface Target
|
||||
|
||||
```text
|
||||
GPUI Window
|
||||
-> raw AppKit NSView
|
||||
-> ELY child NSView for web content bounds
|
||||
-> GPUI NativeSurface element
|
||||
-> platform child surface for web content bounds
|
||||
-> Servo WindowRenderingContext
|
||||
-> Servo WebView
|
||||
```
|
||||
|
||||
This slice creates the real platform surface required by Servo's direct rendering model. Once the content view exists, Servo can paint into a native surface in the ELY app process, and the remote-frame path can be removed tab by tab.
|
||||
This slice gives Servo a native surface in the ELY app process. The compatibility adapter remains a narrow bridge for tests and non-normal display probes.
|
||||
|
||||
Reference in New Issue
Block a user