[Embeddable] Export CSV action for Lens embeddables in dashboard #83654

dej611 · 2020-11-18T15:51:00Z

Summary

This PR is built on top of #83430 , adding a new Action to make the CSV export available also from the dashboard environment.

Note wait to #83430 to be merged before merging this.

Note2: one big change in this PR is the share plugin moved to the required list for the dashboard plugin. That is due to the new download method required in combination with the CSV export. I'm open to alternatives here ( cc @timroes , @ThomThomson )

Plan:

Some assumptions:

currently the export CSV is downloading formatted values by default. Even in the Visualize embeddable
the plugin supports the raw value export as well, this is just not used
Adapters is a generic container as for now, so a little bit of duck typing is required to understand where's the datatable

Checklist

Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

…export

…v-action

…csv-action

…export

…csv-action

…to feature/lens/csv-export

…csv-action

flash1293

Left two nits that should be addressed, but I don't think it needs another round of review from my side, LGTM.

I want to note however this is causing the context menu in "View" mode to be shown using a more link.
Before:

After:

Feedback from @elastic/kibana-presentation appreciated on this.

flash1293 · 2020-12-01T10:43:14Z

x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable.tsx

@@ -54,6 +56,7 @@ export type LensByValueInput = {
 export type LensByReferenceInput = SavedObjectEmbeddableInput & EmbeddableInput;
 export type LensEmbeddableInput = (LensByValueInput | LensByReferenceInput) & {
  palette?: PaletteOutput;
+  activeData?: TableInspectorAdapter;


Is this a leftover? Seems like activeData is never actually passed in as embeddable input (and I don't see a good reason for that).

flash1293 · 2020-12-01T10:43:38Z

x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable.tsx

@@ -84,6 +87,7 @@ export class Embeddable
  private subscription: Subscription;
  private autoRefreshFetchSubscription: Subscription;
  private isInitialized = false;
+  private activeData: TableInspectorAdapter | undefined;


This should be LensInspectorAdapters now

dej611 · 2020-12-01T16:48:25Z

@elasticmachine merge upstream

ThomThomson · 2020-12-01T17:01:45Z

RE. the placement of this action & the 'More' section. The more item will be needed even in view mode soon because we will be adding a share action to panels, so no worries there.

As for the order, seems like Download as CSV belongs in the more section. Looking at the order variables, 'maximize panel' is 7, so an order of 5 could potentially work for the new download action. Will do a full review later today.

…11/kibana into feature/dashboard/export-csv-action

ThomThomson

Code LGTM

Tested locally via downloading CSVs from Lens embeddables. Works with both by value & by reference embeddables, and shows the correct data.

One small problem I noticed when downloading a CSV from an embeddable by value which doesn't have a title is that it downloads as csv.txt by default. Maybe a fallback title should be added, so in this case it would be downloaded as untitled.csv or something similar.

ThomThomson · 2020-12-01T18:13:28Z

src/plugins/dashboard/public/application/actions/export_csv_action.tsx

+  constructor(protected readonly params: Params) {}
+
+  public getIconType() {
+    return 'exportAction';


I'm wondering if the 'download' icon would better suit this action

No strong opinion here.
I think I've picked the same icon used in inspector, but I can change it if you have strong opinion here.

wylieconlon

I haven't reviewed the code, but I have some comments that I'd like to get addressed before merging:

Unlike the "Inspect" action, this action appears to only be available in Edit mode. I would have expected that I could download CSVs any time I'm viewing a dashboard
Please make sure the title of this PR is suitable to be put in the release notes, describing the new feature in one sentence
I think this feature needs documentation, and we should be doing this as part of the same PR in most cases. Specifically, I would expect a new section in the existing docs called Explore dashboard data about how to download CSV data from Lens.

Edit: There are some other frequently asked questions that we get about CSV export, and maybe we can answer this in the docs:

Can the entire dashboard be exported as CSV?
What can or can't be exported?
What is the license level of this feature?
Is there a way to automatically export using the Kibana API?
What happens with very large CSVs?

flash1293 · 2020-12-02T08:39:44Z

Unlike the "Inspect" action, this action appears to only be available in Edit mode. I would have expected that I could download CSVs any time I'm viewing a dashboard

Not sure why you assume this, @wylieconlon - I just checked the latest version and downloading csvs works just fine in view mode as well.

About the docs in general - I totally agree we should document this and answer the questions you raised (thanks for providing these), but given we are close to feature freeze I'm wondering whether it's required in this case? Maybe @KOTungseth can take a pass over new Lens features after feature freeze and extend the documentation where it makes sense? Based on the timing I'm concerned about iterating over documentation as part of this PR (I'm expecting we wouldn't nail it the very first time) because we can add documentation outside of the regular release cycle, but we can't add the feature itself in the same way.

dej611 · 2020-12-02T12:15:10Z

Edit: There are some other frequently asked questions that we get about CSV export, and maybe we can answer this in the docs:

Can the entire dashboard be exported as CSV?

What can or can't be exported?

What is the license level of this feature?

Is there a way to automatically export using the Kibana API?

What happens with very large CSVs?

While I see some overlap here, most of these questions are really out of scope for this PR. Maybe it could be noted as part of the #81780 plan (at least for the Lens part)

dej611 · 2020-12-02T13:23:41Z

One small problem I noticed when downloading a CSV from an embeddable by value which doesn't have a title is that it downloads as csv.txt by default. Maybe a fallback title should be added, so in this case it would be downloaded as untitled.csv or something similar.

Good catch! It used to work, but probably with some refactor it went lost. Just fixed! :)

dej611 · 2020-12-02T16:57:06Z

Pushed a first draft of the possible documentation for the action: I've mostly based it on other articles around it. Let me know if it can be improved somehow.

wylieconlon

LGTM! I was able to find the CSV export in both dashboard modes now- I may have been looking in the wrong place before. The new docs stub looks good.

kibanamachine · 2020-12-02T19:00:25Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 41e308e

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`dashboard`	186	187	+1
`embeddable`	99	101	+2
total			+3

Async chunks

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

id	before	after	diff
`lens`	968.6KB	968.8KB	+273.0B

Page load bundle

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

id	before	after	diff
`dashboard`	322.2KB	327.8KB	+5.6KB
`embeddable`	221.6KB	225.7KB	+4.1KB
total			+9.7KB

History

💚 Build #91428 succeeded 57f01c4
💚 Build #91342 succeeded 2b37204
💚 Build #91129 succeeded cfd2f2e
💚 Build #91110 succeeded b6549b3
💚 Build #90737 succeeded 6084433

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

* master: (40 commits) fix: 🐛 don't add separator befor group on no main items (elastic#83166) [Security Solution][Detections] Implements indicator match rule cypress test (elastic#84323) [APM] Add APM agent config options (elastic#84678) Fixed a11y issue on rollup jobs table selection (elastic#84567) [Discover] Refactor getContextUrl to separate file (elastic#84503) [Embeddable] Export CSV action for Lens embeddables in dashboard (elastic#83654) [TSVB] [Cleanup] Remove extra dateFormat props (elastic#84749) [Lens] Migrate legacy es client and remove total hits as int (elastic#84340) Improve logging pipeline in @kbn/legacy-logging (elastic#84629) Catch @hapi/podium errors (elastic#84575) [Discover] Unskip date histogram test (elastic#84727) Rename server.xsrf.whitelist to server.xsrf.allowlist (elastic#84791) [Enterprise Search] Fix schema errors button (elastic#84842) [APM] Removes react-sticky dependency in favor of using CSS (elastic#84589) [Maps] Always initialize routes on server-startup (elastic#84806) [Fleet] EPM support to handle uploaded file paths (elastic#84708) [Snapshot Restore] Fix initial policy form state (elastic#83928) Upgrade Node.js to version 14 (elastic#83425) [Security Solution] Keep Endpoint policies up to date with license changes (elastic#83992) [Security Solution][Exceptions] Implement exceptions for ML rules (elastic#84006) ...

* master: (236 commits) fix: 🐛 don't add separator befor group on no main items (elastic#83166) [Security Solution][Detections] Implements indicator match rule cypress test (elastic#84323) [APM] Add APM agent config options (elastic#84678) Fixed a11y issue on rollup jobs table selection (elastic#84567) [Discover] Refactor getContextUrl to separate file (elastic#84503) [Embeddable] Export CSV action for Lens embeddables in dashboard (elastic#83654) [TSVB] [Cleanup] Remove extra dateFormat props (elastic#84749) [Lens] Migrate legacy es client and remove total hits as int (elastic#84340) Improve logging pipeline in @kbn/legacy-logging (elastic#84629) Catch @hapi/podium errors (elastic#84575) [Discover] Unskip date histogram test (elastic#84727) Rename server.xsrf.whitelist to server.xsrf.allowlist (elastic#84791) [Enterprise Search] Fix schema errors button (elastic#84842) [APM] Removes react-sticky dependency in favor of using CSS (elastic#84589) [Maps] Always initialize routes on server-startup (elastic#84806) [Fleet] EPM support to handle uploaded file paths (elastic#84708) [Snapshot Restore] Fix initial policy form state (elastic#83928) Upgrade Node.js to version 14 (elastic#83425) [Security Solution] Keep Endpoint policies up to date with license changes (elastic#83992) [Security Solution][Exceptions] Implement exceptions for ML rules (elastic#84006) ...

…overy-action-group * upstream/master: (48 commits) [Lens] accessibility screen reader issues (elastic#84395) [Logs UI] Fetch single log entries via a search strategy (elastic#81710) fix: 🐛 don't add separator befor group on no main items (elastic#83166) [Security Solution][Detections] Implements indicator match rule cypress test (elastic#84323) [APM] Add APM agent config options (elastic#84678) Fixed a11y issue on rollup jobs table selection (elastic#84567) [Discover] Refactor getContextUrl to separate file (elastic#84503) [Embeddable] Export CSV action for Lens embeddables in dashboard (elastic#83654) [TSVB] [Cleanup] Remove extra dateFormat props (elastic#84749) [Lens] Migrate legacy es client and remove total hits as int (elastic#84340) Improve logging pipeline in @kbn/legacy-logging (elastic#84629) Catch @hapi/podium errors (elastic#84575) [Discover] Unskip date histogram test (elastic#84727) Rename server.xsrf.whitelist to server.xsrf.allowlist (elastic#84791) [Enterprise Search] Fix schema errors button (elastic#84842) [APM] Removes react-sticky dependency in favor of using CSS (elastic#84589) [Maps] Always initialize routes on server-startup (elastic#84806) [Fleet] EPM support to handle uploaded file paths (elastic#84708) [Snapshot Restore] Fix initial policy form state (elastic#83928) Upgrade Node.js to version 14 (elastic#83425) ...

#83654) (#84885) Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

dej611 and others added 30 commits November 16, 2020 11:15

✨ First draft of csv export in Lens

078e554

⚗️ Create action stub

5d789d6

🚚 + ✅ Move export csv to data plugins + basic testing

965bb69

💄 Enable/disable rather than show/hide button

456d14a

🐛 Fix tests

8f917b1

💬 Fix i18n checks + :packages: Update API docs

851b98f

✨ Add getInspectorAdapters API to Lens embeddable

b67f3f5

✨ Make action more generic

d7e9595

🔥 removed embeddable action for now

08d75d0

Merge remote-tracking branch 'upstream/master' into feature/lens/csv-…

12ac1e0

…export

✨ First action implementation

0ac58e0

Merge branch feature/lens/csv-export into feature/dashboard/export-cs…

95edd39

…v-action

✨ Make it work for Lens and Visualize embeddables

5f50522

🐛 Forgotten type

88eefc6

Merge branch 'feature/lens/csv-export' into feature/dashboard/export-…

e572964

…csv-action

Merge remote-tracking branch 'upstream/master' into feature/lens/csv-…

ce68a93

…export

💄 Move the cancel button on the right

88c2a8d

🐛 Avoid to save the activeData content

27678f4

Merge branch 'feature/lens/csv-export' into feature/dashboard/export-…

6995ddd

…csv-action

🐛 Fix tests

52f606f

Merge branch 'feature/lens/csv-export' into feature/dashboard/export-…

ad288b1

…csv-action

Merge branch 'master' into feature/lens/csv-export

237664e

✅ Improved logic + add basic unit testing

c14da82

✨ split the current plugin in two distinct areas

4de7ae8

Merge branch 'feature/lens/csv-export' of github.com:dej611/kibana in…

6e88319

…to feature/lens/csv-export

Merge branch 'feature/lens/csv-export' into feature/dashboard/export-…

7a5fc23

…csv-action

🚚 Update with the new download plugin

5157f31

📝 Update API documentation

f851e69

Merge branch 'feature/lens/csv-export' into feature/dashboard/export-…

eb851a6

…csv-action

🐛 Fix for Visualize Embeddable type checking

074c989

👌 Integrate feedback

6084433

flash1293 reviewed Dec 1, 2020

View reviewed changes

flash1293 approved these changes Dec 1, 2020

View reviewed changes

👌 Integrated feedback

09358d6

Merge branch 'master' into feature/dashboard/export-csv-action

b6549b3

dej611 added 2 commits December 1, 2020 18:20

👌 Reduced priority

3357e26

Merge branch 'feature/dashboard/export-csv-action' of github.com:dej6…

cfd2f2e

…11/kibana into feature/dashboard/export-csv-action

ThomThomson approved these changes Dec 1, 2020

View reviewed changes

wylieconlon suggested changes Dec 1, 2020

View reviewed changes

dej611 changed the title ~~[Embeddable] Export CSV actions for Datatables-ready embeddables~~ [Embeddable] Export CSV action for Lens embeddables in dashboard Dec 2, 2020

🐛 Fix untitled Lens downloads

2b37204

📝 Add section for download csv action in the dashboard doc

57f01c4

✏️ Remove word

41e308e

wylieconlon approved these changes Dec 2, 2020

View reviewed changes

dej611 merged commit 17d986e into elastic:master Dec 3, 2020

dej611 deleted the feature/dashboard/export-csv-action branch December 3, 2020 09:46

dej611 mentioned this pull request Dec 3, 2020

[7.x] [Embeddable] Export CSV action for Lens embeddables in dashboard (#83654) #84885

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Embeddable] Export CSV action for Lens embeddables in dashboard #83654

[Embeddable] Export CSV action for Lens embeddables in dashboard #83654

dej611 commented Nov 18, 2020 •

edited

Loading

flash1293 left a comment •

edited

Loading

flash1293 Dec 1, 2020

flash1293 Dec 1, 2020

dej611 commented Dec 1, 2020

ThomThomson commented Dec 1, 2020

ThomThomson left a comment

ThomThomson Dec 1, 2020

dej611 Dec 2, 2020

wylieconlon left a comment •

edited

Loading

flash1293 commented Dec 2, 2020 •

edited

Loading

dej611 commented Dec 2, 2020

dej611 commented Dec 2, 2020

dej611 commented Dec 2, 2020

wylieconlon left a comment

kibanamachine commented Dec 2, 2020

[Embeddable] Export CSV action for Lens embeddables in dashboard #83654

[Embeddable] Export CSV action for Lens embeddables in dashboard #83654

Conversation

dej611 commented Nov 18, 2020 • edited Loading

Summary

Checklist

flash1293 left a comment • edited Loading

Choose a reason for hiding this comment

flash1293 Dec 1, 2020

Choose a reason for hiding this comment

flash1293 Dec 1, 2020

Choose a reason for hiding this comment

dej611 commented Dec 1, 2020

ThomThomson commented Dec 1, 2020

ThomThomson left a comment

Choose a reason for hiding this comment

ThomThomson Dec 1, 2020

Choose a reason for hiding this comment

dej611 Dec 2, 2020

Choose a reason for hiding this comment

wylieconlon left a comment • edited Loading

Choose a reason for hiding this comment

flash1293 commented Dec 2, 2020 • edited Loading

dej611 commented Dec 2, 2020

dej611 commented Dec 2, 2020

dej611 commented Dec 2, 2020

wylieconlon left a comment

Choose a reason for hiding this comment

kibanamachine commented Dec 2, 2020

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

dej611 commented Nov 18, 2020 •

edited

Loading

flash1293 left a comment •

edited

Loading

wylieconlon left a comment •

edited

Loading

flash1293 commented Dec 2, 2020 •

edited

Loading