Skip to content

Commit

Permalink
fix: adds headless ternary to handle 'new', true, and false in a non-…
Browse files Browse the repository at this point in the history
…breaking fashion (garris#1485) (garris#1486) (garris#1511)

Puppet and Playwright complain and pollute logs with warnings about "new headless mode". This reads the value set in backstop.json, or uses true if 'headless' is not set, or 'new', as a string. README updated with details.

Closes: garris#1485
  • Loading branch information
dgrebb authored Nov 22, 2023
1 parent f0651dc commit b67c169
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -644,12 +644,13 @@ ignoreHTTPSErrors: true,
headless: <!!!config.debugWindow>
```

You can add more settings (or override the defaults) with the engineOptions property. (properties are merged)
You can add more settings (or override the defaults) with the engineOptions property. (properties are merged). This is where headless mode can also be set to 'new', until "new headless mode" is the default in Puppet/Playwright.

```json
"engineOptions": {
"ignoreHTTPSErrors": false,
"args": ["--no-sandbox", "--disable-setuid-sandbox"],
"headless": "new",
"gotoParameters": { "waitUntil": "networkidle0" },
}
```
Expand Down
2 changes: 1 addition & 1 deletion core/util/runPlaywright.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ module.exports.createPlaywrightBrowser = async function (config) {
const playwrightArgs = Object.assign(
{},
{
headless: !config.debugWindow
headless: config.debugWindow ? false : config?.engineOptions?.headless || true
},
config.engineOptions
);
Expand Down
2 changes: 1 addition & 1 deletion core/util/runPuppet.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ async function processScenarioView (scenario, variantOrScenarioLabelSafe, scenar
{},
{
ignoreHTTPSErrors: true,
headless: !config.debugWindow
headless: config.debugWindow ? false : config?.engineOptions?.headless || true
},
config.engineOptions
);
Expand Down

0 comments on commit b67c169

Please sign in to comment.