Remove json-schema-ref-parser

Removes json-schema-ref-parser and corresponding resolving functionality
and dependencies from JSON Forms.

Resolving of external dependencies is not a core feature of JSON Forms
which is why we delegated it to a 3rd party dependency. However the
json-schema-ref-parser library is not only slow and mutating schemas in
place but also brings in a number of questionable Node dependent
dependencies.

The only binding actually using this functionality is the React
binding. The way resolving was implemented resulted in the same flow
as resolving it outside of JSON Forms and handing the
resolved schema over.

Based on these downsides and the very little upsides we decided to
remove json-schema-ref-parser without a replacement from JSON Forms.

Angular and Vue consumers don't need to spend any migration efforts. In
@jsonforms/react we still export the backward API compatible
'ResolvedJsonFormsDispatch'. Therefore only React consumers actually
using the now removed 'refParserOptions' are forced to migrate while
for all other React consumers it depends on their use cases.

The built-in resolving mechanism in JSON Forms is quite basic. When
the schema was fully resolved anyway the basic resolving did quite
fine. However as this is no longer the case by default, there are
now cases which are no longer supported and break. This is especially
the case for complex combinator use cases involving references.

Of course these can still be used when the consumer resolves their
schema themselves before handing it over to JSON Forms. We also plan
to make our built-in resolving more robust before the full 3.0 release
to cover more of these cases. However we will not reach feature parity
without major additional efforts.

Author: sdirix

package-lock.json

@@ -63,10 +63,7 @@
   "dependencies": {
     "@types/json-schema": "^7.0.3",
     "ajv": "^6.10.2",
-    "json-schema-ref-parser": "7.1.3",
-    "lodash": "^4.17.15",
-    "uri-js": "^4.2.2",
-    "uuid": "^3.3.3"
+    "lodash": "^4.17.15"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "0.1.3",

packages/core/package.json

@@ -27,7 +27,6 @@ import { JsonSchema, UISchemaElement } from '../';
 import { generateDefaultUISchema, generateJsonSchema } from '../generators';
 
 import { RankedTester } from '../testers';
-import RefParser from 'json-schema-ref-parser';
 import { UISchemaTester } from '../reducers/uischemas';
 import { ValidationMode } from '../reducers/core';
 
@@ -99,7 +98,6 @@ export interface UpdateCoreAction {
 
 export interface InitActionOptions {
   ajv?: AJV.Ajv;
-  refParserOptions?: RefParser.Options;
   validationMode?: ValidationMode;
 }
 

packages/core/src/actions/index.ts

@@ -29,7 +29,6 @@ import filter from 'lodash/filter';
 import isEqual from 'lodash/isEqual';
 import isFunction from 'lodash/isFunction';
 import { Ajv, ErrorObject, ValidateFunction } from 'ajv';
-import RefParser from 'json-schema-ref-parser';
 import {
   CoreActions,
   INIT,
@@ -79,7 +78,6 @@ export interface JsonFormsCore {
   errors?: ErrorObject[];
   validator?: ValidateFunction;
   ajv?: Ajv;
-  refParserOptions?: RefParser.Options;
   validationMode?: ValidationMode;
 }
 
@@ -90,7 +88,6 @@ const initState: JsonFormsCore = {
   errors: [],
   validator: alwaysValid,
   ajv: undefined,
-  refParserOptions: undefined,
   validationMode: 'ValidateAndShow'
 };
 
@@ -107,8 +104,7 @@ const getOrCreateAjv = (state: JsonFormsCore, action?: InitAction | UpdateCoreAc
       // options object with ajv
       return action.options.ajv;
     } else if (
-      action.options !== undefined &&
-      !hasRefParserOption(action.options)
+      action.options !== undefined 
     ) {
       // it is not an option object => should be ajv itself => check for compile function
       if (isFunction(action.options.compile)) {
@@ -124,23 +120,6 @@ const getOrCreateAjv = (state: JsonFormsCore, action?: InitAction | UpdateCoreAc
   return createAjv();
 };
 
-const getRefParserOptions = (
-  state: JsonFormsCore,
-  action?: InitAction | UpdateCoreAction
-): RefParser.Options => {
-  if (action && hasRefParserOption(action.options)) {
-    return action.options.refParserOptions;
-  }
-  return state.refParserOptions;
-};
-
-const hasRefParserOption = (option: any): option is InitActionOptions => {
-  if (option) {
-    return option.refParserOptions !== undefined;
-  }
-  return false;
-};
-
 const hasAjvOption = (option: any): option is InitActionOptions => {
   if (option) {
     return option.ajv !== undefined;
@@ -173,7 +152,6 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
   switch (action.type) {
     case INIT: {
       const thisAjv = getOrCreateAjv(state, action);
-      const o = getRefParserOptions(state, action);
 
       const validationMode = getValidationMode(state, action);
       const v = validationMode === 'NoValidation' ? alwaysValid : thisAjv.compile(action.schema);
@@ -187,13 +165,11 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
         errors: e,
         validator: v,
         ajv: thisAjv,
-        refParserOptions: o,
         validationMode
       };
     }
     case UPDATE_CORE: {
       const thisAjv = getOrCreateAjv(state, action);
-      const refParserOptions = getRefParserOptions(state, action);
       const validationMode = getValidationMode(state, action);
       let validator = state.validator;
       let errors = state.errors;
@@ -219,7 +195,6 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
         state.ajv !== thisAjv ||
         state.errors !== errors ||
         state.validator !== validator ||
-        state.refParserOptions !== refParserOptions ||
         state.validationMode !== validationMode;
       return stateChanged
         ? {
@@ -230,7 +205,6 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
             ajv: thisAjv === state.ajv ? state.ajv : thisAjv,
             errors: isEqual(errors, state.errors) ? state.errors : errors,
             validator: validator === state.validator ? state.validator : validator,
-            refParserOptions: refParserOptions === state.refParserOptions ? state.refParserOptions : refParserOptions,
             validationMode: validationMode === state.validationMode ? state.validationMode : validationMode
           }
         : state;
@@ -402,6 +376,3 @@ export const errorAt = (instancePath: string, schema: JsonSchema) =>
   getErrorsAt(instancePath, schema, path => path === instancePath);
 export const subErrorsAt = (instancePath: string, schema: JsonSchema) =>
   getErrorsAt(instancePath, schema, path => path.startsWith(instancePath));
-
-export const extractRefParserOptions = (state: JsonFormsCore) =>
-  get(state, 'refParserOptions');

packages/core/src/reducers/core.ts

@@ -29,7 +29,6 @@ import {
   errorsAt,
   extractAjv,
   extractData,
-  extractRefParserOptions,
   extractSchema,
   extractUiSchema,
   JsonFormsCore,
@@ -59,7 +58,6 @@ import {
 import { Generate } from '../generators';
 import { JsonFormsCellRendererRegistryEntry } from './cells';
 import { JsonSchema } from '../models/jsonSchema';
-import RefParser from 'json-schema-ref-parser';
 
 import { cellReducer } from './cells';
 import { configReducer } from './config';
@@ -95,8 +93,6 @@ export const getSchema = (state: JsonFormsState): JsonSchema =>
   extractSchema(get(state, 'jsonforms.core'));
 export const getUiSchema = (state: JsonFormsState): UISchemaElement =>
   extractUiSchema(get(state, 'jsonforms.core'));
-export const getRefParserOptions = (state: JsonFormsState): RefParser.Options =>
-  extractRefParserOptions(get(state, 'jsonforms.core'));
 export const getAjv = (
   state: JsonFormsState
 ): Ajv => extractAjv(get(state, 'jsonforms.core'));

packages/core/src/reducers/index.ts

@@ -115,9 +115,6 @@ const Resolve: {
 export {
   resolveData,
   resolveSchema,
-  findRefs,
-  SchemaRef,
-  SchemaRefs
 } from './resolvers';
 export { Resolve };
 

packages/core/src/util/index.ts

@@ -26,15 +26,13 @@ import get from 'lodash/get';
 import { ControlElement, UISchemaElement } from '../models/uischema';
 import union from 'lodash/union';
 import find from 'lodash/find';
-import RefParser from 'json-schema-ref-parser';
 import {
   findUISchema,
   getAjv,
   getCells,
   getConfig,
   getData,
   getErrorAt,
-  getRefParserOptions,
   getRenderers,
   getSchema,
   getSubErrorsAt,
@@ -805,7 +803,6 @@ export interface OwnPropsOfJsonFormsRenderer extends OwnPropsOfRenderer {}
 export interface StatePropsOfJsonFormsRenderer
   extends OwnPropsOfJsonFormsRenderer {
   rootSchema: JsonSchema;
-  refResolver: any;
 }
 
 export interface JsonFormsProps extends StatePropsOfJsonFormsRenderer {}
@@ -834,8 +831,6 @@ export const mapStateToJsonFormsRendererProps = (
     schema: ownProps.schema || getSchema(state),
     rootSchema: getSchema(state),
     uischema: uischema,
-    refResolver: (schema: any) =>
-      RefParser.dereference(schema, getRefParserOptions(state)),
     path: ownProps.path
   };
 };
@@ -892,12 +887,19 @@ const mapStateToCombinatorRendererProps = (
     );
   };
   let indexOfFittingSchema: number;
+  // TODO instead of compiling the combinator subschemas we can compile the original schema
+  // without the combinator alternatives and then revalidate and check the errors for the
+  // element
   for (let i = 0; i < _schema[keyword].length; i++) {
-    const valFn = ajv.compile(_schema[keyword][i]);
-    valFn(data);
-    if (dataIsValid(valFn.errors)) {
-      indexOfFittingSchema = i;
-      break;
+    try {
+      const valFn = ajv.compile(_schema[keyword][i]);
+      valFn(data);
+      if (dataIsValid(valFn.errors)) {
+        indexOfFittingSchema = i;
+        break;
+      }
+    } catch (error) {
+      console.debug("Combinator subschema is not self contained, can't hand it over to AJV");
     }
   }