[Enterprise Search] DRY out createHref helper for navigateToUrl calls #78717
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
- that navigateToUrl will shortly also use + fix mockHistory type complaint
+ add param.history value, since we're technically supposed to be using Kibana's passed history over anything from useHistory
- navigateToUrl is now double-dipping createHref, so we update it to not do so - remove useHistory in favor of grabbing history from KibanaLogic
- since we're now storing it there, we might as well grab it as well instead of passing in props?
cee-chen
added
Feature:Plugins
release_note:skip
cee-chen
commented
Sep 29, 2020
| afterMount: () => { | ||
| // On React Router navigation, clear previous flash messages and load any queued messages | ||
| const unlisten = props.history.listen(() => { | ||
| const unlisten = KibanaLogic.values.history.listen(() => { |
There was a problem hiding this comment.
I'm not super invested in this change (e5f8e15) and would love to get a confidence check from others if they like DRYing out props: param.history or nah. Happy to revert if nah!
There was a problem hiding this comment.
I like this approach, personally.
scottybollinger
approved these changes
Sep 29, 2020
| afterMount: () => { | ||
| // On React Router navigation, clear previous flash messages and load any queued messages | ||
| const unlisten = props.history.listen(() => { | ||
| const unlisten = KibanaLogic.values.history.listen(() => { |
There was a problem hiding this comment.
I like this approach, personally.
cee-chen
pushed a commit
that referenced
this pull request
Sep 29, 2020
…#78717) (#78800) * DRY out createHref helper - that navigateToUrl will shortly also use + fix mockHistory type complaint * KibanaLogic: Update navigateToUrl to use createHref helper + add param.history value, since we're technically supposed to be using Kibana's passed history over anything from useHistory * Update breadcrumbs & eui link helpers w/ new KibanaLogic changes - navigateToUrl is now double-dipping createHref, so we update it to not do so - remove useHistory in favor of grabbing history from KibanaLogic * [Optional?] Update FlashMessages to grab history from KibanaLogic - since we're now storing it there, we might as well grab it as well instead of passing in props? * [Misc] Fix failing tests due to react router mock
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
Scotty pointed out that the
navigateToUrlmethod added in #78513 felt weird dev-usage-wise, because it required a full/app/enterprise_search/workplace_search/somethingURL vs. just/somethingthat we often use (thanks to our helpers).I opted to solve this by DRYing out the
createHrefhelper/logic we're using elsewhere in the codebase (see e329ed4) and adding it tonavigateToUrl(see 9bee2e9). The subsequent PRs then update code & tests accordingly - I recommend following along by commit.You should now be able to use
navigateToUrl('/whatever')from within any Workplace Search file and it will automatically prepend the correct app route basename. If you want to turn this off for any reason (e.g., directing users outside of the Workplace Search plugin), you can passnavigateToUrl('/app/some_other_app', { shouldNotCreateHref: true }).QA/Regression testing
shouldNotCreateHref)/work as expectedChecklist