Uses new frictionless report component to display validation report

[aivuk]

Uses React Frictionless Report component to display a resource validation results.

[codecov]

Codecov Report

Merging #71 (c3b6807) into use-frictionless-framework-v5 (e774828) will decrease coverage by 0.07%.
The diff coverage is 71.42%.

@@                        Coverage Diff                        @@
##           use-frictionless-framework-v5      #71      +/-   ##
=================================================================
- Coverage                          84.38%   84.31%   -0.08%     
=================================================================
  Files                                 24       24              
  Lines                               2075     2078       +3     
=================================================================
+ Hits                                1751     1752       +1     
- Misses                               324      326       +2     

Impacted Files	Coverage Δ
ckanext/validation/plugin/__init__.py	96.24% <ø> (ø)
ckanext/validation/helpers.py	88.88% <50.00%> (-1.81%)	⬇️
ckanext/validation/jobs.py	82.85% <75.00%> (-0.80%)	⬇️
ckanext/validation/tests/test_jobs.py	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[amercader]

@aivuk This is looking good, but there are a couple of things to iron out:

• When you click on the report page:

  • The badge shows "error" when it should show "invalid"
  • The duration of the check is not populated
  • We are showing the local path in the report, which we shouldn't. IIRC this was corrected here but it might need some adjusting to the new format
    

• When you work in sync mode (ckanext.validation.run_on_create_sync = True / ckanext.validation.run_on_update_sync = True) the files are validated in the same request where you create the resource. If there are errors, the validation report is returned. We hijack the error message in the form to not display the raw JSON report but a link instead, that opens a dialog with the report component. The component is not currently rendered in the dialog:

The errors.html template is a good starting point to investigate

[amercader]

Sorry, just realized this was a draft, so apologies if you were already looking at these

[aivuk]

Sorry, just realized this was a draft, so apologies if you were already looking at these

Thanks, I was working on the dialog, but I'm having an error using the report.js. For some reason the validation_error json is not being passed to the module-validation-report.js (it's undefined), but I checked and the json is there in the template validation/snippets/validation_report_dialog.html but it's not being passed to the JS module. I'm investigating it. I missed the error in the badge, I thought that it would need to be "error", but I got it that we need to have three states.

[aivuk]

Hi @amercader, the following points that you raised are fixed:

• The badge shows "error" when it should show "invalid"
• The duration of the check is not populated
• We are showing the local path in the report, which we shouldn't. IIRC this was corrected here but it might need some adjusting to the new format

I'm still debugging why when the plugin is running in sync mode, the report is not being displayed by the component. The same thing happens when the plugin is not running in sync, after you update a resource and click in the badge label before reloading the page.

[amercader]

Thanks @aivuk , that sounds great. If it helps this JSON.parse() seems to be failing here but I'm not sure if that's related

[ThrawnCA]

Is it feasible to remove this constraint? I know that plugin ordering can be important, but perhaps there is a way to make them more independent?

[amercader]

@ThrawnCA I don't think so. We want ckanext-validation's errors.html to override ckanext-scheming's so we can hook the report to the error messages.

I guess that we could add "If using ckanext-scheming and using synchronous mode, the validation plugin should be loaded before the scheming_datasets one" but that would make the instructions a bit more confusing

[ThrawnCA]

Oh, and ckanext-scheming defines the base version of that template, which doesn't extend anything, so if ckanext-scheming comes first, then processing stops and ckanext-validation's version is never reached. That makes sense.

Perhaps the reason can be documented here?

[ThrawnCA]

Is it necessary to copy the Frictionless web assets into this repo? Are they not available in any PyPI package?

[aivuk]

Is it necessary to copy the Frictionless web assets into this repo? Are they not available in any PyPI package?

The frictionless web assets are from https://components.frictionlessdata.io/ and the js package is on npm https://www.npmjs.com/package/frictionless-components. I'm using the latest build (version 1.3.2) instead of a CDN or adding a build it step on ckanext-validation that would download and build the npm package.

[aivuk]

@amercader Fixed the report in sync mode, now the report is being displayed in a dialog if there are errors when creating a new resource.

[amercader]

Great stuff! Can you make the dialog a bit wider? it's a bit hard to read currently. This probably helps: https://getbootstrap.com/docs/4.2/components/modal/#optional-sizes

Besides this, this is good to merge once #69 is done

[aivuk]

Great stuff! Can you make the dialog a bit wider? it's a bit hard to read currently. This probably helps: https://getbootstrap.com/docs/4.2/components/modal/#optional-sizes

Besides this, this is good to merge once #69 is done

It's bigger now