Commit 795696f
[Side navigation] Unit test coverage, refactor active state management (#232925)
## Summary
Resolves elastic/eui-private#377
On this PR, I am adding unit tests that cover the whole side navigation
functionality. See previous PRs:
- #228162
- #230392
- #230787
### Changes
- Added test suites: `both_modes.test.tsx` (expanded + collapsed mode),
`collapsed_mode.test.tsx`, `expanded_mode.test.tsx`.
- Refactored the active state management to be fully controlled by
`activeItemId`, no internal state.
- Refactored `isActive` to be: `isCurrent` (`aria-current="page"`) and
`isHighlighted` (visual indication).
- Added `onItemClick` to the navigation component interface.
- Changed the primary menu limit to 12.
- Improved the roving index.
### Motivation
The reason I'm adding the tests afterwards is because we were iterating
fast, the requirements changed frequently and the acceptance criteria
were not documented anywhere.
With this testing suite, I was able to refactor the active management
state to be fully controlled through `activeItemId` prop without
introducing regression.
### Coverage
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
------------------------------------|---------|----------|---------|---------|-------------------
All files | 78.17 | 71.47 | 70.77 | 79.48 |
core/packages/chrome/navigation | 0 | 0 | 0 | 0 |
types.ts | 0 | 0 | 0 | 0 |
.../packages/chrome/navigation/src | 100 | 100 | 100 | 100 |
constants.ts | 100 | 100 | 100 | 100 |
...rome/navigation/src/__stories__ | 0 | 0 | 0 | 0 |
navigation.stories.tsx | 0 | 0 | 0 | 0 | 23-200
...chrome/navigation/src/__tests__ | 100 | 100 | 100 | 100 |
resize_window.ts | 100 | 100 | 100 | 100 |
...hrome/navigation/src/components | 84.9 | 82.85 | 92.85 | 84.9 |
navigation.tsx | 84.9 | 82.85 | 92.85 | 84.9 | ...44-146,319-321
...omponents/nested_secondary_menu | 94.87 | 69.23 | 100 | 94.87 |
header.tsx | 100 | 100 | 100 | 100 |
menu_item.tsx | 90 | 50 | 100 | 90 | 60
menu_panel.tsx | 100 | 100 | 100 | 100 |
primary_menu_item.tsx | 100 | 75 | 100 | 100 | 31-32
use_nested_menu.ts | 83.33 | 50 | 100 | 83.33 | 24
...vigation/src/components/popover | 95 | 90.32 | 88.23 | 100 |
blur_popover.ts | 100 | 100 | 100 | 100 |
use_keyboard_management.ts | 96.15 | 80 | 100 | 100 | 37,48-54
use_persistent_popover.ts | 100 | 100 | 100 | 100 |
use_popover_hover.ts | 100 | 100 | 100 | 100 |
use_popover_open.ts | 80 | 100 | 60 | 100 |
...n/src/components/secondary_menu | 100 | 80 | 100 | 100 |
item.tsx | 100 | 70.58 | 100 | 100 | 42-47,61,86-100
section.tsx | 100 | 100 | 100 | 100 |
...igation/src/components/side_nav | 100 | 94 | 100 | 100 |
footer.tsx | 100 | 100 | 100 | 100 |
footer_item.tsx | 100 | 92.85 | 100 | 100 | 55
logo.tsx | 100 | 100 | 100 | 100 |
panel.tsx | 100 | 100 | 100 | 100 |
primary_menu.tsx | 100 | 100 | 100 | 100 |
primary_menu_item.tsx | 100 | 92.3 | 100 | 100 | 82-92
...ges/chrome/navigation/src/hooks | 96.49 | 76.74 | 96 | 98.14 |
use_hover_timeout.ts | 100 | 100 | 100 | 100 |
use_layout_width.ts | 100 | 83.33 | 100 | 100 | 27
use_menu_header_style.ts | 100 | 50 | 100 | 100 | 25-32
use_navigation.ts | 100 | 100 | 100 | 100 |
use_responsive_menu.ts | 94.73 | 68.75 | 80 | 94.44 | 47,63
use_roving_index.ts | 94.73 | 81.81 | 100 | 100 | 25,56
use_tooltip.ts | 100 | 100 | 100 | 100 |
...ges/chrome/navigation/src/utils | 87.35 | 75 | 93.75 | 92 |
calculate_item_visible_count.ts | 100 | 83.33 | 100 | 100 | 28
focus_first_element.ts | 85.71 | 50 | 100 | 100 | 19-23
focus_main_content.ts | 75 | 50 | 100 | 75 | 16
get_actual_item_heights.ts | 100 | 100 | 100 | 100 |
get_focusable_elements.ts | 100 | 100 | 100 | 100 |
get_has_submenu.ts | 100 | 100 | 100 | 100 |
get_initial_active_items.ts | 83.33 | 83.33 | 80 | 83.33 | 66-71
partition_menu_items.ts | 100 | 100 | 100 | 100 |
trap_focus.ts | 75 | 62.5 | 100 | 91.66 | 29
...kages/shared/kbn-i18n-react/src | 58.33 | 25 | 33.33 | 58.33 |
compatiblity_layer.tsx | 33.33 | 0 | 0 | 33.33 | 29-32,52
inject.tsx | 0 | 0 | 0 | 0 |
provider.tsx | 83.33 | 50 | 100 | 83.33 | 23
...rm/packages/shared/kbn-i18n/src | 7.69 | 0 | 0 | 8.33 |
loader.ts | 7.69 | 0 | 0 | 8.33 | 36-164
...ckages/shared/kbn-i18n/src/core | 51.16 | 41.66 | 54.54 | 51.16 |
error_handler.ts | 33.33 | 0 | 0 | 33.33 | 24-26
formats.ts | 100 | 100 | 100 | 100 |
i18n.ts | 51.28 | 45.45 | 60 | 51.28 | ...83,193,207-221
.../shared/kbn-test/src/jest/setup | 88.88 | 88.88 | 100 | 88.88 |
emotion.js | 88.88 | 88.88 | 100 | 88.88 | 43
**Test Suites:** 3 passed, 3 total
**Tests:** 73 passed, 73 total
**Snapshots:** 3 passed, 3 total
**Time:** 14.984 s, estimated 16 s
## Checklist
Run `node scripts/jest src/core/packages/chrome/navigation/src/
--coverage`.
### General
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [x] The PR description includes the appropriate Release Notes section,
and the correct `release_note:*` label is applied per the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
- [x] Review the [backport
guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing)
and apply applicable `backport:*` labels.
### Specific
- [ ] All added tests pass in CI. See below 👇🏻
- [ ] All added tests should pass locally. Run `yarn test:jest
src/core/packages/chrome/navigation` to check.
- [ ] There should be a high coverage of unit tests in the `navigation`
package. Run `yarn test:jest src/core/packages/chrome/navigation
--coverage` to check.
- [ ] All side navigation acceptance criteria are covered. Verify with
the Google Doc notebook, "Acceptance criteria" tab.
---------
Co-authored-by: kibanamachine <[email protected]>1 parent 0a91aa9 commit 795696f
File tree
35 files changed
+4392
-401
lines changed35 files changed
+4392
-401
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
10 | | - | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | 9 | | |
19 | 10 | | |
20 | 11 | | |
| |||
66 | 57 | | |
67 | 58 | | |
68 | 59 | | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
69 | 66 | | |
70 | 67 | | |
71 | 68 | | |
| |||
80 | 77 | | |
81 | 78 | | |
82 | 79 | | |
| 80 | + | |
83 | 81 | | |
84 | 82 | | |
85 | 83 | | |
| |||
101 | 99 | | |
102 | 100 | | |
103 | 101 | | |
| 102 | + | |
104 | 103 | | |
105 | 104 | | |
106 | 105 | | |
| |||
111 | 110 | | |
112 | 111 | | |
113 | 112 | | |
114 | | - | |
| 113 | + | |
115 | 114 | | |
116 | 115 | | |
117 | 116 | | |
| |||
122 | 121 | | |
123 | 122 | | |
124 | 123 | | |
| 124 | + | |
125 | 125 | | |
126 | 126 | | |
127 | 127 | | |
| |||
Lines changed: 23 additions & 15 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
76 | | - | |
| 76 | + | |
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
| |||
91 | 91 | | |
92 | 92 | | |
93 | 93 | | |
| 94 | + | |
94 | 95 | | |
95 | 96 | | |
96 | 97 | | |
| |||
108 | 109 | | |
109 | 110 | | |
110 | 111 | | |
| 112 | + | |
111 | 113 | | |
112 | 114 | | |
113 | 115 | | |
| |||
128 | 130 | | |
129 | 131 | | |
130 | 132 | | |
| 133 | + | |
131 | 134 | | |
132 | 135 | | |
133 | 136 | | |
| |||
168 | 171 | | |
169 | 172 | | |
170 | 173 | | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
171 | 192 | | |
172 | 193 | | |
173 | 194 | | |
| |||
212 | 233 | | |
213 | 234 | | |
214 | 235 | | |
215 | | - | |
216 | | - | |
217 | | - | |
218 | | - | |
219 | | - | |
220 | | - | |
221 | | - | |
222 | | - | |
223 | | - | |
| 236 | + | |
224 | 237 | | |
225 | 238 | | |
226 | 239 | | |
| |||
260 | 273 | | |
261 | 274 | | |
262 | 275 | | |
263 | | - | |
264 | | - | |
265 | | - | |
266 | | - | |
267 | | - | |
| |||
0 commit comments