JSON validation (#394)

* Set up JSON testing * Add schema validation * Use parseJson * Finish types * Disambiguate ext/json-schema from node dependency with the same name * Add support for specifying the jsconfig file * Don't expose types * Update types * Use dictionary map type * Fix types * Fix AJV warnings * Move types * Move anb rename file * Move common mocks * Simplify types
yomidevs · Dec 20, 2023 · 8b943cc · 8b943cc
1 parent b13fbd4
commit 8b943cc
Show file tree

Hide file tree

Showing 30 changed files with 842 additions and 235 deletions.
diff --git a/dev/data/manifest-variants.json b/dev/data/manifest-variants.json
@@ -311,7 +311,6 @@
         },
         {
             "name": "safari",
-            "fileName": null,
             "modifications": [
                 {
                     "action": "remove",

diff --git a/dev/jsconfig.json b/dev/jsconfig.json
@@ -29,7 +29,7 @@
             "error": ["../types/ext/error"],
             "event-listener-collection": ["../types/ext/event-listener-collection"],
             "japanese-util": ["../types/ext/japanese-util"],
-            "json-schema": ["../types/ext/json-schema"],
+            "ext/json-schema": ["../types/ext/json-schema"],
             "log": ["../types/ext/log"],
             "settings": ["../types/ext/settings"],
             "structured-content": ["../types/ext/structured-content"],

diff --git a/dev/manifest-util.js b/dev/manifest-util.js
@@ -121,7 +121,7 @@ export class ManifestUtil {
 
     /**
      * @param {import('dev/manifest').Manifest} manifest
-     * @param {import('dev/manifest').Modification[]} modifications
+     * @param {import('dev/manifest').Modification[]|undefined} modifications
      * @returns {import('dev/manifest').Manifest}
      */
     _applyModifications(manifest, modifications) {

diff --git a/dev/schema-validate.js b/dev/schema-validate.js
@@ -62,6 +62,6 @@ class JsonSchemaAjv {
 export function createJsonSchema(mode, schema) {
     switch (mode) {
         case 'ajv': return new JsonSchemaAjv(schema);
-        default: return new JsonSchema(/** @type {import('json-schema').Schema} */ (schema));
+        default: return new JsonSchema(/** @type {import('ext/json-schema').Schema} */ (schema));
     }
 }
diff --git a/dev/util.js b/dev/util.js
@@ -72,7 +72,7 @@ export function getArgs(args, argMap) {
 
 /**
  * @param {string} baseDirectory
- * @param {?(fileName: string) => boolean} predicate
+ * @param {?(fileName: string, isDirectory: boolean) => boolean} predicate
  * @returns {string[]}
  */
 export function getAllFiles(baseDirectory, predicate = null) {
@@ -86,11 +86,13 @@ export function getAllFiles(baseDirectory, predicate = null) {
             const relativeFileName = path.relative(baseDirectory, fullFileName);
             const stats = fs.lstatSync(fullFileName);
             if (stats.isFile()) {
-                if (typeof predicate !== 'function' || predicate(relativeFileName)) {
+                if (typeof predicate !== 'function' || predicate(relativeFileName, false)) {
                     results.push(relativeFileName);
                 }
             } else if (stats.isDirectory()) {
-                directories.push(fullFileName);
+                if (typeof predicate !== 'function' || predicate(relativeFileName, true)) {
+                    directories.push(fullFileName);
+                }
             }
         }
     }

diff --git a/ext/js/background/profile-conditions-util.js b/ext/js/background/profile-conditions-util.js
@@ -158,7 +158,7 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaPopupLevelEqual(value) {
         const number = this._stringToNumber(value);
@@ -172,7 +172,7 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaPopupLevelNotEqual(value) {
         return {
@@ -184,7 +184,7 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaPopupLevelLessThan(value) {
         const number = this._stringToNumber(value);
@@ -198,7 +198,7 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaPopupLevelGreaterThan(value) {
         const number = this._stringToNumber(value);
@@ -212,7 +212,7 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaPopupLevelLessThanOrEqual(value) {
         const number = this._stringToNumber(value);
@@ -226,7 +226,7 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaPopupLevelGreaterThanOrEqual(value) {
         const number = this._stringToNumber(value);
@@ -242,7 +242,7 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaUrlMatchDomain(value) {
         const oneOf = [];
@@ -261,7 +261,7 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaUrlMatchRegExp(value) {
         return {
@@ -276,15 +276,15 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaModifierKeysAre(value) {
         return this._createSchemaArrayCheck('modifierKeys', value, true, false);
     }
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaModifierKeysAreNot(value) {
         return {
@@ -296,15 +296,15 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaModifierKeysInclude(value) {
         return this._createSchemaArrayCheck('modifierKeys', value, false, false);
     }
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaModifierKeysNotInclude(value) {
         return this._createSchemaArrayCheck('modifierKeys', value, false, true);
@@ -314,15 +314,15 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaFlagsAre(value) {
         return this._createSchemaArrayCheck('flags', value, true, false);
     }
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaFlagsAreNot(value) {
         return {
@@ -334,15 +334,15 @@ export class ProfileConditionsUtil {
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaFlagsInclude(value) {
         return this._createSchemaArrayCheck('flags', value, false, false);
     }
 
     /**
      * @param {string} value
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaFlagsNotInclude(value) {
         return this._createSchemaArrayCheck('flags', value, false, true);
@@ -355,10 +355,10 @@ export class ProfileConditionsUtil {
      * @param {string} value
      * @param {boolean} exact
      * @param {boolean} none
-     * @returns {import('json-schema').Schema}
+     * @returns {import('ext/json-schema').Schema}
      */
     _createSchemaArrayCheck(key, value, exact, none) {
-        /** @type {import('json-schema').Schema[]} */
+        /** @type {import('ext/json-schema').Schema[]} */
         const containsList = [];
         for (const item of this._split(value)) {
             if (item.length === 0) { continue; }
@@ -369,7 +369,7 @@ export class ProfileConditionsUtil {
             });
         }
         const containsListCount = containsList.length;
-        /** @type {import('json-schema').Schema} */
+        /** @type {import('ext/json-schema').Schema} */
         const schema = {
             type: 'array'
         };