mirror of
https://github.com/Unleash/unleash.git
synced 2025-07-21 13:47:39 +02:00
f7c667e410
Splits the insights page into separate sections with their own separate filters. Each filter is sticky to the top of the page, similar to how the previous filters worked. In doing this, I have also moved around a lot of code. Refer to the inline comments for more specific examples, but on a high level, this PR: - Moves the flag check from InsightsCharts into Insights itself. Because the old Insights had filters and state, and the new one does not, it made sense to fork off higher up in the tree. Because the new version doesn't have state, I have also simplified it and removed an intermediate component (InsightsCharts) that doesn't feel necessary anymore. - Because InsightsCharts isn't used anymore, I've moved the LegacyInsightsCharts file back into InsightsCharts. However, I'm happy to move it back if we think that's useful. - Instead of all charts living in InsightsCharts, I've split each section into its own file in the new sections directory. Because the sections have separate filters, they don't share any state anymore, so there's nothing they share. - I'm reusing the existing hook and endpoint. As it stands, the performance insights use **most** of the data from that payload (but not all of it). The user insights use some of it. Flag lifecycle insights doesn't use anything, but I've wired it up to make the filters work. I expect that we'll iterate on the API endpoints etc later. 
321 lines
14 KiB
TypeScript
321 lines
14 KiB
TypeScript
import type { FC } from 'react';
|
||
import { Box, Paper, styled } from '@mui/material';
|
||
import { UserStats } from './componentsStat/UserStats/UserStats.tsx';
|
||
import { UsersChart } from './componentsChart/UsersChart/UsersChart.tsx';
|
||
import { UsersPerProjectChart } from './componentsChart/UsersPerProjectChart/UsersPerProjectChart.tsx';
|
||
import { FlagStats } from './componentsStat/FlagStats/FlagStats.tsx';
|
||
import { FlagsChart } from './componentsChart/FlagsChart/FlagsChart.tsx';
|
||
import { FlagsProjectChart } from './componentsChart/FlagsProjectChart/FlagsProjectChart.tsx';
|
||
import { HealthStats } from './componentsStat/HealthStats/HealthStats.tsx';
|
||
import { ProjectHealthChart } from './componentsChart/ProjectHealthChart/ProjectHealthChart.tsx';
|
||
import { TimeToProduction } from './componentsStat/TimeToProduction/TimeToProduction.tsx';
|
||
import { TimeToProductionChart } from './componentsChart/TimeToProductionChart/TimeToProductionChart.tsx';
|
||
import { MetricsSummaryChart } from './componentsChart/MetricsSummaryChart/MetricsSummaryChart.tsx';
|
||
import { UpdatesPerEnvironmentTypeChart } from './componentsChart/UpdatesPerEnvironmentTypeChart/UpdatesPerEnvironmentTypeChart.tsx';
|
||
import type { InstanceInsightsSchema } from 'openapi';
|
||
import type { GroupedDataByProject } from './hooks/useGroupedProjectTrends.ts';
|
||
import { allOption } from 'component/common/ProjectSelect/ProjectSelect';
|
||
import useUiConfig from 'hooks/api/getters/useUiConfig/useUiConfig';
|
||
import { WidgetTitle } from './components/WidgetTitle/WidgetTitle.tsx';
|
||
import { ConditionallyRender } from 'component/common/ConditionallyRender/ConditionallyRender';
|
||
|
||
export interface IChartsProps {
|
||
flagTrends: InstanceInsightsSchema['flagTrends'];
|
||
projectsData: InstanceInsightsSchema['projectFlagTrends'];
|
||
groupedProjectsData: GroupedDataByProject<
|
||
InstanceInsightsSchema['projectFlagTrends']
|
||
>;
|
||
metricsData: InstanceInsightsSchema['metricsSummaryTrends'];
|
||
groupedMetricsData: GroupedDataByProject<
|
||
InstanceInsightsSchema['metricsSummaryTrends']
|
||
>;
|
||
userTrends: InstanceInsightsSchema['userTrends'];
|
||
environmentTypeTrends: InstanceInsightsSchema['environmentTypeTrends'];
|
||
summary: {
|
||
total: number;
|
||
active: number;
|
||
stale: number;
|
||
potentiallyStale: number;
|
||
averageUsers: number;
|
||
averageHealth?: string;
|
||
flagsPerUser?: string;
|
||
medianTimeToProduction?: number;
|
||
};
|
||
loading: boolean;
|
||
projects: string[];
|
||
allMetricsDatapoints: string[];
|
||
}
|
||
|
||
const StyledContainer = styled(Box)(({ theme }) => ({
|
||
display: 'flex',
|
||
flexDirection: 'column',
|
||
gap: theme.spacing(2),
|
||
}));
|
||
|
||
const StyledWidget = styled(Paper)(({ theme }) => ({
|
||
borderRadius: `${theme.shape.borderRadiusLarge}px`,
|
||
boxShadow: 'none',
|
||
display: 'flex',
|
||
flexWrap: 'wrap',
|
||
[theme.breakpoints.up('md')]: {
|
||
flexDirection: 'row',
|
||
flexWrap: 'nowrap',
|
||
},
|
||
}));
|
||
|
||
const StyledWidgetContent = styled(Box)(({ theme }) => ({
|
||
padding: theme.spacing(3),
|
||
width: '100%',
|
||
}));
|
||
|
||
const StyledWidgetStats = styled(Box)<{ width?: number; padding?: number }>(
|
||
({ theme, width = 300, padding = 3 }) => ({
|
||
display: 'flex',
|
||
flexDirection: 'column',
|
||
gap: theme.spacing(2),
|
||
padding: theme.spacing(padding),
|
||
minWidth: '100%',
|
||
[theme.breakpoints.up('md')]: {
|
||
minWidth: `${width}px`,
|
||
borderRight: `1px solid ${theme.palette.background.application}`,
|
||
},
|
||
}),
|
||
);
|
||
|
||
const StyledChartContainer = styled(Box)(({ theme }) => ({
|
||
position: 'relative',
|
||
minWidth: 0, // bugfix, see: https://github.com/chartjs/Chart.js/issues/4156#issuecomment-295180128
|
||
flexGrow: 1,
|
||
margin: 'auto 0',
|
||
padding: theme.spacing(3),
|
||
}));
|
||
|
||
export const InsightsCharts: FC<IChartsProps> = ({
|
||
projects,
|
||
summary,
|
||
userTrends,
|
||
groupedProjectsData,
|
||
flagTrends,
|
||
groupedMetricsData,
|
||
environmentTypeTrends,
|
||
allMetricsDatapoints,
|
||
loading,
|
||
}) => {
|
||
const showAllProjects = projects[0] === allOption.id;
|
||
const isOneProjectSelected = projects.length === 1;
|
||
const { isEnterprise } = useUiConfig();
|
||
|
||
const lastUserTrend = userTrends[userTrends.length - 1];
|
||
const lastFlagTrend = flagTrends[flagTrends.length - 1];
|
||
|
||
const usersTotal = lastUserTrend?.total ?? 0;
|
||
const usersActive = lastUserTrend?.active ?? 0;
|
||
const usersInactive = lastUserTrend?.inactive ?? 0;
|
||
const flagsTotal = lastFlagTrend?.total ?? 0;
|
||
|
||
function getFlagsPerUser(flagsTotal: number, usersTotal: number) {
|
||
const flagsPerUserCalculation = flagsTotal / usersTotal;
|
||
return Number.isNaN(flagsPerUserCalculation)
|
||
? 'N/A'
|
||
: flagsPerUserCalculation.toFixed(2);
|
||
}
|
||
|
||
return (
|
||
<StyledContainer>
|
||
<ConditionallyRender
|
||
condition={showAllProjects}
|
||
show={
|
||
<>
|
||
<StyledWidget>
|
||
<StyledWidgetStats>
|
||
<WidgetTitle title='Total users' />
|
||
<UserStats
|
||
count={usersTotal}
|
||
active={usersActive}
|
||
inactive={usersInactive}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledWidgetStats>
|
||
<StyledChartContainer>
|
||
<UsersChart
|
||
userTrends={userTrends}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledChartContainer>
|
||
</StyledWidget>
|
||
</>
|
||
}
|
||
elseShow={
|
||
<>
|
||
<StyledWidget>
|
||
<StyledWidgetStats>
|
||
<WidgetTitle
|
||
title={
|
||
isOneProjectSelected
|
||
? 'Users in project'
|
||
: 'Users per project on average'
|
||
}
|
||
tooltip={
|
||
isOneProjectSelected
|
||
? 'Number of users in selected projects.'
|
||
: 'Average number of users for selected projects.'
|
||
}
|
||
/>
|
||
<UserStats
|
||
count={summary.averageUsers}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledWidgetStats>
|
||
<StyledChartContainer>
|
||
<UsersPerProjectChart
|
||
projectFlagTrends={groupedProjectsData}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledChartContainer>
|
||
</StyledWidget>
|
||
</>
|
||
}
|
||
/>
|
||
<ConditionallyRender
|
||
condition={isEnterprise()}
|
||
show={
|
||
<>
|
||
<StyledWidget>
|
||
<StyledWidgetStats width={350} padding={0}>
|
||
<HealthStats
|
||
value={summary.averageHealth}
|
||
healthy={summary.active}
|
||
stale={summary.stale}
|
||
potentiallyStale={summary.potentiallyStale}
|
||
title={
|
||
<WidgetTitle
|
||
title='Health'
|
||
tooltip={
|
||
'Percentage of flags that are not stale or potentially stale.'
|
||
}
|
||
/>
|
||
}
|
||
/>
|
||
</StyledWidgetStats>
|
||
<StyledChartContainer>
|
||
<ProjectHealthChart
|
||
projectFlagTrends={groupedProjectsData}
|
||
isAggregate={showAllProjects}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledChartContainer>
|
||
</StyledWidget>
|
||
<StyledWidget>
|
||
<StyledWidgetStats>
|
||
<WidgetTitle
|
||
title='Median time to production'
|
||
tooltip={`How long does it currently take on average from when a feature flag was created until it was enabled in a "production" type environment. This is calculated only from feature flags of the type "release" and is the median across the selected projects.`}
|
||
/>
|
||
<TimeToProduction
|
||
daysToProduction={
|
||
summary.medianTimeToProduction
|
||
}
|
||
/>
|
||
</StyledWidgetStats>
|
||
<StyledChartContainer>
|
||
<TimeToProductionChart
|
||
projectFlagTrends={groupedProjectsData}
|
||
isAggregate={showAllProjects}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledChartContainer>
|
||
</StyledWidget>
|
||
</>
|
||
}
|
||
/>
|
||
<ConditionallyRender
|
||
condition={showAllProjects}
|
||
show={
|
||
<>
|
||
<StyledWidget>
|
||
<StyledWidgetStats width={275}>
|
||
<WidgetTitle title='Flags' />
|
||
<FlagStats
|
||
count={flagsTotal}
|
||
flagsPerUser={getFlagsPerUser(
|
||
flagsTotal,
|
||
usersTotal,
|
||
)}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledWidgetStats>
|
||
<StyledChartContainer>
|
||
<FlagsChart
|
||
flagTrends={flagTrends}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledChartContainer>
|
||
</StyledWidget>
|
||
</>
|
||
}
|
||
elseShow={
|
||
<>
|
||
<StyledWidget>
|
||
<StyledWidgetStats width={275}>
|
||
<WidgetTitle title='Flags' />
|
||
<FlagStats
|
||
count={summary.total}
|
||
flagsPerUser={''}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledWidgetStats>
|
||
<StyledChartContainer>
|
||
<FlagsProjectChart
|
||
projectFlagTrends={groupedProjectsData}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledChartContainer>
|
||
</StyledWidget>
|
||
</>
|
||
}
|
||
/>
|
||
<ConditionallyRender
|
||
condition={isEnterprise()}
|
||
show={
|
||
<>
|
||
<StyledWidget>
|
||
<StyledWidgetContent>
|
||
<WidgetTitle
|
||
title='Flag evaluation metrics'
|
||
tooltip='Summary of all flag evaluations reported by SDKs.'
|
||
/>
|
||
<StyledChartContainer>
|
||
<MetricsSummaryChart
|
||
metricsSummaryTrends={
|
||
groupedMetricsData
|
||
}
|
||
allDatapointsSorted={
|
||
allMetricsDatapoints
|
||
}
|
||
isAggregate={showAllProjects}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledChartContainer>
|
||
</StyledWidgetContent>
|
||
</StyledWidget>
|
||
<StyledWidget>
|
||
<StyledWidgetContent>
|
||
<WidgetTitle
|
||
title='Updates per environment type'
|
||
tooltip='Summary of all configuration updates per environment type.'
|
||
/>
|
||
<UpdatesPerEnvironmentTypeChart
|
||
environmentTypeTrends={
|
||
environmentTypeTrends
|
||
}
|
||
isLoading={loading}
|
||
/>
|
||
</StyledWidgetContent>
|
||
</StyledWidget>
|
||
</>
|
||
}
|
||
/>
|
||
</StyledContainer>
|
||
);
|
||
};
|