Add png report as panel action #26476

bgaddis56 · 2018-11-30T16:11:13Z

Summary

Added a PNG report panel action to each dashboard panel if it is a visualization which produces a PNG report for the visualization selected. It utilized the current filters and time range for the report.

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

This was checked for cross-browser compatibility, including a check against IE11
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
This was checked for keyboard-only and screenreader accessibility

For maintainers

elasticmachine · 2018-11-30T16:11:14Z

Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually?

stacey-gammon · 2018-12-01T13:20:46Z

x-pack/plugins/reporting/public/panel_actions/get_report_panel_action.tsx

+    appquerystring = appquerystring.replace(new RegExp('#', 'g'), '%23');
+
+    // mode of quick is hard coded and works ok even if time is relative or absolute and
+    // refreshinterval is not used in the report
    const visualizationURL =


What do you think about pushing this into the embeddable? Accessing embeddable urls will be useful in many other places. There actually is already an embeddable.metadata.editUrl I think, but it lacks the query parameters. Kind of like how I suggest doing in here: #25247. But rather than an API service, just put it in the embeddable layer, and then later, if we want to use an API service, we can replace it there.

class VisualizeEmbeddable { public generateAccessLink({ containerState }) { const id = linkData.id; const appState = `(filters:!(${containerState.filters})`; const globalState = `(${containerState.globalTime})`; // Use a url service to ensure everything is escaped properly const url = url.parse({ path: `kibana`, hash: `#visualizations/edit/${id}`, queryParameters: { '_g': globalState, '_a': appState, } }) return url.toString(); } }

I think if you use a url service, you will get the encoding for free, that's why I used url to take the string pieces into a url, then back into string again. https://nodejs.org/api/url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost

You will have access to Private in that class as well to grab the state object so this class can probably not be concerned about it.

stacey-gammon · 2018-12-01T13:25:26Z

src/ui/public/embeddable/embeddable.ts

@@ -63,6 +63,10 @@ interface EmbeddableOptions {
 export abstract class Embeddable {
  public readonly metadata: EmbeddableMetadata = {};

+  public readonly filters: Filters = [];
+  public readonly timeRange: TimeRange = { to: '', from: '' };
+  public readonly savedVisualization: SavedVisualization = { id: '' };


don't want this here, since not all embeddables will have a savedVisualization. Saved Search has savedSearch object.

We could store the embeddable type on the embeddable, the one that the Factory is registered under, and do something like embeddable.type == 'visualization' to check. I don't love that idea though... what if another plugin author wants to create an embeddable and it supplies a generateAccessUrl function, so it wants to take advantage of the reporting system? We should be able to handle that, without Reporting needing to know about it. But then we also don't really want the embeddable layer to know about the plugin reporting, so I also don't really want to expose on the embeddable something like canGenerateReport.

So I have put some thought into this, about using another registry where embeddables can say "I support this action" . Let's sync on this later, I'll share some of my docs/thoughts and get your input on it.

tsullivan · 2018-12-05T17:54:08Z

I pulled the branch up and ran the source, and saw some optimizations failures:

optmzr    log   [17:44:23.562] [fatal][optimize] Optimization failed in 23.82 secondsError: Optimizations failure.
   4378 modules

    ERROR in ./x-pack/plugins/reporting/public/panel_actions/get_csv_report_panel_action.tsx
    Module not found: Error: Can't resolve '../../../../../src/core_plugins/kibana/public/discover/embeddable/search_embeddable' in '/Users/tsullivan/elastic/kibana/x-pack/plugins/reporting/public/panel_actions'

    ERROR in ./x-pack/plugins/reporting/public/panel_actions/get_png_report_panel_action.tsx
    Module not found: Error: Can't resolve '../../../../../src/core_plugins/kibana/public/visualize/embeddable/visualize_embeddable' in '/Users/tsullivan/elastic/kibana/x-pack/plugins/reporting/public/panel_actions'

stacey-gammon · 2018-12-05T17:58:06Z

src/legacy/core_plugins/kibana/public/discover/embeddable/search_embeddable.js

+
+    // Use a url service to ensure everything is escaped properly
+    const myurl = `/app/kibana#` +  url.format({
+      pathname: '/visualize/edit/' + id,


This shouldn't work, the url for saved searches I think is discover/edit .

Tests should probably be added as part of this PR too, so if the url format changes, the ci will fail.

stacey-gammon · 2018-12-05T17:59:44Z

src/legacy/core_plugins/kibana/public/discover/embeddable/search_embeddable.js

@@ -58,6 +60,32 @@ export class SearchEmbeddable extends Embeddable {
    };
  }

+  /**
+   * Generates an access URL that will be used in creating a PNG report.


Suggested change

* Generates an access URL that will be used in creating a PNG report.

* Generates an access URL that can be used to open up the saved search directly in the Discover App, with the settings applied from the given containerState.

Don't mention PNG report in here, this is on the base embeddable layer now, reporting just happens to use it, but it's not really here specifically for reporting (I think it will be useful in other scenarios as well).

bgaddis56 · 2018-12-05T18:09:28Z

I had to commit so I could get the latest Typescript changes that were made and left this error in only temporarily until I rebased. I will be fixing this shortly.

…

On Wed, Dec 5, 2018 at 12:54 PM Tim Sullivan ***@***.***> wrote: I pulled the branch up and ran the source, and saw some optimizations failures: optmzr log [17:44:23.562] [fatal][optimize] Optimization failed in 23.82 secondsError: Optimizations failure. 4378 modules ERROR in ./x-pack/plugins/reporting/public/panel_actions/get_csv_report_panel_action.tsx Module not found: Error: Can't resolve '../../../../../src/core_plugins/kibana/public/discover/embeddable/search_embeddable' in '/Users/tsullivan/elastic/kibana/x-pack/plugins/reporting/public/panel_actions' ERROR in ./x-pack/plugins/reporting/public/panel_actions/get_png_report_panel_action.tsx Module not found: Error: Can't resolve '../../../../../src/core_plugins/kibana/public/visualize/embeddable/visualize_embeddable' in '/Users/tsullivan/elastic/kibana/x-pack/plugins/reporting/public/panel_actions' — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#26476 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AQN5Kso2PsukiBf8ttjgLHwLgt7W0V0zks5u2AhegaJpZM4Y78-2> .

tsullivan · 2019-02-11T16:52:11Z

x-pack/plugins/reporting/public/panel_actions/get_csv_report_panel_action.tsx

+} from 'ui/embeddable';
+import { kfetch } from 'ui/kfetch';
+import { toastNotifications } from 'ui/notify';
+import { SearchEmbeddable } from '../../../../../src/legacy/core_plugins/kibana/public/discover/embeddable/search_embeddable';


I'm not entirely sure this will work in a build, because of how x-pack gets relocated as a plugin

yep, you are right, it won't.

joelgriffith · 2019-02-12T23:31:58Z

Going to close this in favor of the work and I are doing. PR link incoming

stacey-gammon added the WIP Work in progress label Nov 30, 2018

stacey-gammon reviewed Dec 1, 2018

View reviewed changes

bgaddis56 added 4 commits December 5, 2018 11:24

WIP Initial changes for PNG as panel action

fbbd8fa

Fixed dup panel action menus and added code for adding app state to URL

09bd4e4

Changes to handle moment timeranges and added customizations to URL

e732e6e

Moved report link generation into embeddable

713d59c

bgaddis56 force-pushed the add-PNG-report-as-panel-action branch from 2de4aa1 to 713d59c Compare December 5, 2018 16:42

tsullivan requested review from tsullivan and joelgriffith December 5, 2018 16:56

stacey-gammon reviewed Dec 5, 2018

View reviewed changes

changes for csv exports

17756db

joelgriffith self-assigned this Jan 3, 2019

joelgriffith mentioned this pull request Jan 3, 2019

De-couple panel action logic from UI #27996

Closed

tsullivan reviewed Feb 11, 2019

View reviewed changes

joelgriffith closed this Feb 12, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add png report as panel action #26476

Add png report as panel action #26476

bgaddis56 commented Nov 30, 2018

elasticmachine commented Nov 30, 2018

stacey-gammon Dec 1, 2018

stacey-gammon Dec 1, 2018

tsullivan commented Dec 5, 2018

stacey-gammon Dec 5, 2018

stacey-gammon Dec 5, 2018

bgaddis56 commented Dec 5, 2018 via email

tsullivan Feb 11, 2019

stacey-gammon Feb 11, 2019

joelgriffith commented Feb 12, 2019 •

edited

Loading

	* Generates an access URL that will be used in creating a PNG report.
	* Generates an access URL that can be used to open up the saved search directly in the Discover App, with the settings applied from the given containerState.

Add png report as panel action #26476

Add png report as panel action #26476

Conversation

bgaddis56 commented Nov 30, 2018

Summary

Checklist

For maintainers

elasticmachine commented Nov 30, 2018

stacey-gammon Dec 1, 2018

Choose a reason for hiding this comment

stacey-gammon Dec 1, 2018

Choose a reason for hiding this comment

tsullivan commented Dec 5, 2018

stacey-gammon Dec 5, 2018

Choose a reason for hiding this comment

stacey-gammon Dec 5, 2018

Choose a reason for hiding this comment

bgaddis56 commented Dec 5, 2018 via email

tsullivan Feb 11, 2019

Choose a reason for hiding this comment

stacey-gammon Feb 11, 2019

Choose a reason for hiding this comment

joelgriffith commented Feb 12, 2019 • edited Loading

joelgriffith commented Feb 12, 2019 •

edited

Loading