sfirke opened a new pull request, #44243:
URL: https://github.com/apache/superset/pull/44243
### SUMMARY
#43028 removed Selenium support, so as of 7.0.0 Playwright with Chromium is
the only backend for Alerts & Reports and thumbnail screenshots. Several
unversioned docs still described the Selenium setup. This updates them to match
`UPDATING.md` and the code:
- `admin_docs/configuration/alerts-reports.mdx`
- Replace the Firefox/Chrome (Selenium) install options with the
Playwright + Chromium requirement. Note that the default image bundles both and
`lean` or custom images must install them.
- Remove `WEBDRIVER_TYPE = "chrome"` and the Selenium-era Chrome flags
from the sample config. Point to `WEBDRIVER_WINDOW["pixel_density"]` and
`WEBDRIVER_OPTION_ARGS` instead.
- Rewrite the worker notes that mentioned Selenium instances and leaked
geckodriver processes.
- Turn "Check web browser and webdriver installation" into a
Playwright/Chromium check with a short launch snippet.
- `admin_docs/configuration/cache.mdx`
- Drop the obsolete "Selenium user" fallback claim.
- Drop the removed `WEBDRIVER_CONFIGURATION` key.
- Fix the `WEBDRIVER_AUTH_FUNC` example to take and return a Playwright
`BrowserContext`, which matches `MachineAuthProvider`.
- Mention overriding `authenticate_browser_context()` via
`MACHINE_AUTH_PROVIDER_CLASS`.
- `admin_docs/configuration/dashboard-performance.mdx`: describe the
screenshot browser as Chromium driven by Playwright.
- `developer_docs/testing/backend-testing.md`: remove the deleted
`PLAYWRIGHT_REPORTS_AND_THUMBNAILS` flag and list Playwright + Chromium as a
prerequisite.
- `developer_docs/contributing/development-setup.md`: clarify that
`INCLUDE_CHROMIUM` provides the browser screenshots need, and that the Firefox
browser from `INCLUDE_FIREFOX` isn't used by screenshot features.
Config keys that still exist and are read by the Playwright code path
(`WEBDRIVER_BASEURL`, `WEBDRIVER_BASEURL_USER_FRIENDLY`, `WEBDRIVER_WINDOW`,
`WEBDRIVER_OPTION_ARGS`, `WEBDRIVER_AUTH_FUNC`, `SCREENSHOT_LOCATE_WAIT`,
`SCREENSHOT_LOAD_WAIT`) are left as documented. Versioned doc snapshots are
untouched.
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
N/A (docs text only)
### TESTING INSTRUCTIONS
- `git grep -n -i -E
'selenium|geckodriver|WEBDRIVER_TYPE|WEBDRIVER_CONFIGURATION|PLAYWRIGHT_REPORTS_AND_THUMBNAILS'
-- docs/admin_docs docs/user_docs docs/developer_docs` returns only the new
"not supported" sentence and `installation/docker-builds.mdx` (handled
separately).
- Build the docs site and review the Alerts & Reports, Caching, Dashboard
Performance, Development Setup and Backend Testing pages.
### ADDITIONAL INFORMATION
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in
[SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
Follow-up to #43028.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
