Never implicitly use fake model for update (#1123)

Author: mvorisek

src/Model/Join.php

@@ -44,6 +44,9 @@ abstract class Join
     /** Weak join does not update foreign table. */
     public bool $weak = false;
 
+    /** Foreign table is updated using fake model and thus no regular foreign model hooks are invoked. */
+    public bool $allowDangerousForeignTableUpdate = false;
+
     /**
      * Normally the foreign table is saved first, then it's ID is used in the
      * primary table. When deleting, the primary table record is deleted first
@@ -127,6 +130,7 @@ protected function createFakeForeignModel(): Model
         $fakeModel = new Model($this->getOwner()->getPersistence(), [
             'table' => $this->foreignTable,
             'idField' => $this->foreignIdField,
+            'readOnly' => !$this->allowDangerousForeignTableUpdate,
         ]);
         foreach ($this->getOwner()->getFields() as $ownerField) {
             if ($ownerField->hasJoin() && $ownerField->getJoin()->shortName === $this->shortName) {

tests/JoinArrayTest.php

@@ -78,6 +78,7 @@ public function testJoinSaving1(): void
         $user2 = $user->createEntity();
         $user2->set('name', 'John');
         $user2->set('contact_phone', '+123');
+        $j->allowDangerousForeignTableUpdate = true;
         $user2->save();
 
         self::assertSame(1, $user2->getId());
@@ -134,6 +135,7 @@ public function testJoinSaving2(): void
         $user2 = $user->createEntity();
         $user2->set('name', 'John');
         $user2->set('contact_phone', '+123');
+        $j->allowDangerousForeignTableUpdate = true;
         $user2->save();
 
         self::assertSame(1, $user2->getId());
@@ -194,6 +196,7 @@ public function testJoinSaving3(): void
         $user = $user->createEntity();
         $user->set('name', 'John');
         $user->set('contact_phone', '+123');
+        $j->allowDangerousForeignTableUpdate = true;
         $user->save();
 
         self::assertSame([
@@ -216,6 +219,7 @@ public function testJoinSaving4(): void
         $user->set('name', 'John');
         $user->set('code', 'C28');
         $user->set('contact_phone', '+123');
+        $j->allowDangerousForeignTableUpdate = true;
         $user->save();
 
         self::assertSame([
@@ -290,6 +294,7 @@ public function testJoinUpdate(): void
         $user2 = $user->load(1);
         $user2->set('name', 'John 2');
         $user2->set('contact_phone', '+555');
+        $j->allowDangerousForeignTableUpdate = true;
         $user2->save();
 
         self::assertSame([
@@ -364,6 +369,7 @@ public function testJoinDelete(): void
         $j->addField('contact_phone');
 
         $user = $user->load(1);
+        $j->allowDangerousForeignTableUpdate = true;
         $user->delete();
 
         self::assertSame([

tests/JoinSqlTest.php

@@ -116,6 +116,7 @@ public function testJoinSaving1(): void
         $user2 = $user->createEntity();
         $user2->set('name', 'John');
         $user2->set('contact_phone', '+123');
+        $j->allowDangerousForeignTableUpdate = true;
         $user2->save();
 
         self::assertSame(1, $user2->getId());
@@ -169,6 +170,7 @@ public function testJoinSaving2(): void
         $user2 = $user->createEntity();
         $user2->set('name', 'John');
         $user2->set('contact_phone', '+123');
+        $j->allowDangerousForeignTableUpdate = true;
         $user2->save();
 
         self::assertSame(1, $user2->getId());
@@ -239,6 +241,7 @@ public function testJoinSaving3(): void
         $user = $user->createEntity();
         $user->set('name', 'John');
         $user->set('contact_phone', '+123');
+        $j->allowDangerousForeignTableUpdate = true;
         $user->save();
 
         self::assertSame([
@@ -313,6 +316,7 @@ public function testJoinUpdate(): void
         $user2 = $user->load(1);
         $user2->set('name', 'John 2');
         $user2->set('contact_phone', '+555');
+        $j->allowDangerousForeignTableUpdate = true;
         $user2->save();
 
         self::assertSame([
@@ -405,6 +409,7 @@ public function testJoinDelete(): void
         $j->addField('contact_phone');
 
         $user = $user->load(3);
+        $j->allowDangerousForeignTableUpdate = true;
         $user->delete();
 
         self::assertSame([
@@ -432,6 +437,20 @@ public function testJoinDelete(): void
         }
     }
 
+    public function testDangerousForeignTableUpdateException(): void
+    {
+        $user = new Model($this->db, ['table' => 'user']);
+        $j = $user->join('contact');
+        $j->addField('phone');
+
+        $user2 = $user->createEntity();
+        $user2->set('phone', '+555');
+
+        $this->expectException(Exception::class);
+        $this->expectExceptionMessage('Model is read-only');
+        $user2->save();
+    }
+
     public function testDoubleSaveHook(): void
     {
         $this->setDb([
@@ -458,6 +477,7 @@ public function testDoubleSaveHook(): void
 
         $user = $user->createEntity();
         $user->set('name', 'John');
+        $j->allowDangerousForeignTableUpdate = true;
         $user->save();
 
         self::assertSame([
@@ -505,6 +525,8 @@ public function testDoubleJoin(): void
 
         $user2 = $user->load(10);
         self::assertSame(['id' => 10, 'contact_id' => 100, 'name' => 'John 2', 'contact_phone' => '+555', 'country_id' => 1, 'country_name' => 'UK'], $user2->get());
+        $jContact->allowDangerousForeignTableUpdate = true;
+        $jCountry->allowDangerousForeignTableUpdate = true;
         $user2->delete();
 
         $user2 = $user->loadBy('country_name', 'US');
@@ -572,6 +594,8 @@ public function testDoubleReverseJoin(): void
 
         $country2 = $country->load(1);
         self::assertSame(['id' => 1, 'name' => 'UK', 'contact_phone' => '+555', 'contact_id' => 100, 'user_name' => 'John 2'], $country2->get());
+        $jContact->allowDangerousForeignTableUpdate = true;
+        $jUser->allowDangerousForeignTableUpdate = true;
         $country2->delete();
 
         $country2 = $country->loadBy('user_name', 'XX');
@@ -706,6 +730,7 @@ public function testJoinReverseOneOnOne(): void
         self::assertSame(['id' => 20, 'name' => 'Peter', 'notes' => 'second note'], $m->get());
 
         // update loaded record
+        $j->allowDangerousForeignTableUpdate = true;
         $m->save(['name' => 'Mark', 'notes' => '2nd note']);
         $m = $user->load(20);
         self::assertSame(['id' => 20, 'name' => 'Mark', 'notes' => '2nd note'], $m->get());
@@ -726,6 +751,7 @@ public function testJoinReverseOneOnOne(): void
         $j->addField('notes');
 
         // insert new record
+        $j->allowDangerousForeignTableUpdate = true;
         $m = $user->createEntity()->save(['name' => 'Olaf', 'notes' => '4th note']);
         $m = $user->load(22);
         self::assertSame(['id' => 22, 'name' => 'Olaf', 'notes' => '4th note'], $m->get());
@@ -741,6 +767,7 @@ public function testJoinReverseOneOnOne(): void
         $j->addField('notes');
 
         // insert new record
+        $j->allowDangerousForeignTableUpdate = true;
         $m = $user->createEntity()->save(['name' => 'Chris', 'notes' => '5th note']);
         $m = $user->load(23);
         self::assertSame(['id' => 23, 'name' => 'Chris', 'notes' => '5th note'], $m->get());
@@ -788,6 +815,8 @@ public function testJoinActualFieldNamesAndPrefix(): void
         $user2->set('name', 'John 2');
         $user2->set('j1_phone', '+555');
         $user2->set('j2_salary', 111);
+        $j->allowDangerousForeignTableUpdate = true;
+        $j2->allowDangerousForeignTableUpdate = true;
         $user2->save();
 
         self::{'assertEquals'}([
@@ -869,6 +898,7 @@ protected function setupJoinWithNonDefaultForeignIdField(array $joinDefaults = [
             'foreignIdField' => 'uid',
         ], $joinDefaults));
         $this->createMigrator()->createForeignKey($j);
+        $j->allowDangerousForeignTableUpdate = true;
         $j->addField('contact_phone');
 
         return [$masterModel, $joinedModel, $user];

tests/Model/Smbo/Payment.php

@@ -17,7 +17,7 @@ protected function init(): void
 
         $this->addCondition('doc_type', 'payment');
 
-        $this->jPayment = $this->join('payment.document_id');
+        $this->jPayment = $this->join('payment.document_id', ['allowDangerousForeignTableUpdate' => true]);
 
         $this->jPayment->addField('cheque_no');
         $this->jPayment->hasOne('account_id', ['model' => [Account::class]]);