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
|
import { GlDisclosureDropdownGroup, GlDisclosureDropdownItem, GlIcon } from '@gitlab/ui';
import { shallowMountExtended } from 'helpers/vue_test_utils_helper';
import GlobalSearchFrequentItems from '~/super_sidebar/components/global_search/components/frequent_items.vue';
import FrequentItem from '~/super_sidebar/components/global_search/components/frequent_item.vue';
import { getItemsFromLocalStorage, removeItemFromLocalStorage } from '~/super_sidebar/utils';
import { cachedFrequentProjects } from 'jest/super_sidebar/mock_data';
jest.mock('~/super_sidebar/utils', () => {
const original = jest.requireActual('~/super_sidebar/utils');
return {
...original,
getItemsFromLocalStorage: jest.fn(),
removeItemFromLocalStorage: jest.fn(),
};
});
describe('FrequentlyVisitedItems', () => {
let wrapper;
const storageKey = 'mockStorageKey';
const mockStoredItems = JSON.parse(cachedFrequentProjects);
const mockProps = {
emptyStateText: 'mock empty state text',
groupName: 'mock group name',
maxItems: 42,
storageKey,
viewAllItemsText: 'View all items',
viewAllItemsIcon: 'question-o',
viewAllItemsPath: '/mock/all_items',
};
const createComponent = (props) => {
wrapper = shallowMountExtended(GlobalSearchFrequentItems, {
propsData: {
...mockProps,
...props,
},
stubs: {
GlDisclosureDropdownGroup,
},
});
};
const findItems = () => wrapper.findAllComponents(GlDisclosureDropdownItem);
const findItemRenderer = (root) => root.findComponent(FrequentItem);
const setStoredItems = (items) => {
getItemsFromLocalStorage.mockReturnValue(items);
};
beforeEach(() => {
setStoredItems(mockStoredItems);
});
describe('without a storage key', () => {
beforeEach(() => {
createComponent({ storageKey: null });
});
it('does not render anything', () => {
expect(wrapper.html()).toBe('');
});
it('emits a nothing-to-render event', () => {
expect(wrapper.emitted('nothing-to-render')).toEqual([[]]);
});
});
describe('with a storageKey', () => {
beforeEach(() => {
createComponent();
});
describe('common behavior', () => {
it('calls getItemsFromLocalStorage', () => {
expect(getItemsFromLocalStorage).toHaveBeenCalledWith({
storageKey,
maxItems: mockProps.maxItems,
});
});
it('renders the group name', () => {
expect(wrapper.text()).toContain(mockProps.groupName);
});
it('renders the view all items link', () => {
const lastItem = findItems().at(-1);
expect(lastItem.props('item')).toMatchObject({
text: mockProps.viewAllItemsText,
href: mockProps.viewAllItemsPath,
});
const icon = lastItem.findComponent(GlIcon);
expect(icon.props('name')).toBe(mockProps.viewAllItemsIcon);
});
});
describe('with stored items', () => {
it('renders the items', () => {
const items = findItems();
mockStoredItems.forEach((storedItem, index) => {
const dropdownItem = items.at(index);
// Check GlDisclosureDropdownItem's item has the right structure
expect(dropdownItem.props('item')).toMatchObject({
text: storedItem.name,
href: storedItem.webUrl,
});
// Check FrequentItem's item has the right structure
expect(findItemRenderer(dropdownItem).props('item')).toMatchObject({
id: storedItem.id,
title: storedItem.name,
subtitle: expect.any(String),
avatar: storedItem.avatarUrl,
});
});
});
it('does not render the empty state text', () => {
expect(wrapper.text()).not.toContain('mock empty state text');
});
describe('removing an item', () => {
let itemToRemove;
beforeEach(() => {
const itemRenderer = findItemRenderer(findItems().at(0));
itemToRemove = itemRenderer.props('item');
itemRenderer.vm.$emit('remove', itemToRemove);
});
it('calls removeItemFromLocalStorage when an item emits a remove event', () => {
expect(removeItemFromLocalStorage).toHaveBeenCalledWith({
storageKey,
item: itemToRemove,
});
});
it('no longer renders that item', () => {
const renderedItemTexts = findItems().wrappers.map((item) => item.props('item').text);
expect(renderedItemTexts).not.toContain(itemToRemove.text);
});
});
});
});
describe('with no stored items', () => {
beforeEach(() => {
setStoredItems([]);
createComponent();
});
it('renders the empty state text', () => {
expect(wrapper.text()).toContain(mockProps.emptyStateText);
});
});
});
|
