[ML] Fixes getTab() to always return an array. #45616
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
walterra
added
bug
walterra
requested review from
darnautov,
alvarezmelissa87 and
jgowdyelastic
|
Pinging @elastic/ml-ui |
| data_frames: [], | ||
| data_frame_analytics: [], | ||
| export function getTabs(tabId: TabId, disableLinks: boolean): Tab[] { | ||
| const TAB_MAP: Partial<Record<TabId, Tab[]>> = { |
There was a problem hiding this comment.
i quite liked having the other main tabs listed here, even though they are empty, because it explicitly states that those tabs have no sub tabs.
There was a problem hiding this comment.
Added back in a90916d.
| datavisualizer: [], | ||
| data_frames: [], | ||
| data_frame_analytics: [], | ||
| export function getTabs(tabId: TabId, disableLinks: boolean): Tab[] { |
There was a problem hiding this comment.
maybe this whole function should be a switch rather than a map which we then have to work around?
That way, all main tabs which have no sub tabs could be caught and fall through to returning []
and all unexpected tab ids would be caught by the default
There was a problem hiding this comment.
I'll leave that to a possible follow up. Since getTabs() itself returns [] in cases where tabId is something that's not part of TAB_MAP there's no work-around needed when .map() is used later on.
💚 Build Succeeded |
peteharverson
added
the
release_note:skip
💚 Build Succeeded |
alvarezmelissa87
approved these changes
Sep 13, 2019
walterra
added a commit
to walterra/kibana
that referenced
this pull request
Sep 13, 2019
- Fixes getTabs() to always return an array. I was wondering why TypeScript didn't flag the tabs.map(...) part because tabs could possibly be undefined. It's because Record assumes that every key exists. More on that can be found in this blog post. - This PR fixes a) the type of TAB_MAP by wrapping it in Partial<...> so it correctly flags the tabs.map() part with tabs possibly being undefined and b) fixes getTabs()'s return value by always returning an array.
walterra
added a commit
that referenced
this pull request
Sep 13, 2019
- Fixes getTabs() to always return an array. I was wondering why TypeScript didn't flag the tabs.map(...) part because tabs could possibly be undefined. It's because Record assumes that every key exists. More on that can be found in this blog post. - This PR fixes a) the type of TAB_MAP by wrapping it in Partial<...> so it correctly flags the tabs.map() part with tabs possibly being undefined and b) fixes getTabs()'s return value by always returning an array.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #45612.
Fixes
getTabs()to always return an array. I was wondering why TypeScript didn't flag thetabs.map(...)part becausetabscould possibly beundefined. It's becauseRecordassumes that every key exists. More on that can be found in this blog post.This PR fixes a) the type of
TAB_MAPby wrapping it inPartial<...>so it correctly flags thetabs.map()part withtabspossibly being undefined and b) fixesgetTabs()'s return value by always returning an array.Checklist
Use
strikethroughsto remove checklist items you don't feel are applicable to this PR.This was checked for cross-browser compatibility, including a check against IE11no DOM changesAny text added follows EUI's writing guidelines, uses sentence case text and includes i18n supportDocumentation was added for features that require explanation or tutorialsThis was checked for keyboard-only and screenreader accessibilityFor maintainers