Merge pull request #134 from moufmouf/cache_findObjectsQueryFactory_5.1

Porting perf improvement to 5.1

Author: moufmouf

composer.json

@@ -19,7 +19,7 @@
     ],
     "require" : {
         "php" : ">=7.1",
-        "mouf/magic-query" : "^1.2.8",
+        "mouf/magic-query" : "^1.3.0",
         "mouf/schema-analyzer": "^1.1.4",
         "doctrine/dbal": "^2.9.2",
         "psr/log": "~1.0",

src/InnerResultIterator.php

@@ -7,6 +7,7 @@
 use Doctrine\DBAL\Statement;
 use Mouf\Database\MagicQuery;
 use Psr\Log\LoggerInterface;
+use TheCodingMachine\TDBM\Utils\DbalUtils;
 
 /*
  Copyright (C) 2006-2017 David Négrier - THE CODING MACHINE
@@ -85,7 +86,7 @@ public function __construct(string $magicSql, array $parameters, ?int $limit, ?i
 
     private function getQuery(): string
     {
-        $sql = $this->magicQuery->build($this->magicSql, $this->parameters);
+        $sql = $this->magicQuery->buildPreparedStatement($this->magicSql, $this->parameters);
         $sql = $this->tdbmService->getConnection()->getDatabasePlatform()->modifyLimitQuery($sql, $this->limit, $this->offset);
         return $sql;
     }
@@ -96,7 +97,7 @@ protected function executeQuery(): void
 
         $this->logger->debug('Running SQL request: '.$sql);
 
-        $this->statement = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters);
+        $this->statement = $this->tdbmService->getConnection()->executeQuery($sql, $this->parameters, DbalUtils::generateArrayTypes($this->parameters));
 
         $this->fetchStarted = true;
     }

src/QueryFactory/FindObjectsQueryFactory.php

@@ -3,6 +3,7 @@
 
 namespace TheCodingMachine\TDBM\QueryFactory;
 
+use Doctrine\Common\Cache\Cache;
 use Doctrine\DBAL\Platforms\MySqlPlatform;
 use Doctrine\DBAL\Schema\Schema;
 use TheCodingMachine\TDBM\OrderByAnalyzer;
@@ -16,17 +17,32 @@ class FindObjectsQueryFactory extends AbstractQueryFactory
     private $mainTable;
     private $additionalTablesFetch;
     private $filterString;
+    /**
+     * @var Cache
+     */
+    private $cache;
 
-    public function __construct(string $mainTable, array $additionalTablesFetch, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer)
+    public function __construct(string $mainTable, array $additionalTablesFetch, $filterString, $orderBy, TDBMService $tdbmService, Schema $schema, OrderByAnalyzer $orderByAnalyzer, Cache $cache)
     {
         parent::__construct($tdbmService, $schema, $orderByAnalyzer, $orderBy);
         $this->mainTable = $mainTable;
         $this->additionalTablesFetch = $additionalTablesFetch;
         $this->filterString = $filterString;
+        $this->cache = $cache;
     }
 
     protected function compute(): void
     {
+        $key = 'FindObjectsQueryFactory_'.$this->mainTable.'__'.implode('_/_',$this->additionalTablesFetch).'__'.$this->filterString.'__'.$this->orderBy;
+        if ($this->cache->contains($key)) {
+            [
+                $this->magicSql,
+                $this->magicSqlCount,
+                $this->columnDescList
+            ] = $this->cache->fetch($key);
+            return;
+        }
+
         list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($this->mainTable, $this->additionalTablesFetch, $this->orderBy, true);
 
         $sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$this->mainTable.')';
@@ -54,5 +70,11 @@ protected function compute(): void
         $this->magicSql = $sql;
         $this->magicSqlCount = $countSql;
         $this->columnDescList = $columnDescList;
+
+        $this->cache->save($key, [
+            $this->magicSql,
+            $this->magicSqlCount,
+            $this->columnDescList,
+        ]);
     }
 }

src/ResultIterator.php

@@ -3,11 +3,16 @@
 
 namespace TheCodingMachine\TDBM;
 
+use function array_map;
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Statement;
+use function is_array;
+use function is_int;
 use Mouf\Database\MagicQuery;
 use TheCodingMachine\TDBM\QueryFactory\QueryFactory;
 use Porpaginas\Result;
 use Psr\Log\LoggerInterface;
+use TheCodingMachine\TDBM\Utils\DbalUtils;
 use Traversable;
 
 /*
@@ -82,9 +87,9 @@ public function __construct(QueryFactory $queryFactory, array $parameters, Objec
 
     protected function executeCountQuery(): void
     {
-        $sql = $this->magicQuery->build($this->queryFactory->getMagicSqlCount(), $this->parameters);
+        $sql = $this->magicQuery->buildPreparedStatement($this->queryFactory->getMagicSqlCount(), $this->parameters);
         $this->logger->debug('Running count query: '.$sql);
-        $this->totalCount = (int) $this->tdbmService->getConnection()->fetchColumn($sql, $this->parameters);
+        $this->totalCount = (int) $this->tdbmService->getConnection()->fetchColumn($sql, $this->parameters, 0, DbalUtils::generateArrayTypes($this->parameters));
     }
 
     /**

src/TDBMService.php

@@ -403,7 +403,7 @@ public function buildFilterFromFilterBag($filter_bag, AbstractPlatform $platform
                 } else {
                     $paramName = 'tdbmparam'.$counter;
                     if (is_array($value)) {
-                        $sqlParts[] = $platform->quoteIdentifier($column).' IN :'.$paramName;
+                        $sqlParts[] = $platform->quoteIdentifier($column).' IN (:'.$paramName.')';
                     } else {
                         $sqlParts[] = $platform->quoteIdentifier($column).' = :'.$paramName;
                     }
@@ -1134,7 +1134,7 @@ public function findObjects(string $mainTable, $filter = null, array $parameters
 
         $parameters = array_merge($parameters, $additionalParameters);
 
-        $queryFactory = new FindObjectsQueryFactory($mainTable, $additionalTablesFetch, $filterString, $orderString, $this, $this->tdbmSchemaAnalyzer->getSchema(), $this->orderByAnalyzer);
+        $queryFactory = new FindObjectsQueryFactory($mainTable, $additionalTablesFetch, $filterString, $orderString, $this, $this->tdbmSchemaAnalyzer->getSchema(), $this->orderByAnalyzer, $this->cache);
 
         return new ResultIterator($queryFactory, $parameters, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
     }

src/UncheckedOrderBy.php

@@ -35,4 +35,12 @@ public function getOrderBy() : string
     {
         return $this->orderBy;
     }
+
+    /**
+     * @return string
+     */
+    public function __toString()
+    {
+        return 'UncheckedOrderBy_'.$this->orderBy;
+    }
 }

src/Utils/DbalUtils.php

@@ -0,0 +1,38 @@
+<?php
+
+
+namespace TheCodingMachine\TDBM\Utils;
+
+use Doctrine\DBAL\Connection;
+use function is_array;
+use function is_int;
+
+/**
+ * Utility class to ease the use of DBAL types.
+ */
+class DbalUtils
+{
+    /**
+     * If a parameter is an array (used in a "IN" statement), we need to tell Doctrine about it.
+     * @see https://www.doctrine-project.org/projects/doctrine-dbal/en/2.9/reference/data-retrieval-and-manipulation.html#list-of-parameters-conversion
+     * @param array<string, mixed> $parameters
+     * @return array<string, int>
+     */
+    public static function generateArrayTypes(array $parameters): array
+    {
+        $types = [];
+        foreach ($parameters as $key => $value) {
+            if (is_array($value)) {
+                foreach ($value as $val) {
+                    if (!is_int($val)) {
+                        $types[$key] = Connection::PARAM_STR_ARRAY;
+                        continue 2;
+                    }
+                }
+                $types[$key] = Connection::PARAM_INT_ARRAY;
+            }
+        }
+
+        return $types;
+    }
+}

tests/Utils/DbalUtilsTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace TheCodingMachine\TDBM\Utils;
+
+use Doctrine\DBAL\Connection;
+use PHPUnit\Framework\TestCase;
+
+class DbalUtilsTest extends TestCase
+{
+
+    public function testGenerateArrayTypes()
+    {
+        $params = [
+            'key1' => 'foo',
+            'key2' => [1,2,3],
+            'key3' => [1,2,'baz'],
+        ];
+
+        $this->assertSame(['key2'=>Connection::PARAM_INT_ARRAY, 'key3'=>Connection::PARAM_STR_ARRAY], DbalUtils::generateArrayTypes($params));
+    }
+}