Add a Program.Run() override with a throwOnError parameter#3140
Open
0xced wants to merge 1 commit intomicrosoft:mainfrom
Open
Add a Program.Run() override with a throwOnError parameter#31400xced wants to merge 1 commit intomicrosoft:mainfrom
0xced wants to merge 1 commit intomicrosoft:mainfrom
Conversation
5f2763c to
2a21386
Compare
This was referenced Jun 18, 2025
xjc90s
approved these changes
Sep 7, 2025
xjc90s
left a comment
There was a problem hiding this comment.
Runnable objects and throwable errors properly managed
Ensuring that playwright is properly installed can be done by running the following code: ```csharp var playwright = new Microsoft.Playwright.Program(); var exitCode = playwright.Run(["install", "--with-deps"]); ``` This is fine when the installation succeeds and the exit code is 0. But when running under xUnit.net (which [does **not** capture the console output](https://xunit.net/docs/capturing-output)) and the installation fails with exit code 1, then it becomes impossibly hard to diagnose the root cause of the failure. For example, a failure can be triggered by deleting the installed browers in the `ms-playwright` cache directory and setting the `https_proxy` environment variable to an invalid proxy: `http://127.0.0.1:33333`. Under these conditions, running with the new `throwOnError` parameter becomes diagnosable. ```csharp var playwright = new Microsoft.Playwright.Program(); var exitCode = playwright.Run(["install", "--with-deps", "firefox"], throwOnError: true); ``` This throws a `PlaywrightException` with the exact command executed and its output, making it clear what the problem is. > Failed to run ~/playwright-dotnet/src/playwright-xunit/bin/Debug/net8.0/.playwright/node/darwin-x64/node "~/playwright-dotnet/src/playwright-xunit/bin/Debug/net8.0/.playwright/package/cli.js" "install" "--with-deps" "firefox" > Downloading Firefox 132.0 (playwright build v1466) from https://playwright.azureedge.net/builds/firefox/1466/firefox-mac.zip > Error: connect ECONNREFUSED 127.0.0.1:33333 > at TCPConnectWrap.afterConnect [as oncomplete] (node:net:1610:16) { > errno: -61, > code: 'ECONNREFUSED', > syscall: 'connect', > address: '127.0.0.1', > port: 33333 > } > Downloading Firefox 132.0 (playwright build v1466) from https://playwright-akamai.azureedge.net/builds/firefox/1466/firefox-mac.zip > Error: connect ECONNREFUSED 127.0.0.1:33333 > at TCPConnectWrap.afterConnect [as oncomplete] (node:net:1610:16) { > errno: -61, > code: 'ECONNREFUSED', > syscall: 'connect', > address: '127.0.0.1', > port: 33333 > } > Downloading Firefox 132.0 (playwright build v1466) from https://playwright-verizon.azureedge.net/builds/firefox/1466/firefox-mac.zip > Error: connect ECONNREFUSED 127.0.0.1:33333 > at TCPConnectWrap.afterConnect [as oncomplete] (node:net:1610:16) { > errno: -61, > code: 'ECONNREFUSED', > syscall: 'connect', > address: '127.0.0.1', > port: 33333 > } > Failed to install browsers > Error: Failed to download Firefox 132.0 (playwright build v1466), caused by > Error: Download failure, code=1
2a21386 to
fadca3b
Compare
xjc90s
approved these changes
Sep 8, 2025
|
I would say it should always throw with detailed info. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ensuring that playwright is properly installed can be done by running the following code:
This is fine when the installation succeeds and the exit code is 0. But when running under xUnit.net (which does not capture the console output) and the installation fails with exit code 1, then it becomes impossibly hard to diagnose the root cause of the failure.
For example, a failure can be triggered by deleting the installed browers in the
ms-playwrightcache directory and setting thehttps_proxyenvironment variable to an invalid proxy:http://127.0.0.1:33333.Under these conditions, running with the new
throwOnErrorparameter becomes diagnosable.This throws a
PlaywrightExceptionwith the exact command executed and its output, making it clear what the problem is.Fixes #3139