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.

Sign up for GitHub

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

Jump to bottom

[Reporting] Remove V1 export types and components #154601

Closed
1 of 5 tasks
tsullivan opened this issue Apr 6, 2023 · 3 comments
Closed
1 of 5 tasks

[Reporting] Remove V1 export types and components #154601

tsullivan opened this issue Apr 6, 2023 · 3 comments
Assignees
@tsullivan
Labels
Breaking Change Feature:Reporting:Framework Reporting issues pertaining to the overall framework Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) technical debt Improvement of the software architecture and operational architecture v9.0.0

Comments

@tsullivan
Copy link
Member

tsullivan commented Apr 6, 2023 •
edited
Loading

Reporting uses export types to expose different ways of exporting data out of Kibana. Sometimes, requirements change or exports need to work in a different way. When those changes will break behavior in automated reports, we implement changes as a new export type. The old export type gets marked as "deprecated." This allows automated reports to keep working while users have time in between releases to update their automation to the new export type.

However, developers need the code in Reporting to be simple and clear to read - having old, deprecated export type in the code prevents that. This issue tracks export type code in Reporting that should be planned for removal.

Requirements
Preview Give feedback

Possibly Required
Preview Give feedback
@tsullivan tsullivan added technical debt Improvement of the software architecture and operational architecture Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) labels Apr 6, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/appex-sharedux (Team:SharedUX)

@tsullivan tsullivan added the (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead label Apr 6, 2023
@tsullivan tsullivan mentioned this issue Apr 6, 2023
Merged
20 tasks
@rshen91 rshen91 mentioned this issue Jul 31, 2023
Merged
2 tasks
rshen91 added a commit that referenced this issue Aug 2, 2023
@rshen91 @kibanamachine
[Reporting] Remove PNG V1 (#162517)
d8078b6 
## Summary

Closes #162293 and partially
addresses [154601](#154601)

Removes the screenshot diagnostic tool but keeps the browser check
Removes PngV1ExportType from core and the export types registry

### Before
There were two steps so the EuiSteps component definitely made more
sense.

![Screenshot 2023-07-31 at 8 38 50
AM](https://github.com/elastic/kibana/assets/20343860/f054f024-9148-4343-be45-9ddf175b8c71)

![Screenshot 2023-07-31 at 8 41 53
AM](https://github.com/elastic/kibana/assets/20343860/71c6de8a-723c-462a-a7ad-51a4ca45f58f)


### After
I removed the use of the EuiSteps component since there's only the
browser check. Since the EuiSteps also showed some validation, I added a
callout to let users know the status of the diagnostic.

![Screenshot 2023-07-31 at 8 35 05
AM](https://github.com/elastic/kibana/assets/20343860/fce09be1-ec2d-43bf-ab7d-f90df82c0579)

![Screenshot 2023-07-31 at 1 51 00
PM](https://github.com/elastic/kibana/assets/20343860/3fdeb41e-5d3a-4e99-b9aa-63d2d739715f)

### 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)

- [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

---------

Co-authored-by: kibanamachine <[email protected]>
@tsullivan tsullivan self-assigned this Jan 26, 2024
@tsullivan
Copy link
Member Author

Let's put this on hold until after:

  1. Sharing modal redesign: https://github.com/elastic/kibana-team/issues/735
  2. Reporting API telemetry EBT replaces the "custom" telemetry: [Reporting/Telemetry] Event-Based Telemetry for Reporting #158501

This was referenced Jul 12, 2024
Closed
Merged
@tsullivan tsullivan added Feature:Reporting:Framework Reporting issues pertaining to the overall framework v9.0.0 Breaking Change and removed (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead labels Aug 1, 2024
@tsullivan
Copy link
Member Author

We shouldn't remove all of the V1 export types, because printable_pdf still shows telemetry that it is in use. This could be due to automated tests that cover that export type - an issue that is resolved by #188270

For now, I don't think it is worth adding another breaking change. Closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tsullivan tsullivan

Labels
Breaking Change Feature:Reporting:Framework Reporting issues pertaining to the overall framework Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) technical debt Improvement of the software architecture and operational architecture v9.0.0
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@tsullivan @elasticmachine @rshen91 @vadimkibana