@schalkneethling/miyagi-core 4.4.2 → 4.4.3

package/lib/validator/mocks.js

@@ -3,6 +3,7 @@ import { existsSync } from "node:fs";
 import deepMerge from "deepmerge";
 import log from "../logger.js";
 import { t } from "../i18n/index.js";
+import { loadGlobalSchemas } from "./schemas.js";
 
 /**
  * Module for validating mock data against JSON schema
@@ -14,97 +15,123 @@ import { t } from "../i18n/index.js";
  * @returns {null|object[]} null if there is no schema or an array with booleans defining the validity of the entries in the data array
  */
 export default function validateMockData(
-	component,
-	dataArray,
-	noCli,
-	validSchemas = [],
+  component,
+  dataArray,
+  noCli,
+  validSchemas = [],
 ) {
-	const componentSchema =
-		global.state.fileContents[component.paths.schema.full];
+  const componentSchema =
+    global.state.fileContents[component.paths.schema.full];
 
-	if (componentSchema) {
-		const validity = [];
-		let validate;
-		let jsonSchemaValidator;
+  if (componentSchema) {
+    const validity = [];
+    let validate;
+    let jsonSchemaValidator;
 
-		try {
-			jsonSchemaValidator = new global.config.schema.ajv(
-				deepMerge(
-					{
-						allErrors: true,
-					},
-					global.config.schema.options || {},
-				),
-			);
+    try {
+      jsonSchemaValidator = new global.config.schema.ajv(
+        deepMerge(
+          {
+            allErrors: true,
+          },
+          global.config.schema.options || {},
+        ),
+      );
 
-			validSchemas.forEach((entry) => {
-				// Preload only other validated schemas for cross-component $ref resolution.
-				// The current component schema is compiled below and must not be added twice.
-				if (entry?.schemaFile !== component.paths.schema.full && entry?.schema) {
-					jsonSchemaValidator.addSchema(entry.schema);
-				}
-			});
+      validSchemas.forEach((entry) => {
+        // Preload only other validated schemas for cross-component $ref resolution.
+        // The current component schema is compiled below and must not be added twice.
+        if (
+          entry?.schemaFile !== component.paths.schema.full &&
+          entry?.schema
+        ) {
+          jsonSchemaValidator.addSchema(entry.schema);
+        }
+      });
 
-			validate = jsonSchemaValidator.compile(componentSchema);
-		} catch (e) {
-			const message = e.toString();
-			if (!noCli) {
-				log("error", `${component.paths.dir.short}:\n${message}`, e);
-			}
-			return [
-				{
-					type: "schema",
-					data: [{ message }],
-				},
-			];
-		}
+      // Register global schema definitions when they were not already included in
+      // validSchemas (e.g. when called directly from the dev server render path).
+      const preloadedSchemaFiles = new Set(
+        validSchemas.map((entry) => entry?.schemaFile),
+      );
+      for (const [
+        index,
+        { schema, globalSchemaFile },
+      ] of loadGlobalSchemas().entries()) {
+        if (preloadedSchemaFiles.has(globalSchemaFile)) {
+          continue;
+        }
 
-		if (validate && dataArray) {
-			dataArray.forEach((entry) => {
-				const valid = validate(entry?.resolved ?? {});
-				if (!valid && !noCli) {
-					validate.errors.forEach((error) => {
-						log(
-							"error",
-							`${component.paths.dir.short} # ${entry.name}\n${jsYaml.dump(error)}`,
-						);
-					});
-				}
+        if (!schema.$id) {
+          schema.$id = `miyagi-global:${index}`;
+        }
 
-				if (!valid) {
-					validity.push({
-						variant: entry.name,
-						data: validate.errors,
-					});
-				}
-			});
-		}
+        try {
+          jsonSchemaValidator.addSchema(schema);
+        } catch {
+          // Silently skip duplicates — the same $id registered by the lint
+          // path would otherwise cause AJV to throw here.
+        }
+      }
 
-		return validity.map((item) => ({
-			type: "mocks",
-			...item,
-		}));
-	}
+      validate = jsonSchemaValidator.compile(componentSchema);
+    } catch (e) {
+      const message = e.toString();
+      if (!noCli) {
+        log("error", `${component.paths.dir.short}:\n${message}`, e);
+      }
+      return [
+        {
+          type: "schema",
+          data: [{ message }],
+        },
+      ];
+    }
 
-	if (!global.config.isBuild && !noCli) {
-		const parseError = global.state.fileReadErrors?.[component.paths.schema.full];
-		const schemaExistsOnDisk = existsSync(component.paths.schema.full);
-		const warningMessage = parseError
-			? t("validator.mocks.schemaParseFailed")
-					.replace("{{schemaFile}}", component.paths.schema.short)
-					.replace("{{format}}", "JSON or YAML")
-			: schemaExistsOnDisk
-				? t("validator.mocks.schemaParseFailed")
-						.replace("{{schemaFile}}", component.paths.schema.short)
-						.replace("{{format}}", "JSON or YAML")
-				: t("validator.mocks.schemaMissing")
-						.replace("{{component}}", component.paths.dir.short)
-						.replace("{{schemaFile}}", component.paths.schema.short);
-		log(
-			"warn",
-			warningMessage,
-		);
-	}
+    if (validate && dataArray) {
+      dataArray.forEach((entry) => {
+        const valid = validate(entry?.resolved ?? {});
+        if (!valid && !noCli) {
+          validate.errors.forEach((error) => {
+            log(
+              "error",
+              `${component.paths.dir.short} # ${entry.name}\n${jsYaml.dump(error)}`,
+            );
+          });
+        }
 
-	return null;
+        if (!valid) {
+          validity.push({
+            variant: entry.name,
+            data: validate.errors,
+          });
+        }
+      });
+    }
+
+    return validity.map((item) => ({
+      type: "mocks",
+      ...item,
+    }));
+  }
+
+  if (!global.config.isBuild && !noCli) {
+    const parseError =
+      global.state.fileReadErrors?.[component.paths.schema.full];
+    const schemaExistsOnDisk = existsSync(component.paths.schema.full);
+    const warningMessage = parseError
+      ? t("validator.mocks.schemaParseFailed")
+          .replace("{{schemaFile}}", component.paths.schema.short)
+          .replace("{{format}}", "JSON or YAML")
+      : schemaExistsOnDisk
+        ? t("validator.mocks.schemaParseFailed")
+            .replace("{{schemaFile}}", component.paths.schema.short)
+            .replace("{{format}}", "JSON or YAML")
+        : t("validator.mocks.schemaMissing")
+            .replace("{{component}}", component.paths.dir.short)
+            .replace("{{schemaFile}}", component.paths.schema.short);
+    log("warn", warningMessage);
+  }
+
+  return null;
 }