[App Search] Relevance Tuning: Fix unsaved changes bug #104951
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
- The fix for this is to change MultiInputRows from useEffect to useUpdateEffect, which prevents onChange from firing on initial mount/render (triggering updateBoostValue->unsavedChanges) @see https://github.com/streamich/react-use/blob/master/docs/useUpdateEffect.md
cee-chen
added
bug
|
jenkins, test this (had to abort for Jenkins upgrade) |
|
Thanks Spencer!! |
💚 Build SucceededMetrics [docs]Module Count
Async chunks
To update your PR or re-run it, just comment with: |
|
👀 |
JasonStoltz
approved these changes
Jul 9, 2021
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jul 9, 2021
* Fix unsavedChanges false positive when MultiInputRows is present - The fix for this is to change MultiInputRows from useEffect to useUpdateEffect, which prevents onChange from firing on initial mount/render (triggering updateBoostValue->unsavedChanges) @see https://github.com/streamich/react-use/blob/master/docs/useUpdateEffect.md * Fix precision tuner not triggering unsavedChanges
This was referenced Jul 9, 2021
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jul 9, 2021
* Fix unsavedChanges false positive when MultiInputRows is present - The fix for this is to change MultiInputRows from useEffect to useUpdateEffect, which prevents onChange from firing on initial mount/render (triggering updateBoostValue->unsavedChanges) @see https://github.com/streamich/react-use/blob/master/docs/useUpdateEffect.md * Fix precision tuner not triggering unsavedChanges
kibanamachine
added a commit
that referenced
this pull request
Jul 9, 2021
…5091) * Fix unsavedChanges false positive when MultiInputRows is present - The fix for this is to change MultiInputRows from useEffect to useUpdateEffect, which prevents onChange from firing on initial mount/render (triggering updateBoostValue->unsavedChanges) @see https://github.com/streamich/react-use/blob/master/docs/useUpdateEffect.md * Fix precision tuner not triggering unsavedChanges Co-authored-by: Constance <constancecchen@users.noreply.github.com>
kibanamachine
added a commit
that referenced
this pull request
Jul 9, 2021
…5092) * Fix unsavedChanges false positive when MultiInputRows is present - The fix for this is to change MultiInputRows from useEffect to useUpdateEffect, which prevents onChange from firing on initial mount/render (triggering updateBoostValue->unsavedChanges) @see https://github.com/streamich/react-use/blob/master/docs/useUpdateEffect.md * Fix precision tuner not triggering unsavedChanges Co-authored-by: Constance <constancecchen@users.noreply.github.com>
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
This PR fixes 2 separate unsaved changes bugs. closes https://github.com/elastic/app-search-team/issues/1881
Bug 1: MultiInputRows causes an unsaved changes false positive (ddcc251)
AKA, the ghost of #96881 (comment) past 👻
MultiInputRows was causing an unsaved change false positive because its
onChangefn (updateBoostValue) was firing on mount.I did a quick search for more elegant ways to mimic the
componentDidUpdate(i.e., sanscomponentDidMount) lifecycle with React hooks, and as it turns out, thereact-uselibrary does exactly what we want, is used in Kibana, and is maintained by an Elastician (the awesome Vadim Dalecky). 🎉 Docs here: https://github.com/streamich/react-use/blob/master/docs/useUpdateEffect.mdBug 2: Precision Tuner not triggering unsaved changes (d51216a)
This is a super small/quick fix for precision tuner changes not triggering the unsaved changes prompt.
QA
Checklist
NB: I was pleasantly surprised
useUpdateEffectworked as-is without any mocking required - huge kudos to the awesome folks & Elasticians writing/maintaining that library