[Reporting] Fix and test for Listing of Reports #74453

tsullivan · 2020-08-05T21:56:59Z

Summary

Fix an issue where the Reporting API route for showing the listing of pages was not working correctly, due to query parameters not being parsed from the request.

Skipping release notes since this bug was not released in the current latest version.

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios
TODO: [Reporting] Fix and test for Listing of Reports #74453 (comment) questions

For maintainers

This was checked for breaking API changes and was labeled appropriately

tsullivan · 2020-08-05T21:57:42Z

x-pack/test/functional/apps/reporting_management/index.ts

@@ -9,6 +9,6 @@ import { FtrProviderContext } from '../../ftr_provider_context';
 export default ({ loadTestFile }: FtrProviderContext) => {
  describe('reporting management app', function () {
    this.tags('ciGroup7');
-    loadTestFile(require.resolve('./report_delete_pagination'));
+    loadTestFile(require.resolve('./report_listing'));


renamed the file since it tests more than just deleting a report in the listing

tsullivan · 2020-08-05T21:59:05Z

x-pack/plugins/reporting/server/routes/jobs.ts

@@ -50,7 +56,7 @@ export function registerJobInfoRoutes(reporting: ReportingCore) {
        page: queryPage = '0',
        size: querySize = '10',
        ids: queryIds = null,
-      } = req.query as ListQuery;
+      } = req.query as ListQuery; // NOTE: type inference is not working here. userHandler breaks it?


I would like to understand why the type of req.query can not be inferred from the validation. I didn't take much time to look into it.

I'd like to know as well. I spent a good deal of time trying to get types to pass through with the higher order handler (https://github.com/elastic/kibana/blob/master/x-pack/plugins/reporting/server/routes/lib/authorized_user_pre_routing.ts#L15), but there's some interesting effects it might have trying to get type information to pass through properly. This was a pretty big change in our codebase to get everything working properly, as a lot of our utilities relied on augmented Hapi request objects since we used the pre handlers fairly extensively. I can take a look at this since I wrote the wrapper handler. Unfortunately nothing is jumping out at me since I pretty much copy/pasted the migration docs for this "higher-order" handler.

elasticmachine · 2020-08-05T22:00:47Z

Pinging @elastic/kibana-reporting-services (Team:Reporting Services)

tsullivan · 2020-08-05T22:01:22Z

x-pack/plugins/reporting/server/routes/jobs.ts

@@ -35,7 +35,13 @@ export function registerJobInfoRoutes(reporting: ReportingCore) {
  router.get(
    {
      path: `${MAIN_ENTRY}/list`,
-      validate: false,
+      validate: {


Note from @restrry: "platform doesn’t provide request params / body / query unless validation schema is provided"

a couple of remarks

page & size should be number, you parse them below

userHandler might break type inference logic, at least it doesn't implement the same interface as wrappers in docs https://github.com/elastic/kibana/blob/e57f4d2b25ac95183e876ea0c305138ab119ea26/src/core/MIGRATION_EXAMPLES.md#migrating-hapi-pre-handlers.
I'd recommend either implement it as RequestHandlerWrapper or pass user via RequestHandlerContext.

Our HoH has roughly the same type passthrough interface. Is there something obvious I'm missing?

tsullivan · 2020-08-11T00:07:00Z

I had to add sleep calls in between clicking the pages before scanning the table and verifying the contents. Right now, the sleep is for 2 seconds.

Instead, there should probably be a paging test subject on the page that we can wait to find, to know that we're on the right page - instead of just waiting a hard 2 seconds

Edit: resolved in 9c7ac46d3f

kibanamachine · 2020-08-11T17:37:34Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: d0215ab

Build metrics

page load bundle size

id	value	diff	baseline
reporting	291.0KB	+33.0B	291.0KB

History

💔 Build #67529 failed 44df9ce
💔 Build #67409 failed 9c7ac46d3f5ff30393b640cddb43ac510c6f79d6
💔 Build #66779 failed b44d21d76c870032d2ddd51255315907881115f7

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

tsullivan · 2020-08-11T17:57:29Z

Hi @restrry, I'm not exactly clear on the advice in #74453 (comment)

page & size should be number, you parse them below

Does this mean the route validates them as number? And also that it will still be a string in my handler and that I should still parse the string into a number?

I'd recommend either implement it as RequestHandlerWrapper or pass user via RequestHandlerContext.

Is this advice for something to change in each of our route handlers? Or is something not set up right in the x-pack/plugins/reporting/server/routes/lib/authorized_user_pre_routing.ts?

joelgriffith

LGTM. Since this is a blocker (IMO), I'm OK with following up with the np changes in a follow up PR

tsullivan · 2020-08-11T19:59:19Z

Since this is a blocker (IMO), I'm OK with following up with the np changes in a follow up PR

I agree with this

* [Reporting] Fix and test for Listing of Reports * add sleeps * await selector instead of sleep * reduce changes * cleanup after csv generated * fix snapshot

* [Reporting] Fix and test for Listing of Reports (#74453) * [Reporting] Fix and test for Listing of Reports * add sleeps * await selector instead of sleep * reduce changes * cleanup after csv generated * fix snapshot * fix test asserts

…nes/processor-forms-a-d * 'master' of github.com:elastic/kibana: (25 commits) [ML] Removing full lodash library imports (elastic#74742) [Search] Server strategy example (elastic#71679) [Reporting] Fix and test for Listing of Reports (elastic#74453) [maps] fix drawing shapes (elastic#74689) [Resolver] Improve simulator. Add more click-through tests and panel tests. (elastic#74601) Deprecate schema-less specs in Vega (elastic#73805) [Security Solution] Rename Administration > Hosts subtab to Endpoints (elastic#74287) Timelion deprecation doc (elastic#74508) [Functional Tests] Adds a wait time between setting the index pattern and the time field on TSVB (elastic#74736) [Lens] Add styling options for x and y axes on the settings popover (elastic#71829) [Maps] add initial location option that fits to data bounds (elastic#74583) theme function (elastic#73451) [data.ui.query] Write filters to query log from default editor. (elastic#74474) [data.search.SearchSource] Move some SearchSource dependencies to the server. (elastic#74607) [Canvas][tech-debt] Convert renderers (elastic#74134) [security solutions][lists] Adds end to end tests (elastic#74473) pluralized for occurrences vs occurrence (elastic#74564) Update links that pointed to CONTRIBUTING.md (elastic#74757) [Ingest pipelines] Implement tabs in processor flyout (elastic#74469) [Event log] Use Alerts client & Actions client when fetching these types of SOs (elastic#73257) ... # Conflicts: # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/field_components/text_editor.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/manage_processor_form.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/append.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/bytes.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/circle.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/common_fields/field_name_field.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/common_fields/ignore_missing_field.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/convert.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/csv.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/date.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/date_index_name.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/dissect.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/dot_expander.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/drop.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/index.ts # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/manage_processor_form/processors/shared.ts

* master: [Vega] add functional tests for Vega visualization (elastic#74097) [ML] Removing full lodash library imports (elastic#74742) [Search] Server strategy example (elastic#71679) [Reporting] Fix and test for Listing of Reports (elastic#74453) [maps] fix drawing shapes (elastic#74689) [Resolver] Improve simulator. Add more click-through tests and panel tests. (elastic#74601) Deprecate schema-less specs in Vega (elastic#73805) [Security Solution] Rename Administration > Hosts subtab to Endpoints (elastic#74287) Timelion deprecation doc (elastic#74508)

* [Reporting] Fix and test for Listing of Reports (#74453) * [Reporting] Fix and test for Listing of Reports * add sleeps * await selector instead of sleep * reduce changes * cleanup after csv generated * fix snapshot * same as 7.9 fix

mshustov · 2020-08-19T08:45:24Z

Is this advice for something to change in each of our route handlers? Or is something not set up right in the x-pack/plugins/reporting/server/routes/lib/authorized_user_pre_routing.ts?

yes, it has ben fixed in #74879

Does this mean the route validates them as number?

yes, @kbn/config-schema will parse them as numbers

tsullivan commented Aug 5, 2020

View reviewed changes

tsullivan added Team:Reporting Services release_note:skip Skip the PR/issue when compiling release notes v7.10.0 v8.0.0 labels Aug 5, 2020

tsullivan requested review from joelgriffith, rashmivkulkarni and mshustov August 5, 2020 22:00

tsullivan marked this pull request as ready for review August 5, 2020 22:00

tsullivan commented Aug 5, 2020

View reviewed changes

tsullivan added 4 commits August 11, 2020 08:08

[Reporting] Fix and test for Listing of Reports

c2415a1

add sleeps

cb6dd51

await selector instead of sleep

e60f215

Merge branch 'master' into reporting/fix-pagination

a39f8af

tsullivan force-pushed the reporting/fix-pagination branch from 9c7ac46 to a39f8af Compare August 11, 2020 15:11

tsullivan added 3 commits August 11, 2020 08:18

reduce changes

44df9ce

cleanup after csv generated

2609d03

fix snapshot

d0215ab

tsullivan mentioned this pull request Aug 11, 2020

[Reporting] Listing of reports pagination is broken #74799

Closed

joelgriffith approved these changes Aug 11, 2020

View reviewed changes

tsullivan added the v7.9.1 label Aug 11, 2020

tsullivan merged commit d786442 into elastic:master Aug 11, 2020

tsullivan deleted the reporting/fix-pagination branch August 11, 2020 19:59

tsullivan mentioned this pull request Aug 11, 2020

[7.x] [Reporting] Fix and test for Listing of Reports (#74453) #74801

Merged

tsullivan mentioned this pull request Aug 11, 2020

[7.9] [Reporting] Fix and test for Listing of Reports (#74453) #74802

Merged

tylersmalley added the bug Fixes for quality problems that affect the customer experience label Aug 12, 2020

azasypkin mentioned this pull request Aug 12, 2020

Implement Server-Side sessions #68117

Merged

8 tasks

LeeDr mentioned this pull request Aug 17, 2020

Reporting page doesn't show any reports. User doesn't get report completed notifications #75239

Closed

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

[Reporting] Fix and test for Listing of Reports #74453

[Reporting] Fix and test for Listing of Reports #74453

tsullivan commented Aug 5, 2020 •

edited

Loading

tsullivan Aug 5, 2020

tsullivan Aug 5, 2020

joelgriffith Aug 11, 2020

elasticmachine commented Aug 5, 2020

tsullivan Aug 5, 2020

mshustov Aug 6, 2020

joelgriffith Aug 11, 2020

tsullivan commented Aug 11, 2020 •

edited

Loading

kibanamachine commented Aug 11, 2020

tsullivan commented Aug 11, 2020

joelgriffith left a comment

tsullivan commented Aug 11, 2020

mshustov commented Aug 19, 2020

[Reporting] Fix and test for Listing of Reports #74453

[Reporting] Fix and test for Listing of Reports #74453

Conversation

tsullivan commented Aug 5, 2020 • edited Loading

Summary

Checklist

For maintainers

tsullivan Aug 5, 2020

Choose a reason for hiding this comment

tsullivan Aug 5, 2020

Choose a reason for hiding this comment

joelgriffith Aug 11, 2020

Choose a reason for hiding this comment

elasticmachine commented Aug 5, 2020

tsullivan Aug 5, 2020

Choose a reason for hiding this comment

mshustov Aug 6, 2020

Choose a reason for hiding this comment

joelgriffith Aug 11, 2020

Choose a reason for hiding this comment

tsullivan commented Aug 11, 2020 • edited Loading

kibanamachine commented Aug 11, 2020

💚 Build Succeeded

Build metrics

page load bundle size

History

tsullivan commented Aug 11, 2020

joelgriffith left a comment

Choose a reason for hiding this comment

tsullivan commented Aug 11, 2020

mshustov commented Aug 19, 2020

tsullivan commented Aug 5, 2020 •

edited

Loading

tsullivan commented Aug 11, 2020 •

edited

Loading