[App Search] Implement various Relevance Tuning states and form actions #92644

JasonStoltz · 2021-02-24T15:41:03Z

Summary

The commits in this PR are atomic, you should be able to follow along commit by commit.

Added Save and Reset buttons

To test:
- The Reset button should clear all current boosts and weights
- The Save button should save your current relevance changes and show a success message
- These buttons should not appear if you have not yet uploaded documents to an engine
Added the UnsavedChangesPrompt to prevent users from leaving the form if they have unsaved changes

To test:
- Try navigating away from the page when there are changes
Re-arranged the header to use the new description, body, and action fields
Added an Invalid boosts error message

To test:
- Change a field to "number" (in old UI "Schema" screen) and create a functional boost
- Switch the schema back to "text" (in old UI "Schema" scree
- In the new UI, you should see the following message
- In the new UI, delete this boost and click save, the message should go away

Added an unconfirmed fields message

To test:
- Upload a document with a new field that is not yet in the schema
- Navigate to the Relevance Tuning scree and you should see this message:

Added a schema conflicts message

Note that I moved the position of this callout to be located with the other callouts, and removed the "dismiss" button, which seemed like overkill.

To test:
- Create a meta engine with two source engines that share a field with the same name, but each engine has the field in their schema as a different type
- Navigate to this screen and you should see both a message at the top AND the fields listed at the bottom of the form

Add an empty state

To test:
- Create a new engine with no documents
- Navigate to this page and you should see the following message:

Un-title cases text in a few places, which was feedback from my previous PR

Checklist

Delete any items that are not applicable to this PR.

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
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

..._search/public/applications/app_search/components/relevance_tuning/relevance_tuning_logic.ts

cee-chen

some test mock comments

..._search/public/applications/app_search/components/relevance_tuning/relevance_tuning.test.tsx

...ch/public/applications/app_search/components/relevance_tuning/relevance_tuning_logic.test.ts

...tions/app_search/components/relevance_tuning/relevance_tuning_form/relevance_tuning_form.tsx

...prise_search/public/applications/app_search/components/relevance_tuning/relevance_tuning.tsx

..._search/public/applications/app_search/components/relevance_tuning/relevance_tuning.test.tsx

…h/components/relevance_tuning/relevance_tuning.test.tsx Co-authored-by: Constance <[email protected]>

…h/components/relevance_tuning/relevance_tuning_form/relevance_tuning_form.tsx Co-authored-by: Constance <[email protected]>

…h/components/relevance_tuning/relevance_tuning.tsx Co-authored-by: Constance <[email protected]>

…h/components/relevance_tuning/relevance_tuning.test.tsx Co-authored-by: Constance <[email protected]>

JasonStoltz · 2021-02-26T16:54:16Z

@constancecchen Removed that old comment: 9c20faf

JasonStoltz · 2021-02-26T16:56:10Z

@constancecchen Cherry-picked 55e9ebcc1e946a1210905c63628c9eb9c39c60a0

JasonStoltz · 2021-03-01T13:02:18Z

@elasticmachine merge upstream

kibanamachine · 2021-03-01T15:41:34Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`enterpriseSearch`	1281	1305	+24

Async chunks

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

id	before	after	diff
`enterpriseSearch`	1.9MB	2.0MB	+87.8KB
`triggersActionsUi`	1.6MB	1.5MB	-23.9KB
total			+63.9KB

Page load bundle

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

id	before	after	diff
`triggersActionsUi`	104.0KB	104.1KB	+82.0B

Unknown metric groups

async chunk count

id	before	after	diff
`triggersActionsUi`	41	42	+1

History

💔 Build #109881 failed 9e90845
💔 Build #109737 failed 335eb1a
💔 Build #109724 failed dc7707d
💚 Build #109562 succeeded c5eea4b
💔 Build #109392 failed 86f1fe2

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

cee-chen

Changes look fantastic! Really love the new Layout and Callout components 😍

cee-chen · 2021-03-01T17:08:46Z

...prise_search/public/applications/app_search/components/relevance_tuning/relevance_tuning.tsx

+    <RelevanceTuningLayout engineBreadcrumb={engineBreadcrumb}>
+      <UnsavedChangesPrompt hasUnsavedChanges={unsavedChanges} />


[optional, not a blocker] I think you could probably bake UnsavedChangesPrompt into the RelevanceTuningLayout, unless you think that's too hidden or confusing. Up to you!

cee-chen · 2021-03-01T17:09:32Z

...prise_search/public/applications/app_search/components/relevance_tuning/relevance_tuning.tsx

+    if (dataLoading) {
+      return <Loading />;
+    }
+
+    if (!engineHasSchemaFields) {
+      return <EmptyCallout />;
+    }


Also optional, but I think Scotty stated a preference for single line returns. I'm fine with whatever though lol, not a big deal to me, we can yolo it and come back to returns later

cee-chen · 2021-03-01T17:10:40Z

...ch/public/applications/app_search/components/relevance_tuning/relevance_tuning_logic.test.ts

+        expect(mockEngineActions.initializeEngine).toHaveBeenCalled();
+      });
+
+      it('will re-fetch the current engine after settings are updated if there were unconfirmed search fieldds', async () => {


damnit, only just noticed this, sorry! optional though, feel free to fix in a future PR instead if you'd rather save time on CI cycles

Suggested change

it('will re-fetch the current engine after settings are updated if there were unconfirmed search fieldds', async () => {

it('will re-fetch the current engine after settings are updated if there were unconfirmed search fields', async () => {

…ns (elastic#92644)

kibanamachine · 2021-03-01T21:52:15Z

💚 Backport successful

✅ 7.x / #93135

Successful backport PRs will be merged automatically after passing CI.

* master: (42 commits) [Lens] Introduces new chart switcher (elastic#91844) [Lens] fix selection when dragging (elastic#93034) Converts usage collection README to .mdx (elastic#92982) Fix expanding document when using saved search data grid (elastic#92999) [SECURITY SOLUTIONS] Bug case connector (elastic#93104) [Security Solution] [Timeline] Bugfix to include unmapped fields in the timeline event details JSON (elastic#92025) [Alerting][Docs] Changed alerting documentation to point to a single source of explaining the configurations. (elastic#92942) [APM] Fix hidden search bar in error pages while loading (elastic#84476) (elastic#93139) [DOCS] Fixes links for machine learning alerts (elastic#92744) [Security Solution][Detections] -Fixes rule edit flow bug with max_signals (elastic#92748) [SecuritySolution][Case] Disable cases on detections in read-only mode (elastic#93010) [Security Solution][Case][Bug] Prevent closing collection when pushing (elastic#93095) [Security Solution][Detections][7.12] Critical Threshold Rule Fixes (elastic#92667) Bump ems landing page to 7.12 (elastic#93065) [App Search] Implement various Relevance Tuning states and form actions (elastic#92644) [actions] for simplistic email servers, set rejectUnauthorized to false (elastic#91760) [Security Solution][Case] Migrate category & subcategory fields of ServiceNow ITSM connector (elastic#93092) Hide instances latency distribution chart (elastic#92869) [Maps] fix MapboxDraw import from pointing to dist just pointing to folder (elastic#93087) [Maps] fix results trimmed tooltip message doubles feature count for line and polygon features (elastic#92932) ...

… playwright-ftr-e2e * 'playwright-ftr-e2e' of github.com:shahzad31/kibana: (38 commits) [chore] Enable core's eslint rule: `@ts-expect-error` (elastic#93086) [Lens] Introduces new chart switcher (elastic#91844) [Lens] fix selection when dragging (elastic#93034) Converts usage collection README to .mdx (elastic#92982) Fix expanding document when using saved search data grid (elastic#92999) [SECURITY SOLUTIONS] Bug case connector (elastic#93104) [Security Solution] [Timeline] Bugfix to include unmapped fields in the timeline event details JSON (elastic#92025) [Alerting][Docs] Changed alerting documentation to point to a single source of explaining the configurations. (elastic#92942) [APM] Fix hidden search bar in error pages while loading (elastic#84476) (elastic#93139) [DOCS] Fixes links for machine learning alerts (elastic#92744) [Security Solution][Detections] -Fixes rule edit flow bug with max_signals (elastic#92748) [SecuritySolution][Case] Disable cases on detections in read-only mode (elastic#93010) [Security Solution][Case][Bug] Prevent closing collection when pushing (elastic#93095) [Security Solution][Detections][7.12] Critical Threshold Rule Fixes (elastic#92667) Bump ems landing page to 7.12 (elastic#93065) [App Search] Implement various Relevance Tuning states and form actions (elastic#92644) [actions] for simplistic email servers, set rejectUnauthorized to false (elastic#91760) [Security Solution][Case] Migrate category & subcategory fields of ServiceNow ITSM connector (elastic#93092) Hide instances latency distribution chart (elastic#92869) [Maps] fix MapboxDraw import from pointing to dist just pointing to folder (elastic#93087) ...

…ns (#92644) (#93135) Co-authored-by: Jason Stoltzfus <[email protected]>

… ilm/rollup-v2-action * 'ilm/rollup-v2-action' of github.com:elastic/kibana: (30 commits) Fix expanding document when using saved search data grid (#92999) [SECURITY SOLUTIONS] Bug case connector (#93104) [Security Solution] [Timeline] Bugfix to include unmapped fields in the timeline event details JSON (#92025) [Alerting][Docs] Changed alerting documentation to point to a single source of explaining the configurations. (#92942) [APM] Fix hidden search bar in error pages while loading (#84476) (#93139) [DOCS] Fixes links for machine learning alerts (#92744) [Security Solution][Detections] -Fixes rule edit flow bug with max_signals (#92748) [SecuritySolution][Case] Disable cases on detections in read-only mode (#93010) [Security Solution][Case][Bug] Prevent closing collection when pushing (#93095) [Security Solution][Detections][7.12] Critical Threshold Rule Fixes (#92667) Bump ems landing page to 7.12 (#93065) [App Search] Implement various Relevance Tuning states and form actions (#92644) [actions] for simplistic email servers, set rejectUnauthorized to false (#91760) [Security Solution][Case] Migrate category & subcategory fields of ServiceNow ITSM connector (#93092) Hide instances latency distribution chart (#92869) [Maps] fix MapboxDraw import from pointing to dist just pointing to folder (#93087) [Maps] fix results trimmed tooltip message doubles feature count for line and polygon features (#92932) [Security Solution][Detecttions] Indicator enrichment tweaks (#92989) [Maps] fix fit to data on heatmap not working (#92697) [Security Solution][Endpoint][Admin] Fixes policy sticky footer save test (#92919) ...

JasonStoltz changed the title ~~[App Search] Relevance Tuning WIP~~ [App Search] Implement Various Relevance Tuning and form actions Feb 24, 2021

JasonStoltz changed the title ~~[App Search] Implement Various Relevance Tuning and form actions~~ [App Search] Implement various Relevance Tuning states and form actions Feb 24, 2021

JasonStoltz added 5 commits February 25, 2021 08:32

Added save and reset buttons

de4241a

Handle unsaved form changes

de595eb

Show invalid boosts message

a5a1479

Fix invalid boosts

3851eb9

Added unconfirmed fields message

6f3226c

JasonStoltz force-pushed the relevance-tuning-6 branch from 5750cc1 to b3de21d Compare February 25, 2021 13:32

JasonStoltz commented Feb 25, 2021

View reviewed changes

..._search/public/applications/app_search/components/relevance_tuning/relevance_tuning_logic.ts Show resolved Hide resolved

JasonStoltz commented Feb 25, 2021

View reviewed changes

..._search/public/applications/app_search/components/relevance_tuning/relevance_tuning_logic.ts Show resolved Hide resolved

JasonStoltz added 3 commits February 25, 2021 08:42

Added schema conflict message

a8fb7dd

Added an empty message

23775c6

Lower cases some button text

86f1fe2

JasonStoltz force-pushed the relevance-tuning-6 branch from b3de21d to 86f1fe2 Compare February 25, 2021 13:43

JasonStoltz marked this pull request as ready for review February 25, 2021 13:55

JasonStoltz requested a review from a team February 25, 2021 13:55

JasonStoltz added v7.13.0 release_note:skip Skip the PR/issue when compiling release notes auto-backport Deprecated - use backport:version if exact versions are needed labels Feb 25, 2021

Type fixes

c5eea4b