Merge pull request #12276 from eileenmcnaughton/memory_more

CRM-19798 fix memory leak on EntityTag.get & other calls in the DB (generic fix)

CRM/Contact/BAO/Contact.php

@@ -1022,10 +1022,6 @@ public static function deleteContact($id, $restore = FALSE, $skipUndelete = FALS
       CRM_Utils_Hook::post('delete', $contactType, $contact->id, $contact);
     }
 
-    // also reset the DB_DO global array so we can reuse the memory
-    // http://issues.civicrm.org/jira/browse/CRM-4387
-    CRM_Core_DAO::freeResult();
-
     return TRUE;
   }
 

CRM/Contact/Import/Parser.php

@@ -275,9 +275,6 @@ public function run(
         break;
       }
 
-      // clean up memory from dao's
-      CRM_Core_DAO::freeResult();
-
       // see if we've hit our timeout yet
       /* if ( $the_thing_with_the_stuff ) {
       do_something( );

CRM/Core/BAO/RecurringEntity.php

@@ -660,7 +660,6 @@ static public function triggerUpdate($event) {
         }
 
         $updateDAO = CRM_Core_DAO::cascadeUpdate($daoName, $obj->id, $entityID, $skipData);
-        CRM_Core_DAO::freeResult();
       }
       else {
         CRM_Core_Error::fatal("DAO Mapper missing for $entityTable.");

CRM/Core/DAO.php

@@ -48,6 +48,13 @@
  */
 class CRM_Core_DAO extends DB_DataObject {
 
+  /**
+   * How many times has this instance been cloned.
+   *
+   * @var int
+   */
+  protected $resultCopies = 0;
+
   /**
    * @var null
    * @deprecated
@@ -119,6 +126,22 @@ public function __construct() {
     $this->__table = $this->getTableName();
   }
 
+  public function __clone() {
+    if (!empty($this->_DB_resultid)) {
+      $this->resultCopies++;
+    }
+  }
+
+  /**
+   * Class destructor.
+   */
+  public function __destruct() {
+    if ($this->resultCopies === 0) {
+      $this->free();
+    }
+    $this->resultCopies--;
+  }
+
   /**
    * Empty definition for virtual function.
    */

CRM/Dedupe/Merger.php

@@ -1457,7 +1457,6 @@ public static function getRowsElementsAndInfo($mainId, $otherId, $checkPermissio
     $otherTree = CRM_Core_BAO_CustomGroup::getTree($main['contact_type'], NULL, $otherId, -1,
       CRM_Utils_Array::value('contact_sub_type', $other), NULL, TRUE, NULL, TRUE, $checkPermissions
     );
-    CRM_Core_DAO::freeResult();
 
     foreach ($otherTree as $gid => $group) {
       $foundField = FALSE;
@@ -2328,8 +2327,6 @@ protected static function dedupePair(&$migrationInfo, &$resultStats, &$deletedCo
       // pair may have been flipped, so make sure we delete using both orders
       CRM_Core_BAO_PrevNextCache::deletePair($mainId, $otherId, $cacheKeyString, TRUE);
     }
-
-    CRM_Core_DAO::freeResult();
   }
 
 }

tests/phpunit/CRM/Core/DAOTest.php

@@ -433,4 +433,18 @@ public function testFieldSerialization($method, $sampleData) {
     }
   }
 
+  /**
+   * Test the DAO cloning method does not hit issues with freeing the result.
+   */
+  public function testCloneDAO() {
+    $dao = CRM_Core_DAO::executeQuery('SELECT * FROM civicrm_domain');
+    $i = 0;
+    while ($dao->fetch()) {
+      $i++;
+      $cloned = clone($dao);
+      unset($cloned);
+    }
+    $this->assertEquals(2, $i);
+  }
+
 }

tests/phpunit/api/v3/EntityTagTest.php

@@ -139,6 +139,19 @@ public function testIndividualEntityTagGet() {
     $this->callAPIAndDocument('entity_tag', 'get', $paramsEntity, __FUNCTION__, __FILE__);
   }
 
+  /**
+   * Test memory usage does not escalate crazily.
+   */
+  public function testMemoryLeak() {
+    $start = memory_get_usage();
+    for ($i = 0; $i < 100; $i++) {
+      $this->callAPISuccess('EntityTag', 'get', []);
+      $memUsage = memory_get_usage();
+    }
+    $max = $start + 2000000;
+    $this->assertTrue($memUsage < $max, "mem usage ( $memUsage ) should be less than $max (start was $start) ");
+  }
+
   /**
    * Test tag can be added to a household.
    */