Enum support #6347

bigfoot90 · 2024-03-22T00:21:43Z

I'm migrating a project to DBAL 4.
This is initial support for native ENUM type.
A custom mapping type is used in the ORM side.

Q	A
Type	feature
Fixed issues	--

Summary

This change allows to track ENUM members in order to be able to generate right migration.

If this is welcome and you like it, I can continue to work on this feature adding some tests

derrabus · 2024-03-22T07:49:07Z

Thank you for your contribution. However, we don't merge any changes that aren't covered by tests.

derrabus

Your feature is not tested against any database. Please have a look at our existing functional tests and add some that cover your feature.

bigfoot90 · 2024-03-24T20:58:50Z

UPDATE: It maps to string by default.
It also supports mapping to php Enum or custom class setting enumClassname property while registering type.

Provided functional test in tests/Functional/Types/EnumTest.php

derrabus · 2024-03-24T21:41:57Z

The functional test only covers happy cases.
Schema introspection and comparison aren't covered at all.

bigfoot90 · 2024-03-24T22:04:48Z

What are unhappy cases?
Where I can take a look for missing tests?
Please help

derrabus · 2024-03-25T06:53:52Z

https://en.wikipedia.org/wiki/Happy_path

bigfoot90 · 2024-03-25T14:44:37Z

Sorry but it don't help me. I know what is Happy path.
I'm asking what do you mean for "unhappy" for the Enum case.
Can you provide any example?

Also where I can found similar Schema introspection and comparison tests so I can see and write the missing cases

derrabus · 2024-03-25T14:55:57Z

I'm asking what do you mean for "unhappy" for the Enum case. Can you provide any example?

Store a value that is not part of the enum.
Store a value that has the wrong type (boolean, DateTime, …).
Store a value from a different enum.
Retrieve a value from the database that is not part of the enum.

Also where I can found similar Schema introspection and comparison tests so I can see and write the missing cases

All tests in Doctrine\DBAL\Tests\Functional\Schema deal with that topic.

bigfoot90 · 2024-03-26T23:36:01Z

@derrabus Wrote Functional tests. You can review.
I need to run CI on all supported platforms

bigfoot90 · 2024-03-26T23:54:48Z

It seems that CHANCH/ALTER COLUMN functionality is not supported on SQLite.

derrabus · 2024-03-27T00:14:19Z

It seems that CHANCH/ALTER COLUMN functionality is not supported on SQLite.

That is correct, see https://www.sqlite.org/lang_altertable.html

bigfoot90 · 2024-03-27T11:56:00Z

Also there is not better way to inspect CHECK constraints on SQLite
This is the only way https://stackoverflow.com/questions/20813007/how-to-list-out-check-constraints-in-a-sqlite-table

Should we drop support for SQLite platform or fallback to TEXT type without CHECK constraint?

greg0ire · 2024-03-27T13:11:27Z

If this cannot be implemented on all platforms, then I don't think we should support enums at all, sorry.

derrabus · 2024-03-27T13:22:23Z

src/Schema/MySQLSchemaManager.php

@@ -211,6 +212,10 @@ protected function _getPortableTableColumnDefinition(array $tableColumn): Column
            'autoincrement' => str_contains($tableColumn['extra'], 'auto_increment'),
        ];

+        if ($dbType === 'enum' && preg_match_all("/'([^']+)'/", $tableColumn['type'], $members) !== false) {


preg_match_all() returns false only if an error occurred, for instance if the regular expression is invalid. I'm pretty sure that's not the case you wanted to catch here.

derrabus · 2024-03-27T13:24:22Z

src/Types/EnumType.php

+{
+    public string $name = 'enum';
+
+    public ?string $enumClassname = null;


Should this be a constructor parameter? Is the class even usable without a class name? Why is this public?

derrabus · 2024-03-27T13:26:03Z

src/Types/EnumType.php

+
+final class EnumType extends Type
+{
+    public string $name = 'enum';


What's the purpose of this property? Types are usually unaware of the name(s) under which they've been registered.

derrabus · 2024-03-27T13:26:47Z

src/Types/EnumType.php

+    public function getMappedDatabaseTypes(AbstractPlatform $platform): array
+    {
+        return [$this->name];
+    }


Doesn't the database type that we map to depend on the platform?

derrabus · 2024-03-27T13:27:38Z

src/Types/EnumType.php

+        $values = implode(
+            ', ',
+            array_map(
+                static fn (string $value) => sprintf('\'%s\'', $value),


The platform should know better how to properly quote and escape a string.

derrabus · 2024-03-27T13:34:06Z

src/Types/EnumType.php

+                throw InvalidType::new($value, $this->name, ['null', $this->enumClassname]);
+            }
+
+            if (! $value instanceof Stringable) {


Why are we dealing with stringables here? I thought this is an enum type?

derrabus · 2024-03-27T13:36:00Z

src/Types/EnumType.php

+            }
+        }
+
+        return (string) $value;


Again, no guesswork please. This type is responsible for writing enums into the database. If the passed value is not an enum, this class shouldn't guess what to do with it.

derrabus · 2024-03-27T13:36:47Z

src/Types/EnumType.php

+            return null;
+        }
+
+        if (! is_string($value)) {


So, we don't support integer-backed enums?

derrabus · 2024-03-27T13:37:27Z

tests/Functional/Schema/ComparatorTestUtils.php

+        $schemaManager = $connection->createSchemaManager();
+
+        $diff = self::diffFromActualToDesiredTable($schemaManager, $comparator, $table);
+        var_dump($diff->getModifiedColumns()[0]);


Forgot your debug code?

derrabus · 2024-03-27T13:38:46Z

tests/Functional/Schema/MySQL/ComparatorTest.php

+        $sql = 'ALTER TABLE enum_test_table CHANGE enum_col enum_col ENUM(\'NOT_A_MEMBER_ANYMORE\') NOT NULL';
+        $this->connection->executeStatement($sql);
+
+        ComparatorTestUtils::assertDiffNotEmpty($this->connection, $this->comparator, $table);


It's good that the diff is not empty, but we should actually have an opinion on what is in that diff, shouldn't we.

derrabus · 2024-03-27T13:43:09Z

Dropping support for SQLite is not an option. We must make sure, our type is usable on all platforms in some shape or form.

derrabus · 2024-03-27T13:45:28Z

Please have a look at the errors reported by PHPCS and PHPStan. You can run those tools locally.

bigfoot90 and others added 3 commits March 21, 2024 19:56

ENUM support

20f952c

Merge branch 'doctrine:4.0.x' into enum-support

bd1688c

EnumType

ccdb800

derrabus changed the base branch from 4.0.x to 4.1.x March 22, 2024 07:41

derrabus added Missing Tests New Feature Types labels Mar 22, 2024

derrabus requested changes Mar 24, 2024

View reviewed changes

bigfoot90 force-pushed the enum-support branch from cbb4017 to 9ed2a3e Compare March 24, 2024 19:59

bigfoot90 requested a review from derrabus March 24, 2024 20:02

bigfoot90 force-pushed the enum-support branch from 9ed2a3e to ee3c5b7 Compare March 24, 2024 20:49

bigfoot90 force-pushed the enum-support branch from ee3c5b7 to 08bca04 Compare March 24, 2024 21:08

Initial testing

1a7fa0e

bigfoot90 force-pushed the enum-support branch from 08bca04 to 1a7fa0e Compare March 24, 2024 23:21

bigfoot90 force-pushed the enum-support branch from 8187fbe to ab3cd8b Compare March 25, 2024 21:11

Write unhappy tests

420239f

bigfoot90 force-pushed the enum-support branch 2 times, most recently from bb32bc9 to 63b812a Compare March 26, 2024 23:01

Functional testing

c48fdd9

bigfoot90 force-pushed the enum-support branch from 63b812a to c48fdd9 Compare March 26, 2024 23:12

Test column diff on all platforms

29f5dcb

bigfoot90 force-pushed the enum-support branch from b892cf2 to 29f5dcb Compare March 26, 2024 23:50

update SQLite comparator test

4e06b15

derrabus requested changes Mar 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enum support #6347

Enum support #6347

bigfoot90 commented Mar 22, 2024

derrabus commented Mar 22, 2024

derrabus left a comment

bigfoot90 commented Mar 24, 2024

derrabus commented Mar 24, 2024

bigfoot90 commented Mar 24, 2024

derrabus commented Mar 25, 2024

bigfoot90 commented Mar 25, 2024

derrabus commented Mar 25, 2024

bigfoot90 commented Mar 26, 2024

bigfoot90 commented Mar 26, 2024

derrabus commented Mar 27, 2024

bigfoot90 commented Mar 27, 2024

greg0ire commented Mar 27, 2024

derrabus Mar 27, 2024

derrabus Mar 27, 2024

derrabus Mar 27, 2024

derrabus Mar 27, 2024

derrabus Mar 27, 2024

derrabus Mar 27, 2024

derrabus Mar 27, 2024

derrabus Mar 27, 2024

derrabus Mar 27, 2024

derrabus Mar 27, 2024

derrabus commented Mar 27, 2024

derrabus commented Mar 27, 2024

Enum support #6347

Are you sure you want to change the base?

Enum support #6347

Conversation

bigfoot90 commented Mar 22, 2024

Summary

derrabus commented Mar 22, 2024

derrabus left a comment

Choose a reason for hiding this comment

bigfoot90 commented Mar 24, 2024

derrabus commented Mar 24, 2024

bigfoot90 commented Mar 24, 2024

derrabus commented Mar 25, 2024

bigfoot90 commented Mar 25, 2024

derrabus commented Mar 25, 2024

bigfoot90 commented Mar 26, 2024

bigfoot90 commented Mar 26, 2024

derrabus commented Mar 27, 2024

bigfoot90 commented Mar 27, 2024

greg0ire commented Mar 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

derrabus commented Mar 27, 2024

derrabus commented Mar 27, 2024