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

[Logstash] Migrate all usages of EuiPage*_Deprecated #161417

Closed
Tracked by #161872
cee-chen opened this issue Jul 7, 2023 · 3 comments · Fixed by #161512
Closed
Tracked by #161872

[Logstash] Migrate all usages of EuiPage*_Deprecated #161417

cee-chen opened this issue Jul 7, 2023 · 3 comments · Fixed by #161512

Comments

@cee-chen
Copy link
Member

cee-chen commented Jul 7, 2023

👋 Hello from your friendly neighborhood EUI team! It's been almost a year since EUI's new EuiPageTemplate came out (if you can believe it), which means we're about a month away from the old deprecated EUI page template components being permanently removed.

Your team is being pinged in this issue because you have 3 usages of EuiPage*_Deprecated components, which you can find listed here:

https://github.com/search?q=repo%3Aelastic%2Fkibana+%2FEuiPage%5Ba-zA-Z%5D%2B_Deprecated%2F+path%3A%2F%5Ex-pack%5C%2Fplugins%5C%2Flogstash%2F&type=code

How

  • Please see our new EuiPageTemplate guidelines and examples for suggestions on how to migrate over.
  • You can also see more examples of layout conversions in the original EuiPageTemplate PR:
    [Feature] EuiPage and EuiPageTemplate Updates eui#5768
  • Here's a quick conversion map of components that approximately translate to their new equivalents:
    • EuiPageTemplate_Deprecated -> EuiPageTemplate
    • EuiPageSideBar_Deprecated -> EuiPageSidebar or EuiPageTemplate.Sidebar
    • EuiPageContent_Deprecated -> EuiPageSection or EuiPageTemplate.Section
    • EuiPageContentBody_Deprecated -> Use EuiPageSection instead
    • EuiPageContentHeader_Deprecated -> Use EuiPageHeader instead
    • EuiPageContentHeaderSection_Deprecated -> Use EuiPageHeader instead

When

We'd really appreciate it if you could migrate your component usages over before or during August if possible.

If your team does not have the ability or bandwidth to perform this work by that time, please let us know. While we'd really appreciate as many teams as possible taking on this work so we're not having to touch hundreds of files by ourselves and in one go, the EUI team can potentially help you out - but we will need you to help QA that work and ensure your layouts look the same as before.

Thanks, and please feel free to reach out anytime with questions or help with migration!

@elasticmachine
Copy link
Contributor

Pinging @elastic/eui-team (EUI)

@cee-chen
Copy link
Member Author

cee-chen commented Jul 7, 2023

Pinging @elastic/logstash

@jlind23
Copy link
Contributor

jlind23 commented Jul 11, 2023

@criamico I can see that @mashhurs is currently trying to tackle this, would you mind reviewing his work? Logstash being part of Ingest it makes sense that someone from the Fleet team help him out.
Sounds good to you?

rshen91 pushed a commit that referenced this issue Sep 27, 2023
## Summary

Migrates the deprecated components in Logstash pipelines view based on
[the gude](https://elastic.github.io/eui/#/layout/page-components).
A list of deprecated components in Logstash pipelines can be found
[here](https://github.com/search?q=repo%3Aelastic%2Fkibana+%2FEuiPage%5Ba-zA-Z%5D%2B_Deprecated%2F+path%3A%2F%5Ex-pack%5C%2Fplugins%5C%2Flogstash%2F&type=code).

### Tests
Opened a dev tools and proceeded manual tests on local dev env (based on
[local env setup
guide](https://docs.elastic.dev/kibana-dev-docs/getting-started/setup-dev-env)):
- create pipeline(s)
- check list of pipeline(s)
- delete pipeline(s)
- check alerts when deleting the pipeline
- check Elasticsearch .logstash_pipelines index (`GET
_logstash/pipeline`) to check the data shape which Logstash polls and
uses.


- Closes: #161417 

### Checklist

Delete any items that are not applicable to this PR.

- [x] 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~~
- [x ] [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
~~- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard
accessibility](https://webaim.org/techniques/keyboard/))~~
- [x] 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)~~
- [x] 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))
- [x] 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—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—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)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants