review: hand in as much context as possible to validate function

Author: lucas-koehler

packages/core/src/models/uischema.ts

@@ -157,7 +157,18 @@ export interface ValidateFunctionCondition extends BaseCondition, Scoped {
    *
    * @param data The data as resolved via the scope.
    * @returns `true` if the condition is fulfilled */
-  validate: (data: unknown) => boolean;
+  validate: (context: ValidateFunctionContext) => boolean;
+}
+
+export interface ValidateFunctionContext {
+  /** The resolved data scoped to the `ValidateFunctionCondition`'s scope. */
+  data: unknown;
+  /** The full data of the form. */
+  fullData: unknown;
+  /** Optional instance path. Necessary when the actual data path can not be inferred via the scope alone as it is the case with nested controls. */
+  path: string | undefined;
+  /** The `UISchemaElement` containing the rule that uses the ValidateFunctionCondition, e.g. a `ControlElement` */
+  uischemaElement: UISchemaElement;
 }
 
 /**

packages/core/src/util/runtime.ts

@@ -64,18 +64,19 @@ const getConditionScope = (condition: Scopable, path: string): string => {
 
 const evaluateCondition = (
   data: any,
+  uischema: UISchemaElement,
   condition: Condition,
   path: string,
   ajv: Ajv
 ): boolean => {
   if (isAndCondition(condition)) {
     return condition.conditions.reduce(
-      (acc, cur) => acc && evaluateCondition(data, cur, path, ajv),
+      (acc, cur) => acc && evaluateCondition(data, uischema, cur, path, ajv),
       true
     );
   } else if (isOrCondition(condition)) {
     return condition.conditions.reduce(
-      (acc, cur) => acc || evaluateCondition(data, cur, path, ajv),
+      (acc, cur) => acc || evaluateCondition(data, uischema, cur, path, ajv),
       false
     );
   } else if (isLeafCondition(condition)) {
@@ -89,7 +90,13 @@ const evaluateCondition = (
     return ajv.validate(condition.schema, value) as boolean;
   } else if (isValidateFunctionCondition(condition)) {
     const value = resolveData(data, getConditionScope(condition, path));
-    return condition.validate(value);
+    const context = {
+      data: value,
+      fullData: data,
+      path,
+      uischemaElement: uischema,
+    };
+    return condition.validate(context);
   } else {
     // unknown condition
     return true;
@@ -103,7 +110,7 @@ const isRuleFulfilled = (
   ajv: Ajv
 ): boolean => {
   const condition = uischema.rule.condition;
-  return evaluateCondition(data, condition, path, ajv);
+  return evaluateCondition(data, uischema, condition, path, ajv);
 };
 
 export const evalVisibility = (

packages/core/test/util/runtime.test.ts

@@ -34,6 +34,7 @@ import {
   RuleEffect,
   SchemaBasedCondition,
   ValidateFunctionCondition,
+  ValidateFunctionContext,
 } from '../../src';
 import { evalEnablement, evalVisibility } from '../../src/util/runtime';
 
@@ -496,7 +497,7 @@ test('evalEnablement disable valid case', (t) => {
 test('evalEnablement enable valid case based on ValidateFunctionCondition', (t) => {
   const condition: ValidateFunctionCondition = {
     scope: '#/properties/ruleValue',
-    validate: (data) => data === 'bar',
+    validate: (context: ValidateFunctionContext) => context.data === 'bar',
   };
   const uischema: ControlElement = {
     type: 'Control',
@@ -517,7 +518,7 @@ test('evalEnablement enable valid case based on ValidateFunctionCondition', (t)
 test('evalEnablement enable invalid case based on ValidateFunctionCondition', (t) => {
   const condition: ValidateFunctionCondition = {
     scope: '#/properties/ruleValue',
-    validate: (data) => data === 'bar',
+    validate: (context: ValidateFunctionContext) => context.data === 'bar',
   };
   const uischema: ControlElement = {
     type: 'Control',
@@ -538,7 +539,7 @@ test('evalEnablement enable invalid case based on ValidateFunctionCondition', (t
 test('evalEnablement disable valid case based on ValidateFunctionCondition', (t) => {
   const condition: ValidateFunctionCondition = {
     scope: '#/properties/ruleValue',
-    validate: (data) => data === 'bar',
+    validate: (context: ValidateFunctionContext) => context.data === 'bar',
   };
   const uischema: ControlElement = {
     type: 'Control',
@@ -559,7 +560,7 @@ test('evalEnablement disable valid case based on ValidateFunctionCondition', (t)
 test('evalEnablement disable invalid case based on ValidateFunctionCondition', (t) => {
   const condition: ValidateFunctionCondition = {
     scope: '#/properties/ruleValue',
-    validate: (data) => data === 'bar',
+    validate: (context: ValidateFunctionContext) => context.data === 'bar',
   };
   const uischema: ControlElement = {
     type: 'Control',
@@ -576,6 +577,35 @@ test('evalEnablement disable invalid case based on ValidateFunctionCondition', (
   t.is(evalEnablement(uischema, data, undefined, createAjv()), true);
 });
 
+// Test context properties for ValidateFunctionCondition
+test('ValidateFunctionCondition correctly passes context parameters', (t) => {
+  const condition: ValidateFunctionCondition = {
+    scope: '#/properties/ruleValue',
+    validate: (context: ValidateFunctionContext) => {
+      // Verify all context properties are passed correctly
+      return (
+        context.data === 'bar' &&
+        (context.fullData as any).value === 'foo' &&
+        context.path === undefined &&
+        (context.uischemaElement as any).scope === '#/properties/value'
+      );
+    },
+  };
+  const uischema: ControlElement = {
+    type: 'Control',
+    scope: '#/properties/value',
+    rule: {
+      effect: RuleEffect.ENABLE,
+      condition: condition,
+    },
+  };
+  const data = {
+    value: 'foo',
+    ruleValue: 'bar',
+  };
+  t.is(evalEnablement(uischema, data, undefined, createAjv()), true);
+});
+
 test('evalEnablement disable invalid case', (t) => {
   const leafCondition: LeafCondition = {
     type: 'LEAF',