Check for indices before enabling get search profile in serverless

[SoniaSanzV]

Closes #195342

Summary

In serverless, the default query for the search profiler fails if there is not indices. For avoiding this error, when there are no indices present, this PR disabled the "Profile" button and add a tooltip explaining why it is disabled.

New strings

This is the tooltip for string verification @kibana-docs [Code]:

How to test

• Run Kibana in serverless
• Go to Index Management and verify you haven't indices (or delete them if you do have indices).
• Go to Dev Tools and click the Search Profiler tab. Verify that the button is disabled and the tooltip displayed if you hover over it.
• Go back to Index Management and create one or more indices.
• Go back to Dev Tools > Search Profiler. Now the button should be enabled and the profile should be created if you click it.

Demo

Screen.Recording.2024-11-25.at.16.02.24.mov

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

• Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
• Documentation was added for features that require explanation or tutorials
• Unit or functional tests were updated or added to match the most common scenarios
• If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
• This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
• Flaky Test Runner was used on any tests changed
• The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

[elasticmachine]

Pinging @elastic/kibana-management (Team:Kibana Management)

[florent-leborgne]

Hi! Small suggestion on the copy to use an active voice 🚗

[florent-leborgne]

Suggested change

	defaultMessage: 'An index must be created before leveraging Search Profiler',
	defaultMessage: 'You must have at least one index to use Search Profiler',

Attempt to make the sentence active

[SoniaSanzV]

Thank you for your feedback. Changed :)

[sabarasaba]

Nice work @SoniaSanzV! Tested locally and all works well. I do have a few things I'd like to discuss further in terms of implementation, but let me know what you think!

[sabarasaba]

It feels a bit odd to redefine the button twice based on the conditionals provided, how about we refactor it a little bit to avoid redefining elements? I was thinking perhaps something like this might work:

const isDisabled = !licenseEnabled || !hasIndices;
const tooltipContent = i18n.translate('xpack.searchProfiler.formProfileButtonTooltip', {
  defaultMessage: 'You must have at least one index to use Search Profiler',
});

const button = (
  <EuiButton
    data-test-subj={isDisabled ? 'disabledProfileButton' : 'profileButton'}
    fill
    disabled={isDisabled}
    onClick={!isDisabled ? handleProfileClick : undefined}
  >
    <EuiText>
      {i18n.translate('xpack.searchProfiler.formProfileButtonLabel', {
        defaultMessage: 'Profile',
      })}
    </EuiText>
  </EuiButton>
);

... 
{isDisabled ? (
  <EuiToolTip position="top" content={tooltipContent}>
    {button}
  </EuiToolTip>
) : (
  button
)};

[SoniaSanzV]

Yup, I agree is odd. I did this way because the tooltip is only displayed when there is not indices. But I can think on a way of avoiding duplicate code.

[sabarasaba]

Suggested change

	path: '/api/searchprofiler/getIndices',
	path: '/api/searchprofiler/get_indices',

[SoniaSanzV]

@florent-leborgne I changed what you requested an added a new tooltip [in code]. It would be shown when the user hasn't a valid license and when it happens we already show a banner at top level

[florent-leborgne]

@SoniaSanzV thanks for the ping. Let me know if the suggestion sounds good to you

[florent-leborgne]

Suggested change

	defaultMessage: 'You do not have the license to use Search Profiler',
	defaultMessage: 'You need an active license to use Search Profiler',

Would that work?

[SoniaSanzV]

yes, that sounds so much better! Changed, thank you!

[sabarasaba]

@elasticmachine merge upstream

[sabarasaba]

Thanks for addressing my feedback @SoniaSanzV! Left few more comments, let me know what you think

[sabarasaba]

this is a bit strange to me, the api endpoint is called get_indices so I would be expecting a list of indices but in reality it returns a boolean that says whether it has indices or not.

I think we can rename this api endpoint to then be something slightly more semantic such as has_indices which clearly reflects that the API checks if indices exists or not. Also we dont need the ok: true since we have the http status code if needed.

Likewise the useIndices hook in the UI I think we could also rename to something like useHasIndices, in order to properly reflect which endpoint is calling.

[SoniaSanzV]

Agree, it makes more sense

[sabarasaba]

I think we can remove the complexity of the useEffect and the useState by leveraging the states returned from the useIndices hook.

  const { data: indicesData, isLoading, error } = useIndices();
  ...
  const hasIndices = (isLoading || error) ? false : indicesData?.hasIndices;

[SoniaSanzV]

Changed!

[sabarasaba]

Nice job, latest changes lgtm! Just one last comment 🚀

[sabarasaba]

I dont think we need the ok: true anymore

[SoniaSanzV]

i missed that part of your previous comment 😓

[kibanamachine]

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/12163452744

[elasticmachine]

💛 Build succeeded, but was flaky

• Buildkite Build
• Commit: 74d6480

Failed CI Steps

• Jest Tests #15

Test Failures

• [job] [logs] Jest Tests #15 / useHistoryBlock without search params should block if edited and not navigate on cancel

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
searchprofiler	79	80	+1

Async chunks

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

id	before	after	diff
searchprofiler	48.5KB	49.0KB	+587.0B

Page load bundle

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

id	before	after	diff
searchprofiler	15.6KB	15.7KB	+132.0B

History

• 💔 Build #256846 failed 74d6480
• 💚 Build #255320 succeeded 510c707
• 💔 Build #255209 failed 62b484a
• 💔 Build #255046 failed 62b484a
• 💔 Build #254853 failed 62b484a

cc @SoniaSanzV

[kibanamachine]

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation