orm: soft-deleted deferred load handling

application/Espo/ORM/Relation/RDBRelations.php

@@ -30,6 +30,7 @@
 namespace Espo\ORM\Relation;
 
 use Espo\ORM\BaseEntity;
+use Espo\ORM\Defs\Defs;
 use Espo\ORM\Entity;
 use Espo\ORM\EntityCollection;
 use Espo\ORM\EntityManager;
@@ -57,9 +58,13 @@ class RDBRelations implements Relations
         RelationType::HAS_CHILDREN,
     ];
 
+    private Defs $defs;
+
     public function __construct(
         private EntityManager $entityManager,
-    ) {}
+    ) {
+        $this->defs = $this->entityManager->getDefs();
+    }
 
     public function setEntity(Entity $entity): void
     {
@@ -253,8 +258,7 @@ class RDBRelations implements Relations
             return new EntityCollection();
         }
 
-        $relationDefs = $this->entityManager
-            ->getDefs()
+        $relationDefs = $this->defs
             ->getEntity($this->entity->getEntityType())
             ->getRelation($relation);
 
@@ -291,8 +295,7 @@ class RDBRelations implements Relations
             throw new LogicException();
         }
 
-        return $this->entityManager
-            ->getDefs()
+        return $this->defs
             ->getEntity($this->entity->getEntityType())
             ->tryGetRelation($relation)
             ?->getType();
@@ -304,8 +307,7 @@ class RDBRelations implements Relations
             throw new LogicException();
         }
 
-        $defs = $this->entityManager
-            ->getDefs()
+        $defs = $this->defs
             ->getEntity($this->entity->getEntityType())
             ->getRelation($relation);
 
@@ -320,7 +322,26 @@ class RDBRelations implements Relations
 
         if ($relationType === RelationType::BELONGS_TO) {
             $foreignEntityType = $defs->getForeignEntityType();
+            $nameAttribute = $relation . 'Name';
             $id = $this->entity->get($relation . 'Id');
+            $name = $this->entity->get($nameAttribute);
+
+            if (
+                $id &&
+                $name === null &&
+                $this->entity->hasAttribute($nameAttribute) &&
+                $this->entity->has($nameAttribute)
+            ) {
+                $hasDeleted = $this->defs
+                    ->getEntity($foreignEntityType)
+                    ->hasAttribute(Attribute::DELETED);
+
+                if ($hasDeleted) {
+                    // Could be either soft-deleted or have name set to null.
+                    // We resort to not using a partially loaded entity.
+                    return null;
+                }
+            }
         } else if ($relationType === RelationType::BELONGS_TO_PARENT) {
             $foreignEntityType = $this->entity->get($relation . 'Type');
             $id = $this->entity->get($relation . 'Id');

schema/metadata/entityDefs.json

@@ -1346,7 +1346,7 @@
                         "properties": {
                             "deferredLoad": {
                                 "type": "boolean",
-                                "description": "When getting a related entity from an entity, it will be returned without loaded values. Values will be loaded on accessing. The downside is that it can return an entity even if it's deleted."
+                                "description": "When getting a related entity from an entity, it will be returned without loaded values. Values will be loaded on accessing. For belongsToParent there's the downside that it can return an entity even if it's deleted."
                             }
                         }
                     }

tests/integration/Espo/ORM/RelationsTest.php

@@ -37,7 +37,6 @@ use Espo\Modules\Crm\Entities\Opportunity;
 use Espo\ORM\Repository\Option\SaveOption;
 use tests\integration\Core\BaseTestCase;
 use tests\integration\testClasses\Entities\Account as AccountExtended;
-use tests\integration\testClasses\Entities\Opportunity as OpportunityExtended;
 
 class RelationsTest extends BaseTestCase
 {
@@ -45,7 +44,11 @@ class RelationsTest extends BaseTestCase
     {
         $metadata = $this->getMetadata();
         $metadata->set('entityDefs', Opportunity::ENTITY_TYPE, [
-            'entityClassName' => OpportunityExtended::class,
+            'links' => [
+                'account' => [
+                    'deferredLoad' => true,
+                ],
+            ],
         ]);
         $metadata->save();
 
@@ -54,8 +57,8 @@ class RelationsTest extends BaseTestCase
         $em = $this->getEntityManager();
 
         $opp = $em->getNewEntity(Opportunity::ENTITY_TYPE);
-        $this->assertInstanceOf(OpportunityExtended::class, $opp);
-        $this->assertNull($opp->getRelatedAccount());
+        $this->assertInstanceOf(Opportunity::class, $opp);
+        $this->assertNull($opp->getAccount());
 
         /** @var Account $account */
         $account = $em->createEntity(Account::ENTITY_TYPE, ['name' => 'Account 1']);
@@ -64,16 +67,16 @@ class RelationsTest extends BaseTestCase
             'accountId' => $account->getId(),
         ]);
 
-        $this->assertInstanceOf(OpportunityExtended::class, $opp);
+        $this->assertInstanceOf(Opportunity::class, $opp);
 
-        $account1 = $opp->getRelatedAccount();
+        $account1 = $opp->getAccount();
 
         $this->assertInstanceOf(Account::class, $account1);
         $this->assertEquals($account->getId(), $account1->getId());
 
         $em->refreshEntity($opp);
 
-        $account2 = $opp->getRelatedAccount();
+        $account2 = $opp->getAccount();
 
         $this->assertInstanceOf(Account::class, $account2);
         $this->assertNotSame($account1, $account2);
@@ -82,11 +85,18 @@ class RelationsTest extends BaseTestCase
 
         $em->saveEntity($opp);
 
-        $account3 = $opp->getRelatedAccount();
+        $account3 = $opp->getAccount();
 
         $this->assertInstanceOf(Account::class, $account3);
         $this->assertNotSame($account1, $account3);
         $this->assertEquals($account->getId(), $account3->getId());
+
+        // Soft-deleted.
+
+        $em->removeEntity($account3);
+        $em->refreshEntity($opp);
+
+        $this->assertNull($opp->getAccount());
     }
 
     public function testGetMany(): void

tests/integration/testClasses/Entities/Opportunity.php

@@ -1,39 +0,0 @@
-<?php
-/************************************************************************
- * This file is part of EspoCRM.
- *
- * EspoCRM – Open Source CRM application.
- * Copyright (C) 2014-2024 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
- * Website: https://www.espocrm.com
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- *
- * The interactive user interfaces in modified source and object code versions
- * of this program must display Appropriate Legal Notices, as required under
- * Section 5 of the GNU Affero General Public License version 3.
- *
- * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
- * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
- ************************************************************************/
-
-namespace tests\integration\testClasses\Entities;
-
-class Opportunity extends \Espo\Modules\Crm\Entities\Opportunity
-{
-    public function getRelatedAccount(): ?\Espo\Modules\Crm\Entities\Account
-    {
-        /** @var ?\Espo\Modules\Crm\Entities\Account */
-        return $this->relations->getOne('account');
-    }
-}