ff9b7298b6
Adds sticky pagination to the event log:  This PR uses the sticky pagination bar that we use on other tables to navigate the event search results. ## Decisions / discussion points The trickiest issue here is how we calculate the next and previous page offsets. This is tricky because we don't expose the page number to the API, but the raw offset itself. This abstraction makes it possible to set an offset that isn't a multiple of the page size. Say the page size is 25. If you manually set an offset of 30 (through changing the URL), what do you expect should happen when you: - load the page? Should you see results 31 to 55? 26 to 50? - go to the next page? Should your next offset be 55 or 50? - previous page: should your previous page offset be 5? 25? 0? The current implementation has taken what I thought would be the easiest way out: If your offset is between two multiples of the page size, we'll consider it to be the lower of the two. - The next page's offset is the next multiple of the page size that is higher than the current offset (50 in the example above). - The previous page's offset will be not the nearest lower page size, but the one below. So if you set offset 35 and page size 25, your next page will take you back to 0 (as if the offset was 25). We could instead update the API to accept `page` instead of offset, but that wouldn't align with how other tables do it. Comparing to the global flags table, if you set an offset that isn't a multiple of the page size, we force the offset to 0. We can look at handling it like that in a follow-up, though I'd argue that forcing it to be the next lower multiple of the page size would make more sense. One issue that appears when you can set custom offsets is that the little "showing x-y items out of z" gets out of whack (because it only operates on multiples of the page size (seemingly))  ## The Event Log as a table While we haven't used the HTML `table` element to render the event log, I would argue that it _is_ actually a table. It displays tabular data. Each card (row) has an id, a project, etc. The current implementation forces the event log search to act as a table state manager, but we could transform the event list into an events table to better align the pagination handling. The best part? We can keep the exact same design too. A table doesn't have to _look_ like a table to be a table. |
||
|---|---|---|
| .. | ||
| .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 | ||
| 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