mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-06 00:07:44 +01:00
356 lines
12 KiB
TypeScript
356 lines
12 KiB
TypeScript
import { useProjectApiTokens } from '../../hooks/api/getters/useProjectApiTokens/useProjectApiTokens';
|
|
import useProjectApiTokensApi from '../../hooks/api/actions/useProjectApiTokensApi/useProjectApiTokensApi';
|
|
import { parseToken } from './parseToken';
|
|
import useToast from '../../hooks/useToast';
|
|
import { formatUnknownError } from '../../utils/formatUnknownError';
|
|
import {
|
|
Box,
|
|
Button,
|
|
styled,
|
|
type Theme,
|
|
Typography,
|
|
useMediaQuery,
|
|
useTheme,
|
|
} from '@mui/material';
|
|
import { SingleSelectConfigButton } from '../common/DialogFormTemplate/ConfigButtons/SingleSelectConfigButton';
|
|
import EnvironmentsIcon from '@mui/icons-material/CloudCircle';
|
|
import { ArcherContainer, ArcherElement } from 'react-archer';
|
|
import { ProjectIcon } from '../common/ProjectIcon/ProjectIcon';
|
|
import CodeIcon from '@mui/icons-material/Code';
|
|
|
|
const ChooseEnvironment = ({
|
|
environments,
|
|
onSelect,
|
|
currentEnvironment,
|
|
}: {
|
|
environments: string[];
|
|
currentEnvironment: string;
|
|
onSelect: (env: string) => void;
|
|
}) => {
|
|
const longestEnv = Math.max(
|
|
...environments.map((environment) => environment.length),
|
|
);
|
|
|
|
return (
|
|
<SingleSelectConfigButton
|
|
tooltip={{ header: '' }}
|
|
description='Select the environment where API key will be created'
|
|
options={environments.map((environment) => ({
|
|
label: environment,
|
|
value: environment,
|
|
}))}
|
|
onChange={(value: any) => {
|
|
onSelect(value);
|
|
}}
|
|
button={{
|
|
label: currentEnvironment,
|
|
icon: <EnvironmentsIcon />,
|
|
labelWidth: `${longestEnv + 5}ch`,
|
|
}}
|
|
search={{
|
|
label: 'Filter project mode options',
|
|
placeholder: 'Select project mode',
|
|
}}
|
|
/>
|
|
);
|
|
};
|
|
|
|
const SecretExplanation = styled('div')(({ theme }) => ({
|
|
backgroundColor: theme.palette.background.elevation1,
|
|
borderRadius: theme.shape.borderRadius,
|
|
padding: theme.spacing(3),
|
|
display: 'flex',
|
|
flexDirection: 'column',
|
|
alignItems: 'center',
|
|
}));
|
|
|
|
const SecretExplanationDescription = styled('div')(({ theme }) => ({
|
|
backgroundColor: theme.palette.primary.contrastText,
|
|
borderRadius: theme.shape.borderRadius,
|
|
padding: theme.spacing(2),
|
|
flex: 1,
|
|
color: theme.palette.text.secondary,
|
|
fontSize: theme.fontSizes.smallBody,
|
|
}));
|
|
|
|
const TokenExplanationBox = styled(Box)(({ theme }) => ({
|
|
display: 'flex',
|
|
gap: theme.spacing(2),
|
|
alignItems: 'flex-start',
|
|
marginTop: theme.spacing(8),
|
|
flexWrap: 'wrap',
|
|
}));
|
|
|
|
const SectionHeader = styled('div')(({ theme }) => ({
|
|
fontWeight: theme.fontWeight.bold,
|
|
marginBottom: theme.spacing(1),
|
|
fontSize: theme.fontSizes.bodySize,
|
|
}));
|
|
|
|
const SectionDescription = styled('p')(({ theme }) => ({
|
|
color: theme.palette.text.secondary,
|
|
fontSize: theme.fontSizes.smallBody,
|
|
marginBottom: theme.spacing(2),
|
|
}));
|
|
|
|
const SpacedContainer = styled('div')(({ theme }) => ({
|
|
padding: theme.spacing(5, 8, 3, 8),
|
|
display: 'flex',
|
|
flexDirection: 'column',
|
|
gap: theme.spacing(3),
|
|
}));
|
|
|
|
const ConceptsDefinitionsWrapper = styled('div')(({ theme }) => ({
|
|
backgroundColor: theme.palette.background.sidebar,
|
|
padding: theme.spacing(6),
|
|
flex: 0,
|
|
minWidth: '400px',
|
|
}));
|
|
|
|
const ConceptDetails = styled('p')(({ theme }) => ({
|
|
color: theme.palette.primary.contrastText,
|
|
fontSize: theme.fontSizes.smallerBody,
|
|
marginBottom: theme.spacing(2),
|
|
}));
|
|
|
|
const IconStyle = ({ theme }: { theme: Theme }) => ({
|
|
color: theme.palette.primary.contrastText,
|
|
fontSize: theme.fontSizes.smallBody,
|
|
marginTop: theme.spacing(0.5),
|
|
});
|
|
|
|
const StyledProjectIcon = styled(ProjectIcon)(IconStyle);
|
|
const StyledEnvironmentsIcon = styled(EnvironmentsIcon)(IconStyle);
|
|
const StyledCodeIcon = styled(CodeIcon)(IconStyle);
|
|
|
|
const ConceptItem = styled('div')(({ theme }) => ({
|
|
display: 'flex',
|
|
gap: theme.spacing(1.5),
|
|
alignItems: 'flex-start',
|
|
marginTop: theme.spacing(3),
|
|
}));
|
|
|
|
const ConceptSummary = styled('div')(({ theme }) => ({
|
|
color: theme.palette.primary.contrastText,
|
|
fontSize: theme.fontSizes.smallBody,
|
|
fontWeight: theme.fontWeight.bold,
|
|
marginBottom: theme.spacing(2),
|
|
}));
|
|
|
|
const TokenExplanation = ({
|
|
project,
|
|
environment,
|
|
secret,
|
|
}: { project: string; environment: string; secret: string }) => {
|
|
const theme = useTheme();
|
|
const isLargeScreen = useMediaQuery(theme.breakpoints.up('lg'));
|
|
|
|
return (
|
|
<ArcherContainer
|
|
strokeColor={theme.palette.secondary.border}
|
|
endMarker={false}
|
|
lineStyle='curve'
|
|
>
|
|
<SecretExplanation>
|
|
<Box sx={{ wordBreak: 'break-all' }}>
|
|
<ArcherElement id='project'>
|
|
<span>{project}</span>
|
|
</ArcherElement>
|
|
:
|
|
<ArcherElement id='environment'>
|
|
<span>{environment}</span>
|
|
</ArcherElement>
|
|
.
|
|
<ArcherElement id='secret'>
|
|
<span>{secret}</span>
|
|
</ArcherElement>
|
|
</Box>
|
|
|
|
{isLargeScreen ? (
|
|
<TokenExplanationBox>
|
|
<ArcherElement
|
|
id='project-description'
|
|
relations={[
|
|
{
|
|
targetId: 'project',
|
|
targetAnchor: 'bottom',
|
|
sourceAnchor: 'top',
|
|
},
|
|
]}
|
|
>
|
|
<SecretExplanationDescription>
|
|
The project this API key will retrieve feature
|
|
flags from
|
|
</SecretExplanationDescription>
|
|
</ArcherElement>
|
|
<ArcherElement
|
|
id='environment-description'
|
|
relations={[
|
|
{
|
|
targetId: 'environment',
|
|
targetAnchor: 'bottom',
|
|
sourceAnchor: 'top',
|
|
},
|
|
]}
|
|
>
|
|
<SecretExplanationDescription>
|
|
The environment the API key will retrieve
|
|
feature flag configuration from
|
|
</SecretExplanationDescription>
|
|
</ArcherElement>
|
|
<ArcherElement
|
|
id='secreat-description'
|
|
relations={[
|
|
{
|
|
targetId: 'secret',
|
|
targetAnchor: 'bottom',
|
|
sourceAnchor: 'top',
|
|
},
|
|
]}
|
|
>
|
|
<SecretExplanationDescription>
|
|
The API key secret
|
|
</SecretExplanationDescription>
|
|
</ArcherElement>
|
|
</TokenExplanationBox>
|
|
) : null}
|
|
</SecretExplanation>
|
|
</ArcherContainer>
|
|
);
|
|
};
|
|
|
|
export const GenrateApiKeyConcepts = () => (
|
|
<ConceptsDefinitionsWrapper>
|
|
<ConceptItem>
|
|
<StyledProjectIcon />
|
|
<Box>
|
|
<ConceptSummary>Flags live in projects</ConceptSummary>
|
|
<ConceptDetails>
|
|
Projects are containers for feature flags. When you create a
|
|
feature flag it will belong to the project you create it in.
|
|
</ConceptDetails>
|
|
</Box>
|
|
</ConceptItem>
|
|
<ConceptItem>
|
|
<StyledEnvironmentsIcon />
|
|
<Box>
|
|
<ConceptSummary>
|
|
Flags have configuration in environments
|
|
</ConceptSummary>
|
|
<ConceptDetails>
|
|
In Unleash you can have multiple environments. Each feature
|
|
flag will have different configuration in every environment.
|
|
</ConceptDetails>
|
|
</Box>
|
|
</ConceptItem>
|
|
<ConceptItem>
|
|
<StyledCodeIcon />
|
|
<Box>
|
|
<ConceptSummary>
|
|
SDKs connect to Unleash to retrieve configuration
|
|
</ConceptSummary>
|
|
<ConceptDetails>
|
|
When you connect an SDK to Unleash it will use the API key
|
|
to deduce which feature flags to retrieve and from which
|
|
environment to retrieve configuration.
|
|
</ConceptDetails>
|
|
</Box>
|
|
</ConceptItem>
|
|
</ConceptsDefinitionsWrapper>
|
|
);
|
|
|
|
interface GenerateApiKeyProps {
|
|
project: string;
|
|
environments: string[];
|
|
environment: string;
|
|
sdkType: 'client' | 'frontend';
|
|
onEnvSelect: (env: string) => void;
|
|
}
|
|
|
|
export const GenerateApiKey = ({
|
|
environments,
|
|
environment,
|
|
project,
|
|
sdkType,
|
|
onEnvSelect,
|
|
}: GenerateApiKeyProps) => {
|
|
const { tokens, refetch: refreshTokens } = useProjectApiTokens(project);
|
|
const { createToken, loading: creatingToken } = useProjectApiTokensApi();
|
|
const currentEnvironmentToken = tokens.find(
|
|
(token) => token.environment === environment && token.type === sdkType,
|
|
);
|
|
const parsedToken = parseToken(currentEnvironmentToken?.secret);
|
|
|
|
const { setToastApiError } = useToast();
|
|
|
|
const generateAPIKey = async () => {
|
|
try {
|
|
await createToken(
|
|
{
|
|
environment,
|
|
type: sdkType,
|
|
projects: [project],
|
|
username: `api-key-${project}-${environment}`,
|
|
},
|
|
project,
|
|
);
|
|
refreshTokens();
|
|
} catch (error: unknown) {
|
|
setToastApiError(formatUnknownError(error));
|
|
}
|
|
};
|
|
|
|
return (
|
|
<SpacedContainer>
|
|
<Typography variant='h2'>Connect an SDK to Unleash</Typography>
|
|
<Box sx={{ mt: 4 }}>
|
|
<SectionHeader>Environment</SectionHeader>
|
|
<SectionDescription>
|
|
The environment SDK will connect to in order to retrieve
|
|
configuration.
|
|
</SectionDescription>
|
|
{environments.length > 0 ? (
|
|
<ChooseEnvironment
|
|
environments={environments}
|
|
currentEnvironment={environment}
|
|
onSelect={onEnvSelect}
|
|
/>
|
|
) : null}
|
|
</Box>
|
|
|
|
<Box sx={{ mt: 3 }}>
|
|
<SectionHeader>API Key</SectionHeader>
|
|
{parsedToken ? (
|
|
<SectionDescription>
|
|
Here is your generated API key. We will use it to
|
|
connect to the <b>{parsedToken.project}</b> project in
|
|
the <b>{parsedToken.environment}</b> environment.
|
|
</SectionDescription>
|
|
) : (
|
|
<SectionDescription>
|
|
You currently have no active API keys for this
|
|
project/environment combination. You'll need to generate
|
|
and API key in order to proceed with connecting your
|
|
SDK.
|
|
</SectionDescription>
|
|
)}
|
|
{parsedToken ? (
|
|
<TokenExplanation
|
|
project={parsedToken.project}
|
|
environment={parsedToken.environment}
|
|
secret={parsedToken.secret}
|
|
/>
|
|
) : (
|
|
<Button
|
|
variant='contained'
|
|
disabled={creatingToken}
|
|
onClick={generateAPIKey}
|
|
>
|
|
Generate API Key
|
|
</Button>
|
|
)}
|
|
</Box>
|
|
</SpacedContainer>
|
|
);
|
|
};
|