Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.x] hide kibana version in help menu on serverless (#193024) #193572

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

kibanamachine
Copy link
Contributor

Backport

This will backport the following commits from main to 8.x:

Questions ?

Please refer to the Backport tool documentation

\r\n\r\n### Visuals\r\n\r\n#### stateful\r\n

\"Screenshot

\r\n\r\n#### serverless\r\n

\"Screenshot

","sha":"fd9691183ec116ea8644640e6e81f5483cf06666","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:SharedUX","backport:prev-minor","v8.16.0"],"title":"hide kibana version in help menu on serverless","number":193024,"url":"https://github.com//pull/193024","mergeCommit":{"message":"hide kibana version in help menu on serverless (#193024)\n\n## Summary\r\n\r\nCloses #175909 and then some.\r\n\r\nThis PR introduces changes that hides the kibana version number from\r\nbeing displayed to the user in serverless, where it makes sense the\r\nversion number is entirely hidden in other cases, where the version\r\nnumber denotes the availability of specific feature the month of release\r\nis replaced with the version number.\r\n\r\n**P.S.**\r\nit's worth noting there are other usages of the kibana version number,\r\nbut they aren't displayed rather used as values for either link params\r\nor function invocations.\r\n\r\n\r\n### How to test;\r\n\r\n- Start up an ES serverless project of your choice; like so ` yarn es\r\nserverless --projectType oblt --license trial`\r\n- Start up an accomapnying kibana project that mirrors the ES project\r\nyou started choose, for our example we'd run; `yarn serverless-oblt`\r\n- Verify that the help menu no longer shows the version number in a\r\nserverless project.\r\n- Verify the version number is also still displayed in stateful kibana\r\n\r\n\r\n\r\n### Visuals\r\n\r\n#### stateful\r\n

\"Screenshot

\r\n\r\n#### serverless\r\n

\"Screenshot

","sha":"fd9691183ec116ea8644640e6e81f5483cf06666"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com//pull/193024","number":193024,"mergeCommit":{"message":"hide kibana version in help menu on serverless (#193024)\n\n## Summary\r\n\r\nCloses #175909 and then some.\r\n\r\nThis PR introduces changes that hides the kibana version number from\r\nbeing displayed to the user in serverless, where it makes sense the\r\nversion number is entirely hidden in other cases, where the version\r\nnumber denotes the availability of specific feature the month of release\r\nis replaced with the version number.\r\n\r\n**P.S.**\r\nit's worth noting there are other usages of the kibana version number,\r\nbut they aren't displayed rather used as values for either link params\r\nor function invocations.\r\n\r\n\r\n### How to test;\r\n\r\n- Start up an ES serverless project of your choice; like so ` yarn es\r\nserverless --projectType oblt --license trial`\r\n- Start up an accomapnying kibana project that mirrors the ES project\r\nyou started choose, for our example we'd run; `yarn serverless-oblt`\r\n- Verify that the help menu no longer shows the version number in a\r\nserverless project.\r\n- Verify the version number is also still displayed in stateful kibana\r\n\r\n\r\n\r\n### Visuals\r\n\r\n#### stateful\r\n

\"Screenshot

\r\n\r\n#### serverless\r\n

\"Screenshot

","sha":"fd9691183ec116ea8644640e6e81f5483cf06666"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->

## Summary

Closes elastic#175909 and then some.

This PR introduces changes that hides the kibana version number from
being displayed to the user in serverless, where it makes sense the
version number is entirely hidden in other cases, where the version
number denotes the availability of specific feature the month of release
is replaced with the version number.

**P.S.**
it's worth noting there are other usages of the kibana version number,
but they aren't displayed rather used as values for either link params
or function invocations.

### How to test;

- Start up an ES serverless project of your choice; like so ` yarn es
serverless --projectType oblt --license trial`
- Start up an accomapnying kibana project that mirrors the ES project
you started choose, for our example we'd run; `yarn serverless-oblt`
- Verify that the help menu no longer shows the version number in a
serverless project.
- Verify the version number is also still displayed in stateful kibana

<!-- ### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |

### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
-->

### Visuals

#### stateful
<img width="1492" alt="Screenshot 2024-09-18 at 17 52 19"
src="https://github.com/user-attachments/assets/9c2d83b3-0b3b-4a2a-a0df-246de58abfaf">

#### serverless
<img width="1493" alt="Screenshot 2024-09-18 at 18 01 31"
src="https://github.com/user-attachments/assets/83740070-e2ec-4b3c-953b-a4e5c3121375">

(cherry picked from commit fd96911)
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #49 / aiops change point detection attaches change point charts to a dashboard

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
dashboard 481.7KB 481.7KB -62.0B
eventAnnotationListing 227.1KB 227.1KB -62.0B
filesManagement 120.6KB 120.5KB -62.0B
graph 413.2KB 413.2KB -62.0B
maps 3.0MB 3.0MB -62.0B
visualizations 315.7KB 315.6KB -62.0B
total -372.0B

Page load bundle

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

id before after diff
core 454.5KB 454.7KB +184.0B
newsfeed 12.5KB 12.7KB +175.0B
total +359.0B

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

cc @eokoneyo

@kibanamachine kibanamachine merged commit 2f79ea6 into elastic:8.x Sep 20, 2024
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants