Merge pull request #157 from TheDMSGroup/ENG-1030-bigint-ids

[ENG-1030] Upgrade IDs to Bigint where appropriate.

Author: Heath Dutton ☕

Entity/BigIntUnsignedTrait.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * @copyright   2018 Mautic Contributors. All rights reserved
+ * @author      Digital Media Solutions, LLC
+ *
+ * @link        http://mautic.org
+ *
+ * @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
+ */
+
+namespace MauticPlugin\MauticContactSourceBundle\Entity;
+
+use Doctrine\DBAL\Types\Type;
+use Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder;
+use Doctrine\ORM\Mapping\ClassMetadata;
+
+trait BigIntUnsignedTrait
+{
+    /**
+     * Adds autogenerated ID field type of BIGINT UNSIGNED.
+     *
+     * @param ClassMetadataBuilder $builder
+     * @param string               $fieldName
+     * @param string               $columnName
+     * @param bool                 $isPrimary
+     * @param bool                 $isNullable
+     */
+    public static function addBigIntUnsignedIdField(
+        ClassMetadataBuilder $builder,
+        $fieldName = 'id',
+        $columnName = 'id',
+        $isPrimary = true,
+        $isNullable = false
+    ) {
+        $cm = $builder->getClassMetadata();
+        $cm->mapField(
+            [
+                'fieldName'  => $fieldName,
+                'columnName' => $columnName,
+                'id'         => $isPrimary,
+                'nullable'   => $isNullable,
+                'type'       => Type::BIGINT,
+                'options'    => [
+                    'unsigned' => true,
+                ],
+            ]
+        );
+        if ($isPrimary) {
+            $cm->setIdGeneratorType(ClassMetadata::GENERATOR_TYPE_AUTO);
+        }
+    }
+}

Entity/Cache.php

@@ -25,6 +25,8 @@
  */
 class Cache
 {
+    use BigIntUnsignedTrait;
+
     /** @var int $id */
     private $id;
 
@@ -88,7 +90,7 @@ public static function loadMetadata(ORM\ClassMetadata $metadata)
     {
         $builder = new ClassMetadataBuilder($metadata);
 
-        $builder->addId();
+        self::addBigIntUnsignedIdField($builder);
 
         $builder->setTable('contactsource_cache');
 

Entity/Event.php

@@ -20,6 +20,8 @@
  */
 class Event
 {
+    use BigIntUnsignedTrait;
+
     /**
      * @ORM\Column(name="id", type="integer")
      * @ORM\Id
@@ -83,7 +85,7 @@ public static function loadMetadata(ORM\ClassMetadata $metadata)
             ->addIndex(['contactsource_id', 'date_added'], 'contactsource_id_date_added')
             ->addIndex(['contact_id'], 'contact_id');
 
-        $builder->addId();
+        self::addBigIntUnsignedIdField($builder);
 
         $builder->createManyToOne('contactSource', 'ContactSource')
             ->addJoinColumn('contactsource_id', 'id', true, false, null)

Entity/Stat.php

@@ -22,6 +22,8 @@
  */
 class Stat
 {
+    use BigIntUnsignedTrait;
+
     /**
      * Real-time:     Indicates that the contact was accepted by one or more clients.
      * Not real-time: Indicates we accepted the contact outright.
@@ -132,7 +134,7 @@ public static function loadMetadata(ORM\ClassMetadata $metadata)
         $builder->setTable('contactsource_stats')
             ->setCustomRepositoryClass('MauticPlugin\MauticContactSourceBundle\Entity\StatRepository');
 
-        $builder->addId();
+        self::addBigIntUnsignedIdField($builder);
 
         $builder->createManyToOne('contactSource', 'ContactSource')
             ->addJoinColumn('contactsource_id', 'id', true, false, null)

Model/Api.php

@@ -931,7 +931,7 @@ private function createContact()
 
                 // Apply to the contact for save later.
                 $this->getUtmTag()->setLead($contact);
-                /** @var UtmTagRepository $utmRepo */
+                /* @var UtmTagRepository $utmRepo */
                 // Randomly causes Doctrine\ORM\ORMInvalidArgumentException in production.
                 // $utmRepo = $this->em->getRepository('MauticLeadBundle:UtmTag');
                 // $utmRepo->saveEntity($this->getUtmTag(), false);