Add IFormValidator

[bollwyvl]

References

• continues Upgrade json schema version #13746

Elevator Pitch

This starts the process of making the JupyterLab's JSON Schema validator replaceable.

Motivation

The choice of underlying validator library is now inextricably (but correctly) linked to the visual presentation of settings and notebook metadata.

Being able to swap to another, as-of-yet unspecified validator, is ultimately to avoid breakage when JupyterLab is hosted with the unsafe-eval CSP set (this can be done, e.g. by portal iframes, over which the application deployer and consumer may have no control). Choosing a validator is out of scope, and discussed in the Future Work session below

And yes, all of this is a little silly when the user controls the application. But here we are.

Code changes

• add a new package, @jupyterlab/validator-ajv8-extension
  • add a plugin @jupyterlab/validator-ajv8-extension:form-validator
    • the definition of IFormValidator stays in @jupyterlab/ui-components
  • consolidates imports of @rjsf/validator-ajv8 into a single async import
    • ...except one test

User-facing changes

• n/a (beyond Update to ajv 8 and react-json-schema-form 5 #13924)

Backwards-incompatible changes

• n/a (beyond Update to ajv 8 and react-json-schema-form 5 #13924)

Future Work

On a follow-on PR:

• add a new package, @jupyterlab/validator
  • consolidate all imports of ajv
  • move ISchemaValidator here
  • expand typings to offer concepts like
    • known schema
    • extra keywords
  • make a dependent of ISettingsRegistry
• refactor settings to not rely on the Schema validator to calculate the composite from defaults

  • this is not supported by any implementation i could find

• add a ISchemaValidator provider to @jupyterlab/validator-ajv8-extension

Even if that were done, there would be more work to address the use of eval in a number other known places in this codebase and dependencies.

• translation
• javascript
• vega
• pageconfig

Of those, probably only pageconfig is "critical," difficult to replace functionality, while the others could probably be worked around.

[jupyterlab-probot]

Thanks for making a pull request to jupyterlab!
To try out this branch on binder, follow this link:

[bollwyvl]

This PR has bitrotted, unlikely to continue this work at this time.