Use a deterministic method to generate parameter names for filters, to allow for proper caching of queries

Author: jbtronics

src/DataTables/Filters/AttachmentFilter.php

@@ -22,6 +22,7 @@
  */
 namespace App\DataTables\Filters;
 
+use App\DataTables\Filters\Constraints\AbstractConstraint;
 use App\DataTables\Filters\Constraints\BooleanConstraint;
 use App\DataTables\Filters\Constraints\DateTimeConstraint;
 use App\DataTables\Filters\Constraints\EntityConstraint;
@@ -32,6 +33,7 @@
 use App\Entity\Attachments\AttachmentType;
 use App\Services\Trees\NodesListBuilder;
 use Doctrine\ORM\QueryBuilder;
+use Omines\DataTablesBundle\Filter\AbstractFilter;
 
 class AttachmentFilter implements FilterInterface
 {
@@ -51,6 +53,9 @@ class AttachmentFilter implements FilterInterface
 
     public function __construct(NodesListBuilder $nodesListBuilder)
     {
+        //Must be done for every new set of attachment filters, to ensure deterministic parameter names.
+        AbstractConstraint::resetParameterCounter();
+
         $this->dbId = new IntConstraint('attachment.id');
         $this->name = new TextConstraint('attachment.name');
         $this->targetType = new InstanceOfConstraint('attachment');

src/DataTables/Filters/Constraints/AbstractConstraint.php

@@ -28,10 +28,7 @@ abstract class AbstractConstraint implements FilterInterface
 {
     use FilterTrait;
 
-    /**
-     * @var string
-     */
-    protected string $identifier;
+    protected ?string $identifier;
 
 
     /**

src/DataTables/Filters/Constraints/FilterTrait.php

@@ -28,6 +28,7 @@ trait FilterTrait
 {
 
     protected bool $useHaving = false;
+    protected static int $parameterCounter = 0;
 
     public function useHaving($value = true): static
     {
@@ -50,8 +51,18 @@ protected function generateParameterIdentifier(string $property): string
     {
         //Replace all special characters with underscores
         $property = preg_replace('/\W/', '_', $property);
-        //Add a random number to the end of the property name for uniqueness
-        return $property . '_' . uniqid("", false);
+        return $property . '_' . (self::$parameterCounter++) . '_';
+    }
+
+    /**
+     * Resets the parameter counter, so the next call to generateParameterIdentifier will start from 0 again.
+     * This should be done before initializing a new set of filters to a fresh query builder, to ensure that the parameter
+     * identifiers are deterministic so that they are cacheable.
+     * @return void
+     */
+    public static function resetParameterCounter(): void
+    {
+        self::$parameterCounter = 0;
     }
 
     /**

src/DataTables/Filters/Constraints/Part/TagsConstraint.php

@@ -88,7 +88,7 @@ protected function getExpressionForTag(QueryBuilder $queryBuilder, string $tag):
         //Escape any %, _ or \ in the tag
         $tag = addcslashes($tag, '%_\\');
 
-        $tag_identifier_prefix = uniqid($this->identifier . '_', false);
+        $tag_identifier_prefix = $this->generateParameterIdentifier('tag');
 
         $expr = $queryBuilder->expr();
 

src/DataTables/Filters/LogFilter.php

@@ -22,6 +22,7 @@
  */
 namespace App\DataTables\Filters;
 
+use App\DataTables\Filters\Constraints\AbstractConstraint;
 use App\DataTables\Filters\Constraints\ChoiceConstraint;
 use App\DataTables\Filters\Constraints\DateTimeConstraint;
 use App\DataTables\Filters\Constraints\EntityConstraint;
@@ -44,6 +45,9 @@ class LogFilter implements FilterInterface
 
     public function __construct()
     {
+        //Must be done for every new set of attachment filters, to ensure deterministic parameter names.
+        AbstractConstraint::resetParameterCounter();
+
         $this->timestamp = new DateTimeConstraint('log.timestamp');
         $this->dbId = new IntConstraint('log.id');
         $this->level = new ChoiceConstraint('log.level');

src/DataTables/Filters/PartFilter.php

@@ -22,6 +22,7 @@
  */
 namespace App\DataTables\Filters;
 
+use App\DataTables\Filters\Constraints\AbstractConstraint;
 use App\DataTables\Filters\Constraints\BooleanConstraint;
 use App\DataTables\Filters\Constraints\ChoiceConstraint;
 use App\DataTables\Filters\Constraints\DateTimeConstraint;
@@ -103,6 +104,9 @@ class PartFilter implements FilterInterface
 
     public function __construct(NodesListBuilder $nodesListBuilder)
     {
+        //Must be done for every new set of attachment filters, to ensure deterministic parameter names.
+        AbstractConstraint::resetParameterCounter();
+
         $this->name = new TextConstraint('part.name');
         $this->description = new TextConstraint('part.description');
         $this->comment = new TextConstraint('part.comment');

src/DataTables/Filters/PartSearchFilter.php

@@ -21,6 +21,7 @@
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 namespace App\DataTables\Filters;
+use App\DataTables\Filters\Constraints\AbstractConstraint;
 use Doctrine\ORM\QueryBuilder;
 
 class PartSearchFilter implements FilterInterface