Add timezone setting to metrics dashboards

Add new component to hold the form group and select to allow timezone
selection.

app/assets/javascripts/operation_settings/components/form_group/dashboard_timezone.vue

+<script>
+import { s__ } from '~/locale';
+import { mapState, mapActions } from 'vuex';
+import { GlFormGroup, GlFormSelect } from '@gitlab/ui';
+import { timezones } from '~/monitoring/format_date';
+
+export default {
+  components: {
+    GlFormGroup,
+    GlFormSelect,
+  },
+  computed: {
+    ...mapState(['dashboardTimezone']),
+    dashboardTimezoneModel: {
+      get() {
+        return this.dashboardTimezone.selected;
+      },
+      set(selected) {
+        this.setDashboardTimezone(selected);
+      },
+    },
+    options() {
+      return [
+        {
+          value: timezones.LOCAL,
+          text: s__("MetricsSettings|User's local timezone"),
+        },
+        {
+          value: timezones.UTC,
+          text: s__('MetricsSettings|UTC (Coordinated Universal Time)'),
+        },
+      ];
+    },
+  },
+  methods: {
+    ...mapActions(['setDashboardTimezone']),
+  },
+};
+</script>
+
+<template>
+  <gl-form-group
+    :label="s__('MetricsSettings|Dashboard timezone')"
+    label-for="dashboard-timezone-setting"
+  >
+    <template #description>
+      {{
+        s__(
+          "MetricsSettings|Choose whether to display dashboard metrics in UTC or the user's local timezone.",
+        )
+      }}
+    </template>
+
+    <gl-form-select
+      id="dashboard-timezone-setting"
+      v-model="dashboardTimezoneModel"
+      :options="options"
+    />
+  </gl-form-group>
+</template>

app/assets/javascripts/operation_settings/components/metrics_settings.vue

@@ -2,12 +2,14 @@
 import { mapState, mapActions } from 'vuex';
 import { GlDeprecatedButton, GlLink } from '@gitlab/ui';
 import ExternalDashboard from './form_group/external_dashboard.vue';
+import DashboardTimezone from './form_group/dashboard_timezone.vue';
 
 export default {
   components: {
     GlDeprecatedButton,
     GlLink,
     ExternalDashboard,
+    DashboardTimezone,
   },
   computed: {
     ...mapState(['helpPage']),
@@ -40,6 +42,7 @@ export default {
     </div>
     <div class="settings-content">
       <form>
+        <dashboard-timezone />
         <external-dashboard />
         <gl-deprecated-button variant="success" @click="saveChanges">
           {{ __('Save Changes') }}

app/assets/javascripts/operation_settings/store/actions.js

@@ -7,11 +7,15 @@ import * as mutationTypes from './mutation_types';
 export const setExternalDashboardUrl = ({ commit }, url) =>
   commit(mutationTypes.SET_EXTERNAL_DASHBOARD_URL, url);
 
+export const setDashboardTimezone = ({ commit }, selected) =>
+  commit(mutationTypes.SET_DASHBOARD_TIMEZONE, selected);
+
 export const saveChanges = ({ state, dispatch }) =>
   axios
     .patch(state.operationsSettingsEndpoint, {
       project: {
         metrics_setting_attributes: {
+          dashboard_timezone: state.dashboardTimezone.selected,
           external_dashboard_url: state.externalDashboard.url,
         },
       },

app/assets/javascripts/operation_settings/store/mutation_types.js

-/* eslint-disable import/prefer-default-export */
-
 export const SET_EXTERNAL_DASHBOARD_URL = 'SET_EXTERNAL_DASHBOARD_URL';
+export const SET_DASHBOARD_TIMEZONE = 'SET_DASHBOARD_TIMEZONE';

app/assets/javascripts/operation_settings/store/mutations.js

@@ -4,4 +4,7 @@ export default {
   [types.SET_EXTERNAL_DASHBOARD_URL](state, url) {
     state.externalDashboard.url = url;
   },
+  [types.SET_DASHBOARD_TIMEZONE](state, selected) {
+    state.dashboardTimezone.selected = selected;
+  },
 };

app/assets/javascripts/operation_settings/store/state.js

@@ -5,4 +5,8 @@ export default (initialState = {}) => ({
     url: initialState.externalDashboardUrl,
     helpPage: initialState.externalDashboardHelpPage,
   },
+  dashboardTimezone: {
+    selected: initialState.dashboardTimezoneSetting,
+    helpPage: initialState.dashboardTimezoneHelpPage,
+  },
 });

changelogs/unreleased/214370-add-timezone-setting.yml

+---
+title: Display dates on metrics dashboards in UTC time zone
+merge_request: 32746
+author:
+type: added

locale/gitlab.pot

@@ -13967,6 +13967,12 @@ msgstr ""
 msgid "MetricsSettings|Add a button to the metrics dashboard linking directly to your existing external dashboard."
 msgstr ""
 
+msgid "MetricsSettings|Choose whether to display dashboard metrics in UTC or the user's local timezone."
+msgstr ""
+
+msgid "MetricsSettings|Dashboard timezone"
+msgstr ""
+
 msgid "MetricsSettings|External dashboard URL"
 msgstr ""
 
@@ -13976,6 +13982,12 @@ msgstr ""
 msgid "MetricsSettings|Metrics Dashboard"
 msgstr ""
 
+msgid "MetricsSettings|UTC (Coordinated Universal Time)"
+msgstr ""
+
+msgid "MetricsSettings|User's local timezone"
+msgstr ""
+
 msgid "Metrics|Add metric"
 msgstr ""
 

spec/frontend/operation_settings/components/metrics_settings_spec.js

 import { mount, shallowMount } from '@vue/test-utils';
-import { GlDeprecatedButton, GlLink, GlFormGroup, GlFormInput } from '@gitlab/ui';
+import { GlDeprecatedButton, GlLink, GlFormGroup, GlFormInput, GlFormSelect } from '@gitlab/ui';
 import { TEST_HOST } from 'helpers/test_constants';
 import MetricsSettings from '~/operation_settings/components/metrics_settings.vue';
+
 import ExternalDashboard from '~/operation_settings/components/form_group/external_dashboard.vue';
+import DashboardTimezone from '~/operation_settings/components/form_group/dashboard_timezone.vue';
+import { timezones } from '~/monitoring/format_date';
 import store from '~/operation_settings/store';
 import axios from '~/lib/utils/axios_utils';
 import { refreshCurrentPage } from '~/lib/utils/url_utility';
@@ -18,6 +21,8 @@ describe('operation settings external dashboard component', () => {
   const helpPage = `${TEST_HOST}/help/metrics/page/path`;
   const externalDashboardUrl = `http://mock-external-domain.com/external/dashboard/url`;
   const externalDashboardHelpPage = `${TEST_HOST}/help/external/page/path`;
+  const dashboardTimezoneSetting = timezones.LOCAL;
+  const dashboardTimezoneHelpPage = `${TEST_HOST}/help/timezone/page/path`;
 
   const mountComponent = (shallow = true) => {
     const config = [
@@ -28,9 +33,12 @@ describe('operation settings external dashboard component', () => {
           helpPage,
           externalDashboardUrl,
           externalDashboardHelpPage,
+          dashboardTimezoneSetting,
+          dashboardTimezoneHelpPage,
         }),
         stubs: {
           ExternalDashboard,
+          DashboardTimezone,
         },
       },
     ];
@@ -84,6 +92,40 @@ describe('operation settings external dashboard component', () => {
   });
 
   describe('form', () => {
+    describe('dashboard timezone', () => {
+      describe('field label', () => {
+        let formGroup;
+
+        beforeEach(() => {
+          mountComponent(false);
+          formGroup = wrapper.find(DashboardTimezone).find(GlFormGroup);
+        });
+
+        it('uses label text', () => {
+          expect(formGroup.find('label').text()).toBe('Dashboard timezone');
+        });
+
+        it('uses description text', () => {
+          const description = formGroup.find('small');
+          expect(description.text()).not.toBeFalsy();
+        });
+      });
+
+      describe('select field', () => {
+        let select;
+
+        beforeEach(() => {
+          mountComponent();
+          select = wrapper.find(DashboardTimezone).find(GlFormSelect);
+        });
+
+        it('defaults to externalDashboardUrl', () => {
+          expect(select.attributes('value')).toBe(dashboardTimezoneSetting);
+        });
+      });
+    });
+
+    describe('external dashboard', () => {
       describe('input label', () => {
         let formGroup;
 
@@ -107,10 +149,11 @@ describe('operation settings external dashboard component', () => {
 
         beforeEach(() => {
           mountComponent();
-        input = wrapper.find(GlFormInput);
+          input = wrapper.find(ExternalDashboard).find(GlFormInput);
         });
 
         it('defaults to externalDashboardUrl', () => {
+          expect(input.attributes().value).toBeTruthy();
           expect(input.attributes().value).toBe(externalDashboardUrl);
         });
 
@@ -118,6 +161,7 @@ describe('operation settings external dashboard component', () => {
           expect(input.attributes().placeholder).toBe('https://my-org.gitlab.io/my-dashboards');
         });
       });
+    });
 
     describe('submit button', () => {
       const findSubmitButton = () =>
@@ -128,6 +172,7 @@ describe('operation settings external dashboard component', () => {
         {
           project: {
             metrics_setting_attributes: {
+              dashboard_timezone: dashboardTimezoneSetting,
               external_dashboard_url: externalDashboardUrl,
             },
           },

spec/frontend/operation_settings/store/mutations_spec.js

 import mutations from '~/operation_settings/store/mutations';
 import createState from '~/operation_settings/store/state';
+import { timezones } from '~/monitoring/format_date';
 
 describe('operation settings mutations', () => {
   let localState;
@@ -16,4 +17,13 @@ describe('operation settings mutations', () => {
       expect(localState.externalDashboard.url).toBe(mockUrl);
     });
   });
+
+  describe('SET_DASHBOARD_TIMEZONE', () => {
+    it('sets dashboardTimezoneSetting', () => {
+      mutations.SET_DASHBOARD_TIMEZONE(localState, timezones.LOCAL);
+
+      expect(localState.dashboardTimezone.selected).not.toBeUndefined();
+      expect(localState.dashboardTimezone.selected).toBe(timezones.LOCAL);
+    });
+  });
 });