Cache schemas by explicit ID in AJV8Validator.isValid

CHANGELOG.md

@@ -15,6 +15,11 @@ it according to semantic versioning. For example, if your PR adds a breaking cha
 should change the heading of the (upcoming) version to include a major version bump.
 
 -->
+# 5.8.2
+
+## @rjsf/validator-ajv8
+
+- Explicitly cache schemas by their hash when checking data is valid to avoid multiple compilations for schemas without IDs leading to poor performance [#3721](https://github.com/rjsf-team/react-jsonschema-form/pull/3721)
 
 # 5.8.1
 

packages/validator-ajv8/src/validator.ts

@@ -13,6 +13,7 @@ import {
   ValidationData,
   ValidatorType,
   withIdRefPrefix,
+  hashForSchema,
 } from '@rjsf/utils';
 
 import { CustomValidatorOptionsType, Localizer } from './types';
@@ -137,12 +138,16 @@ export default class AJV8Validator<T = any, S extends StrictRJSFSchema = RJSFSch
         this.ajv.addSchema(rootSchema, rootSchemaId);
       }
       const schemaWithIdRefPrefix = withIdRefPrefix<S>(schema) as S;
+      const schemaId = schemaWithIdRefPrefix[ID_KEY] ?? hashForSchema(schemaWithIdRefPrefix);
       let compiledValidator: ValidateFunction | undefined;
-      if (schemaWithIdRefPrefix[ID_KEY]) {
-        compiledValidator = this.ajv.getSchema(schemaWithIdRefPrefix[ID_KEY]);
-      }
+      compiledValidator = this.ajv.getSchema(schemaId);
       if (compiledValidator === undefined) {
-        compiledValidator = this.ajv.compile(schemaWithIdRefPrefix);
+        // Add schema by an explicit ID so it can be fetched later
+        // Fall back to using compile if necessary
+        // https://ajv.js.org/guide/managing-schemas.html#pre-adding-all-schemas-vs-adding-on-demand
+        compiledValidator =
+          this.ajv.addSchema(schemaWithIdRefPrefix, schemaId).getSchema(schemaId) ||
+          this.ajv.compile(schemaWithIdRefPrefix);
       }
       const result = compiledValidator(formData);
       return result as boolean;

packages/validator-ajv8/test/validator.test.ts

@@ -93,13 +93,58 @@ describe('AJV8Validator', () => {
         };
 
         // @ts-expect-error - accessing private Ajv instance to verify compilation happens once
-        const compileSpy = jest.spyOn(validator.ajv, 'compile');
+        const addSchemaSpy = jest.spyOn(validator.ajv, 'addSchema');
+        addSchemaSpy.mockClear();
+
+        // Call isValid twice with the same schema
+        validator.isValid(schema, formData, rootSchema);
+        validator.isValid(schema, formData, rootSchema);
+
+        // Root schema is added twice
+        expect(addSchemaSpy).toHaveBeenCalledTimes(3);
+        expect(addSchemaSpy).toHaveBeenNthCalledWith(1, expect.objectContaining(rootSchema), rootSchema.$id);
+        expect(addSchemaSpy).toHaveBeenNthCalledWith(2, expect.objectContaining(schema), schema.$id);
+        expect(addSchemaSpy).toHaveBeenLastCalledWith(expect.objectContaining(rootSchema), rootSchema.$id);
+      });
+      it('should fallback to using compile', () => {
+        const schema: RJSFSchema = {
+          $id: 'schema-id-2',
+        };
+
+        const rootSchema: RJSFSchema = {
+          $id: 'root-schema-id',
+          type: 'object',
+          properties: {
+            name: {
+              type: 'string',
+            },
+          },
+        };
+        const formData = {
+          name: 'John Doe',
+        };
+
+        // @ts-expect-error - accessing private Ajv instance to verify compilation happens once
+        const ajvInstance = validator.ajv;
+        const originalGetSchema = ajvInstance.getSchema.bind(ajvInstance);
+        const getSchemaSpy = jest.spyOn(ajvInstance, 'getSchema');
+        getSchemaSpy.mockClear();
+        getSchemaSpy.mockImplementation((schemaId) => {
+          if (schemaId === schema.$id) {
+            return undefined;
+          }
+
+          return originalGetSchema(schemaId);
+        });
+
+        const compileSpy = jest.spyOn(ajvInstance, 'compile');
         compileSpy.mockClear();
 
         // Call isValid twice with the same schema
         validator.isValid(schema, formData, rootSchema);
         validator.isValid(schema, formData, rootSchema);
 
+        getSchemaSpy.mockRestore();
         expect(compileSpy).toHaveBeenCalledTimes(1);
       });
     });
@@ -546,14 +591,18 @@ describe('AJV8Validator', () => {
         };
 
         // @ts-expect-error - accessing private Ajv instance to verify compilation happens once
-        const compileSpy = jest.spyOn(validator.ajv, 'compile');
-        compileSpy.mockClear();
+        const addSchemaSpy = jest.spyOn(validator.ajv, 'addSchema');
+        addSchemaSpy.mockClear();
 
         // Call isValid twice with the same schema
         validator.isValid(schema, formData, rootSchema);
         validator.isValid(schema, formData, rootSchema);
 
-        expect(compileSpy).toHaveBeenCalledTimes(1);
+        // Root schema is added twice
+        expect(addSchemaSpy).toHaveBeenCalledTimes(3);
+        expect(addSchemaSpy).toHaveBeenNthCalledWith(1, expect.objectContaining(rootSchema), rootSchema.$id);
+        expect(addSchemaSpy).toHaveBeenNthCalledWith(2, expect.objectContaining(schema), schema.$id);
+        expect(addSchemaSpy).toHaveBeenLastCalledWith(expect.objectContaining(rootSchema), rootSchema.$id);
       });
     });
     describe('validator.toErrorList()', () => {
@@ -1000,14 +1049,18 @@ describe('AJV8Validator', () => {
         };
 
         // @ts-expect-error - accessing private Ajv instance to verify compilation happens once
-        const compileSpy = jest.spyOn(validator.ajv, 'compile');
-        compileSpy.mockClear();
+        const addSchemaSpy = jest.spyOn(validator.ajv, 'addSchema');
+        addSchemaSpy.mockClear();
 
         // Call isValid twice with the same schema
         validator.isValid(schema, formData, rootSchema);
         validator.isValid(schema, formData, rootSchema);
 
-        expect(compileSpy).toHaveBeenCalledTimes(1);
+        // Root schema is added twice
+        expect(addSchemaSpy).toHaveBeenCalledTimes(3);
+        expect(addSchemaSpy).toHaveBeenNthCalledWith(1, expect.objectContaining(rootSchema), rootSchema.$id);
+        expect(addSchemaSpy).toHaveBeenNthCalledWith(2, expect.objectContaining(schema), schema.$id);
+        expect(addSchemaSpy).toHaveBeenLastCalledWith(expect.objectContaining(rootSchema), rootSchema.$id);
       });
     });
     describe('validator.toErrorList()', () => {