Add normalized hash-based test IDs to draft2020-12/enum.json (POC for #698)

package.json

@@ -1,12 +1,21 @@
 {
   "name": "json-schema-test-suite",
   "version": "0.1.0",
+  "type": "module",
   "description": "A language agnostic test suite for the JSON Schema specifications",
   "repository": "github:json-schema-org/JSON-Schema-Test-Suite",
   "keywords": [
     "json-schema",
     "tests"
   ],
   "author": "http://json-schema.org",
-  "license": "MIT"
+  "license": "MIT",
+  "dependencies": {
+    "@hyperjump/browser": "^1.3.1",
+    "@hyperjump/json-pointer": "^1.1.1",
+    "@hyperjump/json-schema": "^1.17.2",
+    "@hyperjump/pact": "^1.4.0",
+    "@hyperjump/uri": "^1.3.2",
+    "json-stringify-deterministic": "^1.0.12"
+  }
 }

scripts/add-test-ids.js

@@ -0,0 +1,74 @@
+import * as fs from "node:fs";
+import * as crypto from "node:crypto";
+import jsonStringify from "json-stringify-deterministic";
+import { normalize } from "./normalize.js";
+import { loadRemotes } from "./load-remotes.js";
+
+const DIALECT_MAP = {
+  "https://json-schema.org/draft/2020-12/schema": "https://json-schema.org/draft/2020-12/schema",
+  "https://json-schema.org/draft/2019-09/schema": "https://json-schema.org/draft/2019-09/schema",
+  "http://json-schema.org/draft-07/schema#": "http://json-schema.org/draft-07/schema#",
+  "http://json-schema.org/draft-06/schema#": "http://json-schema.org/draft-06/schema#",
+  "http://json-schema.org/draft-04/schema#": "http://json-schema.org/draft-04/schema#"
+};
+
+function getDialectUri(schema) {
+  if (schema.$schema && DIALECT_MAP[schema.$schema]) {
+    return DIALECT_MAP[schema.$schema];
+  }
+  return "https://json-schema.org/draft/2020-12/schema";
+}
+
+function generateTestId(normalizedSchema, testData, testValid) {
+  return crypto
+    .createHash("md5")
+    .update(jsonStringify(normalizedSchema) + jsonStringify(testData) + testValid)
+    .digest("hex");
+}
+
+async function addIdsToFile(filePath) {
+  console.log("Reading:", filePath);
+  const tests = JSON.parse(fs.readFileSync(filePath, "utf8"));
+  let changed = false;
+  let added = 0;
+
+  if (!Array.isArray(tests)) {
+    console.log("Expected an array at top level, got:", typeof tests);
+    return;
+  }
+
+  for (const testCase of tests) {
+    if (!Array.isArray(testCase.tests)) continue;
+
+    const dialectUri = getDialectUri(testCase.schema || {});
+    const normalizedSchema = await normalize(testCase.schema || true, dialectUri);
+
+    for (const test of testCase.tests) {
+      if (!test.id) {
+        test.id = generateTestId(normalizedSchema, test.data, test.valid);
+        changed = true;
+        added++;
+      }
+    }
+  }
+
+  if (changed) {
+    fs.writeFileSync(filePath, JSON.stringify(tests, null, 2) + "\n");
+    console.log(`✓ Added ${added} IDs`);
+  } else {
+    console.log("✓ All tests already have IDs");
+  }
+}
+
+// Load remotes for all dialects
+const remotesPaths = ["./remotes"];
+for (const dialectUri of Object.values(DIALECT_MAP)) {
+  for (const path of remotesPaths) {
+    if (fs.existsSync(path)) {
+      loadRemotes(dialectUri, path);
+    }
+  }
+}
+
+const filePath = process.argv[2] || "tests/draft2020-12/enum.json";
+addIdsToFile(filePath).catch(console.error);

scripts/check-test-ids.js

@@ -0,0 +1,143 @@
+import * as fs from "node:fs";
+import * as path from "node:path";
+import * as crypto from "node:crypto";
+import jsonStringify from "json-stringify-deterministic";
+import { normalize } from "./normalize.js";
+import { loadRemotes } from "./load-remotes.js";
+
+const DIALECT_MAP = {
+  "https://json-schema.org/draft/2020-12/schema": "https://json-schema.org/draft/2020-12/schema",
+  "https://json-schema.org/draft/2019-09/schema": "https://json-schema.org/draft/2019-09/schema",
+  "http://json-schema.org/draft-07/schema#": "http://json-schema.org/draft-07/schema#",
+  "http://json-schema.org/draft-06/schema#": "http://json-schema.org/draft-06/schema#",
+  "http://json-schema.org/draft-04/schema#": "http://json-schema.org/draft-04/schema#"
+};
+
+function* jsonFiles(dir) {
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    const full = path.join(dir, entry.name);
+    if (entry.isDirectory()) {
+      yield* jsonFiles(full);
+    } else if (entry.isFile() && entry.name.endsWith(".json")) {
+      yield full;
+    }
+  }
+}
+
+function getDialectUri(schema) {
+  if (schema.$schema && DIALECT_MAP[schema.$schema]) {
+    return DIALECT_MAP[schema.$schema];
+  }
+  return "https://json-schema.org/draft/2020-12/schema";
+}
+
+function generateTestId(normalizedSchema, testData, testValid) {
+  return crypto
+    .createHash("md5")
+    .update(jsonStringify(normalizedSchema) + jsonStringify(testData) + testValid)
+    .digest("hex");
+}
+
+async function checkVersion(dir) {
+  const missingIdFiles = new Set();
+  const duplicateIdFiles = new Set();
+  const mismatchedIdFiles = new Set();
+  const idMap = new Map();
+
+  console.log(`Checking tests in ${dir}...`);
+
+  for (const file of jsonFiles(dir)) {
+    const tests = JSON.parse(fs.readFileSync(file, "utf8"));
+
+    for (let i = 0; i < tests.length; i++) {
+      const testCase = tests[i];
+      if (!Array.isArray(testCase.tests)) continue;
+
+      const dialectUri = getDialectUri(testCase.schema || {});
+      const normalizedSchema = await normalize(testCase.schema || true, dialectUri);
+
+      for (let j = 0; j < testCase.tests.length; j++) {
+        const test = testCase.tests[j];
+
+        if (!test.id) {
+          missingIdFiles.add(file);
+          console.log(`  ✗ Missing ID: ${file} | ${testCase.description} | ${test.description}`);
+          continue;
+        }
+
+        const expectedId = generateTestId(normalizedSchema, test.data, test.valid);
+
+        if (test.id !== expectedId) {
+          mismatchedIdFiles.add(file);
+          console.log(`  ✗ Mismatched ID: ${file}`);
+          console.log(`    Test: ${testCase.description} | ${test.description}`);
+          console.log(`    Current ID:  ${test.id}`);
+          console.log(`    Expected ID: ${expectedId}`);
+        }
+
+        if (idMap.has(test.id)) {
+          const existing = idMap.get(test.id);
+          duplicateIdFiles.add(file);
+          duplicateIdFiles.add(existing.file);
+          console.log(`  ✗ Duplicate ID: ${test.id}`);
+          console.log(`    First:  ${existing.file} | ${existing.testCase} | ${existing.test}`);
+          console.log(`    Second: ${file} | ${testCase.description} | ${test.description}`);
+        } else {
+          idMap.set(test.id, {
+            file,
+            testCase: testCase.description,
+            test: test.description
+          });
+        }
+      }
+    }
+  }
+
+  console.log("\n" + "=".repeat(60));
+  console.log("Summary:");
+  console.log("=".repeat(60));
+
+  console.log("\nFiles with missing IDs:");
+  if (missingIdFiles.size === 0) {
+    console.log("  ✓ None");
+  } else {
+    for (const f of missingIdFiles) console.log(`  - ${f}`);
+  }
+
+  console.log("\nFiles with mismatched IDs:");
+  if (mismatchedIdFiles.size === 0) {
+    console.log("  ✓ None");
+  } else {
+    for (const f of mismatchedIdFiles) console.log(`  - ${f}`);
+  }
+
+  console.log("\nFiles with duplicate IDs:");
+  if (duplicateIdFiles.size === 0) {
+    console.log("  ✓ None");
+  } else {
+    for (const f of duplicateIdFiles) console.log(`  - ${f}`);
+  }
+
+  const hasErrors = missingIdFiles.size > 0 || mismatchedIdFiles.size > 0 || duplicateIdFiles.size > 0;
+
+  console.log("\n" + "=".repeat(60));
+  if (hasErrors) {
+    console.log("❌ Check failed - issues found");
+    process.exit(1);
+  } else {
+    console.log("✅ All checks passed!");
+  }
+}
+
+// Load remotes
+const remotesPaths = ["./remotes"];
+for (const dialectUri of Object.values(DIALECT_MAP)) {
+  for (const path of remotesPaths) {
+    if (fs.existsSync(path)) {
+      loadRemotes(dialectUri, path);
+    }
+  }
+}
+
+const dir = process.argv[2] || "tests/draft2020-12";
+checkVersion(dir).catch(console.error);

scripts/load-remotes.js

@@ -0,0 +1,36 @@
+// scripts/load-remotes.js
+import * as fs from "node:fs";
+import { toAbsoluteIri } from "@hyperjump/uri";
+import { registerSchema } from "@hyperjump/json-schema/draft-2020-12";
+
+// Keep track of which remote URLs we've already registered
+const loadedRemotes = new Set();
+
+export const loadRemotes = (dialectId, filePath, url = "") => {
+  if (!fs.existsSync(filePath)) {
+    console.warn(`Warning: Remotes path not found: ${filePath}`);
+    return;
+  }
+
+  fs.readdirSync(filePath, { withFileTypes: true }).forEach((entry) => {
+    if (entry.isFile() && entry.name.endsWith(".json")) {
+      const remotePath = `${filePath}/${entry.name}`;
+      const remoteUrl = `http://localhost:1234${url}/${entry.name}`;
+
+      //  If we've already registered this URL once, skip it
+      if (loadedRemotes.has(remoteUrl)) {
+        return;
+      }
+
+      const remote = JSON.parse(fs.readFileSync(remotePath, "utf8"));
+
+      // Only register if $schema matches dialect OR there's no $schema
+      if (!remote.$schema || toAbsoluteIri(remote.$schema) === dialectId) {
+        registerSchema(remote, remoteUrl, dialectId);
+        loadedRemotes.add(remoteUrl); // ✅ Remember we've registered it
+      }
+    } else if (entry.isDirectory()) {
+      loadRemotes(dialectId, `${filePath}/${entry.name}`, `${url}/${entry.name}`);
+    }
+  });
+};