1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-03-04 00:18:40 +01:00

fix: make api tokens ui consistent and remove check for deprecated envs. (#3410)

<!-- Thanks for creating a PR! To make it easier for reviewers and
everyone else to understand what your changes relate to, please add some
relevant content to the headings below. Feel free to ignore or delete
sections that you don't think are relevant. Thank you! ❤️ -->

This PR removes the check for deprecated environments when validating
api token environment.

Unifies global and project level tokens allow selection of deprecated
environments when creating an api token

Adds 'deprecated' to the EnvironmentSelector when appropriate

## About the changes
<!-- Describe the changes introduced. What are they and why are they
being introduced? Feel free to also add screenshots or steps to view the
changes if they're visual. -->

<!-- Does it close an issue? Multiple? -->
Closes #

<!-- (For internal contributors): Does it relate to an issue on public
roadmap? -->
<!--
Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item:
#
-->

### Important files
<!-- PRs can contain a lot of changes, but not all changes are equally
important. Where should a reviewer start looking to get an overview of
the changes? Are any files particularly important? -->


## Discussion points
<!-- Anything about the PR you'd like to discuss before it gets merged?
Got any questions or doubts? -->

Signed-off-by: andreas-unleash <andreas@getunleash.ai>
This commit is contained in:
andreas-unleash 2023-03-29 10:33:14 +03:00 committed by GitHub
parent 0a6f1ecf77
commit 9b6f5cd198
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 10 additions and 44 deletions

View File

@ -5,38 +5,29 @@ import {
StyledInputDescription, StyledInputDescription,
StyledSelectInput, StyledSelectInput,
} from '../ApiTokenForm.styles'; } from '../ApiTokenForm.styles';
import { import { useEnvironments } from 'hooks/api/getters/useEnvironments/useEnvironments';
IEnvironment,
IProjectEnvironment,
} from '../../../../../interfaces/environments';
interface IEnvironmentSelectorProps { interface IEnvironmentSelectorProps {
type: string; type: string;
environment?: string; environment?: string;
environments: IProjectEnvironment[] | IEnvironment[];
setEnvironment: React.Dispatch<React.SetStateAction<string | undefined>>; setEnvironment: React.Dispatch<React.SetStateAction<string | undefined>>;
} }
export const EnvironmentSelector = ({ export const EnvironmentSelector = ({
type, type,
environment, environment,
setEnvironment, setEnvironment,
environments,
}: IEnvironmentSelectorProps) => { }: IEnvironmentSelectorProps) => {
const isProjectEnv = ( const { environments } = useEnvironments();
environment: IEnvironment | IProjectEnvironment
): environment is IProjectEnvironment => {
return 'projectVisible' in environment;
};
const selectableEnvs = const selectableEnvs =
type === TokenType.ADMIN type === TokenType.ADMIN
? [{ key: '*', label: 'ALL' }] ? [{ key: '*', label: 'ALL' }]
: environments.map(environment => ({ : environments.map(environment => ({
key: environment.name, key: environment.name,
label: environment.name, label: `${environment.name.concat(
!environment.enabled ? ' - deprecated' : ''
)}`,
title: environment.name, title: environment.name,
disabled: isProjectEnv(environment) disabled: false,
? !environment.projectVisible
: !environment.enabled,
})); }));
return ( return (

View File

@ -18,7 +18,6 @@ import { TokenInfo } from '../ApiTokenForm/TokenInfo/TokenInfo';
import { TokenTypeSelector } from '../ApiTokenForm/TokenTypeSelector/TokenTypeSelector'; import { TokenTypeSelector } from '../ApiTokenForm/TokenTypeSelector/TokenTypeSelector';
import { ProjectSelector } from '../ApiTokenForm/ProjectSelector/ProjectSelector'; import { ProjectSelector } from '../ApiTokenForm/ProjectSelector/ProjectSelector';
import { EnvironmentSelector } from '../ApiTokenForm/EnvironmentSelector/EnvironmentSelector'; import { EnvironmentSelector } from '../ApiTokenForm/EnvironmentSelector/EnvironmentSelector';
import { useEnvironments } from '../../../../hooks/api/getters/useEnvironments/useEnvironments';
const pageTitle = 'Create API token'; const pageTitle = 'Create API token';
interface ICreateApiTokenProps { interface ICreateApiTokenProps {
@ -30,7 +29,6 @@ export const CreateApiToken = ({ modal = false }: ICreateApiTokenProps) => {
const navigate = useNavigate(); const navigate = useNavigate();
const [showConfirm, setShowConfirm] = useState(false); const [showConfirm, setShowConfirm] = useState(false);
const [token, setToken] = useState(''); const [token, setToken] = useState('');
const { environments } = useEnvironments();
const { const {
getApiTokenPayload, getApiTokenPayload,
@ -127,7 +125,6 @@ export const CreateApiToken = ({ modal = false }: ICreateApiTokenProps) => {
/> />
<EnvironmentSelector <EnvironmentSelector
type={type} type={type}
environments={environments}
environment={environment} environment={environment}
setEnvironment={setEnvironment} setEnvironment={setEnvironment}
/> />

View File

@ -1,4 +1,4 @@
import { useMemo, useState } from 'react'; import { useState } from 'react';
import { useNavigate } from 'react-router-dom'; import { useNavigate } from 'react-router-dom';
import FormTemplate from 'component/common/FormTemplate/FormTemplate'; import FormTemplate from 'component/common/FormTemplate/FormTemplate';
@ -21,9 +21,6 @@ import { TokenTypeSelector } from 'component/admin/apiToken/ApiTokenForm/TokenTy
import { ConfirmToken } from 'component/admin/apiToken/ConfirmToken/ConfirmToken'; import { ConfirmToken } from 'component/admin/apiToken/ConfirmToken/ConfirmToken';
import { useProjectApiTokens } from 'hooks/api/getters/useProjectApiTokens/useProjectApiTokens'; import { useProjectApiTokens } from 'hooks/api/getters/useProjectApiTokens/useProjectApiTokens';
import { usePlausibleTracker } from 'hooks/usePlausibleTracker'; import { usePlausibleTracker } from 'hooks/usePlausibleTracker';
import { useProjectEnvironments } from '../../../../../hooks/api/getters/useProjectEnvironments/useProjectEnvironments';
import { IProjectEnvironment } from '../../../../../interfaces/environments';
import useProject from '../../../../../hooks/api/getters/useProject/useProject';
const pageTitle = 'Create project API token'; const pageTitle = 'Create project API token';
@ -52,19 +49,7 @@ export const CreateProjectApiTokenForm = () => {
useProjectApiTokensApi(); useProjectApiTokensApi();
const { refetch: refetchProjectTokens } = useProjectApiTokens(projectId); const { refetch: refetchProjectTokens } = useProjectApiTokens(projectId);
const { trackEvent } = usePlausibleTracker(); const { trackEvent } = usePlausibleTracker();
const { environments } = useProjectEnvironments(projectId);
const { project } = useProject(projectId);
const projectEnvironments = useMemo<IProjectEnvironment[]>(
() =>
environments.map(environment => ({
...environment,
projectVisible: project?.environments.includes(
environment.name
),
})),
[environments, project?.environments]
);
usePageTitle(pageTitle); usePageTitle(pageTitle);
const PATH = `api/admin/project/${projectId}/api-tokens`; const PATH = `api/admin/project/${projectId}/api-tokens`;
@ -146,7 +131,6 @@ export const CreateProjectApiTokenForm = () => {
type={type} type={type}
environment={environment} environment={environment}
setEnvironment={setEnvironment} setEnvironment={setEnvironment}
environments={projectEnvironments}
/> />
</ApiTokenForm> </ApiTokenForm>
<ConfirmToken <ConfirmToken

View File

@ -128,10 +128,4 @@ export const validateApiTokenEnvironment = (
if (!selectedEnvironment) { if (!selectedEnvironment) {
throw new BadDataError(`Environment=${environment} does not exist`); throw new BadDataError(`Environment=${environment} does not exist`);
} }
if (!selectedEnvironment.enabled) {
throw new BadDataError(
'Client token cannot be scoped to disabled environments',
);
}
}; };

View File

@ -2,7 +2,7 @@ import { setupApp } from '../../helpers/test-helper';
import dbInit from '../../helpers/database-init'; import dbInit from '../../helpers/database-init';
import getLogger from '../../../fixtures/no-logger'; import getLogger from '../../../fixtures/no-logger';
import { ALL, ApiTokenType } from '../../../../lib/types/models/api-token'; import { ALL, ApiTokenType } from '../../../../lib/types/models/api-token';
import { DEFAULT_ENV } from '../../../../lib/util/constants'; import { DEFAULT_ENV } from '../../../../lib/util';
let db; let db;
let app; let app;
@ -332,7 +332,7 @@ test('client tokens cannot span all environments', async () => {
.expect(400); .expect(400);
}); });
test('should not create token for disabled environment', async () => { test('should create token for disabled environment', async () => {
await db.stores.environmentStore.create({ await db.stores.environmentStore.create({
name: 'disabledEnvironment', name: 'disabledEnvironment',
type: 'production', type: 'production',
@ -347,5 +347,5 @@ test('should not create token for disabled environment', async () => {
environment: 'disabledEnvironment', environment: 'disabledEnvironment',
}) })
.set('Content-Type', 'application/json') .set('Content-Type', 'application/json')
.expect(400); .expect(201);
}); });