Skip to content

Add spec for SharedClusterEnvironment.md#5632

Closed
Navdeep-ss wants to merge 1 commit into
user/singhnavdeep/shared-cluster-environment-draftfrom
user/singhnavdeep/shared-cluster-environment-spec
Closed

Add spec for SharedClusterEnvironment.md#5632
Navdeep-ss wants to merge 1 commit into
user/singhnavdeep/shared-cluster-environment-draftfrom
user/singhnavdeep/shared-cluster-environment-spec

Conversation

@Navdeep-ss

Copy link
Copy Markdown
Contributor

This is an API review for the new Shared WebView2 Cluster Environment API.

It implements Approach 2 (symmetric Create + synchronous Get) from the internal design doc, the recommended proposal.

What this adds

  • CreateCoreWebView2ClusterEnvironment(options, handler) - symmetric async entry point every cooperating host calls with its full desired options. First-creator-wins pins the option set for the cluster Id.
  • GetCoreWebView2ClusterEnvironmentOptions(id, options) - synchronous read of the pinned options for a cluster Id, no browser spawn, for pre-flight.
  • ICoreWebView2ClusterEnvironmentOptions - process-wide options plus the rendezvous Id.
  • ICoreWebView2CreateClusterEnvironmentCompletedHandler - returns the shared environment, or ERROR_CLUSTER_ENVIRONMENT_OPTIONS_MISMATCH.
  • .NET/WinRT projection: static CoreWebView2Environment.CreateClusterEnvironmentAsync / GetClusterEnvironmentOptions and the CoreWebView2ClusterEnvironmentOptions runtimeclass.

Notes for reviewers

  • Recommended usage is "Get, then Create": read what is pinned, reuse it or offer your own, then create (establish or attach to an identical cluster).
  • Storage, locking, and lifetime are summarized in the Appendix, along with the two rejected alternatives (Create/Join role split, and a getter-only shape).

Note: this PR intentionally targets the user/singhnavdeep/shared-cluster-environment-draft branch, not main.

API proposal for a shared WebView2 cluster environment using the symmetric Create + synchronous Get model (Approach 2).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Navdeep-ss Navdeep-ss added the API Proposal Review WebView2 API Proposal for review. label Jul 1, 2026
@Navdeep-ss

Copy link
Copy Markdown
Contributor Author

Superseded by #5633, which uses the correct review-branch naming convention (base SharedClusterEnvironment, head SharedClusterEnvironment-draft).

@Navdeep-ss Navdeep-ss closed this Jul 1, 2026
@Navdeep-ss Navdeep-ss deleted the user/singhnavdeep/shared-cluster-environment-spec branch July 1, 2026 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

API Proposal Review WebView2 API Proposal for review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant