Change how actual DB version is checked #34889

marko-bekhta · 2023-07-20T13:35:49Z

This came up while looking into #34754

In that scenario, the actual DB version is 5.5, but because of the DialectVersions.Defaults, the version is set to 8.0 😨🥲, which I guess may lead to problems in runtime...
And checkActualDbVersion() call never got further than the first if statement. It seems safe to say that buildTimeDbVersion is whatever the driver version got initialized to...

With these changes, the app would first fail with:

Persistence unit '<default>' was configured to run with a database version of at least '8.0.0', but the actual version is '5.5.0'. Consider upgrading your database. Alternatively, rebuild your application with 'quarkus.datasource.db-version=5.5.0' (but this may disable some features and/or impact performance negatively).

and then if the db-version is configured:

WARN: HHH000511: The 5.5.0 version for [org.hibernate.dialect.MySQLDialect] is no longer supported, hence certain features may not work properly. The minimum supported version is 5.7.0. Check the community dialects project for available legacy versions.

ORM will warn the user about the unsupported version.

quarkus-bot · 2023-07-20T13:36:08Z

/cc @Sanne (hibernate-orm), @gsmet (hibernate-orm), @yrodiere (hibernate-orm)

yrodiere · 2023-07-31T07:44:47Z

In that scenario, the actual DB version is 5.5, but because of the DialectVersions.Defaults, the version is set to 8.0, which I guess may lead to problems in runtime...

That's right, and I agree that's problematic, but that's a pre-existing behavior, and in some cases it might be working just fine...

What you're suggesting basically boils down to strictly preventing users from connecting to DBs below the default (minimum supported) version.

That makes sense, but that's also a breaking change, one that I wanted to avoid when I originally added support for db-version (which, as you noticed, is optional).

So IMO we need to:

Document the change in the migration guide.
Maybe offer some way to bypass this check, and test it. Perhaps setting the db-version to 5.5 explicitly already allows users to bypass the check?

WDYT, @gsmet?

yrodiere · 2023-07-31T07:45:33Z

BTW does anyone know how to add @marko-bekhta to an allow-list so that workflow runs are automatically allowed for his PRs? We can trust him :)

marko-bekhta · 2023-07-31T17:07:56Z

Maybe offer some way to bypass this check, and test it. Perhaps setting the db-version to 5.5 explicitly already allows users to bypass the check?

With

quarkus.datasource.db-version=5.5.0

added to the application properties, the app starts and ORM only logs the warning:

WARN: HHH000511: The 5.5.0 version for [org.hibernate.dialect.MySQLDialect] is no longer supported, hence certain features may not work properly. The minimum supported version is 5.7.0. Check the community dialects project for available legacy versions.

So the user can technically proceed on their own risk 😃

yrodiere · 2023-08-01T14:35:43Z

Ok, thanks. Well then I suppose that's fine to break this in 3.3 (probably not in 3.2 though, let's not backport this).

I suggest that you:

update the documentation in this PR for this feature; see https://quarkus.io/version/main/guides/hibernate-orm#hibernate-dialect-supported-databases, especially the part starting with "When a version is set explicitly" (it's no longer only when the version is set explicitly)
add something to the migration guide for 3.3, preferably mentioning the DB versions affected, as well as your workaround. I suppose a full workaround to revert to the previous behavior would be setting an old db-version explicitly (to bypass the version check) AND setting a new dialect with a hardcoded version explicitly (to get the behavior of the dialect for the newer version)

gsmet · 2023-09-22T15:40:36Z

@marko-bekhta any chance you could finalize this? It doesn't look like a lot of work.

@yrodiere Marko will be added automatically to the allow list when more than 10 PRs of his have been merged. Maybe we should have a list in the config file though to bypass this check for people who are trusted from the get go.

marko-bekhta · 2023-09-22T17:11:40Z

@gsmet yes sir 😃 thank you for the reminder. I'll try to make this ready for the next week.

added automatically to the allow list when more than 10 PRs of his have been merged

Noted 😃, need to add more useful things to Quarkus 😃 🙈

marko-bekhta · 2023-09-25T10:02:23Z

I've updated the note in the documentation. As for the migration notes, I'm not sure I can add those, so here's the text I've came up with for it:

=== Hibernate ORM
The Hibernate ORM Quarkus extension changed the way it verifies the database version
to provide more useful feedback from Hibernate ORM itself. In particular, to let the user know if
the version of the database being used is no longer considered as https://in.relation.to/2023/02/15/hibernate-orm-62-db-version-support/[supported by Hibernate ORM].

This change should only affect a supported database subset and only for older versions:

- MariaDB older than `10.6`
- MySQL older than `8`
- Oracle Database older than `12`
- Microsoft SQL Server older than `13 (2016)`

If the database cannot be upgraded at the time, it is still possible to use it after explicitly setting
the database version and, in some cases of very old databases that only have a community version of the dialect, by setting the dialect.
Refer to https://docs.jboss.org/hibernate/orm/6.3/userguide/html_single/Hibernate_User_Guide.html#database-dialect[database dialects] for more information.

I took the DBs and versions from the DialectVersions.Defaults.

yrodiere

LGTM, though you might want to check whether there's dead code in RecordedConfig now (is the db version still needed there?).

Now we just need to think about adding this change to the migration guide for Quarkus 3.5.

yrodiere · 2023-09-25T10:17:09Z

I've updated the note in the documentation. As for the migration notes, I'm not sure I can add those, so here's the text I've came up with for it:

=== Hibernate ORM
The Hibernate ORM Quarkus extension changed the way it verifies the database version
to provide more useful feedback from Hibernate ORM itself. In particular, to let the user know if
the version of the database being used is no longer considered as https://in.relation.to/2023/02/15/hibernate-orm-62-db-version-support/[supported by Hibernate ORM].

This change should only affect a supported database subset and only for older versions:

- MariaDB older than `10.6`
- MySQL older than `8`
- Oracle Database older than `12`
- Microsoft SQL Server older than `13 (2016)`

If the database cannot be upgraded at the time, it is still possible to use it after explicitly setting
the database version and, in some cases of very old databases that only have a community version of the dialect, by setting the dialect.
Refer to https://docs.jboss.org/hibernate/orm/6.3/userguide/html_single/Hibernate_User_Guide.html#database-dialect[database dialects] for more information.

I took the DBs and versions from the DialectVersions.Defaults.

If that's fine with you, I'll add this slightly modified version to the migration guide:

=== Hibernate ORM

==== Database version now gets verified on startup even if relying on defaults

The Hibernate ORM extension for Quarkus now verifies that the database version
it connects to at runtime is at least as high as the one configured at build time,
even when that configuration is not explicit
(i.e. when relying on the defaults that target Quarkus' minimum supported DB versions.

This change was made to make application developers aware
they use a version of the database that is no longer considered as https://in.relation.to/2023/02/15/hibernate-orm-62-db-version-support/[supported by Hibernate ORM] or Quarkus:
in that case, Quarkus will refuse to start with an exception.
 
This change should only affect a supported database subset and only for older versions:

- MariaDB older than `10.6`
- MySQL older than `8`
- Oracle Database older than `12`
- Microsoft SQL Server older than `13 (2016)`

If the database cannot be upgraded to a supported version, it is still possible to use it (although some feature might not work).
To continue using an older, unsupported version of a database:

* https://quarkus.io/guides/hibernate-orm#hibernate-dialect-supported-databases[Set the `db-version` explicitly]
* If necessary, https://quarkus.io/guides/hibernate-orm#hibernate-dialect-other-databases[set the dialect explicitly].
   In some cases, very old databases versions require using a legacy dialect found in the `hibernate-community-dialects` Maven artifact. See https://github.com/hibernate/hibernate-orm/blob/6.2/dialects.adoc#community-dialects[here] for more information.

github-actions · 2023-09-25T11:34:02Z

🎊 PR Preview f0d4d20 has been successfully built and deployed to https://quarkus-pr-main-34889-preview.surge.sh/version/main/guides/

Images of blog posts older than 3 months are not available.
Newsletters older than 3 months are not available.

yrodiere · 2024-06-10T06:53:56Z

Oh my... We added the notes to the migration guide but never merged the PR...
@marko-bekhta could you please have a look at the test failure when you have some time?
Let's try to get this merged in the next version, then I'll adapt the various migration guides...

marko-bekhta · 2024-06-10T08:26:16Z

The minimum Derby version was bumped to 10.15.2 in ORM: https://hibernate.atlassian.net/browse/HHH-15203
and in Quarkus - Derby is still at 10.14.2 😕

Can we bump the version in Quarkus?

As for the Kafka test... all ok locally 😕🤷🏻‍♂️

yrodiere · 2024-06-10T08:46:23Z

Can we bump the version in Quarkus?

+1, will do

Because Hibernate ORM 6.3+ doesn't technically support Derby 10.14: https://hibernate.atlassian.net/browse/HHH-15203 Right now Quarkus and Hibernate ORM will start even if using Derby 10.14, but: * there will be a warning on startup * some Hibernate ORM features may not work correctly Also, we're adding stricter checks in quarkusio#34889, so startup will start failing if people are still on an older version of Derby.

yrodiere · 2024-06-10T08:56:45Z

Can we bump the version in Quarkus?

+1, will do

#41084

Because Hibernate ORM 6.3+ doesn't technically support Derby 10.14: https://hibernate.atlassian.net/browse/HHH-15203 Right now Quarkus and Hibernate ORM will start even if using Derby 10.14, but: * there will be a warning on startup * some Hibernate ORM features may not work correctly Also, we're adding stricter checks in quarkusio#34889, so startup will start failing if people are still on an older version of Derby.

yrodiere

Rebased on top of #41084 (which was merged to main).
LGTM, let's see if CI agrees.

Reminder: we'll need to adjust migration guides once this gets in, see #34889 (comment)

quarkus-bot · 2024-06-11T09:42:41Z

Status for workflow `Quarkus Documentation CI`

This is the status report for running Quarkus Documentation CI on commit 693bfdb.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

⚠️ There are other workflow runs running, you probably need to wait for their status before merging.

quarkus-bot · 2024-06-11T10:48:41Z

Status for workflow `Quarkus CI`

This is the status report for running Quarkus CI on commit 693bfdb.

Failing Jobs

Status	Name	Step	Failures	Logs	Raw logs	Build scan
✖	JVM Tests - JDK 17	`Build`	Failures	Logs	Raw logs	🔍
✔️	JVM Tests - JDK 21			Logs	Raw logs	🔍

You can consult the Develocity build scans.

Failures

⚙️ JVM Tests - JDK 17 #

- Failing: integration-tests/jpa-mssql

📦 integration-tests/jpa-mssql

✖ Failed to execute goal io.fabric8:docker-maven-plugin:0.44.0:start (docker-start) on project quarkus-integration-test-jpa-mssql: I/O Error

Flaky tests - Develocity

⚙️ JVM Tests - JDK 21

📦 integration-tests/reactive-messaging-kafka

✖ io.quarkus.it.kafka.KafkaConnectorTest.testFruits - History

Assertion condition defined as a Lambda expression in io.quarkus.it.kafka.KafkaConnectorTest expected: <6> but was: <5> within 10 seconds. - org.awaitility.core.ConditionTimeoutException

org.awaitility.core.ConditionTimeoutException: Assertion condition defined as a Lambda expression in io.quarkus.it.kafka.KafkaConnectorTest expected: <6> but was: <5> within 10 seconds.
	at org.awaitility.core.ConditionAwaiter.await(ConditionAwaiter.java:167)
	at org.awaitility.core.AssertionCondition.await(AssertionCondition.java:119)
	at org.awaitility.core.AssertionCondition.await(AssertionCondition.java:31)
	at org.awaitility.core.ConditionFactory.until(ConditionFactory.java:1006)
	at org.awaitility.core.ConditionFactory.untilAsserted(ConditionFactory.java:790)
	at io.quarkus.it.kafka.KafkaConnectorTest.testFruits(KafkaConnectorTest.java:63)
	at java.base/java.lang.reflect.Method.invoke(Method.java:580)

gsmet · 2024-06-11T20:19:16Z

I will let you add an item to the migration guide here: https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.12 .

yrodiere · 2024-06-12T07:20:58Z

I will let you add an item to the migration guide here: https://github.com/quarkusio/quarkus/wiki/Migration-Guide-3.12 .

Done, and I also removed the section that was mistakenly added to the 3.5 migration guide.

yrodiere · 2024-06-12T07:30:43Z

Oh my... We added the notes to the migration guide but never merged the PR... @marko-bekhta could you please have a look at the test failure when you have some time? Let's try to get this merged in the next version, then I'll adapt the various migration guides...

@michelle-purcell @rolfedh See ^. There was a section in the migration guide for Quarkus 3.5 that looked a bit like this and that essentially said database version checks were stricter now.
That was wrong, as the corresponding change hadn't been merged into Quarkus. If you incorporated this in RHBQ migration notes, you may want to remove it.

rolfedh · 2024-06-12T15:26:52Z

Thanks for this update, @yrodiere.
I've created https://issues.redhat.com/browse/QDOCS-727 to handle this task.
Please review this Jira and confirm the changes it proposes.

Because Hibernate ORM 6.3+ doesn't technically support Derby 10.14: https://hibernate.atlassian.net/browse/HHH-15203 Right now Quarkus and Hibernate ORM will start even if using Derby 10.14, but: * there will be a warning on startup * some Hibernate ORM features may not work correctly Also, we're adding stricter checks in quarkusio#34889, so startup will start failing if people are still on an older version of Derby.

quarkus-bot bot added area/hibernate-orm Hibernate ORM area/persistence OBSOLETE, DO NOT USE labels Jul 20, 2023

marko-bekhta force-pushed the fix/check-actual-db-version branch from 32f1b6e to f82e09c Compare July 20, 2023 13:41

This comment has been minimized.

Sign in to view

marko-bekhta force-pushed the fix/check-actual-db-version branch from f82e09c to 0172a81 Compare September 25, 2023 10:00

quarkus-bot bot added the area/documentation label Sep 25, 2023

yrodiere approved these changes Sep 25, 2023

View reviewed changes

This comment has been minimized.

Sign in to view

marko-bekhta force-pushed the fix/check-actual-db-version branch from 0172a81 to 1f77223 Compare October 5, 2023 15:18

This comment has been minimized.

Sign in to view

gsmet force-pushed the fix/check-actual-db-version branch from 1f77223 to 01b96bc Compare June 7, 2024 17:04

This comment has been minimized.

Sign in to view

quarkus-bot bot added the triage/flaky-test label Jun 7, 2024

yrodiere mentioned this pull request Jun 10, 2024

Upgrade to Derby 10.16.1.1 #41084

Merged

Change how actual DB version is checked

693bfdb

yrodiere force-pushed the fix/check-actual-db-version branch from 01b96bc to 693bfdb Compare June 11, 2024 09:17

yrodiere approved these changes Jun 11, 2024

View reviewed changes

yrodiere added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Jun 11, 2024

gsmet merged commit 79c5ac6 into quarkusio:main Jun 11, 2024
44 checks passed

quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Jun 11, 2024

quarkus-bot bot added this to the 3.12 - main milestone Jun 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change how actual DB version is checked #34889

Change how actual DB version is checked #34889

marko-bekhta commented Jul 20, 2023

quarkus-bot bot commented Jul 20, 2023

yrodiere commented Jul 31, 2023

yrodiere commented Jul 31, 2023

This comment has been minimized.

marko-bekhta commented Jul 31, 2023

yrodiere commented Aug 1, 2023

gsmet commented Sep 22, 2023

marko-bekhta commented Sep 22, 2023

marko-bekhta commented Sep 25, 2023

yrodiere left a comment

yrodiere commented Sep 25, 2023 •

edited

Loading

github-actions bot commented Sep 25, 2023 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

yrodiere commented Jun 10, 2024

marko-bekhta commented Jun 10, 2024

yrodiere commented Jun 10, 2024

yrodiere commented Jun 10, 2024

yrodiere left a comment

quarkus-bot bot commented Jun 11, 2024

quarkus-bot bot commented Jun 11, 2024 •

edited by github-actions bot

Loading

gsmet commented Jun 11, 2024

yrodiere commented Jun 12, 2024

yrodiere commented Jun 12, 2024

rolfedh commented Jun 12, 2024 •

edited

Loading

Change how actual DB version is checked #34889

Change how actual DB version is checked #34889

Conversation

marko-bekhta commented Jul 20, 2023

quarkus-bot bot commented Jul 20, 2023

yrodiere commented Jul 31, 2023

yrodiere commented Jul 31, 2023

This comment has been minimized.

marko-bekhta commented Jul 31, 2023

yrodiere commented Aug 1, 2023

gsmet commented Sep 22, 2023

marko-bekhta commented Sep 22, 2023

marko-bekhta commented Sep 25, 2023

yrodiere left a comment

Choose a reason for hiding this comment

yrodiere commented Sep 25, 2023 • edited Loading

github-actions bot commented Sep 25, 2023 • edited Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

yrodiere commented Jun 10, 2024

marko-bekhta commented Jun 10, 2024

yrodiere commented Jun 10, 2024

yrodiere commented Jun 10, 2024

yrodiere left a comment

Choose a reason for hiding this comment

quarkus-bot bot commented Jun 11, 2024

Status for workflow Quarkus Documentation CI

quarkus-bot bot commented Jun 11, 2024 • edited by github-actions bot Loading

Status for workflow Quarkus CI

Failing Jobs

Failures

⚙️ JVM Tests - JDK 17 #

📦 integration-tests/jpa-mssql

Flaky tests - Develocity

⚙️ JVM Tests - JDK 21

📦 integration-tests/reactive-messaging-kafka

gsmet commented Jun 11, 2024

yrodiere commented Jun 12, 2024

yrodiere commented Jun 12, 2024

rolfedh commented Jun 12, 2024 • edited Loading

yrodiere commented Sep 25, 2023 •

edited

Loading

github-actions bot commented Sep 25, 2023 •

edited

Loading

Status for workflow `Quarkus Documentation CI`

quarkus-bot bot commented Jun 11, 2024 •

edited by github-actions bot

Loading

Status for workflow `Quarkus CI`

rolfedh commented Jun 12, 2024 •

edited

Loading