tools: generate node_config_schema.h from the json source

Signed-off-by: Mert Can Altin <[email protected]>

Author: mertcanaltin

.github/workflows/linters.yml

@@ -283,3 +283,21 @@ jobs:
       - run: tools/lint-readme-lists.mjs "$TEAMS"
         env:
           TEAMS: ${{ tojson(steps.team_members.outputs) }}
+  check-config-schema-sync:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-slim
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+        with:
+          persist-credentials: false
+          sparse-checkout: |
+            /doc/node-config-schema.json
+            /src/node_config_schema.h
+            /tools/gen_node_config_schema.mjs
+          sparse-checkout-cone-mode: false
+      - name: Use Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e  # v6.4.0
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: Verify src/node_config_schema.h matches doc/node-config-schema.json
+        run: node tools/gen_node_config_schema.mjs --check

doc/node-config-schema.json

@@ -1,5 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment": "Edit this file. src/node_config_schema.h is regenerated from it by tools/gen_node_config_schema.mjs and verified in CI. additionalProperties:false is stripped from the runtime copy so older Node versions tolerate fields added later.",
   "additionalProperties": false,
   "required": [],
   "properties": {

src/node_config_schema.h

@@ -1,9 +1,13 @@
 #ifndef SRC_NODE_CONFIG_SCHEMA_H_
 #define SRC_NODE_CONFIG_SCHEMA_H_
 
-static constexpr const char kNodeConfigSchema[] = R"JSON(
+// AUTO-GENERATED by tools/gen_node_config_schema.mjs from
+// doc/node-config-schema.json. Do not edit by hand.
+
+static constexpr const char kNodeConfigSchema[] = R"NODECONFIG(
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment": "Edit this file. src/node_config_schema.h is regenerated from it by tools/gen_node_config_schema.mjs and verified in CI. additionalProperties:false is stripped from the runtime copy so older Node versions tolerate fields added later.",
   "required": [],
   "properties": {
     "$schema": {
@@ -24,6 +28,10 @@ static constexpr const char kNodeConfigSchema[] = R"JSON(
           "type": "boolean",
           "description": "allow use of child process when any permissions are set"
         },
+        "allow-ffi": {
+          "type": "boolean",
+          "description": "allow use of FFI when any permissions are set (only in builds with FFI support)"
+        },
         "allow-fs-read": {
           "oneOf": [
             {
@@ -172,6 +180,10 @@ static constexpr const char kNodeConfigSchema[] = R"JSON(
           "type": "boolean",
           "description": "experimental EventSource API"
         },
+        "experimental-ffi": {
+          "type": "boolean",
+          "description": "experimental node:ffi module (only in builds with FFI support)"
+        },
         "experimental-global-navigator": {
           "type": "boolean",
           "description": "expose experimental Navigator API on the global scope"
@@ -765,6 +777,10 @@ static constexpr const char kNodeConfigSchema[] = R"JSON(
           "type": "boolean",
           "description": "allow use of addons when any permissions are set"
         },
+        "allow-ffi": {
+          "type": "boolean",
+          "description": "allow use of FFI when any permissions are set (only in builds with FFI support)"
+        },
         "allow-child-process": {
           "type": "boolean",
           "description": "allow use of child process when any permissions are set"
@@ -1021,6 +1037,6 @@ static constexpr const char kNodeConfigSchema[] = R"JSON(
   },
   "type": "object"
 }
-)JSON";
+)NODECONFIG";
 
 #endif  // SRC_NODE_CONFIG_SCHEMA_H_

tools/gen_node_config_schema.mjs

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+// Generates src/node_config_schema.h from doc/node-config-schema.json.
+// Run after editing the JSON. CI runs `--check` to fail on drift.
+//
+// Usage:
+//   node tools/gen_node_config_schema.mjs          # write the header
+//   node tools/gen_node_config_schema.mjs --check  # exit 1 if out of sync
+
+import { readFileSync, writeFileSync } from 'node:fs';
+import { dirname, join, relative } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
+const SOURCE_PATH = join(ROOT, 'doc/node-config-schema.json');
+const HEADER_PATH = join(ROOT, 'src/node_config_schema.h');
+
+// `additionalProperties: false` is kept in the doc but stripped from the
+// runtime copy so older Node versions don't reject configs that mention
+// fields added in later releases.
+function stripAdditionalProperties(node) {
+  if (Array.isArray(node)) return node.map(stripAdditionalProperties);
+  if (node === null || typeof node !== 'object') return node;
+  const out = {};
+  for (const [key, value] of Object.entries(node)) {
+    if (key === 'additionalProperties' && value === false) continue;
+    out[key] = stripAdditionalProperties(value);
+  }
+  return out;
+}
+
+function buildHeader(schemaJson) {
+  return `#ifndef SRC_NODE_CONFIG_SCHEMA_H_
+#define SRC_NODE_CONFIG_SCHEMA_H_
+
+// AUTO-GENERATED by tools/gen_node_config_schema.mjs from
+// doc/node-config-schema.json. Do not edit by hand.
+
+static constexpr const char kNodeConfigSchema[] = R"NODECONFIG(
+${schemaJson}
+)NODECONFIG";
+
+#endif  // SRC_NODE_CONFIG_SCHEMA_H_
+`;
+}
+
+let source;
+try {
+  source = JSON.parse(readFileSync(SOURCE_PATH, 'utf8'));
+} catch (err) {
+  console.error(
+    `Failed to read or parse ${relative(ROOT, SOURCE_PATH)}: ${err.message}`,
+  );
+  process.exit(1);
+}
+const stripped = stripAdditionalProperties(source);
+const expected = buildHeader(JSON.stringify(stripped, null, 2));
+
+if (process.argv.includes('--check')) {
+  const actual = readFileSync(HEADER_PATH, 'utf8');
+  if (actual !== expected) {
+    console.error(
+      `${relative(ROOT, HEADER_PATH)} is out of date with respect to ` +
+      `${relative(ROOT, SOURCE_PATH)}.\n` +
+      `Run \`node tools/gen_node_config_schema.mjs\` and commit the result.`,
+    );
+    process.exit(1);
+  }
+  console.log(`${relative(ROOT, HEADER_PATH)} is up to date.`);
+} else {
+  writeFileSync(HEADER_PATH, expected);
+  console.log(`Wrote ${relative(ROOT, HEADER_PATH)}`);
+}