summaryrefslogtreecommitdiff
path: root/spec/frontend/monitoring/components/dashboard_spec.js
blob: 1d17a9116dff302341d89ea7eaf77603cc4a9b61 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
import MockAdapter from 'axios-mock-adapter';
import VueDraggable from 'vuedraggable';
import { nextTick } from 'vue';
import setWindowLocation from 'helpers/set_window_location_helper';
import { TEST_HOST } from 'helpers/test_constants';
import { mountExtended, shallowMountExtended } from 'helpers/vue_test_utils_helper';
import { createAlert } from '~/flash';
import axios from '~/lib/utils/axios_utils';
import { ESC_KEY } from '~/lib/utils/keys';
import { objectToQuery } from '~/lib/utils/url_utility';
import Dashboard from '~/monitoring/components/dashboard.vue';
import DashboardHeader from '~/monitoring/components/dashboard_header.vue';
import DashboardPanel from '~/monitoring/components/dashboard_panel.vue';
import EmptyState from '~/monitoring/components/empty_state.vue';
import GraphGroup from '~/monitoring/components/graph_group.vue';
import GroupEmptyState from '~/monitoring/components/group_empty_state.vue';
import LinksSection from '~/monitoring/components/links_section.vue';
import { dashboardEmptyStates, metricStates } from '~/monitoring/constants';
import { createStore } from '~/monitoring/stores';
import * as types from '~/monitoring/stores/mutation_types';
import {
  metricsDashboardViewModel,
  metricsDashboardPanelCount,
  dashboardProps,
} from '../fixture_data';
import { dashboardGitResponse, storeVariables } from '../mock_data';
import {
  setupAllDashboards,
  setupStoreWithDashboard,
  setMetricResult,
  setupStoreWithData,
  setupStoreWithDataForPanelCount,
  setupStoreWithLinks,
} from '../store_utils';

jest.mock('~/flash');

describe('Dashboard', () => {
  let store;
  let wrapper;
  let mock;

  const createShallowWrapper = (props = {}, options = {}) => {
    wrapper = shallowMountExtended(Dashboard, {
      propsData: { ...dashboardProps, ...props },
      store,
      stubs: {
        DashboardHeader,
      },
      ...options,
    });
  };

  const createMountedWrapper = (props = {}, options = {}) => {
    wrapper = mountExtended(Dashboard, {
      propsData: { ...dashboardProps, ...props },
      store,
      stubs: {
        'graph-group': true,
        'dashboard-panel': true,
        'dashboard-header': DashboardHeader,
      },
      ...options,
    });
  };

  beforeEach(() => {
    store = createStore();
    mock = new MockAdapter(axios);
    jest.spyOn(store, 'dispatch').mockResolvedValue();
  });

  afterEach(() => {
    mock.restore();
    if (store.dispatch.mockReset) {
      store.dispatch.mockReset();
    }
    wrapper.destroy();
  });

  describe('request information to the server', () => {
    it('calls to set time range and fetch data', async () => {
      createShallowWrapper({ hasMetrics: true });

      await nextTick();
      expect(store.dispatch).toHaveBeenCalledWith(
        'monitoringDashboard/setTimeRange',
        expect.any(Object),
      );

      expect(store.dispatch).toHaveBeenCalledWith('monitoringDashboard/fetchData', undefined);
    });

    it('shows up a loading state', async () => {
      store.state.monitoringDashboard.emptyState = dashboardEmptyStates.LOADING;

      createShallowWrapper({ hasMetrics: true });

      await nextTick();
      expect(wrapper.findComponent(EmptyState).exists()).toBe(true);
      expect(wrapper.findComponent(EmptyState).props('selectedState')).toBe(
        dashboardEmptyStates.LOADING,
      );
    });

    it('hides the group panels when showPanels is false', async () => {
      createMountedWrapper({ hasMetrics: true, showPanels: false });

      setupStoreWithData(store);

      await nextTick();
      expect(wrapper.vm.emptyState).toBeNull();
      expect(wrapper.findAll('.prometheus-panel')).toHaveLength(0);
    });

    it('fetches the metrics data with proper time window', async () => {
      createMountedWrapper({ hasMetrics: true });

      await nextTick();
      expect(store.dispatch).toHaveBeenCalledWith('monitoringDashboard/fetchData', undefined);
      expect(store.dispatch).toHaveBeenCalledWith(
        'monitoringDashboard/setTimeRange',
        expect.objectContaining({ duration: { seconds: 28800 } }),
      );
    });
  });

  describe('panel containers layout', () => {
    const findPanelLayoutWrapperAt = (index) => {
      return wrapper
        .findComponent(GraphGroup)
        .findAll('[data-testid="dashboard-panel-layout-wrapper"]')
        .at(index);
    };

    beforeEach(async () => {
      createMountedWrapper({ hasMetrics: true });
      await nextTick();
    });

    describe('when the graph group has an even number of panels', () => {
      it('2 panels - all panel wrappers take half width of their parent', async () => {
        setupStoreWithDataForPanelCount(store, 2);

        await nextTick();
        expect(findPanelLayoutWrapperAt(0).classes('col-lg-6')).toBe(true);
        expect(findPanelLayoutWrapperAt(1).classes('col-lg-6')).toBe(true);
      });

      it('4 panels - all panel wrappers take half width of their parent', async () => {
        setupStoreWithDataForPanelCount(store, 4);

        await nextTick();
        expect(findPanelLayoutWrapperAt(0).classes('col-lg-6')).toBe(true);
        expect(findPanelLayoutWrapperAt(1).classes('col-lg-6')).toBe(true);
        expect(findPanelLayoutWrapperAt(2).classes('col-lg-6')).toBe(true);
        expect(findPanelLayoutWrapperAt(3).classes('col-lg-6')).toBe(true);
      });
    });

    describe('when the graph group has an odd number of panels', () => {
      it('1 panel - panel wrapper does not take half width of its parent', async () => {
        setupStoreWithDataForPanelCount(store, 1);

        await nextTick();
        expect(findPanelLayoutWrapperAt(0).classes('col-lg-6')).toBe(false);
      });

      it('3 panels - all panels but last take half width of their parents', async () => {
        setupStoreWithDataForPanelCount(store, 3);

        await nextTick();
        expect(findPanelLayoutWrapperAt(0).classes('col-lg-6')).toBe(true);
        expect(findPanelLayoutWrapperAt(1).classes('col-lg-6')).toBe(true);
        expect(findPanelLayoutWrapperAt(2).classes('col-lg-6')).toBe(false);
      });

      it('5 panels - all panels but last take half width of their parents', async () => {
        setupStoreWithDataForPanelCount(store, 5);

        await nextTick();
        expect(findPanelLayoutWrapperAt(0).classes('col-lg-6')).toBe(true);
        expect(findPanelLayoutWrapperAt(1).classes('col-lg-6')).toBe(true);
        expect(findPanelLayoutWrapperAt(2).classes('col-lg-6')).toBe(true);
        expect(findPanelLayoutWrapperAt(3).classes('col-lg-6')).toBe(true);
        expect(findPanelLayoutWrapperAt(4).classes('col-lg-6')).toBe(false);
      });
    });
  });

  describe('dashboard validation warning', () => {
    it('displays a warning if there are validation warnings', async () => {
      createMountedWrapper({ hasMetrics: true });

      store.commit(
        `monitoringDashboard/${types.RECEIVE_DASHBOARD_VALIDATION_WARNINGS_SUCCESS}`,
        true,
      );

      await nextTick();
      expect(createAlert).toHaveBeenCalled();
    });

    it('does not display a warning if there are no validation warnings', async () => {
      createMountedWrapper({ hasMetrics: true });

      store.commit(
        `monitoringDashboard/${types.RECEIVE_DASHBOARD_VALIDATION_WARNINGS_SUCCESS}`,
        false,
      );

      await nextTick();
      expect(createAlert).not.toHaveBeenCalled();
    });
  });

  describe('when the URL contains a reference to a panel', () => {
    const location = window.location.href;

    const setSearch = (searchParams) => {
      setWindowLocation(`?${objectToQuery(searchParams)}`);
    };

    afterEach(() => {
      setWindowLocation(location);
    });

    it('when the URL points to a panel it expands', async () => {
      const panelGroup = metricsDashboardViewModel.panelGroups[0];
      const panel = panelGroup.panels[0];

      setSearch({
        group: panelGroup.group,
        title: panel.title,
        y_label: panel.y_label,
      });

      createMountedWrapper({ hasMetrics: true });
      setupStoreWithData(store);

      await nextTick();
      expect(store.dispatch).toHaveBeenCalledWith('monitoringDashboard/setExpandedPanel', {
        group: panelGroup.group,
        panel: expect.objectContaining({
          title: panel.title,
          y_label: panel.y_label,
        }),
      });
    });

    it('when the URL does not link to any panel, no panel is expanded', async () => {
      setSearch();

      createMountedWrapper({ hasMetrics: true });
      setupStoreWithData(store);

      await nextTick();
      expect(store.dispatch).not.toHaveBeenCalledWith(
        'monitoringDashboard/setExpandedPanel',
        expect.anything(),
      );
    });

    it('when the URL points to an incorrect panel it shows an error', async () => {
      const panelGroup = metricsDashboardViewModel.panelGroups[0];
      const panel = panelGroup.panels[0];

      setSearch({
        group: panelGroup.group,
        title: 'incorrect',
        y_label: panel.y_label,
      });

      createMountedWrapper({ hasMetrics: true });
      setupStoreWithData(store);

      await nextTick();
      expect(createAlert).toHaveBeenCalled();
      expect(store.dispatch).not.toHaveBeenCalledWith(
        'monitoringDashboard/setExpandedPanel',
        expect.anything(),
      );
    });
  });

  describe('when the panel is expanded', () => {
    let group;
    let panel;

    const expandPanel = (mockGroup, mockPanel) => {
      store.commit(`monitoringDashboard/${types.SET_EXPANDED_PANEL}`, {
        group: mockGroup,
        panel: mockPanel,
      });
    };

    beforeEach(() => {
      setupStoreWithData(store);

      const { panelGroups } = store.state.monitoringDashboard.dashboard;
      group = panelGroups[0].group;
      [panel] = panelGroups[0].panels;

      jest.spyOn(window.history, 'pushState').mockImplementation();
    });

    afterEach(() => {
      window.history.pushState.mockRestore();
    });

    it('URL is updated with panel parameters', async () => {
      createMountedWrapper({ hasMetrics: true });
      expandPanel(group, panel);

      const expectedSearch = objectToQuery({
        group,
        title: panel.title,
        y_label: panel.y_label,
      });

      await nextTick();
      expect(window.history.pushState).toHaveBeenCalledTimes(1);
      expect(window.history.pushState).toHaveBeenCalledWith(
        expect.anything(), // state
        expect.any(String), // document title
        expect.stringContaining(`${expectedSearch}`),
      );
    });

    it('URL is updated with panel parameters and custom dashboard', async () => {
      const dashboard = 'dashboard.yml';

      store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
        currentDashboard: dashboard,
      });
      createMountedWrapper({ hasMetrics: true });
      expandPanel(group, panel);

      const expectedSearch = objectToQuery({
        dashboard,
        group,
        title: panel.title,
        y_label: panel.y_label,
      });

      await nextTick();
      expect(window.history.pushState).toHaveBeenCalledTimes(1);
      expect(window.history.pushState).toHaveBeenCalledWith(
        expect.anything(), // state
        expect.any(String), // document title
        expect.stringContaining(`${expectedSearch}`),
      );
    });

    it('URL is updated with no parameters', async () => {
      expandPanel(group, panel);
      createMountedWrapper({ hasMetrics: true });
      expandPanel(null, null);

      await nextTick();
      expect(window.history.pushState).toHaveBeenCalledTimes(1);
      expect(window.history.pushState).toHaveBeenCalledWith(
        expect.anything(), // state
        expect.any(String), // document title
        expect.not.stringMatching(/group|title|y_label/), // no panel params
      );
    });
  });

  describe('when all panels in the first group are loading', () => {
    const findGroupAt = (i) => wrapper.findAllComponents(GraphGroup).at(i);

    beforeEach(async () => {
      setupStoreWithDashboard(store);

      const { panels } = store.state.monitoringDashboard.dashboard.panelGroups[0];
      panels.forEach(({ metrics }) => {
        store.commit(`monitoringDashboard/${types.REQUEST_METRIC_RESULT}`, {
          metricId: metrics[0].metricId,
        });
      });

      createShallowWrapper();

      await nextTick();
    });

    it('a loading icon appears in the first group', () => {
      expect(findGroupAt(0).props('isLoading')).toBe(true);
    });

    it('a loading icon does not appear in the second group', () => {
      expect(findGroupAt(1).props('isLoading')).toBe(false);
    });
  });

  describe('when all requests have been committed by the store', () => {
    beforeEach(async () => {
      store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
        currentEnvironmentName: 'production',
        currentDashboard: dashboardGitResponse[0].path,
        projectPath: TEST_HOST,
      });
      createMountedWrapper({ hasMetrics: true });
      setupStoreWithData(store);

      await nextTick();
    });

    it('does not show loading icons in any group', async () => {
      setupStoreWithData(store);

      await nextTick();
      wrapper.findAllComponents(GraphGroup).wrappers.forEach((groupWrapper) => {
        expect(groupWrapper.props('isLoading')).toBe(false);
      });
    });
  });

  describe('variables section', () => {
    beforeEach(async () => {
      createShallowWrapper({ hasMetrics: true });
      setupStoreWithData(store);
      store.state.monitoringDashboard.variables = storeVariables;
      await nextTick();
    });

    it('shows the variables section', () => {
      expect(wrapper.vm.shouldShowVariablesSection).toBe(true);
    });
  });

  describe('links section', () => {
    beforeEach(async () => {
      createShallowWrapper({ hasMetrics: true });
      setupStoreWithData(store);
      setupStoreWithLinks(store);
      await nextTick();
    });

    it('shows the links section', () => {
      expect(wrapper.vm.shouldShowLinksSection).toBe(true);
      expect(wrapper.findComponent(LinksSection).exists()).toBe(true);
    });
  });

  describe('single panel expands to "full screen" mode', () => {
    const findExpandedPanel = () => wrapper.findComponent({ ref: 'expandedPanel' });

    describe('when the panel is not expanded', () => {
      beforeEach(async () => {
        createShallowWrapper({ hasMetrics: true });
        setupStoreWithData(store);
        await nextTick();
      });

      it('expanded panel is not visible', () => {
        expect(findExpandedPanel().isVisible()).toBe(false);
      });

      it('can set a panel as expanded', () => {
        const panel = wrapper.findAllComponents(DashboardPanel).at(1);

        jest.spyOn(store, 'dispatch');

        panel.vm.$emit('expand');

        const groupData = metricsDashboardViewModel.panelGroups[0];

        expect(store.dispatch).toHaveBeenCalledWith('monitoringDashboard/setExpandedPanel', {
          group: groupData.group,
          panel: expect.objectContaining({
            id: groupData.panels[0].id,
          }),
        });
      });
    });

    describe('when the panel is expanded', () => {
      let group;
      let panel;

      const mockKeyup = (key) => window.dispatchEvent(new KeyboardEvent('keyup', { key }));

      const MockPanel = {
        template: `<div><slot name="top-left"/></div>`,
      };

      beforeEach(async () => {
        createShallowWrapper({ hasMetrics: true }, { stubs: { DashboardPanel: MockPanel } });
        setupStoreWithData(store);

        const { panelGroups } = store.state.monitoringDashboard.dashboard;

        group = panelGroups[0].group;
        [panel] = panelGroups[0].panels;

        store.commit(`monitoringDashboard/${types.SET_EXPANDED_PANEL}`, {
          group,
          panel,
        });

        jest.spyOn(store, 'dispatch');
        await nextTick();
      });

      it('displays a single panel and others are hidden', () => {
        const panels = wrapper.findAllComponents(MockPanel);
        const visiblePanels = panels.filter((w) => w.isVisible());

        expect(findExpandedPanel().isVisible()).toBe(true);
        // v-show for hiding panels is more performant than v-if
        // check for panels to be hidden.
        expect(panels.length).toBe(metricsDashboardPanelCount + 1);
        expect(visiblePanels.length).toBe(1);
      });

      it('sets a link to the expanded panel', () => {
        const searchQuery =
          '?dashboard=config%2Fprometheus%2Fcommon_metrics.yml&group=System%20metrics%20(Kubernetes)&title=Memory%20Usage%20(Total)&y_label=Total%20Memory%20Used%20(GB)';

        expect(findExpandedPanel().attributes('clipboard-text')).toEqual(
          expect.stringContaining(searchQuery),
        );
      });

      it('restores full dashboard by clicking `back`', () => {
        wrapper.findComponent({ ref: 'goBackBtn' }).vm.$emit('click');

        expect(store.dispatch).toHaveBeenCalledWith(
          'monitoringDashboard/clearExpandedPanel',
          undefined,
        );
      });

      it('restores dashboard from full screen by typing the Escape key', () => {
        mockKeyup(ESC_KEY);
        expect(store.dispatch).toHaveBeenCalledWith(
          `monitoringDashboard/clearExpandedPanel`,
          undefined,
        );
      });
    });
  });

  describe('when one of the metrics is missing', () => {
    beforeEach(async () => {
      createShallowWrapper({ hasMetrics: true });

      setupStoreWithDashboard(store);
      setMetricResult({ store, result: [], panel: 2 });
      await nextTick();
    });

    it('shows a group empty area', () => {
      const emptyGroup = wrapper.findAllComponents({ ref: 'empty-group' });

      expect(emptyGroup).toHaveLength(1);
      expect(emptyGroup.is(GroupEmptyState)).toBe(true);
    });

    it('group empty area displays a NO_DATA state', () => {
      expect(
        wrapper.findAllComponents({ ref: 'empty-group' }).at(0).props('selectedState'),
      ).toEqual(metricStates.NO_DATA);
    });
  });

  describe('drag and drop function', () => {
    const findDraggables = () => wrapper.findAllComponents(VueDraggable);
    const findEnabledDraggables = () => findDraggables().filter((f) => !f.attributes('disabled'));
    const findDraggablePanels = () => wrapper.findAll('.js-draggable-panel');
    const findRearrangeButton = () => wrapper.find('.js-rearrange-button');

    const setup = async () => {
      // call original dispatch
      store.dispatch.mockRestore();

      createShallowWrapper({ hasMetrics: true });
      setupStoreWithData(store);
      await nextTick();
    };

    it('wraps vuedraggable', async () => {
      await setup();

      expect(findDraggablePanels().exists()).toBe(true);
      expect(findDraggablePanels().length).toEqual(metricsDashboardPanelCount);
    });

    it('is disabled by default', async () => {
      await setup();

      expect(findRearrangeButton().exists()).toBe(false);
      expect(findEnabledDraggables().length).toBe(0);
    });

    describe('when rearrange is enabled', () => {
      beforeEach(async () => {
        // call original dispatch
        store.dispatch.mockRestore();

        createShallowWrapper({ hasMetrics: true, rearrangePanelsAvailable: true });
        setupStoreWithData(store);

        await nextTick();
      });

      it('displays rearrange button', () => {
        expect(findRearrangeButton().exists()).toBe(true);
      });

      describe('when rearrange button is clicked', () => {
        const findFirstDraggableRemoveButton = () =>
          findDraggablePanels().at(0).find('.js-draggable-remove');

        it('enables draggables', async () => {
          findRearrangeButton().vm.$emit('click');
          await nextTick();

          expect(findRearrangeButton().attributes('pressed')).toBe('true');
          expect(findEnabledDraggables().wrappers).toEqual(findDraggables().wrappers);
        });

        it('metrics can be swapped', async () => {
          findRearrangeButton().vm.$emit('click');
          await nextTick();

          const firstDraggable = findDraggables().at(0);
          const mockMetrics = [...metricsDashboardViewModel.panelGroups[0].panels];

          const firstTitle = mockMetrics[0].title;
          const secondTitle = mockMetrics[1].title;

          // swap two elements and `input` them
          [mockMetrics[0], mockMetrics[1]] = [mockMetrics[1], mockMetrics[0]];
          firstDraggable.vm.$emit('input', mockMetrics);

          await nextTick();

          const { panels } = wrapper.vm.dashboard.panelGroups[0];

          expect(panels[1].title).toEqual(firstTitle);
          expect(panels[0].title).toEqual(secondTitle);
        });

        it('shows a remove button, which removes a panel', async () => {
          findRearrangeButton().vm.$emit('click');
          await nextTick();

          expect(findFirstDraggableRemoveButton().find('a').exists()).toBe(true);

          expect(findDraggablePanels().length).toEqual(metricsDashboardPanelCount);
          await findFirstDraggableRemoveButton().trigger('click');

          expect(findDraggablePanels().length).toEqual(metricsDashboardPanelCount - 1);
        });

        it('disables draggables when clicked again', async () => {
          findRearrangeButton().vm.$emit('click');
          await nextTick();

          findRearrangeButton().vm.$emit('click');
          await nextTick();
          expect(findRearrangeButton().attributes('pressed')).toBeUndefined();
          expect(findEnabledDraggables().length).toBe(0);
        });
      });
    });
  });

  describe('cluster health', () => {
    beforeEach(async () => {
      createShallowWrapper({ hasMetrics: true, showHeader: false });

      // all_dashboards is not defined in health dashboards
      store.commit(`monitoringDashboard/${types.SET_ALL_DASHBOARDS}`, undefined);
      await nextTick();
    });

    it('hides dashboard header by default', () => {
      expect(wrapper.findComponent({ ref: 'prometheusGraphsHeader' }).exists()).toEqual(false);
    });

    it('renders correctly', () => {
      expect(wrapper.html()).not.toBe('');
    });
  });

  describe('document title', () => {
    const originalTitle = 'Original Title';
    const overviewDashboardName = dashboardGitResponse[0].display_name;

    beforeEach(() => {
      document.title = originalTitle;
      createShallowWrapper({ hasMetrics: true });
    });

    afterAll(() => {
      document.title = '';
    });

    it('is prepended with the overview dashboard name by default', async () => {
      setupAllDashboards(store);

      await nextTick();
      expect(document.title.startsWith(`${overviewDashboardName} · `)).toBe(true);
    });

    it('is prepended with dashboard name if path is known', async () => {
      const dashboard = dashboardGitResponse[1];
      const currentDashboard = dashboard.path;

      setupAllDashboards(store, currentDashboard);

      await nextTick();
      expect(document.title.startsWith(`${dashboard.display_name} · `)).toBe(true);
    });

    it('is prepended with the overview dashboard name if path is not known', async () => {
      setupAllDashboards(store, 'unknown/path');

      await nextTick();
      expect(document.title.startsWith(`${overviewDashboardName} · `)).toBe(true);
    });

    it('is not modified when dashboard name is not provided', async () => {
      const dashboard = { ...dashboardGitResponse[1], display_name: null };
      const currentDashboard = dashboard.path;

      store.commit(`monitoringDashboard/${types.SET_ALL_DASHBOARDS}`, [dashboard]);

      store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
        currentDashboard,
      });

      await nextTick();
      expect(document.title).toBe(originalTitle);
    });
  });

  describe('Clipboard text in panels', () => {
    const currentDashboard = dashboardGitResponse[1].path;
    const panelIndex = 1; // skip expanded panel

    const getClipboardTextFirstPanel = () =>
      wrapper.findAllComponents(DashboardPanel).at(panelIndex).props('clipboardText');

    beforeEach(async () => {
      setupStoreWithData(store);
      store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
        currentDashboard,
      });
      createShallowWrapper({ hasMetrics: true });
      await nextTick();
    });

    it('contains a link to the dashboard', () => {
      const dashboardParam = `dashboard=${encodeURIComponent(currentDashboard)}`;

      expect(getClipboardTextFirstPanel()).toContain(dashboardParam);
      expect(getClipboardTextFirstPanel()).toContain(`group=`);
      expect(getClipboardTextFirstPanel()).toContain(`title=`);
      expect(getClipboardTextFirstPanel()).toContain(`y_label=`);
    });
  });

  describe('keyboard shortcuts', () => {
    const currentDashboard = dashboardGitResponse[1].path;
    const panelRef = 'dashboard-panel-response-metrics-aws-elb-4-1'; // skip expanded panel

    // While the recommendation in the documentation is to test
    // with a data-testid attribute, I want to make sure that
    // the dashboard panels have a ref attribute set.
    const getDashboardPanel = () => wrapper.findComponent({ ref: panelRef });

    beforeEach(async () => {
      setupStoreWithData(store);
      store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
        currentDashboard,
      });
      createShallowWrapper({ hasMetrics: true });

      // setData usage is discouraged. See https://gitlab.com/groups/gitlab-org/-/epics/7330 for details
      // eslint-disable-next-line no-restricted-syntax
      wrapper.setData({ hoveredPanel: panelRef });
      await nextTick();
    });

    it('contains a ref attribute inside a DashboardPanel component', () => {
      const dashboardPanel = getDashboardPanel();

      expect(dashboardPanel.exists()).toBe(true);
    });
  });
});