Merge pull request #2 from pfilsx/enum_remove_labels_support

pfilsx · web-flow · commit 84f15761b6f5 · 2023-03-05T13:36:22.000+03:00
Enum remove labels support
diff --git a/README.md b/README.md
@@ -1,11 +1,15 @@
 PostgreSQL Doctrine
 ==============
 
+[![Latest Stable Version](http://poser.pugx.org/pfilsx/postgresql-doctrine/v)](https://packagist.org/packages/pfilsx/postgresql-doctrine)
+[![PHP Version Require](http://poser.pugx.org/pfilsx/postgresql-doctrine/require/php)](https://packagist.org/packages/pfilsx/postgresql-doctrine)
+[![Total Downloads](http://poser.pugx.org/pfilsx/postgresql-doctrine/downloads)](https://packagist.org/packages/pfilsx/postgresql-doctrine)
+
 Description
 ------------
 
 Provides extended Doctrine DBAL and Doctrine migration classes to allow you to use PostgreSQL 
-specific features such as [enums](https://www.postgresql.org/docs/current/datatype-enum.html) with Doctrine.
+specific features such as [enums](https://www.postgresql.org/docs/current/datatype-enum.html) or JSON(B) with Doctrine.
 
 Features
 --------
@@ -36,4 +40,20 @@ Usage
 
 Please refer [Doctrine DBAL](https://www.doctrine-project.org/projects/doctrine-dbal/en/current/index.html) 
 and [Doctrine Migrations](https://www.doctrine-project.org/projects/doctrine-migrations/en/3.5/index.html)
-for instructions on how to override the default doctrine classes in your project.
+for instructions on how to override the default doctrine classes in your project.
+
+Required steps:
+1. Register [PostgreSQLDriverMiddleware.php](src/DBAL/Middleware/PostgreSQLDriverMiddleware.php) as driver middleware
+2. Register [OrmSchemaProvider.php](src/Migrations/Provider/OrmSchemaProvider.php) as Doctrine\Migrations\Provider\SchemaProvider in Doctrine\Migrations\DependencyFactory
+
+For Symfony integration see [PostgreSQLDoctrineBundle](https://github.com/pfilsx/PostgreSQLDoctrineBundle)
+
+Documentation
+-------------
+
+* [ENUMS](docs/ENUMS.md)
+
+License
+-------
+
+This bundle is released under the MIT license.
diff --git a/docs/ENUMS.md b/docs/ENUMS.md
@@ -0,0 +1,61 @@
+Overview
+========
+
+This package provides column type and extended DBAL classes for [PostgreSQL enums](https://www.postgresql.org/docs/current/datatype-enum.html) support for Doctrine and Doctrine migrations. 
+Column type is based on enumType option of Column attribute/annotation.
+
+Example
+--------
+
+```php 
+
+enum ExampleEnum: string 
+{
+    case Case1 = 'case_1';
+    case Case2 = 'case_2';
+}
+
+#[Entity]
+class Example
+{
+    /** ... */
+
+    #[Column(type: 'enum', enumType: ExampleEnum::class)]
+    public ExampleEnum $type;
+}
+```
+
+For the example above the doctrine migrations will generate migration with PostgreSQL enum type creation and column uses this type
+```php
+public function up(Schema $schema): void
+{
+    $this->addSql('CREATE TYPE example_enum_type AS ENUM(\'case_1\', \'case_2\')');
+    $this->addSql('COMMENT ON TYPE example_enum_type IS \'ExampleEnum\'');
+    
+    $this->addSql('CREATE TABLE example (..., type example_enum_type NOT NULL, ...)');
+    
+    /** ... */
+}
+
+public function down(Schema $schema): void
+{
+    /** ... */
+    
+    $this->addSql('DROP TABLE example');
+    $this->addSql('DROP TYPE example_enum_type');
+}
+```
+
+
+Supported actions in migrations
+-----------------
+
+1. Create new enums based on usages in entities
+2. Remove enums based on usages in entities
+3. Update existing enum by adding new labels
+4. Recreate existing enum for removing labels
+
+:warning: Attention :warning:
+
+Adding/removing labels to existing enums will generate SQL which may fail on execution if your tables use those labels.
+Be careful and control your data!
diff --git a/src/DBAL/Platform/PostgreSQLPlatform.php b/src/DBAL/Platform/PostgreSQLPlatform.php
@@ -23,13 +23,29 @@ public function createSchemaManager(Connection $connection): PostgreSQLSchemaMan
 
     public function getListEnumTypesSQL(): string
     {
-        return 'SELECT pg_type.typname AS name,
-                       pg_enum.enumlabel AS label,
-                       pg_description.description AS comment
-                FROM pg_type
-                JOIN pg_enum ON pg_enum.enumtypid = pg_type.oid
-                LEFT JOIN pg_description on pg_description.objoid = pg_type.oid
-                ORDER BY pg_enum.enumsortorder';
+        return 'WITH types AS (
+                    SELECT pg_type.typname            AS name,
+                           pg_enum.enumlabel          AS label,
+                           pg_enum.enumsortorder      AS label_order,
+                           pg_description.description AS comment,
+                           pg_class.relname           AS usage_table,
+                           pg_attribute.attname       AS usage_column,
+                           PG_GET_EXPR(pg_attrdef.adbin, pg_attrdef.adrelid) AS usage_default
+                    FROM pg_type
+                        JOIN pg_enum ON pg_enum.enumtypid = pg_type.oid
+                        LEFT JOIN pg_description ON pg_description.objoid = pg_type.oid
+                        LEFT JOIN pg_depend ON pg_depend.refobjid = pg_type.oid
+                        LEFT JOIN pg_class ON pg_class.oid = pg_depend.objid
+                        LEFT JOIN pg_attribute ON pg_attribute.attrelid = pg_class.oid AND pg_attribute.atttypid = pg_type.oid
+                        LEFT JOIN pg_attrdef ON pg_attrdef.adrelid = pg_class.oid AND pg_attrdef.adnum = pg_attribute.attnum
+                )
+                SELECT types.name,
+                       types.comment,
+                       JSON_AGG(DISTINCT JSONB_BUILD_OBJECT(\'label\', types.label, \'order\', types.label_order)) AS labels,
+                       JSON_AGG(DISTINCT JSONB_BUILD_OBJECT(\'table\', types.usage_table, \'column\', types.usage_column, \'default\', types.usage_default)) FILTER (WHERE types.usage_table IS NOT NULL AND types.usage_column IS NOT NULL) AS usages
+                FROM types
+                GROUP BY types.name, types.comment'
+            ;
     }
 
     /**
@@ -59,13 +75,48 @@ public function getAlterTypeSql(EnumTypeAsset $from, EnumTypeAsset $to): array
         $toLabels = $to->getLabels();
 
         $result = [];
+        $typeName = $to->getQuotedName($this);
+
         foreach (array_diff($toLabels, $fromLabels) as $label) {
-            $result[] = "ALTER TYPE {$to->getQuotedName($this)} ADD VALUE {$this->quoteEnumLabel($label)}";
+            $result[] = "ALTER TYPE {$typeName} ADD VALUE {$this->quoteEnumLabel($label)}";
         }
 
-        if (count(array_diff($fromLabels, $toLabels)) > 0) {
-            throw new Exception('Enum labels reduction is not supported in automatic generation');
+        $removedLabels = array_diff($fromLabels, $toLabels);
+
+        if (count($removedLabels) < 1) {
+            return $result;
         }
+        
+        $self = $this;
+
+        $result[] = "ALTER TYPE {$typeName} RENAME TO {$typeName}_old";
+        $result[] = $this->getCreateTypeSql($to);
+        $result[] = $this->getCommentOnTypeSql($to);
+
+        foreach ($to->getUsages() as $usage) {
+            $tableName = $this->quoteIdentifier($usage->getTable());
+            $columnName = $this->quoteIdentifier($usage->getColumn());
+            if (($default = $usage->getDefault()) !== null) {
+                $result[] = sprintf('ALTER TABLE %s ALTER COLUMN %s DROP DEFAULT', $tableName, $columnName);
+            }
+            $result[] = sprintf(
+                'ALTER TABLE %1$s ALTER COLUMN %2$s TYPE %3$s USING LOWER(%2$s::text)::%3$s',
+                $tableName,
+                $columnName,
+                $typeName
+            );
+
+            if ($default !== null) {
+                $result[] = sprintf(
+                    'ALTER TABLE %s ALTER COLUMN %s SET DEFAULT %s',
+                    $tableName,
+                    $columnName,
+                    $this->quoteEnumLabel($default)
+                );
+            }
+        }
+
+        $result[] = "DROP TYPE {$typeName}_old";
 
         return $result;
     }
diff --git a/src/DBAL/Schema/EnumTypeAsset.php b/src/DBAL/Schema/EnumTypeAsset.php
@@ -14,18 +14,23 @@
 final class EnumTypeAsset extends AbstractAsset
 {
     /**
-     * @var array<int|string>
+     * @var string[]
      */
     private array $labels;
     private string $enumClass;
+    /**
+     * @var EnumTypeUsageAsset[]
+     */
+    private array $usages;
 
     /**
      * @param string $name
      * @param string $className
-     * @param array<int|string> $labels
+     * @param string[] $labels
+     * @param EnumTypeUsageAsset[] $usages
      * @throws InvalidArgumentException
      */
-    public function __construct(string $name, string $className, array $labels = [])
+    public function __construct(string $name, string $className, array $labels = [], array $usages = [])
     {
         if ($name === '') {
             throw new InvalidArgumentException('Invalid custom type name specified');
@@ -34,24 +39,25 @@ public function __construct(string $name, string $className, array $labels = [])
         $this->_setName($name);
         $this->enumClass = $className;
         $this->labels = $labels;
+        $this->usages = $usages;
     }
 
     /**
      * @param class-string<EnumInterface|\UnitEnum> $className
      * @throws InvalidArgumentException
      * @return static
      */
-    public static function fromEnumClassName(string $className): self
+    public static function fromEnumClassName(string $name, string $className): self
     {
         return new self(
-            EnumTool::getEnumTypeNameFromClassName($className),
+            $name,
             $className,
             EnumTool::getEnumLabelsByClassName($className)
         );
     }
 
     /**
-     * @return array<int|string>
+     * @return string[]
      */
     public function getLabels(): array
     {
@@ -63,6 +69,21 @@ public function getEnumClass(): string
         return $this->enumClass;
     }
 
+    public function addUsage(EnumTypeUsageAsset $usage): self
+    {
+        $this->usages[] = $usage;
+
+        return $this;
+    }
+
+    /**
+     * @return EnumTypeUsageAsset[]
+     */
+    public function getUsages(): array
+    {
+        return $this->usages;
+    }
+
     /**
      * @param AbstractPlatform $platform
      * @throws InvalidArgumentException
diff --git a/src/DBAL/Schema/EnumTypeUsageAsset.php b/src/DBAL/Schema/EnumTypeUsageAsset.php
@@ -0,0 +1,35 @@
+<?php
+declare(strict_types=1);
+
+namespace Pfilsx\PostgreSQLDoctrine\DBAL\Schema;
+
+final class EnumTypeUsageAsset
+{
+    private string $table;
+
+    private string $column;
+
+    private ?string $default;
+
+    public function __construct(string $table, string $column, ?string $default = null)
+    {
+        $this->table = $table;
+        $this->column = $column;
+        $this->default = $default;
+    }
+
+    public function getTable(): string
+    {
+        return $this->table;
+    }
+
+    public function getColumn(): string
+    {
+        return $this->column;
+    }
+
+    public function getDefault(): ?string
+    {
+        return $this->default;
+    }
+}
diff --git a/src/DBAL/Schema/PostgreSQLSchemaManager.php b/src/DBAL/Schema/PostgreSQLSchemaManager.php
@@ -330,17 +330,29 @@ protected function _getPortableTableColumnDefinition($tableColumn): Column
 
     private function getPortableEnumTypesList(array $rawTypes): array
     {
-        $typeGroups = [];
-        foreach ($rawTypes as $rawType) {
-            $typeGroup = $typeGroups[$rawType['name']] ?? [];
-            $typeGroup['comment'] = $rawType['comment'];
-            $typeGroup['labels'][] = $rawType['label'];
-            $typeGroups[$rawType['name']] = $typeGroup;
-        }
-
         $list = [];
-        foreach ($typeGroups as $name => $typeGroup) {
-            $list[] = new EnumTypeAsset($name, $typeGroup['comment'], $typeGroup['labels']);
+        foreach ($rawTypes as $rawType) {
+            $labels = json_decode($rawType['labels'], true);
+            usort($labels, static fn (array $a, array $b) => $a['order'] <=> $b['order']);
+
+            $usages = json_decode($rawType['usages'], true);
+            foreach ($usages as &$usage) {
+                $default = $usage['default'] ?? null;
+                if ($default !== null) {
+                    $default = trim(explode('::', $default)[0], '\'');   
+                }
+                $usage['default'] = $default;
+            }
+            
+            $list[] = new EnumTypeAsset(
+                $rawType['name'],
+                $rawType['comment'],
+                array_column($labels, 'label'),
+                array_map(
+                    static fn (array $usage) => new EnumTypeUsageAsset($usage['table'], $usage['column'], $usage['default']),
+                    $usages
+                )
+            );
         }
 
         return $list;
diff --git a/src/DBAL/Schema/Schema.php b/src/DBAL/Schema/Schema.php
diff --git a/src/Tools/EnumTool.php b/src/Tools/EnumTool.php
diff --git a/src/Tools/SchemaTool.php b/src/Tools/SchemaTool.php
