Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-23 00:22:19 +01:00
Code Issues Projects Releases Wiki Activity

fix: do not show flagsPerUser when calculation results to NaN (#6639)

Browse Source 
What it says on the tin

Closes #
[1-2209](https://linear.app/unleash/issue/1-2209/total-flag-widget-says-nan-when-no-data)

---------

Signed-off-by: andreas-unleash <andreas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.io>
This commit is contained in:
andreas-unleash 2024-03-21 13:29:48 +02:00 committed by GitHub
parent 3241d14a05
commit bce25bf0f1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 122 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
frontend/src/component/executiveDashboard/Charts.tsx
View File

@ -39,6 +39,7 @@ interface IChartsProps {
potentiallyStale: number;
averageUsers: number;
averageHealth?: string;
flagsPerUser?: string;
};
avgDaysToProduction: number;
loading: boolean;
@ -124,9 +125,7 @@ export const Charts: VFC<IChartsProps> = ({
<FlagStats
count={summary.total}
flagsPerUser={
showAllProjects
? (summary.total / users.total).toFixed(2)
: ''
showAllProjects ? summary.flagsPerUser : ''
}
/>
</Widget>

5
frontend/src/component/executiveDashboard/hooks/useDashboardData.ts
View File

@ -22,7 +22,10 @@ export const useDashboardData = (
);
const groupedMetricsData = useGroupedProjectTrends(metricsData);
const summary = useFilteredFlagsSummary(projectsData);
const summary = useFilteredFlagsSummary(
projectsData,
executiveDashboardData.users,
);
const avgDaysToProduction = useAvgTimeToProduction(groupedProjectsData);

33
frontend/src/component/executiveDashboard/hooks/useFilteredFlagsSummary.test.ts
View File

@ -1,10 +1,12 @@
import { renderHook } from '@testing-library/react-hooks';
import { useFilteredFlagsSummary } from './useFilteredFlagsSummary';
import type { ExecutiveSummarySchemaUsers } from '../../../openapi';
describe('useFilteredFlagTrends', () => {
it('should summarize only last week of project flag trends', () => {
const { result } = renderHook(() =>
useFilteredFlagsSummary([
useFilteredFlagsSummary(
[
{
week: '2024-01',
project: 'project1',
@ -45,7 +47,9 @@ describe('useFilteredFlagTrends', () => {
users: 3,
date: '',
},
]),
],
{ total: 1 } as unknown as ExecutiveSummarySchemaUsers,
),
);
expect(result.current).toEqual({
@ -55,12 +59,14 @@ describe('useFilteredFlagTrends', () => {
potentiallyStale: 1,
averageUsers: 2,
averageHealth: '79',
flagsPerUser: '14.00',
});
});
it('should work with project with zero users', () => {
const { result, rerender } = renderHook(() =>
useFilteredFlagsSummary([
useFilteredFlagsSummary(
[
{
week: '2024-01',
project: 'project1',
@ -71,7 +77,9 @@ describe('useFilteredFlagTrends', () => {
users: 0,
date: '',
},
]),
],
{ total: 1 } as unknown as ExecutiveSummarySchemaUsers,
),
);
expect(result.current).toEqual({
@ -81,12 +89,14 @@ describe('useFilteredFlagTrends', () => {
potentiallyStale: 0,
averageUsers: 0,
averageHealth: '100',
flagsPerUser: '5.00',
});
});
it('should work with projects where some have with zero users', () => {
const { result } = renderHook(() =>
useFilteredFlagsSummary([
useFilteredFlagsSummary(
[
{
week: '2024-01',
project: 'project1',
@ -107,7 +117,9 @@ describe('useFilteredFlagTrends', () => {
users: 3,
date: '',
},
]),
],
{ total: 1 } as unknown as ExecutiveSummarySchemaUsers,
),
);
expect(result.current).toEqual({
@ -117,12 +129,14 @@ describe('useFilteredFlagTrends', () => {
potentiallyStale: 0,
averageUsers: 1.5,
averageHealth: '100',
flagsPerUser: '10.00',
});
});
it('should set health of a project without feature toggles to undefined', () => {
const { result } = renderHook(() =>
useFilteredFlagsSummary([
useFilteredFlagsSummary(
[
{
week: '2024-01',
project: 'project1',
@ -133,7 +147,9 @@ describe('useFilteredFlagTrends', () => {
users: 0,
date: '',
},
]),
],
{ total: 1 } as unknown as ExecutiveSummarySchemaUsers,
),
);
expect(result.current).toEqual({
@ -143,6 +159,7 @@ describe('useFilteredFlagTrends', () => {
potentiallyStale: 0,
averageUsers: 0,
averageHealth: undefined,
flagsPerUser: '0.00',
});
});
});

12
frontend/src/component/executiveDashboard/hooks/useFilteredFlagsSummary.ts
View File

@ -1,9 +1,13 @@
import { useMemo } from 'react';
import type { ExecutiveSummarySchemaProjectFlagTrendsItem } from 'openapi';
import type {
ExecutiveSummarySchemaProjectFlagTrendsItem,
ExecutiveSummarySchemaUsers,
} from 'openapi';
// NOTE: should we move project filtering to the backend?
export const useFilteredFlagsSummary = (
filteredProjectFlagTrends: ExecutiveSummarySchemaProjectFlagTrendsItem[],
users: ExecutiveSummarySchemaUsers,
) =>
useMemo(() => {
const lastWeekId = filteredProjectFlagTrends.reduce((prev, current) => {
@ -38,8 +42,14 @@ export const useFilteredFlagsSummary = (
},
);
const flagsPerUserCalculation = sum.total / users.total;
const flagsPerUser = Number.isNaN(flagsPerUserCalculation)
? 'N/A'
: flagsPerUserCalculation.toFixed(2);
return {
...sum,
flagsPerUser,
averageUsers,
averageHealth: sum.total
? ((sum.active / (sum.total || 1)) * 100).toFixed(0)