Fixed ambiguous column error in BaseActiveRecord::refresh()

when the query adds a JOIN by default

fixes yiisoft#13757

framework/CHANGELOG.md

@@ -5,6 +5,7 @@ Yii Framework 2 Change Log
 ------------------------
 
 - Chg #14321: `yii\widgets\MaskedInput` is now registering its JavaScript `clientOptions` initialization code in head section (DaveFerger)
+- Bug #13757: Fixed ambiguous column error in `BaseActiveRecord::refresh()` when the query adds a JOIN by default (cebe, ivankff)
 - Bug #14248: `yii\console\controllers\MessageController` no longer outputs colorized filenames when console does not support text colorization (PowerGamer1)
 - Bug #14264: Fixed a bug where `yii\log\Logger::calculateTimings()` was not accepting messages with array tokens (bizley)
 - Bug #14269: Fixed broken error page when calling an undefined method (cebe)

framework/db/ActiveRecord.php

@@ -188,6 +188,21 @@ protected static function findByCondition($condition)
         return $query->andWhere($condition);
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function refresh()
+    {
+        $pk = [];
+        // disambiguate column names in case ActiveQuery adds a JOIN
+        foreach($this->getPrimaryKey(true) as $key => $value) {
+            $pk[static::tableName() . '.' . $key] = $value;
+        }
+        /* @var $record BaseActiveRecord */
+        $record = static::findOne($pk);
+        return $this->refreshInternal($record);
+    }
+
     /**
      * Updates the whole table using the provided attribute values and conditions.
      *

framework/db/BaseActiveRecord.php

@@ -1017,6 +1017,18 @@ public function refresh()
     {
         /* @var $record BaseActiveRecord */
         $record = static::findOne($this->getPrimaryKey(true));
+        return $this->refreshInternal($record);
+    }
+
+    /**
+     * Repopulates this active record with the latest data from a newly fetched instance.
+     * @param BaseActiveRecord $record the record to take attributes from.
+     * @return bool whether refresh was successful.
+     * @see refresh()
+     * @since 2.0.13
+     */
+    protected function refreshInternal($record)
+    {
         if ($record === null) {
             return false;
         }

tests/data/ar/CustomerQuery.php

@@ -14,6 +14,16 @@
  */
 class CustomerQuery extends ActiveQuery
 {
+    public static $joinWithProfile = false;
+
+    public function init()
+    {
+        if (static::$joinWithProfile) {
+            $this->innerJoinWith('profile');
+        }
+        parent::init();
+    }
+
     public function active()
     {
         $this->andWhere('[[status]]=1');

tests/framework/db/ActiveRecordTest.php

@@ -14,6 +14,7 @@
 use yiiunit\data\ar\Cat;
 use yiiunit\data\ar\Category;
 use yiiunit\data\ar\Customer;
+use yiiunit\data\ar\CustomerQuery;
 use yiiunit\data\ar\Document;
 use yiiunit\data\ar\Dog;
 use yiiunit\data\ar\Item;
@@ -36,6 +37,7 @@ protected function setUp()
     {
         parent::setUp();
         ActiveRecord::$db = $this->getConnection();
+        CustomerQuery::$joinWithProfile = false;
     }
 
     /**
@@ -1505,4 +1507,15 @@ public function testNoTablenameReplacement()
         $this->assertEquals('Some {{updated}} name', $customer->name);
         $this->assertEquals('Some {{%updated}} address', $customer->address);
     }
+
+    /**
+     * Ensure no ambiguous colum error occurs if ActiveQuery adds a JOIN
+     */
+    public function testAmbiguousColumnFindOne()
+    {
+        CustomerQuery::$joinWithProfile = true;
+        $model = Customer::findOne(1);
+        $this->assertTrue($model->refresh());
+        CustomerQuery::$joinWithProfile = false;
+    }
 }