Skip to content

fix: Add Trends Line graph on Deployment events page #652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 165 additions & 0 deletions web-server/src/content/DoraMetrics/DoraMetricsDuration.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
import { Card, Chip, Tooltip, useTheme } from '@mui/material';
import { FC, useMemo } from 'react';
import { CheckCircleRounded, AccessTimeRounded, OpenInNew, Code, ArrowForwardIosRounded } from '@mui/icons-material';

import { FlexBox } from '@/components/FlexBox';
import { Line } from '@/components/Text';
import { Deployment } from '@/types/resources';
import { getDurationString, isoDateString } from '@/utils/date';

type DeploymentCardType = 'Longest' | 'Shortest';


interface DeploymentCardProps {
deployment: Deployment;
type: DeploymentCardType;
}

interface DoraMetricsDurationProps {
deployments: Deployment[];
}


const formatDeploymentDate = (dateString: string): string => {
if (!dateString) return 'Unknown Date';

try {
const date = new Date(dateString);
const isoDate = isoDateString(date);
const formattedDate = new Date(isoDate);

const options: Intl.DateTimeFormatOptions = {
month: 'short',
day: 'numeric',
year: 'numeric',
hour: 'numeric',
minute: 'numeric',
hour12: true
};

return formattedDate.toLocaleDateString('en-US', options);
} catch (error) {
console.error('Error formatting date:', error);
return 'Invalid Date';
}
};

const DeploymentCard: FC<DeploymentCardProps> = ({ deployment }) => {
const theme = useTheme();

const handleDeploymentClick = () => {
if (deployment.html_url) {
window.open(deployment.html_url, '_blank', 'noopener,noreferrer');
}
};
Comment on lines +47 to +54
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

DeploymentCard crashes when deployment is null

longestDeployment / shortestDeployment can be null, yet the prop is typed as non-nullable.
This causes a TypeScript error and a potential runtime exception when there are no valid deployments.

-interface DeploymentCardProps {
-  deployment: DeploymentWithValidDuration;
+interface DeploymentCardProps {
+  deployment?: DeploymentWithValidDuration | null;

Add an early return inside the component:

-  const theme = useTheme();
+  const theme = useTheme();
+  if (!deployment) {
+    return (
+      <Card elevation={0} sx={{ p: 1.6, flex: 1, textAlign: 'center' }}>
+        <Line white>No data</Line>
+      </Card>
+    );
+  }

And adjust the caller:

-<DeploymentCard deployment={longestDeployment} type="Longest" />
+<DeploymentCard deployment={longestDeployment} type="Longest" />


return (
<Card
elevation={0}
sx={{
flex: 1,
p: 1.6,
width: '20vw',
maxWidth: '30vw',
border: `1px solid ${theme.palette.primary.light}`,
borderRadius: 2,
}}
>
<FlexBox col gap={1.2} sx={{ position: 'relative' }}>
<FlexBox gap={0.8} alignItems="center" >
<FlexBox alignItems="center" gap={1}>
<CheckCircleRounded color="success" fontSize="inherit" />
<Line white semibold>Run On {formatDeploymentDate(deployment.conducted_at)}</Line>
</FlexBox>
<Tooltip title="Open in new tab" arrow>
<FlexBox
alignItems="center"
gap={0.5}
sx={{
cursor: deployment.html_url ? 'pointer' : 'not-allowed',
opacity: deployment.html_url ? 1 : 0.7
}}
onClick={handleDeploymentClick}
>
<OpenInNew fontSize="inherit" />
</FlexBox>
</Tooltip>
</FlexBox>

<FlexBox gap={0.8} alignItems="center" justifyContent="space-between">
<FlexBox gap={0.8} alignItems="center" flex={1}>
<Code fontSize="small" />
<Line sx={{ color: theme.palette.primary.light }}>
{deployment.pr_count || 0} new PR's
</Line>
<Line sx={{ color: theme.palette.primary.light }}>
{deployment.head_branch || 'Unknown Branch'}
</Line>
<AccessTimeRounded fontSize="small" />
<Line sx={{ color: theme.palette.primary.light }}>
{getDurationString(deployment.run_duration)}
</Line>
</FlexBox>
<ArrowForwardIosRounded
sx={{
position: 'absolute',
right: 0,
top: '35%',
bottom: '35%',
}}
fontSize="medium"
/>
</FlexBox>
</FlexBox>
</Card>
);
};

export const DoraMetricsDuration: FC<DoraMetricsDurationProps> = ({ deployments }) => {
const { longestDeployment, shortestDeployment } = useMemo(() => {
if (!Array.isArray(deployments) || !deployments.length) {
return { longestDeployment: null, shortestDeployment: null };
}

const validDeployments = deployments
.filter((d): d is Deployment => Boolean(d.conducted_at && typeof d.run_duration === 'number'))
.filter((d) => d.run_duration >= 0);

if (!validDeployments.length) {
return { longestDeployment: null, shortestDeployment: null };
}

// Function to calculate Longest and shortest deployments
const { longest, shortest } = validDeployments.reduce((acc, current) => ({
longest: !acc.longest || current.run_duration > acc.longest.run_duration ? current : acc.longest,
shortest: !acc.shortest || current.run_duration < acc.shortest.run_duration ? current : acc.shortest
}), {
longest: null as Deployment | null,
shortest: null as Deployment | null
});

return { longestDeployment: longest, shortestDeployment: shortest };
}, [deployments]);

return (
<FlexBox col gap={1.5}>
<FlexBox gap={3}>
<FlexBox col gap={1}>
<Line white sx={{ fontSize: '1.0rem' }} semibold>Longest Deployment</Line>
<DeploymentCard
deployment={longestDeployment}
type="Longest"
/>
</FlexBox>

<FlexBox col gap={1}>
<Line white sx={{ fontSize: '1.0rem' }} semibold>Shortest Deployment</Line>
<DeploymentCard
deployment={shortestDeployment}
type="Shortest"
/>
</FlexBox>
</FlexBox>
</FlexBox>
);
};
Loading