Refactored schema to support running schema tests from other packages (#2899)

* Refactored schema to support runnings from other packages
- Fixed the import of `types` in `mergeSchemas.ts`
- Renamed all of the `xxx.test.ts` to `xxxTest.ts` and wrapped them in an outer `xxxTest()` function that takes a `TestValidatorType`
- Added a `types.ts` file in the `schema` directory to provide the `TestValidatorType` and `TestValidatorParams` interfaces
- Added an `index.ts` file in the `schema` directory to export all of the `xxxTest` functions
- Updated `getTestValidator()` to import the types from the `schema/types`
- Added a `test/schema.test.ts` to create a `TestValidator` and run all of the `xxxTest()` functions from `schema`

* - Fixed the tests based on using the real validator

* - Removed the use of `xxx.hasOwnProperty('y')` in favor `'y' in xxx` to eliminate lint warnings
- Fixed bug in `stubExistingAdditionalProperties()` related to the `additionalProperties: true` case, adding new test to verify fix

* - Removed console.log statement

* - Moved `stubExistingAdditionalProperties()` into the `retrieveSchema.ts` file to eliminate a circular dependency
  - Did the same for the `stubExistingAdditionalPropertiesTest()` function
- Updated the `index.ts` files to remove the `stubExistingAdditionalProperties[Test]()` functions
- Updated `SchemaUtilsType` and `createSchemaUtils` to remove the `stubExistingAdditionalProperties()` function

Author: heath-freenome

packages/utils/src/createSchemaUtils.ts

@@ -7,7 +7,6 @@ import {
   isMultiSelect,
   isSelect,
   retrieveSchema,
-  stubExistingAdditionalProperties,
   toIdSchema,
   toPathSchema,
 } from './schema';
@@ -104,16 +103,6 @@ class SchemaUtils<T = any> implements SchemaUtilsType<T> {
     return retrieveSchema<T>(this.validator, schema, this.rootSchema, rawFormData);
   }
 
-  /** Creates new 'properties' items for each key in the `formData`
-   *
-   * @param schema - The schema for which the existing additional properties is desired
-   * @param [formData] - The current formData, if any, to assist retrieving a schema
-   * @returns - The updated schema with additional properties stubbed
-   */
-  stubExistingAdditionalProperties(schema: RJSFSchema, formData?: T) {
-    return stubExistingAdditionalProperties<T>(this.validator, schema, this.rootSchema, formData);
-  }
-
   /** Generates an `IdSchema` object for the `schema`, recursively
    *
    * @param schema - The schema for which the display label flag is desired

packages/utils/src/getWidget.tsx

@@ -108,17 +108,17 @@ export default function getWidget<T = any, F = any>(
     throw new Error(`Unsupported widget definition: ${typeof widget}`);
   }
 
-  if (registeredWidgets.hasOwnProperty(widget)) {
+  if (widget in registeredWidgets) {
     const registeredWidget = registeredWidgets[widget];
     return getWidget<T, F>(schema, registeredWidget, registeredWidgets);
   }
 
   if (typeof type === 'string') {
-    if (!widgetMap.hasOwnProperty(type)) {
+    if (!(type in widgetMap)) {
       throw new Error(`No widget for type '${type}'`);
     }
 
-    if (widgetMap[type].hasOwnProperty(widget)) {
+    if (widget in widgetMap[type]) {
       const registeredWidget = registeredWidgets[widgetMap[type][widget]];
       return getWidget<T, F>(schema, registeredWidget, registeredWidgets);
     }

packages/utils/src/isConstant.ts

@@ -9,5 +9,5 @@ import { RJSFSchema } from './types';
  * @returns - True if the `schema` has a single constant value, false otherwise
  */
 export default function isConstant(schema: RJSFSchema) {
-  return (Array.isArray(schema.enum) && schema.enum.length === 1) || schema.hasOwnProperty(CONST_KEY);
+  return (Array.isArray(schema.enum) && schema.enum.length === 1) || CONST_KEY in schema;
 }

packages/utils/src/mergeObjects.ts

@@ -12,7 +12,7 @@ export default function mergeObjects(obj1: GenericObjectType, obj2: GenericObjec
   return Object.keys(obj2).reduce((acc, key) => {
     const left = obj1 ? obj1[key] : {},
       right = obj2[key];
-    if (obj1 && obj1.hasOwnProperty(key) && isObject(right)) {
+    if (obj1 && key in obj1 && isObject(right)) {
       acc[key] = mergeObjects(left, right, concatArrays);
     } else if (concatArrays && Array.isArray(left) && Array.isArray(right)) {
       acc[key] = left.concat(right);

packages/utils/src/mergeSchemas.ts

@@ -2,7 +2,7 @@ import union from 'lodash/union';
 
 import getSchemaType from './getSchemaType';
 import isObject from './isObject';
-import { GenericObjectType } from 'types';
+import { GenericObjectType } from './types';
 
 /** Recursively merge deeply nested schemas. The difference between mergeSchemas and mergeObjects is that mergeSchemas
  * only concats arrays for values under the 'required' keyword, and when it does, it doesn't include duplicate values.
@@ -16,7 +16,7 @@ export default function mergeSchemas(obj1: GenericObjectType, obj2: GenericObjec
   return Object.keys(obj2).reduce((acc, key) => {
     const left = obj1 ? obj1[key] : {},
       right = obj2[key];
-    if (obj1 && obj1.hasOwnProperty(key) && isObject(right)) {
+    if (obj1 && key in obj1 && isObject(right)) {
       acc[key] = mergeSchemas(left, right);
     } else if (
       obj1 &&

packages/utils/src/schema/index.ts

@@ -5,7 +5,6 @@ import isFilesArray from './isFilesArray';
 import isMultiSelect from './isMultiSelect';
 import isSelect from './isSelect';
 import retrieveSchema from './retrieveSchema';
-import stubExistingAdditionalProperties from './stubExistingAdditionalProperties';
 import toIdSchema from './toIdSchema';
 import toPathSchema from './toPathSchema';
 
@@ -17,7 +16,6 @@ export {
   isMultiSelect,
   isSelect,
   retrieveSchema,
-  stubExistingAdditionalProperties,
   toIdSchema,
   toPathSchema,
 };

packages/utils/src/schema/retrieveSchema.ts

@@ -1,13 +1,20 @@
 import get from 'lodash/get';
+import set from 'lodash/set';
 import mergeAllOf from 'json-schema-merge-allof';
 
-import { ADDITIONAL_PROPERTIES_KEY, ALL_OF_KEY, DEPENDENCIES_KEY, REF_KEY } from '../constants';
+import {
+  ADDITIONAL_PROPERTIES_KEY,
+  ADDITIONAL_PROPERTY_FLAG,
+  ALL_OF_KEY,
+  DEPENDENCIES_KEY,
+  REF_KEY
+} from '../constants';
 import findSchemaDefinition, { splitKeyElementFromObject } from '../findSchemaDefinition';
+import guessType from '../guessType';
 import isObject from '../isObject';
 import mergeSchemas from '../mergeSchemas';
 import { GenericObjectType, RJSFSchema, RJSFSchemaDefinition, ValidatorType } from '../types';
 import getMatchingOption from './getMatchingOption';
-import stubExistingAdditionalProperties from './stubExistingAdditionalProperties';
 
 /** Resolves a conditional block (if/else/then) by removing the condition and merging the appropriate conditional branch
  * with the rest of the schema
@@ -58,14 +65,14 @@ export function resolveCondition<T = any>(
 export function resolveSchema<T = any>(
   validator: ValidatorType, schema: RJSFSchema, rootSchema: RJSFSchema = {}, formData?: T
 ): RJSFSchema {
-  if (schema.hasOwnProperty(REF_KEY)) {
+  if (REF_KEY in schema) {
     return resolveReference<T>(validator, schema, rootSchema, formData);
   }
-  if (schema.hasOwnProperty(DEPENDENCIES_KEY)) {
+  if (DEPENDENCIES_KEY in schema) {
     const resolvedSchema = resolveDependencies<T>(validator, schema, rootSchema, formData);
     return retrieveSchema<T>(validator, resolvedSchema, rootSchema, formData);
   }
-  if (schema.hasOwnProperty(ALL_OF_KEY)) {
+  if (ALL_OF_KEY in schema) {
     return {
       ...schema,
       allOf: schema.allOf!.map((allOfSubschema) =>
@@ -101,6 +108,61 @@ export function resolveReference<T = any>(
   );
 }
 
+/** Creates new 'properties' items for each key in the `formData`
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param theSchema - The schema for which the existing additional properties is desired
+ * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s * @param validator
+ * @param [aFormData] - The current formData, if any, to assist retrieving a schema
+ * @returns - The updated schema with additional properties stubbed
+ */
+export function stubExistingAdditionalProperties<T = any>(
+  validator: ValidatorType,
+  theSchema: RJSFSchema,
+  rootSchema?: RJSFSchema,
+  aFormData?: T
+): RJSFSchema {
+  // Clone the schema so we don't ruin the consumer's original
+  const schema = {
+    ...theSchema,
+    properties: { ...theSchema.properties },
+  };
+
+  // make sure formData is an object
+  const formData: GenericObjectType = aFormData && isObject(aFormData) ? aFormData : {};
+  Object.keys(formData).forEach((key) => {
+    if (key in schema.properties) {
+      // No need to stub, our schema already has the property
+      return;
+    }
+
+    let additionalProperties: RJSFSchema = {};
+    if (typeof schema.additionalProperties !== 'boolean') {
+      if (REF_KEY in schema.additionalProperties!) {
+        additionalProperties = retrieveSchema<T>(
+          validator,
+          { $ref: get(schema.additionalProperties, [REF_KEY]) },
+          rootSchema,
+          formData as T
+        );
+      } else if ('type' in schema.additionalProperties!) {
+        additionalProperties = { ...schema.additionalProperties };
+      } else {
+        additionalProperties = { type: guessType(get(formData, [key])) };
+      }
+    } else {
+      additionalProperties = { type: guessType(get(formData, [key])) };
+    }
+
+    // The type of our new key should match the additionalProperties value;
+    schema.properties[key] = additionalProperties;
+    // Set our additional property flag so we know it was dynamically added
+    set(schema.properties, [key, ADDITIONAL_PROPERTY_FLAG], true);
+  });
+
+  return schema;
+}
+
 /** Retrieves an expanded schema that has had all of its conditions, additional properties, references and dependencies
  * resolved and merged into the `schema` given a `validator`, `rootSchema` and `rawFormData` that is used to do the
  * potentially recursive resolution.
@@ -119,7 +181,7 @@ export default function retrieveSchema<T = any>(
   }
   let resolvedSchema = resolveSchema<T>(validator, schema, rootSchema, rawFormData);
 
-  if (schema.hasOwnProperty('if')) {
+  if ('if' in schema) {
     return resolveCondition<T>(validator, schema, rootSchema, rawFormData as T);
   }
 
@@ -165,7 +227,7 @@ export default function retrieveSchema<T = any>(
     }
   }
   const hasAdditionalProperties =
-    resolvedSchema.hasOwnProperty(ADDITIONAL_PROPERTIES_KEY) &&
+    ADDITIONAL_PROPERTIES_KEY in resolvedSchema &&
     resolvedSchema.additionalProperties !== false;
   if (hasAdditionalProperties) {
     return stubExistingAdditionalProperties<T>(
@@ -309,7 +371,7 @@ export function withDependentSchema<T>(
   }
   // Resolve $refs inside oneOf.
   const resolvedOneOf = oneOf.map((subschema) => {
-    if (typeof subschema === 'boolean' || !subschema.hasOwnProperty(REF_KEY)) {
+    if (typeof subschema === 'boolean' || !(REF_KEY in subschema)) {
       return subschema;
     }
     return resolveReference<T>(validator, subschema as RJSFSchema, rootSchema, formData);

packages/utils/src/schema/stubExistingAdditionalProperties.ts

@@ -37,11 +37,11 @@ export default function toPathSchema<T = any>(
     $name: name.replace(/^\./, ''),
   } as PathSchema;
 
-  if (schema.hasOwnProperty(ADDITIONAL_PROPERTIES_KEY)) {
+  if (ADDITIONAL_PROPERTIES_KEY in schema) {
     set(pathSchema, '__rjsf_additionalProperties', true);
   }
 
-  if (schema.hasOwnProperty(ITEMS_KEY) && Array.isArray(formData)) {
+  if (ITEMS_KEY in schema && Array.isArray(formData)) {
     formData.forEach((element, i: number) => {
       pathSchema[i] = toPathSchema<T>(
         validator,
@@ -51,7 +51,7 @@ export default function toPathSchema<T = any>(
         element
       );
     });
-  } else if (schema.hasOwnProperty(PROPERTIES_KEY)) {
+  } else if (PROPERTIES_KEY in schema) {
     for (const property in schema.properties) {
       const field = get(schema, [PROPERTIES_KEY, property]);
       pathSchema[property] = toPathSchema<T>(

packages/utils/src/schema/toPathSchema.ts

@@ -5,7 +5,7 @@ export default function toConstant(schema: RJSFSchema) {
   if (Array.isArray(schema.enum) && schema.enum.length === 1) {
     return schema.enum[0];
   }
-  if (schema.hasOwnProperty(CONST_KEY)) {
+  if (CONST_KEY in schema) {
     return schema.const;
   }
   throw new Error('schema cannot be inferred as a constant');

packages/utils/src/toConstant.ts

@@ -308,7 +308,6 @@ export interface SchemaUtilsType<T = any> {
   isMultiSelect(schema: RJSFSchema): boolean;
   isSelect(schema: RJSFSchema): boolean;
   retrieveSchema(schema: RJSFSchema, formData: T): RJSFSchema;
-  stubExistingAdditionalProperties(schema: RJSFSchema, formData: T): RJSFSchema;
   toIdSchema(schema: RJSFSchema, id?: string, formData?: T, idPrefix?: string, idSeparator?: string): IdSchema<T>;
   toPathSchema(schema: RJSFSchema, name?: string, formData?: T): PathSchema<T>;
 }

packages/utils/src/types.ts

@@ -0,0 +1,24 @@
+import getTestValidator from './testUtils/getTestValidator';
+import {
+  getDefaultFormStateTest,
+  getDisplayLabelTest,
+  getMatchingOptionTest,
+  isFilesArrayTest,
+  isMultiSelectTest,
+  isSelectTest,
+  retrieveSchemaTest,
+  toIdSchemaTest,
+  toPathSchemaTest,
+} from './schema';
+
+const testValidator = getTestValidator({});
+
+getDefaultFormStateTest(testValidator);
+getDisplayLabelTest(testValidator);
+getMatchingOptionTest(testValidator);
+isFilesArrayTest(testValidator);
+isMultiSelectTest(testValidator);
+isSelectTest(testValidator);
+retrieveSchemaTest(testValidator);
+toIdSchemaTest(testValidator);
+toPathSchemaTest(testValidator);