refactor webhookAnalytics call and enrich analytics module (#8253)
**TLDR** Refactor WebhoonAnalytics Graph to a more abstract version AnalyticsGraph (in analytics module). Thus enabling the components to be used on different instances (ex: new endpoint, new kind of graph). **In order to test:** 1. Set ANALYTICS_ENABLED to true 2. Set TINYBIRD_JWT_TOKEN to the ADMIN token from the workspace twenty_analytics_playground 3. Set TINYBIRD_JWT_TOKEN to the datasource or your admin token from the workspace twenty_analytics_playground 4. Create a Webhook in twenty and set wich events it needs to track 5. Run twenty-worker in order to make the webhooks work. 6. Do your tasks in order to populate the data 7. Enter to settings> webhook>your webhook and the statistics section should be displayed. --------- Co-authored-by: Félix Malfait <felix@twenty.com>
This commit is contained in:
Ana Sofia Marin Alexandre
committed by
GitHub
GitHub
parent
f9c076df31
commit
f06cdbdfc6
@ -0,0 +1,181 @@
|
||||
import { WebhookAnalyticsTooltip } from '@/analytics/components/WebhookAnalyticsTooltip';
|
||||
import { ANALYTICS_GRAPH_DESCRIPTION_MAP } from '@/analytics/constants/AnalyticsGraphDescriptionMap';
|
||||
import { ANALYTICS_GRAPH_TITLE_MAP } from '@/analytics/constants/AnalyticsGraphTitleMap';
|
||||
import { useGraphData } from '@/analytics/hooks/useGraphData';
|
||||
import { analyticsGraphDataComponentState } from '@/analytics/states/analyticsGraphDataComponentState';
|
||||
import { AnalyticsComponentProps as AnalyticsActivityGraphProps } from '@/analytics/types/AnalyticsComponentProps';
|
||||
import { computeAnalyticsGraphDataFunction } from '@/analytics/utils/computeAnalyticsGraphDataFunction';
|
||||
import { Select } from '@/ui/input/components/Select';
|
||||
import { useRecoilComponentStateV2 } from '@/ui/utilities/state/component-state/hooks/useRecoilComponentStateV2';
|
||||
import { useTheme } from '@emotion/react';
|
||||
import styled from '@emotion/styled';
|
||||
import { ResponsiveLine } from '@nivo/line';
|
||||
import { Section } from '@react-email/components';
|
||||
import { useId, useState } from 'react';
|
||||
import { H2Title } from 'twenty-ui';
|
||||
|
||||
const StyledGraphContainer = styled.div`
|
||||
background-color: ${({ theme }) => theme.background.secondary};
|
||||
border: 1px solid ${({ theme }) => theme.border.color.medium};
|
||||
border-radius: ${({ theme }) => theme.border.radius.md};
|
||||
height: 199px;
|
||||
|
||||
padding: ${({ theme }) => theme.spacing(4, 2, 2, 2)};
|
||||
width: 496px;
|
||||
`;
|
||||
const StyledTitleContainer = styled.div`
|
||||
align-items: flex-start;
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
`;
|
||||
|
||||
export const AnalyticsActivityGraph = ({
|
||||
recordId,
|
||||
endpointName,
|
||||
}: AnalyticsActivityGraphProps) => {
|
||||
const [analyticsGraphData, setAnalyticsGraphData] = useRecoilComponentStateV2(
|
||||
analyticsGraphDataComponentState,
|
||||
);
|
||||
const theme = useTheme();
|
||||
|
||||
const [windowLengthGraphOption, setWindowLengthGraphOption] = useState<
|
||||
'7D' | '1D' | '12H' | '4H'
|
||||
>('7D');
|
||||
|
||||
const { fetchGraphData } = useGraphData({
|
||||
recordId,
|
||||
endpointName,
|
||||
});
|
||||
|
||||
const transformDataFunction = computeAnalyticsGraphDataFunction(endpointName);
|
||||
|
||||
const dropdownId = useId();
|
||||
return (
|
||||
<>
|
||||
{analyticsGraphData.length ? (
|
||||
<Section>
|
||||
<StyledTitleContainer>
|
||||
<H2Title
|
||||
title={`${ANALYTICS_GRAPH_TITLE_MAP[endpointName]}`}
|
||||
description={`${ANALYTICS_GRAPH_DESCRIPTION_MAP[endpointName]}`}
|
||||
/>
|
||||
<Select
|
||||
dropdownId={dropdownId}
|
||||
value={windowLengthGraphOption}
|
||||
options={[
|
||||
{ value: '7D', label: 'This week' },
|
||||
{ value: '1D', label: 'Today' },
|
||||
{ value: '12H', label: 'Last 12 hours' },
|
||||
{ value: '4H', label: 'Last 4 hours' },
|
||||
]}
|
||||
onChange={(windowLengthGraphOption) => {
|
||||
setWindowLengthGraphOption(windowLengthGraphOption);
|
||||
fetchGraphData(windowLengthGraphOption).then((graphInput) => {
|
||||
setAnalyticsGraphData(transformDataFunction(graphInput));
|
||||
});
|
||||
}}
|
||||
/>
|
||||
</StyledTitleContainer>
|
||||
|
||||
<StyledGraphContainer>
|
||||
<ResponsiveLine
|
||||
data={analyticsGraphData}
|
||||
curve={'monotoneX'}
|
||||
enableArea={true}
|
||||
colors={{ scheme: 'set1' }}
|
||||
//it "addapts" to the color scheme of the graph without hardcoding them
|
||||
//is there a color scheme for graph Data in twenty? Do we always want the gradient?
|
||||
theme={{
|
||||
text: {
|
||||
fill: theme.font.color.light,
|
||||
fontSize: theme.font.size.sm,
|
||||
fontFamily: theme.font.family,
|
||||
},
|
||||
axis: {
|
||||
domain: {
|
||||
line: {
|
||||
stroke: theme.border.color.light,
|
||||
},
|
||||
},
|
||||
ticks: {
|
||||
line: {
|
||||
stroke: theme.border.color.light,
|
||||
},
|
||||
},
|
||||
},
|
||||
grid: {
|
||||
line: {
|
||||
stroke: theme.border.color.light,
|
||||
},
|
||||
},
|
||||
|
||||
crosshair: {
|
||||
line: {
|
||||
stroke: theme.font.color.light,
|
||||
strokeDasharray: '2 2',
|
||||
},
|
||||
},
|
||||
}}
|
||||
margin={{ top: 20, right: 0, bottom: 30, left: 30 }}
|
||||
xFormat="time:%Y-%m-%d %H:%M%"
|
||||
xScale={{
|
||||
type: 'time',
|
||||
useUTC: false,
|
||||
format: '%Y-%m-%d %H:%M:%S',
|
||||
precision: 'hour',
|
||||
}}
|
||||
defs={[
|
||||
{
|
||||
colors: [
|
||||
{
|
||||
color: 'inherit',
|
||||
offset: 0,
|
||||
},
|
||||
{
|
||||
color: 'inherit',
|
||||
offset: 100,
|
||||
opacity: 0,
|
||||
},
|
||||
],
|
||||
id: 'gradientGraph',
|
||||
type: 'linearGradient',
|
||||
},
|
||||
]}
|
||||
fill={[
|
||||
{
|
||||
id: 'gradientGraph',
|
||||
match: '*',
|
||||
},
|
||||
]}
|
||||
yScale={{
|
||||
type: 'linear',
|
||||
}}
|
||||
axisBottom={{
|
||||
format: '%b %d, %I:%M %p', //TODO: add the user prefered time format for the graph
|
||||
tickValues: 2,
|
||||
tickPadding: 5,
|
||||
tickSize: 6,
|
||||
}}
|
||||
axisLeft={{
|
||||
tickPadding: 5,
|
||||
tickSize: 6,
|
||||
tickValues: 4,
|
||||
}}
|
||||
enableGridX={false}
|
||||
lineWidth={1}
|
||||
gridYValues={4}
|
||||
enablePoints={false}
|
||||
isInteractive={true}
|
||||
useMesh={true}
|
||||
enableSlices={false}
|
||||
enableCrosshair={false}
|
||||
tooltip={({ point }) => <WebhookAnalyticsTooltip point={point} />} // later add a condition to get different tooltips
|
||||
/>
|
||||
</StyledGraphContainer>
|
||||
</Section>
|
||||
) : (
|
||||
<></>
|
||||
)}
|
||||
</>
|
||||
);
|
||||
};
|
||||
@ -0,0 +1,32 @@
|
||||
import { useGraphData } from '@/analytics/hooks/useGraphData';
|
||||
import { analyticsGraphDataComponentState } from '@/analytics/states/analyticsGraphDataComponentState';
|
||||
import { AnalyticsComponentProps as AnalyticsGraphEffectProps } from '@/analytics/types/AnalyticsComponentProps';
|
||||
import { computeAnalyticsGraphDataFunction } from '@/analytics/utils/computeAnalyticsGraphDataFunction';
|
||||
import { useSetRecoilComponentStateV2 } from '@/ui/utilities/state/component-state/hooks/useSetRecoilComponentStateV2';
|
||||
import { useState } from 'react';
|
||||
|
||||
export const AnalyticsGraphEffect = ({
|
||||
recordId,
|
||||
endpointName,
|
||||
}: AnalyticsGraphEffectProps) => {
|
||||
const setAnalyticsGraphData = useSetRecoilComponentStateV2(
|
||||
analyticsGraphDataComponentState,
|
||||
);
|
||||
|
||||
const transformDataFunction = computeAnalyticsGraphDataFunction(endpointName);
|
||||
const [isLoaded, setIsLoaded] = useState(false);
|
||||
|
||||
const { fetchGraphData } = useGraphData({
|
||||
recordId,
|
||||
endpointName,
|
||||
});
|
||||
|
||||
if (!isLoaded) {
|
||||
fetchGraphData('7D').then((graphInput) => {
|
||||
setAnalyticsGraphData(transformDataFunction(graphInput));
|
||||
});
|
||||
setIsLoaded(true);
|
||||
}
|
||||
|
||||
return <></>;
|
||||
};
|
||||
@ -0,0 +1,89 @@
|
||||
import { formatDateISOStringToDateTimeSimplified } from '@/localization/utils/formatDateISOStringToDateTimeSimplified';
|
||||
import { UserContext } from '@/users/contexts/UserContext';
|
||||
import styled from '@emotion/styled';
|
||||
import { Point } from '@nivo/line';
|
||||
import { ReactElement, useContext } from 'react';
|
||||
|
||||
const StyledTooltipContainer = styled.div`
|
||||
align-items: center;
|
||||
border-radius: ${({ theme }) => theme.border.radius.md};
|
||||
border: 1px solid ${({ theme }) => theme.border.color.medium};
|
||||
display: flex;
|
||||
width: 128px;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
background: ${({ theme }) => theme.background.transparent.secondary};
|
||||
box-shadow: ${({ theme }) => theme.boxShadow.light};
|
||||
backdrop-filter: ${({ theme }) => theme.blur.medium};
|
||||
`;
|
||||
|
||||
const StyledTooltipDateContainer = styled.div`
|
||||
align-items: flex-start;
|
||||
align-self: stretch;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
font-weight: ${({ theme }) => theme.font.weight.medium};
|
||||
font-family: ${({ theme }) => theme.font.family};
|
||||
gap: ${({ theme }) => theme.spacing(2)};
|
||||
color: ${({ theme }) => theme.font.color.secondary};
|
||||
padding: ${({ theme }) => theme.spacing(2)};
|
||||
`;
|
||||
|
||||
const StyledTooltipDataRow = styled.div`
|
||||
align-items: flex-start;
|
||||
align-self: stretch;
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
color: ${({ theme }) => theme.font.color.tertiary};
|
||||
padding: ${({ theme }) => theme.spacing(2)};
|
||||
`;
|
||||
|
||||
const StyledLine = styled.div`
|
||||
background-color: ${({ theme }) => theme.border.color.medium};
|
||||
height: 1px;
|
||||
width: 100%;
|
||||
`;
|
||||
const StyledColorPoint = styled.div<{ color: string }>`
|
||||
background-color: ${({ color }) => color};
|
||||
border-radius: 50%;
|
||||
height: 8px;
|
||||
width: 8px;
|
||||
display: inline-block;
|
||||
`;
|
||||
const StyledDataDefinition = styled.div`
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: ${({ theme }) => theme.spacing(2)};
|
||||
`;
|
||||
const StyledSpan = styled.span`
|
||||
color: ${({ theme }) => theme.font.color.primary};
|
||||
`;
|
||||
type WebhookAnalyticsTooltipProps = {
|
||||
point: Point;
|
||||
};
|
||||
export const WebhookAnalyticsTooltip = ({
|
||||
point,
|
||||
}: WebhookAnalyticsTooltipProps): ReactElement => {
|
||||
const { timeFormat, timeZone } = useContext(UserContext);
|
||||
const windowInterval = new Date(point.data.x);
|
||||
const windowIntervalDate = formatDateISOStringToDateTimeSimplified(
|
||||
windowInterval,
|
||||
timeZone,
|
||||
timeFormat,
|
||||
);
|
||||
return (
|
||||
<StyledTooltipContainer>
|
||||
<StyledTooltipDateContainer>
|
||||
{windowIntervalDate}
|
||||
</StyledTooltipDateContainer>
|
||||
<StyledLine />
|
||||
<StyledTooltipDataRow>
|
||||
<StyledDataDefinition>
|
||||
<StyledColorPoint color={point.serieColor} />
|
||||
{String(point.serieId)}
|
||||
</StyledDataDefinition>
|
||||
<StyledSpan>{String(point.data.y)}</StyledSpan>
|
||||
</StyledTooltipDataRow>
|
||||
</StyledTooltipContainer>
|
||||
);
|
||||
};
|
||||
Reference in New Issue
Block a user