ea31154d9a
This PR fixes an error where useSWR would throw a TypeError: `subs[i] is not a function`: https://github.com/vercel/swr/issues/2357 I can't be totally sure why this is happening but we had a design flaw in our setup that caused our group overview to first fetch all groups, and then subsequently fetch each individual group after the groups were rendered. This was happening because GroupCard was rendering the EditGroupUsers component which used the `useGroup(groupId)` getter. The flow in the old version looked like this: 1. Fetch all the groups 2. Use the groups data to render all the `GroupCard` elements 3. Once the GroupCard was rendered the EditGroupComponent would be mounted and set up a recurring GET on the individual group, causing each group to be fetched recurringly in the Group overview. The useSWR error seems to be connected to setting up these subscriptions, and then removing the element from the DOM. We were able to trigger this error by removing the group. ## How did we fix it? We refactored the components concerned with editing group users and removing groups to exist outside of the `GroupCard` and have the group card supply the base data through a state setter. This pattern is also better for the remove functionality because the remove functionality in its current state could trigger a react update on a component removed from the DOM if you awaited the refetching of the data. This is because the groups data is controlling the rendering of the `GroupCard` and when the `RemoveGroup` modal is nested underneath the `GroupCard` a refetch would trigger an update, re-render the overview and remove the entire `GroupCard` and the associated `RemoveGroup` component. I'm still not sure if this is a bug with SWR or a side-effect of how we architected the functionality, but this change seems to remove the problem. |
||
|---|---|---|
| .. | ||
| cypress | ||
| public | ||
| src | ||
| .editorconfig | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| cypress.json | ||
| index.html | ||
| index.js | ||
| orval.config.js | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| tsconfig.node.json | ||
| vercel.json | ||
| vite.config.ts | ||
| yarn.lock | ||
frontend
This directory contains the Unleash Admin UI frontend app.
Run with a local instance of the unleash-api
First, start the unleash-api backend on port 4242. Then, start the frontend dev server:
cd ~/frontend
yarn install
yarn run start
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:
./scripts/generate-openapi.sh
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.