mirror of
https://github.com/Unleash/unleash.git
synced 2025-12-09 20:04:11 +01:00
chore: add warning about release plans in import-export (#10805)
https://linear.app/unleash/issue/2-3965/add-a-note-if-were-exporting-that-we-dont-understand-release-plans-in Adds a warning about release plans in import/export. It's not trivial to know every flag that will be exported in every scenario, and whether they have release plans, so our logic here is "have you configured release templates?" <img width="706" height="516" alt="image" src="https://github.com/user-attachments/assets/68ba8618-9887-491c-b46e-256b45700d74" /> <img width="732" height="503" alt="image" src="https://github.com/user-attachments/assets/086e37d4-78ae-4647-93a2-5d1845c2758a" />
This commit is contained in:
parent
f3ab70aeca
commit
4ff41fa6a9
@ -1,5 +1,5 @@
|
|||||||
import { createRef, useState } from 'react';
|
import { createRef, useState } from 'react';
|
||||||
import { styled, Typography, Box } from '@mui/material';
|
import { styled, Typography, Box, Alert } from '@mui/material';
|
||||||
import { Dialogue } from 'component/common/Dialogue/Dialogue';
|
import { Dialogue } from 'component/common/Dialogue/Dialogue';
|
||||||
import GeneralSelect from 'component/common/GeneralSelect/GeneralSelect';
|
import GeneralSelect from 'component/common/GeneralSelect/GeneralSelect';
|
||||||
import { useExportApi } from 'hooks/api/actions/useExportApi/useExportApi';
|
import { useExportApi } from 'hooks/api/actions/useExportApi/useExportApi';
|
||||||
@ -8,10 +8,11 @@ import type { FeatureSchema } from 'openapi';
|
|||||||
|
|
||||||
import { formatUnknownError } from 'utils/formatUnknownError';
|
import { formatUnknownError } from 'utils/formatUnknownError';
|
||||||
import { ConditionallyRender } from '../../common/ConditionallyRender/ConditionallyRender.tsx';
|
import { ConditionallyRender } from '../../common/ConditionallyRender/ConditionallyRender.tsx';
|
||||||
|
import { useReleasePlanTemplates } from 'hooks/api/getters/useReleasePlanTemplates/useReleasePlanTemplates.ts';
|
||||||
|
|
||||||
interface IExportDialogProps {
|
interface IExportDialogProps {
|
||||||
showExportDialog: boolean;
|
showExportDialog: boolean;
|
||||||
data: Pick<FeatureSchema, 'name'>[];
|
data: Pick<FeatureSchema, 'name' | 'environments'>[];
|
||||||
project?: string;
|
project?: string;
|
||||||
onClose: () => void;
|
onClose: () => void;
|
||||||
onConfirm?: () => void;
|
onConfirm?: () => void;
|
||||||
@ -35,6 +36,8 @@ export const ExportDialog = ({
|
|||||||
const { createExport } = useExportApi();
|
const { createExport } = useExportApi();
|
||||||
const ref = createRef<HTMLDivElement>();
|
const ref = createRef<HTMLDivElement>();
|
||||||
const { setToastApiError } = useToast();
|
const { setToastApiError } = useToast();
|
||||||
|
const { templates } = useReleasePlanTemplates();
|
||||||
|
const hasReleaseTemplates = Boolean(templates.length);
|
||||||
|
|
||||||
const getOptions = () =>
|
const getOptions = () =>
|
||||||
environments.map((env) => ({
|
environments.map((env) => ({
|
||||||
@ -88,6 +91,13 @@ export const ExportDialog = ({
|
|||||||
secondaryButtonText='Cancel'
|
secondaryButtonText='Cancel'
|
||||||
>
|
>
|
||||||
<Box ref={ref}>
|
<Box ref={ref}>
|
||||||
|
{hasReleaseTemplates && (
|
||||||
|
<Alert severity='warning' sx={{ mb: 4 }}>
|
||||||
|
Exporting does not include release plans. You may need
|
||||||
|
to set up new release plans for the imported feature
|
||||||
|
flags.
|
||||||
|
</Alert>
|
||||||
|
)}
|
||||||
<ConditionallyRender
|
<ConditionallyRender
|
||||||
condition={data.length > 0}
|
condition={data.length > 0}
|
||||||
show={
|
show={
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
import type { FC } from 'react';
|
import type { FC } from 'react';
|
||||||
import { Box, styled, Typography } from '@mui/material';
|
import { Box, styled, Typography } from '@mui/material';
|
||||||
|
import { useReleasePlanTemplates } from 'hooks/api/getters/useReleasePlanTemplates/useReleasePlanTemplates';
|
||||||
|
|
||||||
const ImportExplanationContainer = styled(Box)(({ theme }) => ({
|
const ImportExplanationContainer = styled(Box)(({ theme }) => ({
|
||||||
backgroundColor: theme.palette.background.elevation2,
|
backgroundColor: theme.palette.background.elevation2,
|
||||||
@ -17,33 +18,45 @@ const ImportExplanationDescription = styled(Box)(({ theme }) => ({
|
|||||||
fontSize: theme.fontSizes.smallBody,
|
fontSize: theme.fontSizes.smallBody,
|
||||||
}));
|
}));
|
||||||
|
|
||||||
export const ImportExplanation: FC = () => (
|
export const ImportExplanation: FC = () => {
|
||||||
<ImportExplanationContainer>
|
const { templates } = useReleasePlanTemplates();
|
||||||
<ImportExplanationHeader>
|
const hasReleaseTemplates = Boolean(templates.length);
|
||||||
What is being imported?
|
return (
|
||||||
</ImportExplanationHeader>
|
<ImportExplanationContainer>
|
||||||
<ImportExplanationDescription>
|
<ImportExplanationHeader>
|
||||||
Feature flags will be imported with full configuration:
|
What is being imported?
|
||||||
<ul>
|
</ImportExplanationHeader>
|
||||||
<li>strategies</li>
|
<ImportExplanationDescription>
|
||||||
<li>context fields</li>
|
Feature flags will be imported with full configuration:
|
||||||
<li>variants</li>
|
<ul>
|
||||||
<li>tags</li>
|
<li>strategies</li>
|
||||||
<li>feature flag status</li>
|
<li>context fields</li>
|
||||||
<li>feature dependencies</li>
|
<li>variants</li>
|
||||||
<li>feature links</li>
|
<li>tags</li>
|
||||||
</ul>
|
<li>feature flag status</li>
|
||||||
</ImportExplanationDescription>
|
<li>feature dependencies</li>
|
||||||
<ImportExplanationHeader>Exceptions?</ImportExplanationHeader>
|
<li>feature links</li>
|
||||||
<ImportExplanationDescription>
|
</ul>
|
||||||
If the feature flag already exists in the new instance, it will be
|
</ImportExplanationDescription>
|
||||||
overwritten
|
<ImportExplanationHeader>Exceptions?</ImportExplanationHeader>
|
||||||
</ImportExplanationDescription>
|
<ImportExplanationDescription>
|
||||||
<ImportExplanationHeader>What is not imported?</ImportExplanationHeader>
|
If the feature flag already exists in the new instance, it will
|
||||||
<ImportExplanationDescription sx={{ marginBottom: 0 }}>
|
be overwritten
|
||||||
If we detect segments or custom strategies in your imported file, we
|
</ImportExplanationDescription>
|
||||||
will stop the import. You need to create them first in the new
|
<ImportExplanationHeader>
|
||||||
instance and run the import again
|
What is not imported?
|
||||||
</ImportExplanationDescription>
|
</ImportExplanationHeader>
|
||||||
</ImportExplanationContainer>
|
<ImportExplanationDescription sx={{ marginBottom: 0 }}>
|
||||||
);
|
If we detect segments or custom strategies in your imported
|
||||||
|
file, we will stop the import. You need to create them first in
|
||||||
|
the new instance and run the import again
|
||||||
|
</ImportExplanationDescription>
|
||||||
|
{hasReleaseTemplates && (
|
||||||
|
<ImportExplanationDescription sx={{ marginTop: 2 }}>
|
||||||
|
Release plans are not included in the import. You may need
|
||||||
|
to set up new release plans for the imported feature flags
|
||||||
|
</ImportExplanationDescription>
|
||||||
|
)}
|
||||||
|
</ImportExplanationContainer>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
import { type FC, type ReactNode, useState } from 'react';
|
import { type FC, type ReactNode, useState } from 'react';
|
||||||
import { Box, IconButton, Tooltip } from '@mui/material';
|
import { Box, IconButton, styled, Tooltip } from '@mui/material';
|
||||||
import useLoading from 'hooks/useLoading';
|
import useLoading from 'hooks/useLoading';
|
||||||
import { PageHeader } from 'component/common/PageHeader/PageHeader';
|
import { PageHeader } from 'component/common/PageHeader/PageHeader';
|
||||||
import { useRequiredPathParam } from 'hooks/useRequiredPathParam';
|
import { useRequiredPathParam } from 'hooks/useRequiredPathParam';
|
||||||
@ -8,6 +8,10 @@ import IosShare from '@mui/icons-material/IosShare';
|
|||||||
import { FlagCreationButton } from './FlagCreationButton/FlagCreationButton.tsx';
|
import { FlagCreationButton } from './FlagCreationButton/FlagCreationButton.tsx';
|
||||||
import { ImportButton } from './ImportButton/ImportButton.tsx';
|
import { ImportButton } from './ImportButton/ImportButton.tsx';
|
||||||
|
|
||||||
|
const StyledIconButton = styled(IconButton)(({ theme }) => ({
|
||||||
|
padding: theme.spacing(1.5),
|
||||||
|
}));
|
||||||
|
|
||||||
type ProjectFeatureTogglesHeaderProps = {
|
type ProjectFeatureTogglesHeaderProps = {
|
||||||
isLoading?: boolean;
|
isLoading?: boolean;
|
||||||
totalItems?: number;
|
totalItems?: number;
|
||||||
@ -39,12 +43,12 @@ export const ProjectFeatureTogglesHeader: FC<
|
|||||||
<>
|
<>
|
||||||
{actions}
|
{actions}
|
||||||
<Tooltip title='Export all project flags' arrow>
|
<Tooltip title='Export all project flags' arrow>
|
||||||
<IconButton
|
<StyledIconButton
|
||||||
data-loading
|
data-loading
|
||||||
onClick={() => setShowExportDialog(true)}
|
onClick={() => setShowExportDialog(true)}
|
||||||
>
|
>
|
||||||
<IosShare />
|
<IosShare />
|
||||||
</IconButton>
|
</StyledIconButton>
|
||||||
</Tooltip>
|
</Tooltip>
|
||||||
<ImportButton />
|
<ImportButton />
|
||||||
|
|
||||||
|
|||||||
@ -335,7 +335,8 @@ export default class FakeFeatureStrategiesStore
|
|||||||
this.featureStrategies.filter(
|
this.featureStrategies.filter(
|
||||||
(strategy) =>
|
(strategy) =>
|
||||||
features.includes(strategy.featureName) &&
|
features.includes(strategy.featureName) &&
|
||||||
strategy.environment === environment,
|
strategy.environment === environment &&
|
||||||
|
!strategy.milestoneId,
|
||||||
),
|
),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@ -278,6 +278,7 @@ class FeatureStrategiesStore implements IFeatureStrategiesStore {
|
|||||||
.select(COLUMNS)
|
.select(COLUMNS)
|
||||||
.from<IFeatureStrategiesTable>(T.featureStrategies)
|
.from<IFeatureStrategiesTable>(T.featureStrategies)
|
||||||
.whereIn('feature_name', features)
|
.whereIn('feature_name', features)
|
||||||
|
.andWhere('milestone_id', null)
|
||||||
.orderBy('feature_name', 'asc');
|
.orderBy('feature_name', 'asc');
|
||||||
if (environment) {
|
if (environment) {
|
||||||
query.where('environment', environment);
|
query.where('environment', environment);
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user