Upgrade to doctrine/dbal:^4

- The old array / object serialization types from doctrine have been moved / integrated into our codebase for backward compatability.

- Fix typo in allowed_idp_entity_ids. The db is a medium text, which is 16777215 bytes. This change aligns the column with the mapping.

- Make the nullable: false explicit to avoid future confusion. Confusion could stem from the fact that the fields are nullable in code, but not nullable in the database. This is because a serialized `null` results in something like `s:` in the database.

Author: johanib

composer.json

@@ -23,8 +23,8 @@
         "ext-openssl": "*",
         "ext-pdo": "*",
         "beberlei/assert": "^3.3.3",
-        "composer/package-versions-deprecated": "^1.11.99.5",
-        "doctrine/dbal": "^3.10.3",
+        "composer/package-versions-deprecated": "^1.11",
+        "doctrine/dbal": "^4.3.3",
         "doctrine/doctrine-bundle": "^2.13.3",
         "doctrine/doctrine-migrations-bundle": "^3.6.0",
         "doctrine/orm": "^3.5.7",

composer.lock

@@ -23,6 +23,10 @@ doctrine:
             engineblock_collab_person_uuid: OpenConext\EngineBlockBundle\Doctrine\Type\CollabPersonUuidType
             engineblock_metadata_coins: OpenConext\EngineBlockBundle\Doctrine\Type\MetadataCoinType
             engineblock_metadata_mdui: OpenConext\EngineBlockBundle\Doctrine\Type\MetadataMduiType
+
+            array: OpenConext\EngineBlockBundle\Doctrine\Type\SerializedArrayType
+            object: OpenConext\EngineBlockBundle\Doctrine\Type\SerializedObjectType
+
     orm:
         auto_generate_proxy_classes: "%kernel.debug%"
         proxy_dir: '%kernel.cache_dir%/doctrine/orm/Proxies'

config/packages/doctrine.yaml

@@ -18,7 +18,6 @@
 
 namespace OpenConext\EngineBlock\Metadata\Entity;
 
-use DateTime;
 use Doctrine\ORM\Mapping as ORM;
 use OpenConext\EngineBlock\Metadata\Coins;
 use OpenConext\EngineBlock\Metadata\ContactPerson;
@@ -28,12 +27,17 @@
 use OpenConext\EngineBlock\Metadata\Organization;
 use OpenConext\EngineBlock\Metadata\Service;
 use OpenConext\EngineBlock\Metadata\X509\X509Certificate;
+use OpenConext\EngineBlockBundle\Doctrine\Type\SerializedArrayType;
+use OpenConext\EngineBlockBundle\Doctrine\Type\SerializedObjectType;
 use RuntimeException;
 use SAML2\Constants;
 
 /**
  * Abstract base class for configuration entities.
  *
+ * Note: This baseclass is extended by IdentityProvider and ServiceProvider. Both entities are stored in a single table.
+ * This means all columns defined in both subclasses are nullable by default, even if you pass 'nullable: false'.
+ *
  * @package OpenConext\EngineBlock\Metadata\Entity
  * @SuppressWarnings(PHPMD.TooManyFields)
  *
@@ -134,25 +138,25 @@ abstract class AbstractRole
      * @var Logo
      * @deprecated Will be removed in favour of using the Mdui value object, use the getter for this field instead
      */
-    #[ORM\Column(name: 'logo', type: \Doctrine\DBAL\Types\Types::OBJECT)]
+    #[ORM\Column(name: 'logo', type: SerializedObjectType::NAME)]
     public $logo;
 
     /**
      * @var Organization
      */
-    #[ORM\Column(name: 'organization_nl_name', type: \Doctrine\DBAL\Types\Types::OBJECT, nullable: true, length: 65535)]
+    #[ORM\Column(name: 'organization_nl_name', type: SerializedObjectType::NAME, length: 65535, nullable: true)]
     public $organizationNl;
 
     /**
      * @var Organization
      */
-    #[ORM\Column(name: 'organization_en_name', type: \Doctrine\DBAL\Types\Types::OBJECT, nullable: true, length: 65535)]
+    #[ORM\Column(name: 'organization_en_name', type: SerializedObjectType::NAME, length: 65535, nullable: true)]
     public $organizationEn;
 
     /**
      * @var Organization
      */
-    #[ORM\Column(name: 'organization_pt_name', type: \Doctrine\DBAL\Types\Types::OBJECT, nullable: true, length: 65535)]
+    #[ORM\Column(name: 'organization_pt_name', type: SerializedObjectType::NAME, length: 65535, nullable: true)]
     public $organizationPt;
 
     /**
@@ -179,7 +183,7 @@ abstract class AbstractRole
     /**
      * @var X509Certificate[]
      */
-    #[ORM\Column(name: 'certificates', type: \Doctrine\DBAL\Types\Types::ARRAY, length: 65535)]
+    #[ORM\Column(name: 'certificates', type: SerializedArrayType::NAME, length: 65535)]
     public $certificates = array();
 
     /**
@@ -191,7 +195,7 @@ abstract class AbstractRole
     /**
      * @var ContactPerson[]
      */
-    #[ORM\Column(name: 'contact_persons', type: \Doctrine\DBAL\Types\Types::ARRAY, length: 65535)]
+    #[ORM\Column(name: 'contact_persons', type: SerializedArrayType::NAME, length: 65535)]
     public $contactPersons;
 
     /**
@@ -203,13 +207,13 @@ abstract class AbstractRole
     /**
      * @var string[]
      */
-    #[ORM\Column(name: 'name_id_formats', type: \Doctrine\DBAL\Types\Types::ARRAY, length: 65535)]
+    #[ORM\Column(name: 'name_id_formats', type: SerializedArrayType::NAME, length: 65535)]
     public $supportedNameIdFormats;
 
     /**
      * @var Service
      */
-    #[ORM\Column(name: 'single_logout_service', type: \Doctrine\DBAL\Types\Types::OBJECT, nullable: true, length: 65535)]
+    #[ORM\Column(name: 'single_logout_service', type: SerializedObjectType::NAME, length: 65535, nullable: true)]
     public $singleLogoutService;
 
     /**

src/OpenConext/EngineBlock/Metadata/Entity/AbstractRole.php

@@ -32,6 +32,7 @@
 use OpenConext\EngineBlock\Metadata\ShibMdScope;
 use OpenConext\EngineBlock\Metadata\Service;
 use OpenConext\EngineBlock\Metadata\StepupConnections;
+use OpenConext\EngineBlockBundle\Doctrine\Type\SerializedArrayType;
 use RobRichards\XMLSecLibs\XMLSecurityKey;
 use SAML2\Constants;
 
@@ -71,7 +72,7 @@ class IdentityProvider extends AbstractRole
     /**
      * @var Service[]
      */
-    #[ORM\Column(name: 'single_sign_on_services', type: \Doctrine\DBAL\Types\Types::ARRAY, length: 65535)]
+    #[ORM\Column(name: 'single_sign_on_services', type: SerializedArrayType::NAME, length: 65535)]
     public $singleSignOnServices = array();
 
     /**
@@ -83,7 +84,7 @@ class IdentityProvider extends AbstractRole
     /**
      * @var ShibMdScope[]
      */
-    #[ORM\Column(name: 'shib_md_scopes', type: \Doctrine\DBAL\Types\Types::ARRAY, length: 65535)]
+    #[ORM\Column(name: 'shib_md_scopes', type: SerializedArrayType::NAME, length: 65535)]
     public $shibMdScopes = array();
 
     /**

src/OpenConext/EngineBlock/Metadata/Entity/IdentityProvider.php

@@ -29,6 +29,7 @@
 use OpenConext\EngineBlock\Metadata\RequestedAttribute;
 use OpenConext\EngineBlock\Metadata\IndexedService;
 use OpenConext\EngineBlock\Metadata\Service;
+use OpenConext\EngineBlockBundle\Doctrine\Type\SerializedArrayType;
 use RobRichards\XMLSecLibs\XMLSecurityKey;
 use SAML2\Constants;
 
@@ -48,19 +49,19 @@ class ServiceProvider extends AbstractRole
     /**
      * @var null|AttributeReleasePolicy
      */
-    #[ORM\Column(name: 'attribute_release_policy', type: \Doctrine\DBAL\Types\Types::ARRAY, length: 65535)]
+    #[ORM\Column(name: 'attribute_release_policy', type: SerializedArrayType::NAME, length: 65535)]
     public $attributeReleasePolicy;
 
     /**
      * @var IndexedService[]
      */
-    #[ORM\Column(name: 'assertion_consumer_services', type: \Doctrine\DBAL\Types\Types::ARRAY, length: 65535)]
+    #[ORM\Column(name: 'assertion_consumer_services', type: SerializedArrayType::NAME, length: 65535)]
     public $assertionConsumerServices;
 
     /**
      * @var string[]
      */
-    #[ORM\Column(name: 'allowed_idp_entity_ids', type: \Doctrine\DBAL\Types\Types::ARRAY, length: 6777215)]
+    #[ORM\Column(name: 'allowed_idp_entity_ids', type: SerializedArrayType::NAME, length: 6777215)]
     public $allowedIdpEntityIds;
 
     /**
@@ -72,7 +73,7 @@ class ServiceProvider extends AbstractRole
     /**
      * @var null|RequestedAttribute[]
      */
-    #[ORM\Column(name: 'requested_attributes', type: \Doctrine\DBAL\Types\Types::ARRAY, length: 65535)]
+    #[ORM\Column(name: 'requested_attributes', type: SerializedArrayType::NAME, length: 65535)]
     public $requestedAttributes;
 
     /**