Fix config schema tests (#1752)

jonathanKingston · web-flow · commit 77f59d6ac7b0 · 2025-06-18T12:17:23.000+01:00
* Conditional matching config validation

* Make a unit test to ensure the test configs are valid

* Make all test configs valid

* Fix lint errors

* Update config

* Fix windows path lookup
diff --git a/injected/integration-test/test-pages/api-manipulation/config/apis.json b/injected/integration-test/test-pages/api-manipulation/config/apis.json
@@ -1,8 +1,11 @@
 {
+    "readme": "This config is used to test the api manipulation feature.",
+    "version": 1,
     "unprotectedTemporary": [],
     "features": {
         "apiManipulation": {
             "state": "enabled",
+            "exceptions": [],
             "settings": {
                 "apiChanges": {
                     "Navigator.prototype.hardwareConcurrency": {
diff --git a/injected/integration-test/test-pages/autofill-password-import/config/config.json b/injected/integration-test/test-pages/autofill-password-import/config/config.json
@@ -1,4 +1,6 @@
 {
+  "readme": "This config is used to test the autofill password import feature.",
+  "version": 1,
   "features": {
     "autofillPasswordImport": {
       "state": "enabled",
diff --git a/injected/integration-test/test-pages/breakage-reporting/config/config.json b/injected/integration-test/test-pages/breakage-reporting/config/config.json
@@ -1,4 +1,6 @@
 {
+  "readme": "This config is used to test the breakage reporting feature.",
+  "version": 1,
   "unprotectedTemporary": [],
   "features": {
     "breakageReporting": {
diff --git a/injected/integration-test/test-pages/duckplayer-native/config/native.json b/injected/integration-test/test-pages/duckplayer-native/config/native.json
@@ -1,4 +1,6 @@
 {
+  "readme": "This config is used to test the duckplayer native feature.",
+  "version": 1,
   "unprotectedTemporary": [],
   "features": {
     "duckPlayerNative": {
diff --git a/injected/integration-test/test-pages/harmful-apis/config/apis.json b/injected/integration-test/test-pages/harmful-apis/config/apis.json
@@ -1,8 +1,11 @@
 {
+  "readme": "This config is used to test the harmful APIs feature.",
+  "version": 1,
   "unprotectedTemporary": [],
   "features": {
     "windowsPermissionUsage": {
-      "state": "disabled"
+      "state": "disabled",
+      "exceptions": []
     },
     "harmfulApis": {
       "state": "enabled",
diff --git a/injected/integration-test/test-pages/infra/config/conditional-matching-experiments.json b/injected/integration-test/test-pages/infra/config/conditional-matching-experiments.json
@@ -1,12 +1,20 @@
 {
+    "version": 1,
+    "readme": "This config is used to test the conditional matching of experiments using the API manipulation feature.",
     "features": {
       "contentScopeExperiments": {
         "exceptions": [],
         "state": "enabled",
         "features": {
           "bloops": {
             "state": "enabled",
-            "rollout": {},
+            "rollout": {
+              "steps": [
+                {
+                  "percent": 100
+                }
+              ]
+            },
             "cohorts": [
               {
                 "name": "control",
@@ -20,7 +28,13 @@
           },
           "test": {
             "state": "enabled",
-            "rollout": {},
+            "rollout": {
+              "steps": [
+                {
+                  "percent": 100
+                }
+              ]
+            },
             "cohorts": [
               {
                 "name": "control",
@@ -78,8 +92,9 @@
               ]
             }
           ]
-        }
-      },
-      "exceptions": []
-    }
+        },
+        "exceptions": []
+      }
+    },
+    "unprotectedTemporary": []
 }
diff --git a/injected/integration-test/test-pages/infra/config/conditional-matching.json b/injected/integration-test/test-pages/infra/config/conditional-matching.json
@@ -1,7 +1,10 @@
 {
+    "readme": "This config is used to test the conditional matching of experiments using the API manipulation feature.",
+    "version": 1,
     "features": {
         "apiManipulation": {
             "state": "enabled",
+            "exceptions": [],
             "settings": {
                 "apiChanges": {
                     "Navigator.prototype.hardwareConcurrency": {
diff --git a/injected/integration-test/test-pages/message-bridge/config/message-bridge-disabled.json b/injected/integration-test/test-pages/message-bridge/config/message-bridge-disabled.json
@@ -1,4 +1,6 @@
 {
+  "readme": "This config is used to test disabling the message bridge feature.",
+  "version": 1,
   "unprotectedTemporary": [],
   "features": {
     "favicon": {
diff --git a/injected/integration-test/test-pages/message-bridge/config/message-bridge-enabled.json b/injected/integration-test/test-pages/message-bridge/config/message-bridge-enabled.json
@@ -1,4 +1,6 @@
 {
+  "readme": "This config is used to test the message bridge feature.",
+  "version": 1,
   "unprotectedTemporary": [],
   "features": {
     "navigatorInterface": {
diff --git a/injected/integration-test/test-pages/permissions/config/permissions.json b/injected/integration-test/test-pages/permissions/config/permissions.json
@@ -1,4 +1,6 @@
 {
+  "readme": "This config is used to test the windows permissions feature.",
+  "version": 1,
   "unprotectedTemporary": [],
   "features": {
     "windowsPermissionUsage": {
diff --git a/injected/integration-test/test-pages/webcompat/config/message-handlers.json b/injected/integration-test/test-pages/webcompat/config/message-handlers.json
@@ -1,4 +1,6 @@
 {
+  "readme": "This config is used to test the webcompat message handlers feature.",
+  "version": 1,
   "unprotectedTemporary": [],
   "features": {
     "webCompat": {
diff --git a/injected/integration-test/test-pages/webcompat/config/modify-cookies.json b/injected/integration-test/test-pages/webcompat/config/modify-cookies.json
@@ -1,4 +1,6 @@
 {
+  "readme": "This config is used to test the modify cookies feature.",
+  "version": 1,
   "unprotectedTemporary": [],
   "features": {
     "webCompat": {
diff --git a/injected/integration-test/test-pages/webcompat/config/modify-localstorage.json b/injected/integration-test/test-pages/webcompat/config/modify-localstorage.json
@@ -1,4 +1,6 @@
 {
+  "readme": "This config is used to test the modify local storage feature.",
+  "version": 1,
   "unprotectedTemporary": [],
   "features": {
     "webCompat": {
diff --git a/injected/integration-test/test-pages/webcompat/config/shims.json b/injected/integration-test/test-pages/webcompat/config/shims.json
@@ -1,7 +1,11 @@
 {
+    "readme": "This config is used to test the webcompat shims.",
+    "version": 1,
+    "unprotectedTemporary": [],
     "features": {
         "webCompat": {
             "state": "enabled",
+            "exceptions": [],
             "settings": {
                 "mediaSession": "enabled",
                 "presentation": "enabled"
diff --git a/injected/package.json b/injected/package.json
@@ -32,7 +32,7 @@
   },
   "devDependencies": {
     "@canvas/image-data": "^1.0.0",
-    "@duckduckgo/privacy-configuration": "github:duckduckgo/privacy-configuration#b5c39e2b0592c044d609dfed624db31c3c5bca3b",
+    "@duckduckgo/privacy-configuration": "github:duckduckgo/privacy-configuration#2c569c49990bae4ac83578fc9eaef282489d7926",
     "@fingerprintjs/fingerprintjs": "^4.6.2",
     "@types/chrome": "^0.0.326",
     "@types/jasmine": "^5.1.8",
diff --git a/injected/unit-test/features.js b/injected/unit-test/features.js
@@ -1,4 +1,15 @@
 import { platformSupport } from '../src/features.js';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { readFile } from 'fs/promises';
+import * as glob from 'glob';
+import { formatErrors } from '@duckduckgo/privacy-configuration/tests/schema-validation.js';
+
+// TODO: Ignore eslint redeclare as we're linting for esm and cjs
+// eslint-disable-next-line no-redeclare
+const __filename = fileURLToPath(import.meta.url);
+// eslint-disable-next-line no-redeclare
+const __dirname = path.dirname(__filename);
 
 describe('Features definition', () => {
     it('calls `webCompat` before `fingerPrintingScreenSize` https://app.asana.com/0/1177771139624306/1204944717262422/f', () => {
@@ -23,3 +34,83 @@ describe('Features definition', () => {
         ]);
     });
 });
+
+describe('test-pages/*/config/*.json schema validation', () => {
+    let Ajv, schemaGenerator;
+    beforeAll(async () => {
+        Ajv = (await import('ajv')).default;
+        schemaGenerator = await import('ts-json-schema-generator');
+    });
+
+    // TODO make the config export all of this so it can be imported
+    function createGenerator() {
+        return schemaGenerator.createGenerator({
+            path: path.resolve(__dirname, '../../node_modules/@duckduckgo/privacy-configuration/schema/config.ts'),
+        });
+    }
+
+    function getSchema(schemaName) {
+        return createGenerator().createSchema(schemaName);
+    }
+
+    function createValidator(schemaName) {
+        const ajv = new Ajv({ allowUnionTypes: true });
+        return ajv.compile(getSchema(schemaName));
+    }
+
+    // Utility to ensure 'hash' exists on all features in the config
+    // Ideally we would not have these required in the config, it's pretty unnecessary for tests.
+    function ensureHashOnFeatures(config) {
+        if (config && typeof config === 'object' && config.features) {
+            for (const featureKey of Object.keys(config.features)) {
+                if (config.features[featureKey] && typeof config.features[featureKey] === 'object') {
+                    if (!('hash' in config.features[featureKey])) {
+                        config.features[featureKey].hash = '';
+                    }
+                }
+            }
+        }
+        return config;
+    }
+
+    const configFiles = glob
+        .sync('../integration-test/test-pages/*/config/*.json', { cwd: __dirname })
+        .map((p) => path.resolve(__dirname, p));
+
+    // Legacy allowlist: skip schema validation for these known legacy files
+    // Some of these have expected invalid configs
+    const legacyAllowlist = [
+        // Favicon configs
+        path.resolve(__dirname, '../integration-test/test-pages/favicon/config/favicon-disabled.json'),
+        path.resolve(__dirname, '../integration-test/test-pages/favicon/config/favicon-absent.json'),
+        path.resolve(__dirname, '../integration-test/test-pages/favicon/config/favicon-enabled.json'),
+        path.resolve(__dirname, '../integration-test/test-pages/favicon/config/favicon-monitor-disabled.json'),
+        // Duckplayer configs
+        path.resolve(__dirname, '../integration-test/test-pages/duckplayer/config/overlays-live.json'),
+        path.resolve(__dirname, '../integration-test/test-pages/duckplayer/config/click-interceptions-disabled.json'),
+        path.resolve(__dirname, '../integration-test/test-pages/duckplayer/config/disabled.json'),
+        path.resolve(__dirname, '../integration-test/test-pages/duckplayer/config/overlays-drawer.json'),
+        path.resolve(__dirname, '../integration-test/test-pages/duckplayer/config/overlays.json'),
+        path.resolve(__dirname, '../integration-test/test-pages/duckplayer/config/thumbnail-overlays-disabled.json'),
+        path.resolve(__dirname, '../integration-test/test-pages/duckplayer/config/video-alt-selectors.json'),
+        path.resolve(__dirname, '../integration-test/test-pages/duckplayer/config/video-overlays-disabled.json'),
+        // Message bridge configs
+        path.resolve(__dirname, '../integration-test/test-pages/message-bridge/config/message-bridge-enabled.json'),
+        path.resolve(__dirname, '../integration-test/test-pages/message-bridge/config/message-bridge-disabled.json'),
+    ];
+    for (const configPath of configFiles) {
+        if (legacyAllowlist.includes(configPath)) {
+            xit(`LEGACY: skipped schema validation for ${path.relative(process.cwd(), configPath)}`, () => {});
+            continue;
+        }
+        it(`should match the GenericV4Config schema: ${path.relative(process.cwd(), configPath)}`, async () => {
+            let config = JSON.parse(await readFile(configPath, 'utf-8'));
+            config = ensureHashOnFeatures(config);
+            const validate = createValidator('GenericV4Config');
+            const valid = validate(config);
+            if (!valid) {
+                throw new Error(`Schema validation failed for ${configPath}: ` + formatErrors(validate.errors));
+            }
+        });
+    }
+});
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`	`1`	`{`
	`2`	`+ "readme": "This config is used to test the autofill password import feature.",`
	`3`	`+ "version": 1,`
`2`	`4`	`"features": {`
`3`	`5`	`"autofillPasswordImport": {`
`4`	`6`	`"state": "enabled",`