2191de7713
This PR disables the filtering capability in the front end for unknown users. Modifying the back end to support filtering for unknown users is not something we want to do yet. It's possible, but it requires adding a lot of special cases to the handling code (refer to [PR #7359](https://github.com/Unleash/unleash/pull/7359)), which we'd like to avoid if possible. To avoid annoying cases where the filtering doesn't work as expected and breaks user expectations, we're disabling the filtering capability for unknown users in the front end. We can consider whether to enable back-end results for unknown in the future if we get user feedback that it's important. This PR works by changing the avatar cell component. When the user has id 0 (and is therefore unknown), we: - set aria-disabled to true. This alerts users with assistive tech that the button is disabled, but it doesn't take it out of the tab order, so it's not mysteriously missing. - change the tooltip text, telling users that they can't filter by unknown users. - disable the avatar callback function, so clicking on the avatar doesn't do anything. The accompanying tests assert this functionality. I considered also updating the screen reader text, but I think that would add more confusion or be more information than the user needs. According to MDN's article on the [aria-disabled attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-disabled): > [the aria-disabled] declaration will inform people using assistive technologies, such as screen readers, that such elements are not meant to be editable or otherwise operable. |
||
|---|---|---|
| .. | ||
| cypress | ||
| public | ||
| scripts | ||
| src | ||
| .editorconfig | ||
| .gitignore | ||
| .nvmrc | ||
| check-imports.rc | ||
| cypress.config.ts | ||
| cypress.d.ts | ||
| index.html | ||
| index.js | ||
| orval.config.js | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| tsconfig.node.json | ||
| vercel.json | ||
| vite.config.mts | ||
| yarn.lock | ||
frontend
This directory contains the Unleash Admin UI frontend app.
Run with a local instance of the unleash-api
Refer to the Contributing to Unleash guide for instructions. The frontend dev server runs (in port 3000) simultaneously with the backend dev server (in port 4242):
yarn install
yarn dev
Run with a sandbox instance of the Unleash API
Alternatively, instead of running unleash-api on localhost, you can use a remote instance:
cd ./frontend
yarn install
yarn run start:sandbox
Running end-to-end tests
We have a set of Cypress tests that run on the build before a PR can be merged so it's important that you check these yourself before submitting a PR. On the server the tests will run against the deployed Heroku app so this is what you probably want to test against:
yarn run start:sandbox
In a different shell, you can run the tests themselves:
yarn run e2e:heroku
If you need to test against patches against a local server instance, you'll need to run that, and then run the end to end tests using:
yarn run e2e
You may also need to test that a feature works against the enterprise version of unleash. Assuming the Heroku instance is still running, this can be done by:
yarn run start:enterprise
yarn run e2e
Generating the OpenAPI client
The frontend uses an OpenAPI client generated from the backend's OpenAPI spec. Whenever there are changes to the backend API, the client should be regenerated:
For now we only use generated types (src/openapi/models). We will use methods (src/openapi/apis) for new features soon.
yarn gen:api
rm -rf src/openapi/apis
clean up src/openapi/index.ts imports, only keep first line export * from './models';
This script assumes that you have a running instance of the enterprise backend at http://localhost:4242.
The new OpenAPI client will be generated from the runtime schema of this instance.
The target URL can be changed by setting the UNLEASH_OPENAPI_URL env var.
Analyzing bundle size
npx vite-bundle-visualizer in the root of the frontend directory