Skip to content

Allow custom wsEndpoint for Playwright #33115

@d3n1el1

Description

@d3n1el1

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.

  1. 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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions