[Reporting/CSV] Deprecate Download CSV, add a config flag to enable

[tsullivan]

Closes #164104

Summary

Replace "Download CSV" with "Generate CSV report" to export a CSV file from saved search panel, deprecate "Download CSV", use a config flag for providing the deprecated feature.

This PR uses the xpack.reporting.csv.enablePanelActionDownload kibana.yml setting, which was previously unused, for choosing behavior of CSV export in a Dashboard saved search panel, and sets the default value to false. The options allow the user to download a CSV file without creating a report (deprecated, support will be removed in the future) or to generate a CSV report (default).

1. Use the config as a flag to switch between implementations:
   • downloading a CSV file without a generated report
   • generating a CSV report
2. Updated documentation
3. Refactored / cleaned up tests
4. Increased API test coverage in Serverless
5. Better error handling in packages/kbn-reporting/public/reporting_api_client.ts

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

Release Note

Kibana CSV Reporting offered a feature allowing users to download a CSV file from a saved search panel in a dashboard, without having a report generated. This feature is now deprecated. Now, when users need to access saved search data from a dashboard panel as CSV, a normal report will be generated. To access the deprecated functionality, you can add xpack.reporting.csv.enablePanelActionDownload: true to kibana.yml, but this ability will be removed in a future version of Kibana.

[github-actions]

A documentation preview will be available soon.

• 🔨 Buildkite builds
• 📚 HTML diff
• 📙 Preview page

Request a new doc build by commenting

• Rebuild this PR: run docs-build
• Rebuild this PR and all Elastic docs: run docs-build rebuild

_{run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.}

_{If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.}

[tsullivan]

/ci

[tsullivan]

/ci

[tsullivan]

/ci

[tsullivan]

/ci

[tsullivan]

/ci

[tsullivan]

/ci

[tsullivan]

/ci

[Dosant]

Tested the new implemention. Looks good!

I'd suggest to look into the number of snapshot additions. Seems excessive, maybe we could consider asserting something more specific (e.g number of rows + inline snapshot of the first two line)

[tsullivan]

I'd suggest to look into the number of snapshot additions. Seems excessive, maybe we could consider asserting something more specific (e.g number of rows + inline snapshot of the first two line)

The many snapshot changes are due to:

1. Previously, the bulk of testing CSV export was run through the Download CSV endpoint. After this PR, the functional tests server runs with that endpoint disabled, so the tests have been moved to run through the Generate CSV Report endpoint.
2. Some of the request params for generating the CSV report were updated, as the format of the request parameters have changed since they were originally captured for the test. One big change was the addition of a 2nd sort field in the request.
3. I am in favor of asserting less for the sake of not having huge bulk of text to match against. I will go with your suggestion to assert something more specific, such as the number of rows and first 2 lines of output. I think this will help the code overall.

[Dosant]

Thanks for snapshots clean up 👏

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: 7ef8449

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
reporting	115	122	+7

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
@kbn/reporting-export-types-csv-common	22	21	-1

Async chunks

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

id	before	after	diff
reporting	72.1KB	71.2KB	-1014.0B

Page load bundle

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

id	before	after	diff
reporting	43.2KB	47.8KB	+4.5KB

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
@kbn/reporting-public	1	4	+3

References to deprecated APIs

id	before	after	diff
@kbn/reporting-export-types-csv	0	8	+8
reporting	21	34	+13
total			+21

Total ESLint disabled count

id	before	after	diff
@kbn/reporting-public	1	4	+3

Unreferenced deprecated APIs

id	before	after	diff
@kbn/reporting-public	0	1	+1

History

• 💚 Build #198522 succeeded e3eb217
• 💚 Build #198186 succeeded f7bfea0
• 💔 Build #198139 failed 7c1fc3d
• 💚 Build #197742 succeeded af955f4
• 💛 Build #197506 was flaky d706e34
• 💚 Build #197033 succeeded e6fe922

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

cc @tsullivan