Skip to content

Tame doctrine migrations / determine which we want to apply. #1917

Merged
johanib merged 1 commit intomainfrom
feature/ensure_no_schema_changes
Mar 10, 2026
Merged

Tame doctrine migrations / determine which we want to apply. #1917
johanib merged 1 commit intomainfrom
feature/ensure_no_schema_changes

Conversation

@johanib
Copy link
Contributor

@johanib johanib commented Feb 26, 2026

Prior to this change, doctrine wants to change the longtext types of consent_settings and idp_discoveries to json. This has some implications, as at a db level, as it requires a migration. This migration is not strictly needed.

Ensure no database migrations are applied by configuring doctrine to use the old legacy mappings, until we have reason to upgrade in a coordinated operation.

Even with this change, doctrine wants to remove the comments. But we can safely apply this in the next release, without causing any big migrations.

After this change, doctrine wants to create a migration for this.

--- <unnamed>
+++ <unnamed>
@@ -10,37 +10,37 @@
   `display_name_nl` varchar(255) NOT NULL,
   `display_name_en` varchar(255) NOT NULL,
   `display_name_pt` varchar(255) NOT NULL,
-  `logo` longtext NOT NULL COMMENT '(DC2Type:object)',
-  `organization_nl_name` text DEFAULT NULL COMMENT '(DC2Type:object)',
-  `organization_en_name` text DEFAULT NULL COMMENT '(DC2Type:object)',
-  `organization_pt_name` text DEFAULT NULL COMMENT '(DC2Type:object)',
+  `logo` longtext NOT NULL,
+  `organization_nl_name` text DEFAULT NULL,
+  `organization_en_name` text DEFAULT NULL,
+  `organization_pt_name` text DEFAULT NULL,
   `keywords_nl` varchar(255) NOT NULL,
   `keywords_en` varchar(255) NOT NULL,
   `keywords_pt` varchar(255) NOT NULL,
-  `certificates` text NOT NULL COMMENT '(DC2Type:array)',
+  `certificates` text NOT NULL,
   `workflow_state` varchar(255) NOT NULL,
-  `contact_persons` text NOT NULL COMMENT '(DC2Type:array)',
+  `contact_persons` text NOT NULL,
   `name_id_format` varchar(255) DEFAULT NULL,
-  `name_id_formats` text NOT NULL COMMENT '(DC2Type:array)',
-  `single_logout_service` text DEFAULT NULL COMMENT '(DC2Type:object)',
+  `name_id_formats` text NOT NULL,
+  `single_logout_service` text DEFAULT NULL,
   `requests_must_be_signed` tinyint(1) NOT NULL,
   `manipulation` text NOT NULL,
   `type` varchar(255) NOT NULL,
-  `attribute_release_policy` text DEFAULT NULL COMMENT '(DC2Type:array)',
-  `assertion_consumer_services` text DEFAULT NULL COMMENT '(DC2Type:array)',
-  `allowed_idp_entity_ids` mediumtext DEFAULT NULL COMMENT '(DC2Type:array)',
+  `attribute_release_policy` text DEFAULT NULL,
+  `assertion_consumer_services` text DEFAULT NULL,
+  `allowed_idp_entity_ids` mediumtext DEFAULT NULL,
   `allow_all` tinyint(1) DEFAULT NULL,
-  `requested_attributes` text DEFAULT NULL COMMENT '(DC2Type:array)',
+  `requested_attributes` text DEFAULT NULL,
   `enabled_in_wayf` tinyint(1) DEFAULT NULL,
-  `single_sign_on_services` text DEFAULT NULL COMMENT '(DC2Type:array)',
-  `shib_md_scopes` text DEFAULT NULL COMMENT '(DC2Type:array)',
+  `single_sign_on_services` text DEFAULT NULL,
+  `shib_md_scopes` text DEFAULT NULL,
   `support_url_en` varchar(255) DEFAULT NULL,
   `support_url_pt` varchar(255) DEFAULT NULL,
   `support_url_nl` varchar(255) DEFAULT NULL,
-  `consent_settings` longtext DEFAULT NULL COMMENT '(DC2Type:json)',
-  `coins` longtext NOT NULL COMMENT '(DC2Type:engineblock_metadata_coins)',
-  `mdui` longtext NOT NULL COMMENT '(DC2Type:engineblock_metadata_mdui)',
-  `idp_discoveries` longtext DEFAULT NULL COMMENT '(DC2Type:json)',
+  `consent_settings` longtext DEFAULT NULL,
+  `coins` longtext NOT NULL,
+  `mdui` longtext NOT NULL,
+  `idp_discoveries` longtext DEFAULT NULL,
   PRIMARY KEY (`id`),
   UNIQUE KEY `idx_sso_provider_roles_entity_id_type` (`type`,`entity_id`),
   KEY `idx_sso_provider_roles_type` (`type`),

Before this change, Doctrine wanted to migrate to this:

--- <unnamed>
+++ <unnamed>
@@ -10,37 +10,37 @@
   `display_name_nl` varchar(255) NOT NULL,
   `display_name_en` varchar(255) NOT NULL,
   `display_name_pt` varchar(255) NOT NULL,
-  `logo` longtext NOT NULL COMMENT '(DC2Type:object)',
-  `organization_nl_name` text DEFAULT NULL COMMENT '(DC2Type:object)',
-  `organization_en_name` text DEFAULT NULL COMMENT '(DC2Type:object)',
-  `organization_pt_name` text DEFAULT NULL COMMENT '(DC2Type:object)',
+  `logo` longtext NOT NULL,
+  `organization_nl_name` text DEFAULT NULL,
+  `organization_en_name` text DEFAULT NULL,
+  `organization_pt_name` text DEFAULT NULL,
   `keywords_nl` varchar(255) NOT NULL,
   `keywords_en` varchar(255) NOT NULL,
   `keywords_pt` varchar(255) NOT NULL,
-  `certificates` text NOT NULL COMMENT '(DC2Type:array)',
+  `certificates` text NOT NULL,
   `workflow_state` varchar(255) NOT NULL,
-  `contact_persons` text NOT NULL COMMENT '(DC2Type:array)',
+  `contact_persons` text NOT NULL,
   `name_id_format` varchar(255) DEFAULT NULL,
-  `name_id_formats` text NOT NULL COMMENT '(DC2Type:array)',
-  `single_logout_service` text DEFAULT NULL COMMENT '(DC2Type:object)',
+  `name_id_formats` text NOT NULL,
+  `single_logout_service` text DEFAULT NULL,
   `requests_must_be_signed` tinyint(1) NOT NULL,
   `manipulation` text NOT NULL,
   `type` varchar(255) NOT NULL,
-  `attribute_release_policy` text DEFAULT NULL COMMENT '(DC2Type:array)',
-  `assertion_consumer_services` text DEFAULT NULL COMMENT '(DC2Type:array)',
-  `allowed_idp_entity_ids` mediumtext DEFAULT NULL COMMENT '(DC2Type:array)',
+  `attribute_release_policy` text DEFAULT NULL,
+  `assertion_consumer_services` text DEFAULT NULL,
+  `allowed_idp_entity_ids` mediumtext DEFAULT NULL,
   `allow_all` tinyint(1) DEFAULT NULL,
-  `requested_attributes` text DEFAULT NULL COMMENT '(DC2Type:array)',
+  `requested_attributes` text DEFAULT NULL,
   `enabled_in_wayf` tinyint(1) DEFAULT NULL,
-  `single_sign_on_services` text DEFAULT NULL COMMENT '(DC2Type:array)',
-  `shib_md_scopes` text DEFAULT NULL COMMENT '(DC2Type:array)',
+  `single_sign_on_services` text DEFAULT NULL,
+  `shib_md_scopes` text DEFAULT NULL,
   `support_url_en` varchar(255) DEFAULT NULL,
   `support_url_pt` varchar(255) DEFAULT NULL,
   `support_url_nl` varchar(255) DEFAULT NULL,
-  `consent_settings` longtext DEFAULT NULL COMMENT '(DC2Type:json)',
-  `coins` longtext NOT NULL COMMENT '(DC2Type:engineblock_metadata_coins)',
-  `mdui` longtext NOT NULL COMMENT '(DC2Type:engineblock_metadata_mdui)',
-  `idp_discoveries` longtext DEFAULT NULL COMMENT '(DC2Type:json)',
+  `consent_settings` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT NULL CHECK (json_valid(`consent_settings`)),
+  `coins` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL CHECK (json_valid(`coins`)),
+  `mdui` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_bin NOT NULL CHECK (json_valid(`mdui`)),
+  `idp_discoveries` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT NULL CHECK (json_valid(`idp_discoveries`)),
   PRIMARY KEY (`id`),
   UNIQUE KEY `idx_sso_provider_roles_entity_id_type` (`type`,`entity_id`),
   KEY `idx_sso_provider_roles_type` (`type`),

@johanib johanib mentioned this pull request Feb 26, 2026
Merged
@johanib johanib moved this from New to Backlog in PHP development Feb 26, 2026
@baszoetekouw baszoetekouw moved this from Backlog to In Progress in PHP development Mar 2, 2026
@johanib johanib force-pushed the feature/update_dbal_4_1799_3 branch from b83392f to 156245f Compare March 3, 2026 08:48
Base automatically changed from feature/update_dbal_4_1799_3 to upgrade-84 March 3, 2026 12:29
@johanib johanib force-pushed the feature/ensure_no_schema_changes branch from e9849bf to 3eebb07 Compare March 5, 2026 09:46
@johanib johanib marked this pull request as ready for review March 5, 2026 09:48
@johanib johanib requested a review from MKodde March 5, 2026 09:48
MKodde
MKodde requested changes Mar 5, 2026
View reviewed changes
@github-project-automation github-project-automation bot moved this from In Progress to Backlog in PHP development Mar 5, 2026
Base automatically changed from upgrade-84 to main March 5, 2026 14:02
@johanib johanib force-pushed the feature/ensure_no_schema_changes branch 2 times, most recently from 64fdb01 to d2045e2 Compare March 10, 2026 10:35
@johanib johanib requested a review from MKodde March 10, 2026 10:36
@johanib johanib force-pushed the feature/ensure_no_schema_changes branch from d2045e2 to 80ef081 Compare March 10, 2026 10:47
MKodde
MKodde approved these changes Mar 10, 2026
View reviewed changes
Copy link
Member

@MKodde MKodde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! 🚢

@johanib
Prevent migration to json
495b5ff 
Prior to this change, doctrine wants to change the longtext types of consent_settings and idp_discoveries to `json`.
This has some implications, as at a db level, as it requires a migration.
This migration is not strictly needed.

Ensure no database migrations are applied by configuring doctrine to use the old legacy mappings, until we have reason to upgrade in a coordinated operation.

Even with this change, doctrine wants to remove the comments. But we can safely apply this in the next release, without causing any big migrations.
@johanib johanib force-pushed the feature/ensure_no_schema_changes branch from 80ef081 to 495b5ff Compare March 10, 2026 12:37
@johanib johanib merged commit 8237047 into main Mar 10, 2026
2 checks passed
@johanib johanib deleted the feature/ensure_no_schema_changes branch March 10, 2026 12:41
@github-project-automation github-project-automation bot moved this from Backlog to Delivered in PHP development Mar 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MKodde MKodde MKodde approved these changes

Assignees

No one assigned

Labels

None yet

Projects

PHP development
Status: Delivered

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@johanib @MKodde