[AppServices/Examples] Add the example for Reporting integration #82091

tsullivan · 2020-10-29T22:40:57Z

Summary

First step for #19914

This PR creates an area for developers to learn how to add a "Generate PDF" button to a page and make it reportable using the Reporting framework.

Over time, this area will change and demonstrate how the generate button can be made available depending on user privileges: the example app should define Reporting as a sub-feature privilege of the page.

Having feature controls implemented around Reporting integrations is an important step for deprecating the reporting_user custom role definition.

!!!

This PR changes a few parts of Reporting code to allow the example plugin to import shared variables from Reporting. The example plugin is all UI code, and it needs to import UI helpers like constants and helper functions from Reporting. I tried to minimize the number of things that got moved around, and I was able to limit it to just moving the constants and the getDefaultLayout function, which are in common now, but were originally in `server.

These changes move closer to giving an API to other plugins to use Reporting.

TODO

Add alternate URL to turn off controls for screenshot

tsullivan · 2020-11-04T23:50:18Z

x-pack/plugins/reporting/public/lib/stream_handler.ts

@@ -107,9 +106,9 @@ export class ReportingNotifierStreamHandler {
            _source: { status: jobStatus },
          } = job;
          if (storedJobs.includes(jobId)) {
-            if (jobStatus === JOB_STATUS_COMPLETED || jobStatus === JOB_STATUS_WARNINGS) {


Cleaned up duplicated constants here: JOB_STATUS_COMPLETED / JOB_STATUSES.COMPLETED, etc

tsullivan · 2020-12-14T16:47:00Z

@elasticmachine merge upstream

joelgriffith

Nitpicks, but also saw deltas in our reporting plugin. Wanted to verify that's intentional -- I'm guessing so.

x-pack/examples/reporting_example/public/plugin.ts

x-pack/plugins/reporting/common/index.ts

ppisljar

i like the simplicity of example but i think it would be nice to provide some more information about what's expected from the app to provide (and what reporting won't)

x-pack/examples/reporting_example/README.md

tsullivan · 2020-12-22T00:46:06Z

@elasticmachine merge upstream

joelgriffith

This is so great! Thanks for doing this, will be super helpful in the future.

tsullivan · 2020-12-29T01:30:28Z

@elasticmachine merge upstream

kibanamachine · 2020-12-29T03:45:59Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 4240dc4

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`reporting`	49	51	+2

Async chunks

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

id	before	after	diff
`reporting`	46.9KB	45.0KB	-1.9KB

Distributable file count

id	before	after	diff
`default`	47267	48027	+760

Page load bundle

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

id	before	after	diff
`reporting`	99.7KB	106.8KB	+7.1KB

History

💚 Build #95896 succeeded f7d8a70
💚 Build #95588 succeeded a2ad912
💚 Build #95580 succeeded e472c7c
💚 Build #94097 succeeded ec849c5
💚 Build #92806 succeeded ca889a45f779b0f69a3042c2157fd8b0a514c06c

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

…stic#82091) * Add developer example for Reporting Refactor Reporting plugin to have shareable services * Update plugin.ts * use constant * add more description to using reporting as a service Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

) (#87000) * Add developer example for Reporting Refactor Reporting plugin to have shareable services * Update plugin.ts * use constant * add more description to using reporting as a service Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

) (#86999) * Add developer example for Reporting Refactor Reporting plugin to have shareable services * Update plugin.ts * use constant * add more description to using reporting as a service Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

* master: (108 commits) [DOCS] Refreshes Data Visualizer screenshot (elastic#87017) [Security Solution] Change 'anti-virus' text to 'antivirus' (elastic#87001) [securitySolution/cypress] temporarily limit to PRs [AppServices/Examples] Add the example for Reporting integration (elastic#82091) [Build Chromium] Improve git checkout (elastic#83225) Deprecate `services.callCluster` in alerts and actions executors (elastic#86474) [Security Solution] Use system node version for Cypress and increase exec command timeout (elastic#86985) [Lens] Add more chart editor tests based on the debug state (elastic#86750) [Lens] Integrate searchSessionId into Lens app (elastic#86297) skip "pagination updates results and page number" elastic#86975 skip "Custom detection rules" elastic#83772 [logging/json] use merge from kbn/std (elastic#86330) skip network and timeline inspection. elastic#85677, elastic#85678 skip "adds correctly a filter to the global search bar" elastic#86552 [ftr/flags] improve help text (elastic#86971) skip "Fields Browser rendering. elastic#60209 skip "Closes and opens alerts" elastic#83773 [Security Solution] Skip failing Cypress tests (elastic#86967) Removes archives (elastic#86537) [ML] Fix charts grid on the Anomaly Explorer page (elastic#86904) ...

* master: (72 commits) [DOCS] Refreshes Data Visualizer screenshot (elastic#87017) [Security Solution] Change 'anti-virus' text to 'antivirus' (elastic#87001) [securitySolution/cypress] temporarily limit to PRs [AppServices/Examples] Add the example for Reporting integration (elastic#82091) [Build Chromium] Improve git checkout (elastic#83225) Deprecate `services.callCluster` in alerts and actions executors (elastic#86474) [Security Solution] Use system node version for Cypress and increase exec command timeout (elastic#86985) [Lens] Add more chart editor tests based on the debug state (elastic#86750) [Lens] Integrate searchSessionId into Lens app (elastic#86297) skip "pagination updates results and page number" elastic#86975 skip "Custom detection rules" elastic#83772 [logging/json] use merge from kbn/std (elastic#86330) skip network and timeline inspection. elastic#85677, elastic#85678 skip "adds correctly a filter to the global search bar" elastic#86552 [ftr/flags] improve help text (elastic#86971) skip "Fields Browser rendering. elastic#60209 skip "Closes and opens alerts" elastic#83773 [Security Solution] Skip failing Cypress tests (elastic#86967) Removes archives (elastic#86537) [ML] Fix charts grid on the Anomaly Explorer page (elastic#86904) ...

tsullivan force-pushed the reporting/feature-control-example branch 14 times, most recently from 03a5c6a to a765dbc Compare November 4, 2020 23:49

tsullivan commented Nov 4, 2020

View reviewed changes

tsullivan force-pushed the reporting/feature-control-example branch 9 times, most recently from 7d65351 to 7741a11 Compare November 6, 2020 23:20

tsullivan mentioned this pull request Nov 11, 2020

[Reporting] Move "common" types and constants into common #83198

Merged

1 task

tsullivan force-pushed the reporting/feature-control-example branch 4 times, most recently from 9d23bcb to 5d06833 Compare November 13, 2020 00:12

tsullivan force-pushed the reporting/feature-control-example branch from 5d06833 to c0a4eb1 Compare December 1, 2020 23:36

tsullivan requested review from mikecote and ppisljar and removed request for nreese and mikecote December 9, 2020 17:52

Merge branch 'master' into reporting/feature-control-example

ec849c5

tsullivan force-pushed the reporting/feature-control-example branch from e566b93 to ec849c5 Compare December 14, 2020 16:51

joelgriffith suggested changes Dec 14, 2020

View reviewed changes

x-pack/examples/reporting_example/public/plugin.ts Outdated Show resolved Hide resolved

x-pack/plugins/reporting/common/index.ts Show resolved Hide resolved

ppisljar approved these changes Dec 15, 2020

View reviewed changes

x-pack/examples/reporting_example/README.md Outdated Show resolved Hide resolved

tsullivan added 3 commits December 18, 2020 15:36

Merge branch 'master' into reporting/feature-control-example

6fe790d

use constant

e472c7c

add more description to using reporting as a service

a2ad912

tsullivan requested a review from joelgriffith December 22, 2020 00:46

Merge branch 'master' into reporting/feature-control-example

f7d8a70

joelgriffith approved these changes Dec 22, 2020

View reviewed changes

Merge branch 'master' into reporting/feature-control-example

4240dc4

tsullivan merged commit b120cb3 into elastic:master Dec 29, 2020

tsullivan deleted the reporting/feature-control-example branch December 29, 2020 16:55

tsullivan mentioned this pull request Dec 29, 2020

[7.x] [AppServices/Examples] Add the example for Reporting integration (#82091) #86999

Merged

tsullivan mentioned this pull request Dec 29, 2020

[7.11] [AppServices/Examples] Add the example for Reporting integration (#82091) #87000

Merged

sophiec20 added the (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead label Aug 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[AppServices/Examples] Add the example for Reporting integration #82091

[AppServices/Examples] Add the example for Reporting integration #82091

tsullivan commented Oct 29, 2020 •

edited

Loading

tsullivan Nov 4, 2020 •

edited

Loading

tsullivan commented Dec 14, 2020

joelgriffith left a comment

ppisljar left a comment

tsullivan commented Dec 22, 2020

joelgriffith left a comment

tsullivan commented Dec 29, 2020

kibanamachine commented Dec 29, 2020

[AppServices/Examples] Add the example for Reporting integration #82091

[AppServices/Examples] Add the example for Reporting integration #82091

Conversation

tsullivan commented Oct 29, 2020 • edited Loading

Summary

!!!

TODO

tsullivan Nov 4, 2020 • edited Loading

Choose a reason for hiding this comment

tsullivan commented Dec 14, 2020

joelgriffith left a comment

Choose a reason for hiding this comment

ppisljar left a comment

Choose a reason for hiding this comment

tsullivan commented Dec 22, 2020

joelgriffith left a comment

Choose a reason for hiding this comment

tsullivan commented Dec 29, 2020

kibanamachine commented Dec 29, 2020

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Distributable file count

Page load bundle

History

tsullivan commented Oct 29, 2020 •

edited

Loading

tsullivan Nov 4, 2020 •

edited

Loading