[Discover] Show "unsaved changes" label when in unsaved state of saved search

[jughosta]

• Resolves [Discover] Show "unsaved changes" label when in unsaved state of saved search #135887

Summary

This PR adds "Unsaved changes" badge to Discover for modified saved searches. It also removes "Reset search" button from the histogram area. Code for the badge is added to a new package @kbn/unsaved-changes-badge.

Checklist

• Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
• Unit or functional tests were updated or added to match the most common scenarios
• This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
• This was checked for cross-browser compatibility

[tonyghiani]

log_explorer changes LGTM

[davismcphee]

Code changes look great (thanks for using RTL for new tests 🙌), and it's working well overall! I think there are some improvements we could make as followups, like maybe directly saving the search when clicking the "Save" button, but we don't need to add more to this PR and I think it's working great as an initial implementation.

The only issue I encountered other than a stuck popover was that I somehow got the search into a state where the changes had to be reverted twice in order for the badge to disappear. I couldn't reproduce it consistently, but it seemed to happen after I made changes to most of the state and then switched data views:

revert.mp4

[jughosta]

@davismcphee

The only issue I encountered other than a stuck popover was that I somehow got the search into a state where the changes had to be reverted twice in order for the badge to disappear. I couldn't reproduce it consistently, but it seemed to happen after I made changes to most of the state and then switched data views.

I made some updates to address it. Could you please set window.ELASTIC_DISCOVER_LOGGER = 'debug' when testing? This should help to catch other instances of this problem.

[davismcphee]

With the latest changes I can no longer reproduce the issue I was seeing, and I didn't encounter any other issues while testing. Great job on this, and it's a significant improvement over the reset button! LGTM 👍

[davismcphee]

GitHub updated their comment component and apparently broke multiline suggestions so I can't add it as a suggestion, but could we type keys so that we can drop all the @ts-expect-error comments below?

const keys = new Set([
  ...Object.keys(prevSavedSearch),
  ...Object.keys(nextSavedSearchWithoutSearchSource),
] as Array<keyof Omit<SavedSearch, 'searchSource'>>);

[davismcphee]

Suggested change

	const hasChangesInSavedSearch = [...keys].some((key: string) => {
	const hasChangesInSavedSearch = [...keys].some((key) => {

No need to type as string if we type keys.

[jughosta]

@elasticmachine merge upstream

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: d83fe6e
• Storybooks Preview

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
discover	701	705	+4

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
@kbn/unsaved-changes-badge	-	9	+9
discover	87	89	+2
navigation	34	35	+1
total			+12

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
cloudSecurityPosture	402.7KB	402.7KB	+28.0B
discover	587.1KB	590.1KB	+3.0KB
total			+3.0KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
discover	18	20	+2

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
logExplorer	38.3KB	38.4KB	+50.0B
navigation	11.8KB	11.8KB	+53.0B
total			+103.0B

Unknown metric groups

API count

id	before	after	diff
@kbn/unsaved-changes-badge	-	13	+13
discover	130	132	+2
navigation	34	35	+1
total			+16

History

• 💔 Build #175233 failed c1dd889
• 💔 Build #174106 failed 316ec35
• 💛 Build #172495 was flaky 35be168
• 💔 Build #172455 failed cff1810
• 💚 Build #171575 succeeded 9424da3

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @jughosta