feat(apidom-ls): single ajv instance

Author: frantuma

packages/apidom-ls/src/services/validation/providers/ajv-utils.ts

@@ -0,0 +1,54 @@
+import Ajv2020, * as Ajv2020Ns from 'ajv/dist/2020';
+import Ajv, * as AjvNs from 'ajv';
+import * as draft7MetaSchema from 'ajv/dist/refs/json-schema-draft-07.json';
+import AjvErrors from 'ajv-errors';
+import addFormats from 'ajv-formats';
+
+import openapiSchemaJson31Ajv from '../json-schema/open-api-31/openapi-schema-31-ajv.json';
+import openapiSchemaJson31Meta from '../json-schema/open-api-31/openapi-schema-31-meta.json';
+import openapiSchemaJson31Dialect from '../json-schema/open-api-31/openapi-schema-31-dialect.json';
+
+let ajvInstance: Ajv;
+let ajv2020Instance: Ajv2020;
+
+export function ajv(ajv2020: boolean): Ajv2020 | Ajv {
+  if (!ajv2020Instance && ajv2020) {
+    ajv2020Instance = new Ajv2020({
+      strict: false,
+      allErrors: true,
+      schemas: [openapiSchemaJson31Ajv, openapiSchemaJson31Meta, openapiSchemaJson31Dialect],
+    });
+    ajv2020Instance.addMetaSchema(draft7MetaSchema);
+    addFormats(ajv2020Instance);
+    ajv2020Instance.addFormat('media-range', true);
+
+    AjvErrors(ajv2020Instance);
+  } else if (!ajvInstance && !ajv2020) {
+    ajvInstance = new Ajv({
+      strict: false,
+      meta: true,
+      allErrors: true,
+      validateFormats: false,
+      unicodeRegExp: false,
+    });
+    AjvErrors(ajvInstance);
+  }
+
+  if (ajv2020) {
+    return ajv2020Instance;
+  }
+  return ajvInstance;
+}
+
+export function compileAjv(
+  jsonSchema: Record<string, unknown>,
+  ajv2020: boolean,
+): Ajv2020Ns.ValidateFunction | AjvNs.ValidateFunction {
+  if (!ajv2020Instance && ajv2020) {
+    ajv(ajv2020);
+  } else if (!ajvInstance && !ajv2020) {
+    ajv(ajv2020);
+  }
+  const ajvInst = ajv2020 ? ajv2020Instance : ajvInstance;
+  return ajvInst.compile(jsonSchema);
+}

packages/apidom-ls/src/services/validation/providers/asyncapi-20-json-schema-validation-provider.ts

@@ -4,17 +4,7 @@ import { JsonSchemaValidationProvider } from './json-schema-validation-provider'
 // eslint-disable-next-line import/prefer-default-export
 export class Asyncapi20JsonSchemaValidationProvider extends JsonSchemaValidationProvider {
   public constructor() {
-    super(
-      false,
-      {
-        strict: false,
-        meta: true,
-        allErrors: true,
-        validateFormats: false,
-        unicodeRegExp: false,
-      },
-      asyncapiSchemaJson,
-    );
+    super(false, asyncapiSchemaJson);
   }
 
   // eslint-disable-next-line class-methods-use-this

packages/apidom-ls/src/services/validation/providers/json-schema-validation-provider.ts

@@ -1,7 +1,5 @@
-import Ajv2020, * as Ajv2020Ns from 'ajv/dist/2020';
-import Ajv, * as AjvNs from 'ajv';
-import AjvErrors from 'ajv-errors';
-import addFormats from 'ajv-formats';
+import Ajv2020 from 'ajv/dist/2020';
+import Ajv from 'ajv';
 import { Diagnostic, DiagnosticSeverity, Range, Position } from 'vscode-languageserver-types';
 import jsonSourceMap from 'json-source-map';
 import { TextDocument } from 'vscode-languageserver-textdocument';
@@ -14,6 +12,7 @@ import {
   ValidationProvider,
 } from '../../../apidom-language-types';
 import { isJsonDoc } from '../../../parser-factory';
+import * as AjvUtils from './ajv-utils';
 
 // eslint-disable-next-line import/prefer-default-export
 export abstract class JsonSchemaValidationProvider implements ValidationProvider {
@@ -23,14 +22,13 @@ export abstract class JsonSchemaValidationProvider implements ValidationProvider
 
   private jsonSchema: Record<string, unknown>;
 
-  protected constructor(
-    ajv2020: boolean,
-    ajvOpts: Ajv2020Ns.Options | AjvNs.Options,
-    jsonSchema: Record<string, unknown>,
-  ) {
+  protected ajv2020: boolean;
+
+  protected constructor(ajv2020: boolean, jsonSchema: Record<string, unknown>) {
     this.validationEnabled = true;
-    this.ajv = JsonSchemaValidationProvider.setupAjv(ajvOpts, ajv2020);
     this.jsonSchema = jsonSchema;
+    this.ajv2020 = ajv2020;
+    this.ajv = AjvUtils.ajv(ajv2020);
   }
 
   public doValidation(
@@ -71,7 +69,7 @@ export abstract class JsonSchemaValidationProvider implements ValidationProvider
     if (!this.validationEnabled) {
       return;
     }
-    const validateFunction = JsonSchemaValidationProvider.compileAjv(this.ajv, this.jsonSchema);
+    const validateFunction = AjvUtils.compileAjv(this.jsonSchema, this.ajv2020);
     const jsonDoc = JSON.parse(jsonDocument);
     const valid = validateFunction(jsonDoc);
     if (!valid) {
@@ -136,29 +134,6 @@ export abstract class JsonSchemaValidationProvider implements ValidationProvider
     }
   }
 
-  protected static setupAjv(
-    ajvOpts: Ajv2020Ns.Options | AjvNs.Options,
-    ajv2020: boolean,
-  ): Ajv2020 | Ajv {
-    let ajv: Ajv2020 | Ajv;
-    if (ajv2020) {
-      ajv = new Ajv2020(ajvOpts);
-      addFormats(ajv);
-      ajv.addFormat('media-range', true);
-    } else {
-      ajv = new Ajv(ajvOpts);
-    }
-    AjvErrors(ajv);
-    return ajv;
-  }
-
-  protected static compileAjv(
-    ajv: Ajv2020 | Ajv,
-    jsonSchema: Record<string, unknown>,
-  ): Ajv2020Ns.ValidateFunction | AjvNs.ValidateFunction {
-    return ajv.compile(jsonSchema);
-  }
-
   abstract break(): boolean;
 
   abstract namespaces(): string[];

packages/apidom-ls/src/services/validation/providers/openapi-31-json-schema-validation-provider.ts

@@ -1,5 +1,3 @@
-import openapiSchemaJson31Meta from '../json-schema/open-api-31/openapi-schema-31-meta.json';
-import openapiSchemaJson31Dialect from '../json-schema/open-api-31/openapi-schema-31-dialect.json';
 import openapiSchemaJson31Ajv from '../json-schema/open-api-31/openapi-schema-31-ajv.json';
 import { JsonSchemaValidationProvider } from './json-schema-validation-provider';
 
@@ -8,27 +6,9 @@ export class OpenAPi31JsonSchemaValidationProvider extends JsonSchemaValidationP
   public constructor(jsonSchema?: Record<string, unknown>, ajv2020 = false) {
     // default to OAI provided 3.1 schema
     if (!jsonSchema) {
-      super(
-        true,
-        {
-          strict: false,
-          allErrors: true,
-          schemas: [openapiSchemaJson31Ajv, openapiSchemaJson31Meta, openapiSchemaJson31Dialect],
-        },
-        openapiSchemaJson31Ajv,
-      );
+      super(true, openapiSchemaJson31Ajv);
     } else {
-      super(
-        ajv2020,
-        {
-          strict: false,
-          meta: true,
-          allErrors: true,
-          validateFormats: false,
-          unicodeRegExp: false,
-        },
-        jsonSchema,
-      );
+      super(ajv2020, jsonSchema);
     }
   }