Skip to content

[FEATURE]: add timezone logic to the dashbaord toolbar #177

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.

Sign up for GitHub

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

Draft
shahrokni wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[FEATURE]: add timezone logic to the dashbaord toolbar #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion dashboards/src/components/DashboardToolbar/DashboardToolbar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { Typography, Stack, Button, Box, useTheme, useMediaQuery, Alert } from '
import { ErrorBoundary, ErrorAlert } from '@perses-dev/components';
import { TimeRangeControls, useTimeZoneParams } from '@perses-dev/plugin-system';
import { ReactElement, ReactNode } from 'react';
import { DashboardSpec } from '@perses-dev/spec';
import { OnSaveDashboard, useEditMode, useDashboardLinks } from '../../context';
import { AddPanelButton } from '../AddPanelButton';
import { AddGroupButton } from '../AddGroupButton';
Expand All @@ -29,6 +30,11 @@ import { EditAnnotationsButton } from '../Annotations/EditAnnotationsButton';
import { EditDashboardLinksButton } from '../DashboardLinks';
import { LinksDisplay } from '../LinksDisplay';

export type DashboardTimezone = {
specTimezone?: DashboardSpec['timezone'];
userPreferenceTimezone?: DashboardSpec['timezone'];
};

export interface DashboardToolbarProps {
dashboardName: string;
dashboardTitleComponent?: ReactNode;
Expand All @@ -38,6 +44,7 @@ export interface DashboardToolbarProps {
isAnnotationEnabled: boolean;
isDatasourceEnabled: boolean;
isLinksEnabled?: boolean;
dashboardTimezone: DashboardTimezone;
onEditButtonClick: () => void;
onCancelButtonClick: () => void;
onSave?: OnSaveDashboard;
Expand All @@ -53,13 +60,16 @@ export const DashboardToolbar = (props: DashboardToolbarProps): ReactElement =>
isAnnotationEnabled,
isDatasourceEnabled,
isLinksEnabled = true,
dashboardTimezone,
onEditButtonClick,
onCancelButtonClick,
onSave,
} = props;

const { isEditMode } = useEditMode();
const { timeZone, setTimeZone } = useTimeZoneParams('local');
const { timeZone, setTimeZone } = useTimeZoneParams(
dashboardTimezone.specTimezone || dashboardTimezone.userPreferenceTimezone || 'local'
);
const dashboardLinks = useDashboardLinks();

const isBiggerThanSm = useMediaQuery(useTheme().breakpoints.up('sm'));
Expand Down
14 changes: 13 additions & 1 deletion dashboards/src/views/ViewDashboard/DashboardApp.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

import { ReactElement, ReactNode, useState } from 'react';
import { ReactElement, ReactNode, useMemo, useState } from 'react';
import { Box } from '@mui/material';
import { ChartsProvider, ErrorAlert, ErrorBoundary, useChartsTheme } from '@perses-dev/components';
import { useDatasourceStore } from '@perses-dev/plugin-system';
Expand All @@ -30,6 +30,7 @@ import {
EditJsonDialog,
SaveChangesConfirmationDialog,
LeaveDialog,
DashboardTimezone,
} from '../../components';
import { OnSaveDashboard, useDashboard, useDiscardChangesConfirmationDialog, useEditMode } from '../../context';
import { PanelFocusProvider } from '../../keyboard-shortcuts';
Expand All @@ -47,6 +48,7 @@ export interface DashboardAppProps {
// If true, browser confirmation dialog will be shown when navigating away with unsaved changes (closing tab, ...).
isLeavingConfirmDialogEnabled?: boolean;
dashboardTitleComponent?: ReactNode;
userPreferenceTimezone?: DashboardSpec['timezone'];
onSave?: OnSaveDashboard;
onDiscard?: (name: string, spec: DashboardSpec) => void;
}
Expand All @@ -72,6 +74,7 @@ const DashboardAppContent = (props: DashboardAppProps): ReactElement => {
isInitialVariableSticky,
isLeavingConfirmDialogEnabled,
dashboardTitleComponent,
userPreferenceTimezone,
onSave,
onDiscard,
} = props;
Expand Down Expand Up @@ -130,6 +133,14 @@ const DashboardAppContent = (props: DashboardAppProps): ReactElement => {
disabled: disableShortcuts,
});

const dashboardTimezone = useMemo(
(): DashboardTimezone => ({
specTimezone: dashboardResource.spec.timezone,
userPreferenceTimezone,
}),
[dashboardResource.spec, userPreferenceTimezone]
);

return (
<Box
sx={{
Expand All @@ -142,6 +153,7 @@ const DashboardAppContent = (props: DashboardAppProps): ReactElement => {
>
<DashboardToolbar
dashboardName={dashboardResource.metadata.name}
dashboardTimezone={dashboardTimezone}
dashboardTitleComponent={dashboardTitleComponent}
initialVariableIsSticky={isInitialVariableSticky}
onSave={onSave}
Expand Down
Loading