## What
- For LDAP, OAuth2, Radius, SAML, SCIM, and Proxy providers, extract the literal form rendering
component of each provider into a function. After all, that's what they are: they take input (the
render state) and produce output (HTML with event handlers).
- Rip out all of the forms in the wizard and replace them with ☝️
- Write E2E tests that exercise *all* of the components in *all* of the forms mentioned. See test
results. These tests come in two flavors, "simple" (minimum amount needed to make the provider
"pass" the backend's parsers) and "complete" (touches every legal field in the form according to
the authentik `./schema.yml` file). As a result, every field is validated against the schema
(although the schema is currently ported into the test by hand.
- Fixed some serious bugginess in the way the wizard `commit` phase handles errors.
## Details
### Providers
In some cases, I broke up the forms into smaller units:
- Proxy, especially, with standalone units now for `renderHttpBasic`, `renderModeSelector`,
`renderSettings`, and the differing modes)
- SAML now has a `renderHasSigningKp` object, which makes that part of the code much more readable.
I also extracted a few of static `options` collections into static const objects, so that the form
object itself would be a bit more readable.
### Wizard
Just ripped out all of the Provider forms. All of them. They weren't going to be needed in our
glorious new future.
Using the information provided by the `providerTypes` object, it was easy to extract all of the
information that had once been in `ak-application-wizard-authentication-method-choice.choices`. The
only thing left now is the renderers, one for each of the forms ripped out. Everything else is just
gone.
As a result, though, that's no longer a static list. It has to be derived from information sent via
the API. So now it's in a context that's built when the wizard is initialized, and accessed by the
`createTypes` pass as well as the specific provider.
The error handling in the `commit` pass was just broken. I have improved it quite a bit, and now it
actually displays helpful messages when things go wrong.
### Tests
Wrote a simple test runner that iterates through a collection of fields, setting their values via
field-type instructions contained in each line. For example, the "simple" OAuth2 Provider test looks
like this:
```
export const simpleOAuth2ProviderForm: TestProvider = () => [
[setTypeCreate, "selectProviderType", "OAuth2/OpenID Provider"],
[clickButton, "Next"],
[setTextInput, "name", newObjectName("New Oauth2 Provider")],
[setSearchSelect, "authorizationFlow", /default-provider-authorization-explicit-consent/],
];
```
Each control checks for the existence of the object, and in most cases its current `display`.
(SearchSelect only checks existence, due to the oddness of the portaled popup.) Where a field can't
reasonably be modified and still pass, we at least verify that the name provided in `schema.yml`
corresponds to an existing, available control on the form or wizard panel.
Combined with a routine for logging in and navigating to the Provider page, and another one to
validate that a new and uniqute "Successfully Created Provider" notification appeared, this makes
testing each provider a simple message of filling out the table of fields you want populated.
Equally simple: these *exact same tests* can be incorporated into a wrapper for logging in,
navigating to the Application page, and filling out an Application, and then a new and unique
Provider for that Application, by Provider Type.
As a special case, the Wizard variant checks the `TestSequence` object returned by the
`TestProvider` function and removes the `name` field, since the Wizard pre-populates that
automatically.
As a result of this, the contents of `./web/src` has lost 1,504 lines of code. And results like
these, where the behavior has been cross-checked three ways (the forms, the tests (and so the
back-end), *and the schema* all agree on field names and behaviors, gives me much more confidence
that the refactor works as expected:
```
[chrome 130.0.6723.70 mac #0-1] Running: chrome (v130.0.6723.70) on mac
[chrome 130.0.6723.70 mac #0-1] Session ID: 039c70690eebc83ffbc2eef97043c774
[chrome 130.0.6723.70 mac #0-1]
[chrome 130.0.6723.70 mac #0-1] » /tests/specs/providers.ts
[chrome 130.0.6723.70 mac #0-1] Configuring Providers
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Simple LDAP provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Simple OAuth2 provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Simple Radius provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Simple SAML provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Simple SCIM provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Simple Proxy provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Simple Forward Auth (single application) provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Simple Forward Auth (domain level) provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Complete OAuth2 provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Complete LDAP provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Complete Radius provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Complete SAML provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Complete SCIM provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Complete Proxy provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Complete Forward Auth (single application) provider
[chrome 130.0.6723.70 mac #0-1] ✓ Should successfully configure a Complete Forward Auth (domain level) provider
[chrome 130.0.6723.70 mac #0-1]
[chrome 130.0.6723.70 mac #0-1] 16 passing (1m 48.5s)
------------------------------------------------------------------
[chrome 130.0.6723.70 mac #0-2] Running: chrome (v130.0.6723.70) on mac
[chrome 130.0.6723.70 mac #0-2] Session ID: 5a3ae12c851eff8fffd2686096759146
[chrome 130.0.6723.70 mac #0-2]
[chrome 130.0.6723.70 mac #0-2] » /tests/specs/new-application-by-wizard.ts
[chrome 130.0.6723.70 mac #0-2] Configuring Applications Via the Wizard
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Simple LDAP provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Simple OAuth2 provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Simple Radius provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Simple SAML provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Simple SCIM provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Simple Proxy provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Simple Forward Auth (single) provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Simple Forward Auth (domain) provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Complete OAuth2 provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Complete LDAP provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Complete Radius provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Complete SAML provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Complete SCIM provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Complete Proxy provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Complete Forward Auth (single) provider
[chrome 130.0.6723.70 mac #0-2] ✓ Should successfully configure an application with a Complete Forward Auth (domain) provider
[chrome 130.0.6723.70 mac #0-2]
[chrome 130.0.6723.70 mac #0-2] 16 passing (2m 3s)
```
🎉
* main: (22 commits)
lifecycle: fix missing krb5 deps for full testing in image (#11815)
translate: Updates for file web/xliff/en.xlf in zh-Hans (#11810)
translate: Updates for file locale/en/LC_MESSAGES/django.po in zh-Hans (#11809)
translate: Updates for file locale/en/LC_MESSAGES/django.po in zh_CN (#11808)
web: bump API Client version (#11807)
core: bump goauthentik.io/api/v3 from 3.2024083.12 to 3.2024083.13 (#11806)
core: bump ruff from 0.7.0 to 0.7.1 (#11805)
core: bump twilio from 9.3.4 to 9.3.5 (#11804)
core, web: update translations (#11803)
providers/scim: handle no members in group in consistency check (#11801)
stages/identification: add captcha to identification stage (#11711)
website/docs: improve root page and redirect (#11798)
providers/scim: clamp batch size for patch requests (#11797)
web/admin: fix missing div in wizard forms (#11794)
providers/proxy: fix handling of AUTHENTIK_HOST_BROWSER (#11722)
core, web: update translations (#11789)
core: bump goauthentik.io/api/v3 from 3.2024083.11 to 3.2024083.12 (#11790)
core: bump gssapi from 1.8.3 to 1.9.0 (#11791)
web: bump API Client version (#11792)
stages/authenticator_validate: autoselect last used 2fa device (#11087)
...
* main: (44 commits)
web/admin: add strict dompurify config for diagram (#11783)
core: bump cryptography from 43.0.1 to 43.0.3 (#11750)
web: bump API Client version (#11781)
sources: add Kerberos (#10815)
root: rework CSRF middleware to set secure flag (#11753)
web/admin: improve invalidation flow default & field grouping (#11769)
providers/scim: add comparison with existing group on update and delta update users (#11414)
website: bump mermaid from 10.6.0 to 10.9.3 in /website (#11766)
web/flows: use dompurify for footer links (#11773)
core, web: update translations (#11775)
core: bump goauthentik.io/api/v3 from 3.2024083.10 to 3.2024083.11 (#11776)
website: bump @types/react from 18.3.11 to 18.3.12 in /website (#11777)
website: bump http-proxy-middleware from 2.0.6 to 2.0.7 in /website (#11771)
web: bump API Client version (#11770)
stages: authenticator_endpoint_gdtc (#10477)
core: add prompt_data to auth flow (#11702)
tests/e2e: fix dex tests failing (#11761)
web/rac: disable DPI scaling (#11757)
web/admin: update flow background (#11758)
website/docs: fix some broken links (#11742)
...
- Pull the OAuth2 Provider Form `render()` method out into a standalone function.
- Why: So it can be shared by both the Wizard and the Provider function. The renderer is (or at
least, can be) a pure function: you give it input and it produces HTML, *and then it stops*.
- Provide a test harness that can test the OAuth2 provider form.
* Adding the aliases to Vite helped, but now why are the E2E tests failing?
* web: fix CSS loading with unit tests
- Fix the CSS loader and replace the cut-and-paste loader with a standardized one.
- Fix the aliasing for Wdio's "browser"-based unit testing (Vite)
- With the aliasing fixed, remove all of the dotted paths in tests.
- Update the End-to-End tests to run in Firefox and Safari.
- Put an (optional) pause at the end of each unit test so we can visually confirm the CSS works.
- Environment flag is `WDIO_LEMME_SEE=true`
- Reduce the verbosity of the tests to level `warn` or higher
* This change was due to a misunderstanding. It is not needed in 9.
* Fix the Oauth2 Provider test.
* Just cleaning up.
* web: removing sonarjs from yet another branch.
* web: everything except the tests are up-to-date. There was a lot, it turns out, we simply weren't using.
* web: update package.json to support WebdriverIO 9
This commit:
- Upgrades to WebdriverIO 9.1.2
- Resets our `devDependencies` collection to remove all imports that we either were not using or
were duplicates of existing dependencies:
- *Babel*, of all things
- Storybook addon css user preferences, now native to Storybook 8
- SonarJS, *again*, sigh.
- React
- Fixes a bug where ESLint would report missing features in our build scripts
- Fixes a bug where Wdio might not reach a headless browser before timeout
- Replaces Rollup's CSSLit with Vite's CSSLit, which actually works without hacks, for testing.
- Moves the package-lock scanner to its own script, with better reporting and tool verification,
which also cleans up the package.lock file a little.
* web: unify unit and end-to-end tests
This commit builds on the Upgrade to WebdriverIO 9.1 and provides *two* variants of the wdio.conf
file: One in `browser` mode, so that standalone component tests are uploaded to the browser and run
independently, and one in `local` mode that allows the Webdriver-DOM framework to run end-to-end
tests. This means that both Component and End-to-End tests use the same drivers, same framework,
and same versions, and all tests for the WebUI are contained in this folder.
* Prettier just opinionatin' all over the place.
* Eslint bein' disagreeable.
* Tests embedded like ticks.
* Someday I'll get prettier to agree with my IDE.
* Re-ran the installation with resolutions enforced.
* web: fix type errors in tests
Typechecking the tests is pretty messy, first because WebdriverIO passes around a lot of `ChainablePromise` objects, which TSC does not know
how to resolve to their final form after a full `await`, and second because I used a lot of metaprogramming to provide getters for the
different kinds of subtypes (here: providers) that we are targeting. So there are a lot of compromises here, none of which make me
spectacularly happy, but they're all well-commented, so there's that.
* But I am done with you, orc.
* Fixed broken comment.
