[Enterprise Search][Search Application] Update engines to be search application #155299

saarikabhasi · 2023-04-19T16:20:28Z

Summary

Update "engines" to be "Search Application" in UI
Navigate to Search application from indices page rather than app search engine
Pre-select index and open Create Search Application Flyout when navigated from Index page

demo.mov

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

change selected indices to accept string new create search application routes Fix: all errors

saarikabhasi · 2023-04-19T17:19:06Z

...ise_search/public/applications/enterprise_search_content/components/engines/engines_list.tsx


-export const EnginesList: React.FC = () => {
+export const EnginesList: React.FC<ListProps> = ({ isCreateEngineFlyoutOpen }) => {


Without this new prop ListProps , When create search app flyout is open ( instantiated from indices page ) doesn't redirect to engine list page after successfully creating search application.
Adding this optional isCreateEngineFlyoutOpen helped with that.

This was the best solution I could come up with. So looking for better alternative if any!

I think this is the right solution to control the flyout being open via URL instead of using state.

saarikabhasi · 2023-04-19T17:21:17Z

...ise_search/public/applications/enterprise_search_content/components/engines/engines_list.tsx

            onClick={openEngineCreate}
+            to={ENGINE_CREATION_PATH}


Replaced EuiButton to EuiButtonTo in create search application buttons to help with redirecting route to /new route path

saarikabhasi · 2023-04-19T17:25:20Z

...e_search/public/applications/enterprise_search_content/components/new_index/method_steps.tsx

@@ -56,16 +55,8 @@ export const BUILD_SEARCH_EXPERIENCE_STEP: EuiContainedStepProps = {
      <p>
        <FormattedMessage
          id="xpack.enterpriseSearch.content.newIndex.steps.buildSearchExperience.content"
-          defaultMessage="After building your connector, your content is ready. Build your first search experience with {elasticsearchLink}, or explore the search experience tools provided by {appSearchLink}. We recommend that you create a {searchEngineLink} for the best balance of flexible power and turnkey simplicity."
+          defaultMessage="After building your connector, your content is ready to create a {searchApplicationLink} with {elasticsearchLink}."


@julianrosado FYI I think this page will not exist when new redesign PR is merged. Added these changes in this PR, just in case

TattdCodeMonkey · 2023-04-19T19:26:10Z

...ch/public/applications/enterprise_search_content/components/engines/create_engine_flyout.tsx


  return (
    <EuiFlyout onClose={onClose} size="m">
      <EuiFlyoutHeader>
        <EuiTitle size="m">
          <h3>
            {i18n.translate('xpack.enterpriseSearch.content.engines.createEngine.headerTitle', {
-              defaultMessage: 'Create an engine',
+              defaultMessage: 'Create an Search Application',


Suggested change

defaultMessage: 'Create an Search Application',

defaultMessage: 'Create a Search Application',

TattdCodeMonkey · 2023-04-19T19:26:25Z

...ch/public/applications/enterprise_search_content/components/engines/create_engine_flyout.tsx

@@ -81,7 +92,7 @@ export const CreateEngineFlyout = ({ onClose }: CreateEngineFlyoutProps) => {
          <p>
            <FormattedMessage
              id="xpack.enterpriseSearch.content.engines.createEngine.headerSubTitle"
-              defaultMessage="An engine allows your users to query data in your indices. Explore our {enginesDocsLink} to learn more!"
+              defaultMessage="An Search Application allows your users to query data in your indices. Explore our {enginesDocsLink} to learn more!"


Suggested change

defaultMessage="An Search Application allows your users to query data in your indices. Explore our {enginesDocsLink} to learn more!"

defaultMessage="A Search Application allows your users to query data in your indices. Explore our {enginesDocsLink} to learn more!"

TattdCodeMonkey · 2023-04-19T19:28:45Z

...ise_search/public/applications/enterprise_search_content/components/engines/engines_list.tsx


-export const EnginesList: React.FC = () => {
+export const EnginesList: React.FC<ListProps> = ({ isCreateEngineFlyoutOpen }) => {


I think this is the right solution to control the flyout being open via URL instead of using state.

TattdCodeMonkey · 2023-04-19T19:31:29Z

...ise_search/public/applications/enterprise_search_content/components/engines/engines_list.tsx

@@ -139,6 +148,9 @@ export const EnginesList: React.FC = () => {
    if (!isGated) {
      setIsFirstRequest();
    }
+    if (!!isCreateEngineFlyoutOpen) {
+      openEngineCreate();


I don't think this should be needed. We should just be able to render the Flyout with isOpen if isCreateEngineFlyoutOpen

We should be able to remove openEngineCreate and the state in the logic completely.
We would also remove closeEngineCreate and just navigate to the list URL or to the engine on create being completed.

I'll work on removing the state in the logic completely

TattdCodeMonkey · 2023-04-19T19:40:46Z

...e_search/public/applications/enterprise_search_content/components/new_index/method_steps.tsx

-            searchEngineLink: (
-              <EuiLinkTo to={`${APP_SEARCH_URL}/engines/new`} shouldNotCreateHref>
+            searchApplicationLink: (
+              <EuiLink onClick={() => KibanaLogic.values.navigateToUrl(ENGINES_PATH)}>


we could continue to use to if we do ${ENTERPRISE_SEARCH_CONTENT_PLUGIN.URL}${ENGINES_PATH}

leemthompo · 2023-04-20T09:13:05Z

...ise_search/public/applications/enterprise_search_content/components/engines/engines_list.tsx

            defaultMessage: 'Search Applications',
          }),
        ]}
        pageHeader={{
          description: (
            <FormattedMessage
-              id="xpack.enterpriseSearch.content.engines.description"
+              id="xpack.enterpriseSearch.content.searchApplications.description"
              defaultMessage="Search Applications allow you to query indexed data with a complete set of relevance, analytics and personalization tools. To learn more about how engines work in Enterprise search {documentationUrl}"


Suggested change

defaultMessage="Search Applications allow you to query indexed data with a complete set of relevance, analytics and personalization tools. To learn more about how engines work in Enterprise search {documentationUrl}"

defaultMessage="Search Applications allow you to query indexed data with a complete set of relevance, analytics and personalization tools. To learn more about how Search Applications work in Enterprise search {documentationUrl}"

leemthompo · 2023-04-20T09:15:31Z

...ise_search/public/applications/enterprise_search_content/components/engines/engines_list.tsx

                {
-                  defaultMessage: 'Locate an engine via name or by its included indices.',
+                  defaultMessage:
+                    'Locate an search application via name or by its included indices.',


Suggested change

'Locate an search application via name or by its included indices.',

'Find a search application by name or by an index it includes.',

leemthompo · 2023-04-20T09:16:34Z

...search_content/components/search_index/components/header_actions/create_engine_menu_item.tsx

+              {i18n.translate(
+                'xpack.enterpriseSearch.content.index.searchApplication.createSearchApplication',
+                {
+                  defaultMessage: 'Create an Search Application',


Suggested change

defaultMessage: 'Create an Search Application',

defaultMessage: 'Create a Search Application',

saarikabhasi · 2023-04-20T15:59:58Z

...ise_search/public/applications/enterprise_search_content/components/engines/engines_list.tsx

          </EuiButtonTo>
        </div>
      }
    >
      <EuiPopoverTitle>
        <FormattedMessage
-          id="xpack.enterpriseSearch.content.engines.createEngineDisabledPopover.title"
+          id="xpack.enterpriseSearch.content.searchApplications.createEngineDisabledPopover.title"


Question: Should I continue including these translation changes in this PR ?

saarikabhasi · 2023-04-20T17:16:12Z

x-pack/plugins/enterprise_search/common/constants.ts

-  NAV_TITLE: i18n.translate('xpack.enterpriseSearch.engines.navTitle', {
-    defaultMessage: 'Engines',
+  NAV_TITLE: i18n.translate('xpack.enterpriseSearch.applications.navTitle', {
+    defaultMessage: 'Applications',


Changed the breadcrumb to Applications

…to search-app-rename

kibana-ci · 2023-04-20T21:43:45Z

💚 Build Succeeded

Buildkite Build
Commit: 7292466

Metrics [docs]

Async chunks

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

id	before	after	diff
`enterpriseSearch`	2.3MB	2.3MB	+137.0B

Page load bundle

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

id	before	after	diff
`enterpriseSearch`	31.0KB	30.9KB	-62.0B

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`securitySolution`	394	397	+3

Total ESLint disabled count

id	before	after	diff
`securitySolution`	474	477	+3

History

💚 Build #121698 succeeded 0c4f318
💔 Build #121659 failed 175fc6d
💔 Build #121297 failed e726f8d
💔 Build #121264 failed 58a14c3
💔 Build #121257 failed f38ffa377a8a5d6718c9fcf2774d753d024b54af
💔 Build #121247 failed d5ce092

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

TattdCodeMonkey · 2023-04-20T22:16:48Z

...arch/public/applications/enterprise_search_content/components/engines/create_engine_logic.ts

      });
    },
    engineCreated: () => {
      actions.fetchEngines();
-      actions.closeEngineCreate();
+      KibanaLogic.values.navigateToUrl(ENGINES_PATH);


Not needed in this PR but we should check with Product and see if we should navigate to the Search Application (Preview) on create.

IMO that would be better UX. since if you have a lot of applications it might be annoying to find the new one.

Yeah. Agree with you 💯

saarikabhasi added 3 commits April 19, 2023 11:14

initial commit - rewording engines to search application

a762ba9

change selected indices to accept string new create search application routes Fix: all errors

Merge branch 'main' of github.com:elastic/kibana into search-app-rename

068121f

Fix add indices and rewording

d5ce092

saarikabhasi changed the title ~~Search app rename~~ [Search Application] Update engines to be search application Apr 19, 2023

saarikabhasi added release_note:fix Team:EnterpriseSearch v8.8.0 release_note:skip Skip the PR/issue when compiling release notes and removed release_note:fix labels Apr 19, 2023

saarikabhasi changed the title ~~[Search Application] Update engines to be search application~~ [Enterprise Search][Search Application] Update engines to be search application Apr 19, 2023

Fix: test cases and remove debug log

c51cf9c

saarikabhasi force-pushed the search-app-rename branch from e9a0808 to c51cf9c Compare April 19, 2023 16:53

saarikabhasi marked this pull request as ready for review April 19, 2023 17:09

saarikabhasi requested a review from a team April 19, 2023 17:09

Remove unused translations

58a14c3

saarikabhasi force-pushed the search-app-rename branch from f38ffa3 to 58a14c3 Compare April 19, 2023 17:13

saarikabhasi requested a review from TattdCodeMonkey April 19, 2023 17:13

saarikabhasi commented Apr 19, 2023

View reviewed changes

saarikabhasi added 2 commits April 19, 2023 14:57

Fix: translation error and more rewording

e726f8d

Rename engines to search application - API page

175fc6d

TattdCodeMonkey reviewed Apr 19, 2023

View reviewed changes

leemthompo reviewed Apr 20, 2023

View reviewed changes

saarikabhasi commented Apr 20, 2023

View reviewed changes

saarikabhasi added 3 commits April 20, 2023 12:59

PR feedback - suggested changes and more rewording

62af97a

Resolve merge conflicts

37bf8e8

Fix: Jest test error and translations

0c4f318

saarikabhasi commented Apr 20, 2023

View reviewed changes

saarikabhasi and others added 6 commits April 20, 2023 14:43

Remove types from Create search app logic

a742248

Rewording and delete stale file

54977aa

Merge branch 'main' into search-app-rename

8d9598d

Fix: navigate to list page after search app creations, cleanups

85f1603

Merge branch 'search-app-rename' of github.com:saarikabhasi/kibana in…

4cf99fb

…to search-app-rename

Merge branch 'main' into search-app-rename

7292466

TattdCodeMonkey approved these changes Apr 20, 2023

View reviewed changes

saarikabhasi merged commit d32c867 into elastic:main Apr 21, 2023

kibanamachine added the backport:skip This commit does not require backporting label Apr 21, 2023

saarikabhasi deleted the search-app-rename branch April 21, 2023 13:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enterprise Search][Search Application] Update engines to be search application #155299

[Enterprise Search][Search Application] Update engines to be search application #155299

saarikabhasi commented Apr 19, 2023 •

edited

Loading

saarikabhasi Apr 19, 2023 •

edited

Loading

TattdCodeMonkey Apr 19, 2023

saarikabhasi Apr 19, 2023

saarikabhasi Apr 19, 2023 •

edited

Loading

TattdCodeMonkey Apr 19, 2023

TattdCodeMonkey Apr 19, 2023

TattdCodeMonkey Apr 19, 2023

TattdCodeMonkey Apr 19, 2023

saarikabhasi Apr 19, 2023

TattdCodeMonkey Apr 19, 2023

leemthompo Apr 20, 2023

leemthompo Apr 20, 2023 •

edited

Loading

leemthompo Apr 20, 2023

saarikabhasi Apr 20, 2023

saarikabhasi Apr 20, 2023

kibana-ci commented Apr 20, 2023

ESLint disabled line counts

Total ESLint disabled count

TattdCodeMonkey Apr 20, 2023

saarikabhasi Apr 21, 2023


		export const EnginesList: React.FC = () => {
		export const EnginesList: React.FC<ListProps> = ({ isCreateEngineFlyoutOpen }) => {

	defaultMessage: 'Create an Search Application',
	defaultMessage: 'Create a Search Application',

	defaultMessage="An Search Application allows your users to query data in your indices. Explore our {enginesDocsLink} to learn more!"
	defaultMessage="A Search Application allows your users to query data in your indices. Explore our {enginesDocsLink} to learn more!"

	defaultMessage="Search Applications allow you to query indexed data with a complete set of relevance, analytics and personalization tools. To learn more about how engines work in Enterprise search {documentationUrl}"
	defaultMessage="Search Applications allow you to query indexed data with a complete set of relevance, analytics and personalization tools. To learn more about how Search Applications work in Enterprise search {documentationUrl}"

	'Locate an search application via name or by its included indices.',
	'Find a search application by name or by an index it includes.',

[Enterprise Search][Search Application] Update engines to be search application #155299

[Enterprise Search][Search Application] Update engines to be search application #155299

Conversation

saarikabhasi commented Apr 19, 2023 • edited Loading

Summary

Checklist

saarikabhasi Apr 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saarikabhasi Apr 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leemthompo Apr 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibana-ci commented Apr 20, 2023

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

ESLint disabled line counts

Total ESLint disabled count

History

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saarikabhasi commented Apr 19, 2023 •

edited

Loading

saarikabhasi Apr 19, 2023 •

edited

Loading

saarikabhasi Apr 19, 2023 •

edited

Loading

leemthompo Apr 20, 2023 •

edited

Loading