Skip to content

Commit

Permalink
Merge branch 'develop' into chore/segment-oss
Browse files Browse the repository at this point in the history
  • Loading branch information
prashant-shahi authored Sep 10, 2024
2 parents efa46d6 + 3c151e3 commit 5c3ee97
Show file tree
Hide file tree
Showing 6 changed files with 161 additions and 14 deletions.
1 change: 1 addition & 0 deletions frontend/src/constants/localStorage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,6 @@ export enum LOCALSTORAGE {
SHOW_EXPLORER_TOOLBAR = 'SHOW_EXPLORER_TOOLBAR',
PINNED_ATTRIBUTES = 'PINNED_ATTRIBUTES',
THEME_ANALYTICS_V1 = 'THEME_ANALYTICS_V1',
LAST_USED_SAVED_VIEWS = 'LAST_USED_SAVED_VIEWS',
SHOW_LOGS_QUICK_FILTERS = 'SHOW_LOGS_QUICK_FILTERS',
}
111 changes: 104 additions & 7 deletions frontend/src/container/ExplorerOptions/ExplorerOptions.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import axios from 'axios';
import cx from 'classnames';
import { getViewDetailsUsingViewKey } from 'components/ExplorerCard/utils';
import { SOMETHING_WENT_WRONG } from 'constants/api';
import { LOCALSTORAGE } from 'constants/localStorage';
import { QueryParams } from 'constants/query';
import { PANEL_TYPES } from 'constants/queryBuilder';
import ROUTES from 'constants/routes';
Expand Down Expand Up @@ -48,6 +49,7 @@ import {
Dispatch,
SetStateAction,
useCallback,
useEffect,
useMemo,
useRef,
useState,
Expand All @@ -61,7 +63,9 @@ import { DataSource, StringOperators } from 'types/common/queryBuilder';
import AppReducer from 'types/reducer/app';
import { USER_ROLES } from 'types/roles';

import { PreservedViewsTypes } from './constants';
import ExplorerOptionsHideArea from './ExplorerOptionsHideArea';
import { PreservedViewsInLocalStorage } from './types';
import {
DATASOURCE_VS_ROUTES,
generateRGBAFromHex,
Expand Down Expand Up @@ -90,6 +94,12 @@ function ExplorerOptions({
const history = useHistory();
const ref = useRef<RefSelectProps>(null);
const isDarkMode = useIsDarkMode();
const isLogsExplorer = sourcepage === DataSource.LOGS;

const PRESERVED_VIEW_LOCAL_STORAGE_KEY = LOCALSTORAGE.LAST_USED_SAVED_VIEWS;
const PRESERVED_VIEW_TYPE = isLogsExplorer
? PreservedViewsTypes.LOGS
: PreservedViewsTypes.TRACES;

const onModalToggle = useCallback((value: boolean) => {
setIsExport(value);
Expand All @@ -107,7 +117,7 @@ function ExplorerOptions({
logEvent('Traces Explorer: Save view clicked', {
panelType,
});
} else if (sourcepage === DataSource.LOGS) {
} else if (isLogsExplorer) {
logEvent('Logs Explorer: Save view clicked', {
panelType,
});
Expand Down Expand Up @@ -141,7 +151,7 @@ function ExplorerOptions({
logEvent('Traces Explorer: Create alert', {
panelType,
});
} else if (sourcepage === DataSource.LOGS) {
} else if (isLogsExplorer) {
logEvent('Logs Explorer: Create alert', {
panelType,
});
Expand All @@ -166,7 +176,7 @@ function ExplorerOptions({
logEvent('Traces Explorer: Add to dashboard clicked', {
panelType,
});
} else if (sourcepage === DataSource.LOGS) {
} else if (isLogsExplorer) {
logEvent('Logs Explorer: Add to dashboard clicked', {
panelType,
});
Expand Down Expand Up @@ -265,6 +275,31 @@ function ExplorerOptions({
[viewsData, handleExplorerTabChange],
);

const updatePreservedViewInLocalStorage = (option: {
key: string;
value: string;
}): void => {
// Retrieve stored views from local storage
const storedViews = localStorage.getItem(PRESERVED_VIEW_LOCAL_STORAGE_KEY);

// Initialize or parse the stored views
const updatedViews: PreservedViewsInLocalStorage = storedViews
? JSON.parse(storedViews)
: {};

// Update the views with the new selection
updatedViews[PRESERVED_VIEW_TYPE] = {
key: option.key,
value: option.value,
};

// Save the updated views back to local storage
localStorage.setItem(
PRESERVED_VIEW_LOCAL_STORAGE_KEY,
JSON.stringify(updatedViews),
);
};

const handleSelect = (
value: string,
option: { key: string; value: string },
Expand All @@ -277,18 +312,42 @@ function ExplorerOptions({
panelType,
viewName: option?.value,
});
} else if (sourcepage === DataSource.LOGS) {
} else if (isLogsExplorer) {
logEvent('Logs Explorer: Select view', {
panelType,
viewName: option?.value,
});
}

updatePreservedViewInLocalStorage(option);

if (ref.current) {
ref.current.blur();
}
};

const removeCurrentViewFromLocalStorage = (): void => {
// Retrieve stored views from local storage
const storedViews = localStorage.getItem(PRESERVED_VIEW_LOCAL_STORAGE_KEY);

if (storedViews) {
// Parse the stored views
const parsedViews = JSON.parse(storedViews);

// Remove the current view type from the parsed views
delete parsedViews[PRESERVED_VIEW_TYPE];

// Update local storage with the modified views
localStorage.setItem(
PRESERVED_VIEW_LOCAL_STORAGE_KEY,
JSON.stringify(parsedViews),
);
}
};

const handleClearSelect = (): void => {
removeCurrentViewFromLocalStorage();

history.replace(DATASOURCE_VS_ROUTES[sourcepage]);
};

Expand Down Expand Up @@ -323,7 +382,7 @@ function ExplorerOptions({
panelType,
viewName: newViewName,
});
} else if (sourcepage === DataSource.LOGS) {
} else if (isLogsExplorer) {
logEvent('Logs Explorer: Save view successful', {
panelType,
viewName: newViewName,
Expand Down Expand Up @@ -358,6 +417,44 @@ function ExplorerOptions({

const isEditDeleteSupported = allowedRoles.includes(role as string);

const [
isRecentlyUsedSavedViewSelected,
setIsRecentlyUsedSavedViewSelected,
] = useState(false);

useEffect(() => {
const parsedPreservedView = JSON.parse(
localStorage.getItem(PRESERVED_VIEW_LOCAL_STORAGE_KEY) || '{}',
);

const preservedView = parsedPreservedView[PRESERVED_VIEW_TYPE] || {};

let timeoutId: string | number | NodeJS.Timeout | undefined;

if (
!!preservedView?.key &&
viewsData?.data?.data &&
!(!!viewName || !!viewKey) &&
!isRecentlyUsedSavedViewSelected
) {
// prevent the race condition with useShareBuilderUrl
timeoutId = setTimeout(() => {
onMenuItemSelectHandler({ key: preservedView.key });
}, 0);
setIsRecentlyUsedSavedViewSelected(false);
}

return (): void => clearTimeout(timeoutId);
}, [
PRESERVED_VIEW_LOCAL_STORAGE_KEY,
PRESERVED_VIEW_TYPE,
isRecentlyUsedSavedViewSelected,
onMenuItemSelectHandler,
viewKey,
viewName,
viewsData?.data?.data,
]);

return (
<div className="explorer-options-container">
{isQueryUpdated && !isExplorerOptionHidden && (
Expand Down Expand Up @@ -476,12 +573,12 @@ function ExplorerOptions({
<Tooltip
title={
<div>
{sourcepage === DataSource.LOGS
{isLogsExplorer
? 'Learn more about Logs explorer '
: 'Learn more about Traces explorer '}
<Typography.Link
href={
sourcepage === DataSource.LOGS
isLogsExplorer
? 'https://signoz.io/docs/product-features/logs-explorer/?utm_source=product&utm_medium=logs-explorer-toolbar'
: 'https://signoz.io/docs/product-features/trace-explorer/?utm_source=product&utm_medium=trace-explorer-toolbar'
}
Expand Down
4 changes: 4 additions & 0 deletions frontend/src/container/ExplorerOptions/constants.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export enum PreservedViewsTypes {
LOGS = 'logs',
TRACES = 'traces',
}
10 changes: 10 additions & 0 deletions frontend/src/container/ExplorerOptions/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import { ICompositeMetricQuery } from 'types/api/alerts/compositeQuery';
import { SaveViewPayloadProps, SaveViewProps } from 'types/api/saveViews/types';
import { DataSource, QueryBuilderContextType } from 'types/common/queryBuilder';

import { PreservedViewsTypes } from './constants';

export interface SaveNewViewHandlerProps {
viewName: string;
compositeQuery: ICompositeMetricQuery;
Expand All @@ -26,3 +28,11 @@ export interface SaveNewViewHandlerProps {
redirectWithQueryBuilderData: QueryBuilderContextType['redirectWithQueryBuilderData'];
setNewViewName: Dispatch<SetStateAction<string>>;
}

export type PreservedViewType =
| PreservedViewsTypes.LOGS
| PreservedViewsTypes.TRACES;

export type PreservedViewsInLocalStorage = Partial<
Record<PreservedViewType, { key: string; value: string }>
>;
1 change: 1 addition & 0 deletions frontend/src/container/TimeSeriesView/TimeSeriesView.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ function TimeSeriesView({
className="graph-container"
style={{ height: '100%', width: '100%' }}
ref={graphRef}
data-testid="time-series-graph"
>
{isLoading &&
(dataSource === DataSource.LOGS ? <LogsLoading /> : <TracesLoading />)}
Expand Down
48 changes: 41 additions & 7 deletions frontend/src/container/TracesExplorer/ListView/utils.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,26 @@ import { getMs } from 'container/Trace/Filters/Panel/PanelBody/Duration/util';
import { formUrlParams } from 'container/TraceDetail/utils';
import dayjs from 'dayjs';
import { RowData } from 'lib/query/createTableColumnsFromQuery';
import { Link } from 'react-router-dom';
import { ILog } from 'types/api/logs/log';
import { BaseAutocompleteData } from 'types/api/queryBuilder/queryAutocompleteResponse';
import { QueryDataV3 } from 'types/api/widgets/getQuery';

function BlockLink({
children,
to,
}: {
children: React.ReactNode;
to: string;
}): any {
// Display block to make the whole cell clickable
return (
<Link to={to} style={{ display: 'block' }}>
{children}
</Link>
);
}

export const transformDataWithDate = (
data: QueryDataV3[],
): Omit<ILog, 'timestamp'>[] =>
Expand Down Expand Up @@ -36,7 +52,11 @@ export const getListColumns = (
typeof item === 'string'
? dayjs(item).format('YYYY-MM-DD HH:mm:ss.SSS')
: dayjs(item / 1e6).format('YYYY-MM-DD HH:mm:ss.SSS');
return <Typography.Text>{date}</Typography.Text>;
return (
<BlockLink to={getTraceLink(item)}>
<Typography.Text>{date}</Typography.Text>
</BlockLink>
);
},
},
];
Expand All @@ -49,22 +69,36 @@ export const getListColumns = (
width: 145,
render: (value): JSX.Element => {
if (value === '') {
return <Typography data-testid={key}>N/A</Typography>;
return (
<BlockLink to={getTraceLink(value)}>
<Typography data-testid={key}>N/A</Typography>
</BlockLink>
);
}

if (key === 'httpMethod' || key === 'responseStatusCode') {
return (
<Tag data-testid={key} color="magenta">
{value}
</Tag>
<BlockLink to={getTraceLink(value)}>
<Tag data-testid={key} color="magenta">
{value}
</Tag>
</BlockLink>
);
}

if (key === 'durationNano') {
return <Typography data-testid={key}>{getMs(value)}ms</Typography>;
return (
<BlockLink to={getTraceLink(value)}>
<Typography data-testid={key}>{getMs(value)}ms</Typography>
</BlockLink>
);
}

return <Typography data-testid={key}>{value}</Typography>;
return (
<BlockLink to={getTraceLink(value)}>
<Typography data-testid={key}>{value}</Typography>
</BlockLink>
);
},
responsive: ['md'],
})) || [];
Expand Down

0 comments on commit 5c3ee97

Please sign in to comment.