Merge pull request #710 from protofire/improve-ajv-schema-validation

improve ajv-schema validation

Author: dbale-altoros

lib/rules/base-checker.js

@@ -13,12 +13,9 @@ class BaseChecker {
     if (!reporter) return
 
     const userConfig = reporter.config[ruleId]
-
     if (userConfig === undefined) return
 
-    // build schema in memory to use better errors
-    // can be skipped if the rule has no options
-    // can be disabled when solhint rules are compatible with ajv-errors
+    // build schema related to userConfig and meta.schema
     const buildSchema = () => {
       const base = {
         type: 'object',
@@ -38,58 +35,46 @@ class BaseChecker {
           properties: {
             value: {
               ...meta.schema,
-              errorMessage: meta.schema.description,
+              errorMessage: meta.schema.description, // used by ajv-errors
             },
           },
           required: ['value'],
           additionalProperties: false,
         }
       }
+
       return base
     }
 
-    // console.log('userConfig :>> ', userConfig, ' - ', ruleId, ' - ', userConfig.length)
-
     const data =
       Array.isArray(userConfig) && userConfig.length > 1
         ? { severity: userConfig[0], options: { value: userConfig[1] } }
         : { severity: userConfig }
 
-    // console.log('data :>> ', data)
-
+    // build schema and cache by the actual content of the schema
     const schema = buildSchema()
+    const schemaKey = ruleId + '//' + JSON.stringify(schema)
 
-    // console.log('schema :>> ', schema)
+    if (!BaseChecker.validators.has(schemaKey)) {
+      const validate = BaseChecker.ajv.compile(schema)
+      BaseChecker.validators.set(schemaKey, validate)
+    }
 
-    const ajv = new Ajv({ allErrors: true, jsonPointers: true })
-    ajvErrors(ajv) // activate ajv-errors
-    const validate = ajv.compile(schema)
+    const validate = BaseChecker.validators.get(schemaKey)
 
     if (!validate(data)) {
       this.enabled = false
       let message = ''
       try {
         message =
-          betterAjvErrors(schema, data, validate.errors, {
+          betterAjvErrors(validate.schema, data, validate.errors, {
             format: 'cli',
             indent: 2,
             json: JSON.stringify(data, null, 2),
           }) || ''
       } catch (_) {
-        //
+        // noop
       }
-      // if (!message.trim()) {
-      //   message = validate.errors
-      //     .map((e) => {
-      //       const dp = e.instancePath || ''
-      //       let human
-      //       if (dp === '/severity') human = 'severity'
-      //       else if (dp.startsWith('/options/value')) human = 'options.value'
-      //       else human = dp.slice(1) || 'config'
-      //       return `→ ${human}: ${e.message}`
-      //     })
-      //     .join('\n')
-      // }
       console.warn(
         chalk.yellow(`[solhint] Warning: invalid configuration for rule '${ruleId}':\n${message}`)
       )
@@ -114,4 +99,8 @@ class BaseChecker {
   }
 }
 
+BaseChecker.ajv = new Ajv({ allErrors: true, jsonPointers: true })
+ajvErrors(BaseChecker.ajv) // <- kee support of errorMessage
+BaseChecker.validators = new Map()
+
 module.exports = BaseChecker