Merge remote-tracking branch 'origin/main' into mbg/config/merge

Author: mbg

lib/entry-points.js

@@ -107,7 +107,7 @@ const checkSchemaTestSchema = {
   rootKey: json.object(objectSchema),
 };
 
-test("validateSchema - checkSchema reports unknown keys", async (t) => {
+test("checkSchema - reports unknown keys", async (t) => {
   const result = json.checkSchema(checkSchemaTestSchema, {
     rootKey: {
       objectKey: {
@@ -125,7 +125,7 @@ test("validateSchema - checkSchema reports unknown keys", async (t) => {
   );
 });
 
-test("validateSchema - checkSchema reports invalid keys", async (t) => {
+test("checkSchema - reports invalid keys", async (t) => {
   const result = json.checkSchema(checkSchemaTestSchema, {
     rootKey: {
       objectKey: {

src/json/index.test.ts

@@ -104,12 +104,18 @@ export function array<T>(validator: Validator<T>) {
         const elementPath = `${path}[${index}]`;
         const eResult = validator.check(e, opts, `${elementPath}`);
 
+        result.invalidKeys.push(...eResult.invalidKeys);
         result.unknownKeys.push(...eResult.unknownKeys);
         index++;
 
         if (!eResult.valid) {
           result.valid = false;
-          result.invalidKeys.push(elementPath);
+
+          // Add the element path to `invalidKeys` if we didn't get
+          // any more specific ones from the element validator.
+          if (eResult.invalidKeys.length === 0) {
+            result.invalidKeys.push(elementPath);
+          }
 
           if (opts.failFast) {
             return result;
@@ -258,9 +264,16 @@ export function checkSchema<S extends Schema>(
   path: string = "",
 ): CheckSchemaResult {
   const result: CheckSchemaResult = successfulCheckSchema();
+
+  // Track the set of input keys. We remove keys from this set as we recognise them
+  // during validation.
   const inputKeys = new Set(Object.keys(obj));
+
+  // Track keys that have failed validation, starting with the empty set.
   const invalidKeys = new Set();
 
+  // Loop through all keys in the object schema and validate that the given object
+  // satisfies the schema key.
   for (const [key, validator] of Object.entries(schema)) {
     const hasKey = key in obj;
 
@@ -276,7 +289,7 @@ export function checkSchema<S extends Schema>(
       result.valid = false;
 
       if (options.failFast) {
-        return result;
+        break;
       }
       continue;
     }
@@ -286,7 +299,7 @@ export function checkSchema<S extends Schema>(
       result.valid = false;
 
       if (options.failFast) {
-        return result;
+        break;
       }
       continue;
     }
@@ -308,7 +321,7 @@ export function checkSchema<S extends Schema>(
         result.valid = false;
 
         if (options.failFast) {
-          return result;
+          break;
         }
         continue;
       }