Merge pull request #530: Set ignoreUninitializedRelations option to false by default

Author: roxblnfk

.github/workflows/main.yml

@@ -30,7 +30,7 @@ jobs:
           sudo ACCEPT_EULA=Y apt-get install -y msodbcsql18
 
       - name: 📦 Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
       - name: 🛠️ Setup DB services
         run: |
           cd tests
@@ -86,7 +86,7 @@ jobs:
           - "8.4"
     steps:
       - name: 📦 Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
       - name: 🛠️ Setup DB services
         run: |
           cd tests

psalm-baseline.xml

@@ -378,12 +378,9 @@
     </ClassMustBeFinal>
   </file>
   <file src="src/Factory.php">
-    <InvalidArgument>
-      <code><![CDATA[$database]]></code>
-    </InvalidArgument>
-    <InvalidCast>
-      <code><![CDATA[$database]]></code>
-    </InvalidCast>
+    <ArgumentTypeCoercion>
+      <code><![CDATA[$role]]></code>
+    </ArgumentTypeCoercion>
     <InvalidPropertyAssignmentValue>
       <code><![CDATA[[
         SchemaInterface::REPOSITORY => Repository::class,
@@ -472,9 +469,6 @@
       <code><![CDATA[$class]]></code>
       <code><![CDATA[$e->getCode()]]></code>
     </PossiblyInvalidArgument>
-    <TooFewArguments>
-      <code><![CDATA[new Typecast($database)]]></code>
-    </TooFewArguments>
   </file>
   <file src="src/Heap/Heap.php">
     <InvalidNullableReturnType>
@@ -2014,8 +2008,6 @@
       <code><![CDATA[\IteratorAggregate]]></code>
     </MissingTemplateParam>
     <MixedArgument>
-      <code><![CDATA[$data[0]]]></code>
-      <code><![CDATA[$node->getResult()]]></code>
       <code><![CDATA[$subOption]]></code>
       <code><![CDATA[$subOption + $options]]></code>
     </MixedArgument>
@@ -2050,17 +2042,18 @@
             $this->schema,
             $this->entityFactory,
             $this->loader->getTarget(),
-            $node->getResult(),
+            $this->loadData(),
             $findInHeap,
             typecast: true,
         )]]></code>
       <code><![CDATA[Iterator<TEntity>]]></code>
-      <code><![CDATA[\array_map([$mapper, 'cast'], $node->getResult())]]></code>
-      <code><![CDATA[array<array-key, array<string, mixed>>]]></code>
+      <code><![CDATA[\array_map([$mapper, 'cast'], $this->loadData(false))]]></code>
+      <code><![CDATA[array<array-key, array<non-empty-string, mixed>>]]></code>
+      <code><![CDATA[array<array-key, array<non-empty-string, mixed>>]]></code>
     </MixedReturnTypeCoercion>
-    <PossiblyInvalidArgument>
-      <code><![CDATA[$node->getResult()]]></code>
-    </PossiblyInvalidArgument>
+    <PossiblyFalseArgument>
+      <code><![CDATA[\reset($pk)]]></code>
+    </PossiblyFalseArgument>
   </file>
   <file src="src/Select/AbstractLoader.php">
     <MixedArgument>

src/Options.php

@@ -13,7 +13,7 @@ final class Options
      * @readonly
      * @note will be set to TRUE in the next major version.
      */
-    public bool $ignoreUninitializedRelations = true;
+    public bool $ignoreUninitializedRelations = false;
 
     /**
      * @readonly

tests/ORM/Functional/Driver/Common/BaseTest.php

@@ -153,6 +153,9 @@ public function setUp(): void
             ))->withCollectionFactory('array', new ArrayCollectionFactory()),
             new Schema([]),
             $this->getCommandGenerator(),
+            options: (new \Cycle\ORM\Options())
+                ->withIgnoreUninitializedRelations(true)
+                ->withGroupByToDeduplicate(true),
         );
     }
 

tests/ORM/Functional/Driver/Common/Relation/BelongsTo/BelongsToNullableRelationTest.php

@@ -4,6 +4,7 @@
 
 namespace Cycle\ORM\Tests\Functional\Driver\Common\Relation\BelongsTo;
 
+use Cycle\ORM\Options;
 use Cycle\ORM\Relation;
 use Cycle\ORM\Select;
 use Cycle\ORM\Tests\Fixtures\Profile;
@@ -65,4 +66,22 @@ public function testRemoveParentUsingSetNull(): void
             ->fetchOne();
         $this->assertNull($profile->user);
     }
+
+    /**
+     * If relation property was unset and IgnoreUninitializedRelations option is false - set to null
+     */
+    public function testUnsetPropertyWithoutIgnoreUninitializedRelations(): void
+    {
+        echo static::class;
+        $this->orm = $this->orm->with(options: (new Options())->withIgnoreUninitializedRelations(false));
+        /** @var Profile $profile */
+        $profile = (new Select($this->orm, Profile::class))
+            ->wherePK(1)->load('user')->fetchOne();
+
+        unset($profile->user);
+
+        $this->captureWriteQueries();
+        $this->save($profile);
+        $this->assertNumWrites(1);
+    }
 }

tests/ORM/Functional/Driver/Common/Relation/BelongsTo/BelongsToRelationTest.php

@@ -8,6 +8,7 @@
 use Cycle\ORM\Heap\Heap;
 use Cycle\ORM\Heap\Node;
 use Cycle\ORM\Mapper\Mapper;
+use Cycle\ORM\Options;
 use Cycle\ORM\Relation;
 use Cycle\ORM\Schema;
 use Cycle\ORM\Select;
@@ -394,6 +395,28 @@ public function testUnsetProperty(): void
         $this->assertNumWrites(0);
     }
 
+    /**
+     * If non-nullable relation property was unset - throw NullException
+     */
+    public function testUnsetPropertyWithoutIgnoreUninitializedRelations(): void
+    {
+        echo static::class;
+        $this->orm = $this->orm->with(options: (new Options())->withIgnoreUninitializedRelations(false));
+        /** @var Profile $profile */
+        $profile = (new Select($this->orm, Profile::class))
+            ->wherePK(1)->load('user')->fetchOne();
+
+        unset($profile->user);
+        $this->expectException(NullException::class);
+
+        $this->captureWriteQueries();
+        try {
+            $this->save($profile);
+        } finally {
+            $this->assertNumWrites(0);
+        }
+    }
+
     public function setUp(): void
     {
         parent::setUp();