Merge branch '5.1' of github.com:thecodingmachine/tdbm into merge51

Author: moufmouf

.travis.yml

@@ -1,12 +1,12 @@
 language: php
 php:
-- 7.1
+  - 7.1
 cache:
   directories:
     - $HOME/.composer/cache
 matrix:
   include:
-    - php: 7.2
+    - php: 7.4
       env: PREFER_LOWEST="" DB=mysql RUN_PHPSTAN=1 RUN_CSCHECK=1 RUN_REQUIRECHECKER=1 RUN_PERF_TEST=1
       services:
         - mysql
@@ -26,7 +26,7 @@ matrix:
       env: PREFER_LOWEST="" DB=mysql8
       sudo: required
       services:
-      - docker
+        - docker
     - php: 7.2
       env: PREFER_LOWEST="" DB=mariadb
       addons:
@@ -64,45 +64,45 @@ matrix:
       env: PREFER_LOWEST="--prefer-lowest" DB=oracle PHPUNITFILE="-c phpunit.oracle.xml"
 env:
   global:
-  - GIT_NAME: "'Couscous auto deploy'"
-  - GIT_EMAIL: [email protected]
-  - GH_REF: github.com/thecodingmachine/tdbm
-  - secure: pAdXEBkhe0KJbbZEP61lcZzvKKMkVK2RDIZTf1RzjQRgk+PxIG5JLBiHKuvG3MgtFjZbdtl2Vf6nAZbeMyy3H0eCryQCjjqdb5mS3eDekJ4WwviN6hQDc7+Xw6R1saHvDvJs9GQENUzHPWfAfY7LuwUgHXdc+BCLZmV+j0H6liZMNlXIYqP1kdwl7u5a/Y3FvXFws6R7A0giUBCb4HOYkInaXV0yzuAEsB6XBDbTjw3EqI0GBs6746O4tn7NOGaFlFSZan6RZe6jEkw7A+U3xLCfFnIN2q1uk/tk511KkOcSFQyGKRMDSKRDesdMQaOt/ze14+t+ISTqOSn8bUrCBhpj4VsjvzZE0FOS3WWGXpayODqdxuDjacwCZwiOHG7FWbwyQ3APiIrfO82ABbI8HoJURbgOb/Qnl2iPg9tCcvDqhsHxppGq5oOyhBq+GGtucOTW6lO6QnlMaez4nJJ7a3cn8WJB6NxaCZLii3aOXSLMahzFCcQxtq9/WfKwbOtf4GWUSLk28kDMov5h7tzuuHXmzOivzRxztQ9WC2GT7eMCIL8mvWFRMNiLJTE03J0ZbQDZ9N4OU3tdcgjV+d6pU6bu4SrCFtjCJnLaeLfIjoHkx+kK+kyCOQpOcuHMM6zq8l+ztd7VGZ3Br8HJTs1CxiWXrs+JIx2i8V06IE8nLKA=
+    - GIT_NAME: "'Couscous auto deploy'"
+    - GIT_EMAIL: [email protected]
+    - GH_REF: github.com/thecodingmachine/tdbm
+    - secure: pAdXEBkhe0KJbbZEP61lcZzvKKMkVK2RDIZTf1RzjQRgk+PxIG5JLBiHKuvG3MgtFjZbdtl2Vf6nAZbeMyy3H0eCryQCjjqdb5mS3eDekJ4WwviN6hQDc7+Xw6R1saHvDvJs9GQENUzHPWfAfY7LuwUgHXdc+BCLZmV+j0H6liZMNlXIYqP1kdwl7u5a/Y3FvXFws6R7A0giUBCb4HOYkInaXV0yzuAEsB6XBDbTjw3EqI0GBs6746O4tn7NOGaFlFSZan6RZe6jEkw7A+U3xLCfFnIN2q1uk/tk511KkOcSFQyGKRMDSKRDesdMQaOt/ze14+t+ISTqOSn8bUrCBhpj4VsjvzZE0FOS3WWGXpayODqdxuDjacwCZwiOHG7FWbwyQ3APiIrfO82ABbI8HoJURbgOb/Qnl2iPg9tCcvDqhsHxppGq5oOyhBq+GGtucOTW6lO6QnlMaez4nJJ7a3cn8WJB6NxaCZLii3aOXSLMahzFCcQxtq9/WfKwbOtf4GWUSLk28kDMov5h7tzuuHXmzOivzRxztQ9WC2GT7eMCIL8mvWFRMNiLJTE03J0ZbQDZ9N4OU3tdcgjV+d6pU6bu4SrCFtjCJnLaeLfIjoHkx+kK+kyCOQpOcuHMM6zq8l+ztd7VGZ3Br8HJTs1CxiWXrs+JIx2i8V06IE8nLKA=
 before_script:
-- composer update --prefer-dist
-# For some reason, $PREFER_LOWEST will fail unless a composer update has been run before...
-- if [ "$PREFER_LOWEST" = "--prefer-lowest" ] ; then composer update --prefer-dist --prefer-lowest; fi
-- if [ -z "$NO_WEAKREF" ] ; then pecl install weakref-beta; fi
+  - composer update --prefer-dist
+  # For some reason, $PREFER_LOWEST will fail unless a composer update has been run before...
+  - if [ "$PREFER_LOWEST" = "--prefer-lowest" ] ; then composer update --prefer-dist --prefer-lowest; fi
+  - if [ -z "$NO_WEAKREF" ] ; then pecl install weakref-beta; fi
 script:
-# Let's run the Oracle script only when the password is available (it is not available in forks unfortunately)
-- |
-  if [[ "$COVERALLS" != "true" ]] ; then export NO_COVERAGE="--no-coverage"; fi;
-  if [ "$DB" == "oracle" ] ; then
-    docker run -v $(pwd):/app -v $(pwd)/tests/Fixtures/oracle-startup.sql:/docker-entrypoint-initdb.d/oracle-startup.sql moufmouf/oracle-xe-php vendor/bin/phpunit $PHPUNITFILE $NO_COVERAGE;
-  elif [ "$DB" == "mysql8" ] ; then
-    sudo /etc/init.d/mysql stop;
-    tests/phpunit-mysql8.sh
-  else
-    echo ./vendor/bin/phpunit $PHPUNITFILE $NO_COVERAGE;
-    ./vendor/bin/phpunit $PHPUNITFILE $NO_COVERAGE;
-  fi
-- |
-  if [ "$RUN_CSCHECK" == "1" ] ; then
-    composer cscheck
-  fi
-- |
-  if [ "$RUN_PHPSTAN" == "1" ] ; then
-    composer phpstan
-  fi
-- |
-  if [ "$RUN_REQUIRECHECKER" == "1" ] ; then
-    composer require-checker
-  fi
-- |
-  if [ "$RUN_PERF_TEST" == "1" ] ; then
-    echo "***** Running PHPBENCH on current branch *****" && \
-    ./phpbench.dist.sh run --tag=current_pr --store
-  fi
+  # Let's run the Oracle script only when the password is available (it is not available in forks unfortunately)
+  - |
+    if [[ "$COVERALLS" != "true" ]] ; then export NO_COVERAGE="--no-coverage"; fi;
+    if [ "$DB" == "oracle" ] ; then
+      docker run -v $(pwd):/app -v $(pwd)/tests/Fixtures/oracle-startup.sql:/docker-entrypoint-initdb.d/oracle-startup.sql moufmouf/oracle-xe-php vendor/bin/phpunit $PHPUNITFILE $NO_COVERAGE;
+    elif [ "$DB" == "mysql8" ] ; then
+      sudo /etc/init.d/mysql stop;
+      tests/phpunit-mysql8.sh
+    else
+      echo ./vendor/bin/phpunit $PHPUNITFILE $NO_COVERAGE;
+      ./vendor/bin/phpunit $PHPUNITFILE $NO_COVERAGE;
+    fi
+  - |
+    if [ "$RUN_CSCHECK" == "1" ] ; then
+      composer cscheck
+    fi
+  - |
+    if [ "$RUN_PHPSTAN" == "1" ] ; then
+      composer phpstan
+    fi
+  - |
+    if [ "$RUN_REQUIRECHECKER" == "1" ] ; then
+      composer require-checker
+    fi
+  - |
+    if [ "$RUN_PERF_TEST" == "1" ] ; then
+      echo "***** Running PHPBENCH on current branch *****" && \
+      ./phpbench.dist.sh run --tag=current_pr --store
+    fi
 after_success:
   - |
     if [ "$RUN_PERF_TEST" == "1" ] && [ "${TRAVIS_PULL_REQUEST_BRANCH:-$TRAVIS_BRANCH}" != "master" ] ; then
@@ -114,5 +114,5 @@ after_success:
       ./phpbench.dist.sh report --uuid=tag:current_pr --uuid=tag:master --report='{extends: compare, compare: tag}'
     fi
 after_script:
-- if [ "$COVERALLS" = "true" ] ; then ./vendor/bin/php-coveralls -v; fi
-- if [ "$COVERALLS" = "true" ] ; then vendor/bin/couscous travis-auto-deploy --php-version=7.2 -vvv; fi
+  - if [ "$COVERALLS" = "true" ] ; then ./vendor/bin/php-coveralls -v; fi
+  - if [ "$COVERALLS" = "true" ] ; then vendor/bin/couscous travis-auto-deploy --php-version=7.2 -vvv; fi

composer-require-checker.json

@@ -3,7 +3,7 @@
     "null", "true", "false",
     "static", "self", "parent",
     "array", "string", "int", "float", "bool", "iterable", "callable", "void", "object",
-    "WeakRef",
+    "WeakRef", "WeakReference",
     "TheCodingMachine\\TDBM\\Fixtures\\Interfaces\\TestUserDaoInterface",
     "TheCodingMachine\\TDBM\\Fixtures\\Traits\\TestUserDaoTrait",
     "TheCodingMachine\\TDBM\\Fixtures\\Interfaces\\TestUserInterface",

phpstan.neon

@@ -13,6 +13,10 @@ parameters:
      #- "#expects array<string>, array<int, int|string> given.#"
      - "/Parameter #. \\$types of method Doctrine\\\\DBAL\\\\Connection::.*() expects array<int|string>, array<int, Doctrine\\\\DBAL\\\\Types\\\\Type> given./"
      - "#Method TheCodingMachine\\\\TDBM\\\\Schema\\\\ForeignKey::.*() should return .* but returns array<string>|string.#"
+     - '#Method TheCodingMachine\\TDBM\\NativeWeakrefObjectStorage::get\(\) should return TheCodingMachine\\TDBM\\DbRow\|null but returns object\|null.#'
+     -
+             message: '#WeakRef#'
+             path: src/WeakrefObjectStorage.php
      -
         message: '#Result of && is always false.#'
         path: src/Test/Dao/Bean/Generated/ArticleBaseBean.php

src/NativeWeakrefObjectStorage.php

@@ -0,0 +1,107 @@
+<?php
+declare(strict_types=1);
+
+/*
+ Copyright (C) 2006-2014 David Négrier - THE CODING MACHINE
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+namespace TheCodingMachine\TDBM;
+
+use WeakReference;
+
+/**
+ * The NativeWeakrefObjectStorage class is used to reference all beans that have been fetched from the database.
+ * If a bean is requested twice from TDBM, the NativeWeakrefObjectStorage is used to "cache" the bean.
+ * Unlike the StandardObjectStorage, the NativeWeakrefObjectStorage manages memory in a clever way, using WeakReference.
+ * WeakReference have been added in PHP 7.4.
+ *
+ * @author David Negrier
+ */
+class NativeWeakrefObjectStorage implements ObjectStorageInterface
+{
+    /**
+     * An array of fetched object, accessible via table name and primary key.
+     * If the primary key is split on several columns, access is done by an array of columns, serialized.
+     *
+     * @var WeakReference[][]
+     */
+    private $objects = array();
+
+    /**
+     * Every 10000 set in the dataset, we perform a cleanup to ensure the WeakRef instances
+     * are removed if they are no more valid.
+     * This is to avoid having memory used by dangling WeakRef instances.
+     *
+     * @var int
+     */
+    private $garbageCollectorCount = 0;
+
+    /**
+     * Sets an object in the storage.
+     *
+     * @param string $tableName
+     * @param string|int $id
+     * @param DbRow  $dbRow
+     */
+    public function set(string $tableName, $id, DbRow $dbRow): void
+    {
+        $this->objects[$tableName][$id] = WeakReference::create($dbRow);
+        ++$this->garbageCollectorCount;
+        if ($this->garbageCollectorCount === 10000) {
+            $this->garbageCollectorCount = 0;
+            $this->cleanupDanglingWeakRefs();
+        }
+    }
+
+    /**
+     * Returns an object from the storage (or null if no object is set).
+     *
+     * @param string $tableName
+     * @param string|int $id
+     *
+     * @return DbRow|null
+     */
+    public function get(string $tableName, $id) : ?DbRow
+    {
+        if (isset($this->objects[$tableName][$id])) {
+            return $this->objects[$tableName][$id]->get();
+        }
+        return null;
+    }
+
+    /**
+     * Removes an object from the storage.
+     *
+     * @param string $tableName
+     * @param string|int $id
+     */
+    public function remove(string $tableName, $id): void
+    {
+        unset($this->objects[$tableName][$id]);
+    }
+
+    private function cleanupDanglingWeakRefs(): void
+    {
+        foreach ($this->objects as $tableName => $table) {
+            foreach ($table as $id => $obj) {
+                if ($obj->get() === null) {
+                    unset($this->objects[$tableName][$id]);
+                }
+            }
+        }
+    }
+}

src/TDBMService.php

@@ -21,6 +21,7 @@
 
 namespace TheCodingMachine\TDBM;
 
+use function class_exists;
 use Doctrine\Common\Cache\Cache;
 use Doctrine\Common\Cache\ClearableCache;
 use Doctrine\Common\Cache\VoidCache;
@@ -46,7 +47,7 @@
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
 use Psr\Log\NullLogger;
-use function var_export;
+use WeakReference;
 
 /**
  * The TDBMService class is the main TDBM class. It provides methods to retrieve TDBMObject instances
@@ -101,7 +102,7 @@ class TDBMService
      * Access is done by table name and then by primary key.
      * If the primary key is split on several columns, access is done by an array of columns, serialized.
      *
-     * @var StandardObjectStorage|WeakrefObjectStorage
+     * @var ObjectStorageInterface
      */
     private $objectStorage;
 
@@ -179,7 +180,9 @@ class TDBMService
      */
     public function __construct(ConfigurationInterface $configuration)
     {
-        if (extension_loaded('weakref')) {
+        if (class_exists(WeakReference::class)) {
+            $this->objectStorage = new NativeWeakrefObjectStorage();
+        } elseif (extension_loaded('weakref')) {
             $this->objectStorage = new WeakrefObjectStorage();
         } else {
             $this->objectStorage = new StandardObjectStorage();

src/WeakrefObjectStorage.php

@@ -26,7 +26,9 @@
  * If a bean is requested twice from TDBM, the WeakrefObjectStorage is used to "cache" the bean.
  * Unlike the StandardObjectStorage, the WeakrefObjectStorage manages memory in a clever way, using the weakref
  * PHP extension. It is used if the "weakref" extension is available.
- * Otherwise, the StandardObjectStorage is used instead.
+ * Otherwise, the StandardObjectStorage or NativeWeakrefObjectStorage (in PHP 7.4+) is used instead.
+ *
+ * Note: the weakref extension is available until PHP 7.2, but not available in PHP 7.3+
  *
  * @author David Negrier
  */

tests/TDBMDaoGeneratorTest.php

@@ -1852,7 +1852,6 @@ public function testFilterBag(): void
     public function testDecimalIsMappedToString(): void
     {
         $reflectionClass = new \ReflectionClass(BoatBaseBean::class);
-        /** @var ReflectionNamedType $nameParam */
         $this->assertSame('string', $reflectionClass->getMethod('getLength')->getReturnType()->getName());
     }