angular / angular/angular-cli

Allow custom wsEndpoint for Playwright

Offen
#33,115 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area: @angular-devkit/build-angular gemini-triaged
Vorherrschende Sprache
TypeScript
Sterne
27k
Forks
11.8k
Ø Merge
14 Std. 23 Min.
Gemergte PRs (30 T.)
162

Beschreibung

### Command

build

### Description

In our project, I've been trying to set up visual regression testing using Vitest, and to make the screenshot tests stable, we want to make those tests in the same environment, regardless of the developers' OS, which can impact the tests. When using Playwright as a browser provider, Vites allows for providing/overriding the WS endpoint, which is not respected & overridden in the unit test builder.

After a quick look at the code, presumably this is being dropped in `browser-provider.ts:164-87` - `providerFactory(..)` function is called with only `baseOptions`, and also, `plugins.ts:265-284` has some more overrides, and comments (`// CLI provider browser options override, if present`)

### Describe the solution you'd like

Ideally, as a developer, I'd like to have better control over the browser provider configuration, instead of having it implicitly overridden on the builder side.

These are the options that I have on my mind, both of them backward compatible with the existing API:

1. Allow full customization for the browser provider

The solution is as simple as not overriding the provider value if defined explicitly in `vitetest-base.config.ts`. This option would be backward compatible with the existing API, but might break the projects that've attempted to override the provider property and haven't noticed that it has no impact.

2. Add `wsEndpoint` property to the builder schema, and allow overriding the value from `angular.json`

Safer solution, but less flexible.

### Describe alternatives you've considered

All other alternatives require significant efforts to support, and require bypassing the Angular builders, or using a different framework for the same purpose.

I'm also happy to make a contribution, but first, I'd like to get an opinion, and maybe get more context on why the browser config is overridden from Angular's side.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, browser-provider.ts ungefähr in den Zeilen 164–187 zu lesen, insbesondere providerFactory, und untersuche anschließend die Provider-Überschreibungen in plugins.ts ungefähr in den Zeilen 265–284. Verfolge, wie die Playwright-Konfiguration den Angular builder erreicht, und bestimme, welche rückwärtskompatible Option geeignet ist. Als erledigt gilt die Änderung, wenn ein explizit konfiguriertes wsEndpoint respektiert wird, statt implizit überschrieben zu werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
angular, playwright, typescript
Bereich
build-system, testing-qa, tooling
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.