Skip to content
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

chore: use new signal meta properties in event timeline #8421

Merged
merged 5 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
24 changes: 21 additions & 3 deletions frontend/src/component/events/EventTimeline/EventTimeline.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ export type TimelineEventType = 'signal' | EventSchemaType;

type RawTimelineEvent = EventSchema | ISignalQuerySignal;

type TimelineEvent = {
export type TimelineEvent = {
id: number;
timestamp: number;
type: TimelineEventType;
label: string;
summary: string;
icon?: string;
variant?: string;
};

export type TimelineEventGroup = TimelineEvent[];
Expand Down Expand Up @@ -111,6 +113,9 @@ const getTimestamp = (event: RawTimelineEvent) => {
const isInRange = (timestamp: number, startTime: number, endTime: number) =>
timestamp >= startTime && timestamp <= endTime;

const isValidString = (str: unknown): str is string =>
typeof str === 'string' && str.trim().length > 0;

const getTimelineEvent = (
event: RawTimelineEvent,
timestamp: number,
Expand All @@ -122,17 +127,30 @@ const getTimelineEvent = (
sourceName = 'unknown source',
sourceDescription,
tokenName,
payload: {
unleash_title,
unleash_description,
unleash_icon,
unleash_variant,
},
} = event;

const label = `Signal: ${sourceName}`;
const summary = `Signal originated from **[${sourceName} (${tokenName})](/integrations/signals)** endpoint${sourceDescription ? `: ${sourceDescription}` : ''}`;
const title = unleash_title || sourceName;
const label = `Signal: ${title}`;
const summary = unleash_description
? `Signal: **[${title}](/integrations/signals)** ${unleash_description}`
: `Signal originated from **[${sourceName} (${tokenName})](/integrations/signals)** endpoint${sourceDescription ? `: ${sourceDescription}` : ''}`;

return {
id,
timestamp,
type: 'signal',
label,
summary,
...(isValidString(unleash_icon) ? { icon: unleash_icon } : {}),
...(isValidString(unleash_variant)
? { variant: unleash_variant }
: {}),
};
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,18 @@ import FlagOutlinedIcon from '@mui/icons-material/FlagOutlined';
import ExtensionOutlinedIcon from '@mui/icons-material/ExtensionOutlined';
import SegmentsIcon from '@mui/icons-material/DonutLargeOutlined';
import QuestionMarkIcon from '@mui/icons-material/QuestionMark';
import { styled } from '@mui/material';
import type { TimelineEventGroup, TimelineEventType } from '../EventTimeline';
import { Icon, styled } from '@mui/material';
import type {
TimelineEvent,
TimelineEventGroup,
TimelineEventType,
} from '../EventTimeline';
import MoreHorizIcon from '@mui/icons-material/MoreHoriz';
import type { HTMLAttributes } from 'react';
import SensorsIcon from '@mui/icons-material/Sensors';

type DefaultEventVariant = 'secondary';
type CustomEventVariant = 'success' | 'neutral' | 'warning';
type CustomEventVariant = 'success' | 'neutral' | 'warning' | 'error';
type EventVariant = DefaultEventVariant | CustomEventVariant;

const StyledEventCircle = styled('div', {
Expand All @@ -26,17 +30,26 @@ const StyledEventCircle = styled('div', {
alignItems: 'center',
justifyContent: 'center',
transition: 'transform 0.2s',
'& svg': {
'& svg, span': {
color: theme.palette[variant].main,
},
'& svg': {
height: theme.spacing(2.5),
width: theme.spacing(2.5),
},
'& span': {
fontSize: theme.fontSizes.bodySize,
},
'&:hover': {
transform: 'scale(1.5)',
},
}));

const getEventIcon = (type: TimelineEventType) => {
const getEventIcon = ({ icon, type }: TimelineEvent) => {
if (icon) {
return <Icon>{icon}</Icon>;
}

if (type === 'signal') {
return <SensorsIcon />;
}
Expand Down Expand Up @@ -72,6 +85,10 @@ const customEventVariants: Partial<
'feature-archived': 'neutral',
};

const isValidVariant = (variant?: string): variant is EventVariant =>
variant !== undefined &&
['secondary', 'success', 'neutral', 'warning', 'error'].includes(variant);

interface IEventTimelineEventCircleProps
extends HTMLAttributes<HTMLDivElement> {
group: TimelineEventGroup;
Expand All @@ -89,10 +106,14 @@ export const EventTimelineEventCircle = ({

return (
<StyledEventCircle
variant={customEventVariants[event.type]}
variant={
isValidVariant(event.variant)
? event.variant
: customEventVariants[event.type]
}
{...props}
>
{getEventIcon(event.type)}
{getEventIcon(event)}
</StyledEventCircle>
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ const StyledEventTimelineEventCircle = styled(EventTimelineEventCircle)(
'& > svg': {
height: theme.spacing(1.75),
},
'& > span': {
fontSize: theme.fontSizes.smallBody,
},
'&:hover': {
transform: 'none',
},
Expand Down
Loading