d7da5fe6a4
This PR offers a little QoL upgrade in cases where you have only a single available filter: Instead of having to first click "filters" and then select the only option, we'll now always show the available filter, whether it's marked as persistent or not. The filter still gets a 'delete filter' button that clears the filter (which is more convenient than having to deselect every one of the options one by one), but the filter won't disappear when you clear it. Additionally, because the `state` of the filter item will be undefined if it has no value, I've added a `preventAutoOpen` prop to the underlying Filter component. ~~I don't understand why we want to auto-open the filter, but it was added by @kwasniew in https://github.com/Unleash/unleash/pull/5611, so it appears to be deliberate.~~ The fact that we auto-open the filter when state is undefined makes this a little tricky. I realized during this that the reason we do it is that we want the filter to auto-open when you select it from the dropdown. Maybe there's a better way to do that than useEffect, but maybe not 🤷🏼 Further, the filter handling logic is quite complex (what filters to show, ordering, etc), so I've moved as much of that into the multifilter component, leaving the singlefilter as simple as possible. I'm ... not particularly proud of the code here, so I'm happy to take any suggestions for improvements. Happy to throw it all away if you have a better way to achieve this goal. ## Rendered The lifecycle insights use the persistent, single filter, the performance insights do not: <img width="1629" alt="image" src="https://github.com/user-attachments/assets/b8599883-97dc-428e-a98f-ad59ad1c74ab" /> <img width="1556" alt="image" src="https://github.com/user-attachments/assets/eacdc4bf-bc60-4e26-a88c-8be7dc5e31be" /> |
||
|---|---|---|
| .. | ||
| .yarn/releases | ||
| cypress | ||
| public | ||
| scripts | ||
| src | ||
| .editorconfig | ||
| .gitignore | ||
| .npmignore | ||
| .nvmrc | ||
| .yarnrc.yml | ||
| check-imports.rc | ||
| cypress.config.ts | ||
| cypress.d.ts | ||
| index.html | ||
| index.js | ||
| mise.toml | ||
| orval.config.ts | ||
| 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