Welcome to mirror list, hosted at ThFree Co, Russian Federation.

discussion_navigation_spec.js « mixins « notes « frontend « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: bef8ed8e6595e1d4de6938159e8e2dfb1db914d5 (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
import { shallowMount } from '@vue/test-utils';
import Vue, { nextTick } from 'vue';
import Vuex from 'vuex';
import { setHTMLFixture, resetHTMLFixture } from 'helpers/fixtures';
import createEventHub from '~/helpers/event_hub_factory';
import * as utils from '~/lib/utils/common_utils';
import discussionNavigation from '~/notes/mixins/discussion_navigation';
import notesModule from '~/notes/stores/modules';

let scrollToFile;
const discussion = (id, index) => ({
  id,
  resolvable: index % 2 === 0, // discussions 'b' and 'd' are not resolvable
  active: true,
  notes: [{}],
  diff_discussion: true,
  position: { new_line: 1, old_line: 1 },
  diff_file: { file_path: 'test.js' },
});
const mockDiscussionIds = [...'abcde'];
const createDiscussions = () => mockDiscussionIds.map(discussion);
const createComponent = () => ({
  mixins: [discussionNavigation],
  render() {
    return this.$slots.default;
  },
});

describe('Discussion navigation mixin', () => {
  Vue.use(Vuex);

  let wrapper;
  let store;
  let expandDiscussion;

  const findDiscussionEl = (id) => document.querySelector(`div[data-discussion-id="${id}"]`);

  beforeEach(() => {
    setHTMLFixture(
      `<div class="tab-pane notes">
      ${mockDiscussionIds
        .map(
          (id, index) =>
            `<ul class="notes" data-discussion-id="${id}"></ul>
            <div class="discussion" data-discussion-id="${id}" ${
              discussion(id, index).resolvable
                ? 'data-discussion-resolvable="true"'
                : 'data-discussion-resolved="true"'
            }></div>`,
        )
        .join('')}
      </div>`,
    );

    expandDiscussion = jest.fn();
    scrollToFile = jest.fn();
    const { actions, ...notesRest } = notesModule();
    store = new Vuex.Store({
      modules: {
        notes: {
          ...notesRest,
          actions: { ...actions, expandDiscussion },
        },
        diffs: {
          namespaced: true,
          actions: { scrollToFile, disableVirtualScroller: () => {} },
          state: { diffFiles: [] },
        },
      },
    });
    store.state.notes.discussions = createDiscussions();

    wrapper = shallowMount(createComponent(), { store });
  });

  afterEach(() => {
    resetHTMLFixture();
  });

  describe('jumpToFirstUnresolvedDiscussion method', () => {
    let vm;

    beforeEach(() => {
      createComponent();

      ({ vm } = wrapper);

      jest.spyOn(store, 'dispatch');
      jest.spyOn(vm, 'jumpToNextDiscussion');
    });

    it('triggers the setCurrentDiscussionId action with null as the value', () => {
      vm.jumpToFirstUnresolvedDiscussion();

      expect(store.dispatch).toHaveBeenCalledWith('setCurrentDiscussionId', null);
    });

    it('triggers the jumpToNextDiscussion action when the previous store action succeeds', async () => {
      store.dispatch.mockResolvedValue();

      vm.jumpToFirstUnresolvedDiscussion();

      await nextTick();
      expect(vm.jumpToNextDiscussion).toHaveBeenCalled();
    });
  });

  describe('cycle through discussions', () => {
    beforeEach(() => {
      window.mrTabs = { eventHub: createEventHub(), tabShown: jest.fn() };

      // Since we cannot actually scroll on the window, we have to mock each
      // discussion's `getBoundingClientRect` to replicate the scroll position:
      // a is at 100, b is at 200, c is at 300, d is at 400, e is at 500.
      mockDiscussionIds.forEach((id, index) => {
        jest
          .spyOn(findDiscussionEl(id), 'getBoundingClientRect')
          .mockReturnValue({ y: (index + 1) * 100 });
      });

      jest.spyOn(utils, 'scrollToElement');
    });

    describe.each`
      fn                            | currentScrollPosition | expectedId
      ${'jumpToNextDiscussion'}     | ${null}               | ${'a'}
      ${'jumpToNextDiscussion'}     | ${100}                | ${'c'}
      ${'jumpToNextDiscussion'}     | ${200}                | ${'c'}
      ${'jumpToNextDiscussion'}     | ${500}                | ${'a'}
      ${'jumpToPreviousDiscussion'} | ${null}               | ${'e'}
      ${'jumpToPreviousDiscussion'} | ${100}                | ${'e'}
      ${'jumpToPreviousDiscussion'} | ${200}                | ${'a'}
      ${'jumpToPreviousDiscussion'} | ${500}                | ${'c'}
    `(
      '$fn (currentScrollPosition = $currentScrollPosition)',
      ({ fn, currentScrollPosition, expectedId }) => {
        describe('on `show` active tab', () => {
          beforeEach(async () => {
            window.mrTabs.currentAction = 'show';

            // Set `document.body.scrollHeight` higher than `window.innerHeight` (which is 768)
            // to prevent `hasReachedPageEnd` from always returning true
            jest.spyOn(document.body, 'scrollHeight', 'get').mockReturnValue(1000);
            // Mock current scroll position
            jest.spyOn(utils, 'contentTop').mockReturnValue(currentScrollPosition);

            wrapper.vm[fn]();

            await nextTick();
          });

          it('expands discussion', () => {
            expect(expandDiscussion).toHaveBeenCalledWith(expect.any(Object), {
              discussionId: expectedId,
            });
          });

          it(`scrolls to discussion element with id "${expectedId}"`, () => {
            expect(utils.scrollToElement).toHaveBeenLastCalledWith(
              findDiscussionEl(expectedId),
              undefined,
            );
          });
        });
      },
    );
  });
});