Fix CompareValidator client-side closure compareValue resolution to pass ($model, $attribute) and avoid mutating validator state. (#20814)

Author: terabytesoftw

framework/CHANGELOG.md

@@ -37,6 +37,7 @@ Yii Framework 2 Change Log
 - Chg #20808: Rename `ApcCache` to `ApcuCache` and remove legacy APC extension support (terabytesoftw)
 - Bug: Fix `ActiveField::generateLabel()` to strip `label`/`for` attributes for custom tags and preserve prior label in `radio()`/`checkbox()` (terabytesoftw)
 - Bug: Fix `clientScript` not being instantiated in validators when a custom array config is set and `useJquery` is `false` (terabytesoftw)
+- Bug: Fix `CompareValidator` client-side closure `compareValue` resolution to pass `($model, $attribute)` and avoid mutating validator state (terabytesoftw)
 
 
 2.0.55 under development

framework/jquery/validators/CompareValidatorJqueryClientScript.php

@@ -1,15 +1,16 @@
 <?php
 
+declare(strict_types=1);
+
 /**
  * @link https://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC
  * @license https://www.yiiframework.com/license/
  */
 
-declare(strict_types=1);
-
 namespace yii\jquery\validators;
 
+use Closure;
 use yii\base\Model;
 use yii\helpers\Html;
 use yii\helpers\Json;
@@ -19,8 +20,10 @@
 use yii\validators\Validator;
 use yii\web\View;
 
+use function call_user_func;
+
 /**
- * CompareValidatorJqueryClientScript provides client-side validation script generation for attribute comparison.
+ * Provides client-side validation script generation for attribute comparison.
  *
  * This class implements {@see ClientValidatorScriptInterface} to supply client-side validation options and register the
  * corresponding JavaScript code for comparison validation in Yii2 forms using jQuery.
@@ -29,20 +32,26 @@
  * @implements ClientValidatorScriptInterface<T>
  *
  * @author Wilmer Arambula <terabytesoftw@gmail.com>
- * @since 2.2.0
+ * @since 2.2
  */
 class CompareValidatorJqueryClientScript implements ClientValidatorScriptInterface
 {
     public function getClientOptions(Validator $validator, Model $model, string $attribute): array
     {
+        $resolvedCompareValue = $validator->compareValue;
+
+        if ($resolvedCompareValue instanceof Closure) {
+            $resolvedCompareValue = call_user_func($resolvedCompareValue, $model, $attribute);
+        }
+
         $options = [
             'operator' => $validator->operator,
             'type' => $validator->type,
         ];
 
-        if ($validator->compareValue !== null) {
-            $options['compareValue'] = $validator->compareValue;
-            $compareLabel = $compareValue = $compareValueOrAttribute = $validator->compareValue;
+        if ($resolvedCompareValue !== null) {
+            $options['compareValue'] = $resolvedCompareValue;
+            $compareLabel = $compareValue = $compareValueOrAttribute = $resolvedCompareValue;
         } else {
             $compareAttribute = $validator->compareAttribute === null ? $attribute . '_repeat' : $validator->compareAttribute;
 
@@ -71,10 +80,6 @@ public function getClientOptions(Validator $validator, Model $model, string $att
 
     public function register(Validator $validator, Model $model, string $attribute, View $view): string
     {
-        if ($validator->compareValue != null && $validator->compareValue instanceof \Closure) {
-            $validator->compareValue = call_user_func($validator->compareValue);
-        }
-
         ValidationAsset::register($view);
 
         $options = $this->getClientOptions($validator, $model, $attribute);

tests/framework/jquery/validators/CompareValidatorJqueryClientScriptTest.php

@@ -10,6 +10,7 @@
 
 namespace yiiunit\framework\jquery\validators;
 
+use Closure;
 use PHPUnit\Framework\Attributes\Group;
 use Yii;
 use yii\validators\CompareValidator;
@@ -81,23 +82,42 @@ public function testClientValidateAttribute(): void
 
     public function testClientValidateAttributeWithClosureCompareValue(): void
     {
+        $closureConfig = [
+            'compareValue' => static fn(FakedValidationModel $model, string $attribute): string => 'closure_value',
+            'operator' => '==',
+            'type' => CompareValidator::TYPE_STRING,
+        ];
+
+        $validator = new CompareValidator($closureConfig);
+
         $modelValidator = new FakedValidationModel();
 
-        $validator = new CompareValidator(
-            [
-                'compareValue' => static fn(): string => 'closure_value',
-                'operator' => '==',
-                'type' => CompareValidator::TYPE_STRING,
-            ],
+        self::assertInstanceOf(
+            Closure::class,
+            $validator->compareValue,
+            'Should start as Closure before client validation.',
         );
-
         self::assertSame(
             <<<JS
             yii.validation.compare(value, messages, {"operator":"==","type":"string","compareValue":"closure_value","skipOnEmpty":1,"message":"attrA must be equal to \u0022closure_value\u0022."}, \$form);
             JS,
             $validator->clientValidateAttribute($modelValidator, 'attrA', Yii::$app->view),
             'Should return correct validation script.',
         );
+        self::assertInstanceOf(
+            Closure::class,
+            $validator->compareValue,
+            'Should not resolve compareValue in-place.',
+        );
+
+        $validator = new CompareValidator($closureConfig);
+
+        self::assertInstanceOf(
+            Closure::class,
+            $validator->compareValue,
+            'Should start as Closure before client validation.',
+        );
+
         self::assertSame(
             [
                 'operator' => '==',
@@ -109,6 +129,19 @@ public function testClientValidateAttributeWithClosureCompareValue(): void
             $validator->getClientOptions($modelValidator, 'attrA'),
             'Should return correct options array.',
         );
+        self::assertInstanceOf(
+            Closure::class,
+            $validator->compareValue,
+            'Should not resolve compareValue in-place.',
+        );
+
+        $validator = new CompareValidator(
+            [
+                'compareValue' => static fn(): string => 'closure_value',
+                'operator' => '==',
+                'type' => CompareValidator::TYPE_STRING,
+            ],
+        );
 
         $validator->validate('someIncorrectValue', $errorMessage);
 
@@ -128,7 +161,6 @@ public function testClientValidateAttributeWithNullCompareAttribute(): void
 
         $validator = new CompareValidator(
             [
-                'compareAttribute' => 'attrA_repeat',
                 'operator' => '==',
                 'type' => CompareValidator::TYPE_STRING,
             ],