Skip to content

Hibernate 7 - Step 2#15568

Open
jdaugherty wants to merge 1292 commits into
8.0.xfrom
8.0.x-hibernate7
Open

Hibernate 7 - Step 2#15568
jdaugherty wants to merge 1292 commits into
8.0.xfrom
8.0.x-hibernate7

Conversation

@jdaugherty

@jdaugherty jdaugherty commented Apr 10, 2026

Copy link
Copy Markdown
Contributor

Reopening. This PR replaces #15530

Please note that I split off a prerequisite PR #15654

This allows us to better see what changed between hibernate 5 & 7 - otherwise the hibernate 7 code looks like it was just added instead of changed. Commit a47d8cb is the original commit prior to this split if we need to compare this branch to that for any reason (mistakes, etc).

borinquenkid and others added 17 commits April 9, 2026 09:52
…and proper applicationClass

- Replace executeQuery(plainString) and executeUpdate(plainString) calls
  with the (String, Map) overloads (empty map for parameterless queries).
  HibernateGormStaticApi intentionally rejects plain String in the
  no-arg overload to prevent HQL injection; parameterless static queries
  must use the Map overload.

- Add applicationClass = Application to @Integration so the spec shares
  the same application context and transaction manager as the other specs
  in this module, preventing test-data bleed between specs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
# Conflicts:
#	NOTICE
#	dependencies.gradle
#	gradle/publish-root-config.gradle
…ibernate7

# Conflicts:
#	.idea/codeStyles/Project.xml
#	NOTICE
#	build-logic/plugins/build.gradle
#	dependencies.gradle
#	gradle/publish-root-config.gradle
  Following the pattern used in Hibernate 5, I have moved the vendored Spring Framework ORM Hibernate 7 integration classes from the core module to a dedicated spring-orm module:
   - Created Module: grails-data-hibernate7-spring-orm (located in grails-data-hibernate7/spring-orm).
   - Moved Classes: All classes in org.grails.orm.hibernate.support.hibernate7 (including HibernateTransactionManager, HibernateTemplate, LocalSessionFactoryBean, etc.) are now in the new module.
   - Updated Dependencies:
       - Added the new module to settings.gradle.
       - Updated grails-data-hibernate7-core, grails-plugin, boot-plugin, and dbmigration to depend on the new spring-orm module.
       - Updated gradle/publish-root-config.gradle to ensure the new module is included in the publishing process.
- HibernateDetachedCriteria.isNumericPropertyType: box primitive types
  before the Number.isAssignableFrom check so that domains declaring
  numeric properties as primitives (int/long/double/float/short/byte)
  work correctly in where-DSL arithmetic expressions.
  Method is protected to allow subclass overrides.

- ToManyEntityMultiTenantFilterBinder.bind: add null guard for
  getHibernateAssociatedEntity() return value to prevent
  NullPointerException on partially-resolved associations.

- grails-data-hibernate7/README.md: add grails-data-hibernate7-spring-orm
  to the Module Structure table.

- Tests: new HibernateDetachedCriteriaSpec covering boxed and all 6
  primitive numeric types, non-numeric delegation, and unknown property.
  Added null-associated-entity test to ToManyEntityMultiTenantFilterBinderSpec.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
# Conflicts:
#	grails-data-mongodb/core/src/test/groovy/org/apache/grails/data/mongo/core/GrailsDataMongoTckManager.groovy
#	grails-data-mongodb/core/src/test/groovy/org/grails/datastore/gorm/mongo/BeforeUpdatePropertyPersistenceSpec.groovy
#	grails-datamapping-core-test/src/test/groovy/org/grails/datastore/gorm/CustomAutoTimestampSpec.groovy
#	grails-datamapping-core-test/src/test/groovy/org/grails/datastore/gorm/NestedCriteriaWithNamedQuerySpec.groovy
#	grails-datamapping-core/src/main/groovy/org/grails/datastore/gorm/GormStaticApi.groovy
#	grails-datamapping-core/src/main/groovy/org/grails/datastore/gorm/query/NamedCriteriaProxy.groovy
#	grails-datamapping-tck/src/main/groovy/org/apache/grails/data/testing/tck/tests/NamedQuerySpec.groovy
#	grails-test-suite-uber/src/test/groovy/grails/compiler/DomainClassWithInnerClassUsingStaticCompilationSpec.groovy
@jdaugherty jdaugherty mentioned this pull request Apr 10, 2026
@jdaugherty jdaugherty changed the base branch from 7.0.x to 8.0.x April 10, 2026 14:02
@testlens-app

This comment has been minimized.

@testlens-app

This comment has been minimized.

# Conflicts:
#	grails-data-mongodb/core/src/test/groovy/org/apache/grails/data/mongo/core/GrailsDataMongoTckManager.groovy
@testlens-app

This comment has been minimized.

@borinquenkid

Copy link
Copy Markdown
Member

To help guide the review of this PR, I want to provide a high-level overview of the major architectural changes and design decisions introduced in this branch. Given the magnitude of the changes, this
context should clarify the mechanical shifts across the modules.

  1. Hibernate Criteria API to JPA Criteria API Migration
    Hibernate 6 and 7 completely removed the legacy native Criteria API, replacing it with the JPA Criteria API. Because our HibernateCriteriaBuilder heavily depended on that legacy API, we had to rethink
    how queries are built. To bridge this gap, we implemented a chain using HibernateCriteriaBuilder and HibernateQuery. This chain now leverages GORM's DetachedCriteria internally to collect all the
    necessary query elements and state before eventually constructing and executing the final JPA query.
  2. HQL Query Compilation and State Management
    On the HQL side of things, we introduced the HQLQueryContext. This new context object is responsible for cleanly collecting all state and handling the compilation of HQL queries, providing better
    isolation and structure for HQL execution.
  3. GrailsDomainBinder Decomposition
    The GrailsDomainBinder had grown significantly and was handling too many responsibilities. As part of this update, it has been decomposed into multiple focused, smaller classes. This improves
    maintainability and makes it much easier to reason about the binding lifecycle.
  4. HibernateMappingContext Hierarchy
    We tightened the HibernateMappingContext hierarchy to be strictly Hibernate-specific. This ensures that the context semantics are well-defined and prevents leakage of generic data-mapping concepts
    where Hibernate-specific behavior is required.

These architectural shifts are the primary drivers of the footprint of this PR. The accompanying style adjustments (CodeNarc, Checkstyle, PMD) were applied mechanically to ensure the new monorepo
maintains high code quality from day one and to prevent accumulating technical debt moving forward.

Let me know if you have any questions about specific implementation details in these areas!***

Comment thread .github/workflows/codeanalysis.yml
…le-quotes inside single-quoted strings

Three regex bugs in registerCodenarcFixTask:

1. SpaceAroundMapEntryColon matched the first ':' of '::' method references,
   turning String::trim into String: :trim.
   Fix: add (?!:) lookahead so only standalone map-entry colons are matched.

2. UnnecessaryGString fused the closing quote of a GString with the opening
   quote of an adjacent plain string (e.g. obj."${name}"("arg") became
   obj."${name}'('arg")).
   Fix: add (?<!}) lookbehind so a double-quote preceded by '}' is never
   treated as an opening delimiter.

3. UnnecessaryGString matched double-quoted content inside single-quoted strings
   (e.g. 'format "hh:mm:ss"'), corrupting the outer string.
   Fix: the regex alternation now first matches and skips complete single-quoted
   strings so their embedded double-quoted content is never converted.

Tests added for all three cases.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Base automatically changed from 8.0.x-stage-hibernate7 to 8.0.x June 4, 2026 20:08
Assisted-by: opencode:openai/gpt-5.5 oracle
@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 19.0184%. Comparing base (7da662f) to head (76340d7).

Additional details and impacted files

Impacted file tree graph

@@                 Coverage Diff                 @@
##                8.0.x     #15568         +/-   ##
===================================================
- Coverage     48.4322%   19.0184%   -29.4138%     
+ Complexity      15265        288      -14977     
===================================================
  Files            1875         57       -1818     
  Lines           85852       3423      -82429     
  Branches        14972        597      -14375     
===================================================
- Hits            41580        651      -40929     
+ Misses          37863       2642      -35221     
+ Partials         6409        130       -6279     

see 1818 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Resolved dependencies.gradle by taking the latest base dependency versions for Spring Boot, Spock, and Sitemesh while retaining Hibernate 7 BOM-specific dependency sections.

Assisted-by: opencode:openai/gpt-5.5 oracle
@jamesfredley

Copy link
Copy Markdown
Contributor

I found a list of items here that I think are important and will have a PR against this PR in a few hours.

Resolve dependencies.gradle conflict: take mongodb 5.8.0 from 8.0.x
(aligned with the Spring Boot 4.1 BOM) and keep the reactor.version
3.8.5 entry added on this branch.

Assisted-by: claude-code:claude-opus-4-8
@matrei

matrei commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

I found a list of items here that I think are important and will have a PR against this PR in a few hours.

@jamesfredley Ok, I started reviewing, but I'll hold off until you are done.

@jamesfredley

Copy link
Copy Markdown
Contributor

@matrei @jdaugherty @borinquenkid #15731 is the list of items I found. Feel free to commit to that branch and anything can be added or subtracted. The PR description will be update in a few minutes with a full breaking changes table between h5.6 and h7.2.

Hopefully CI will finish in that PR, if not feel free to push fixes.

@jdaugherty

Copy link
Copy Markdown
Contributor Author

@jamesfredley I have said it before but I am highly against module substitution to expand test coverage. For multiple reasons:

  1. the dependency substitution conflicts are not immediately clear
  2. we only see those in CI / its not easy to run the tests locally
  3. hibernate 7 logic now is tied to hibernate 5 and can prevent us from refactoring/ evolving

We should just copy tests to expand coverage.

@borinquenkid

borinquenkid commented Jun 13, 2026

Copy link
Copy Markdown
Member

@jamesfredley @jdaugherty

Thinking ahead to the broader roadmap: we also need to start actively planning and working toward Hibernate 8.

With that in mind, framing Grails 8.0 as a permanent, dual-baseline bridge isn't sustainable. It forces us to carry too much legacy weight while trying to leapfrog forward. Instead, we should use this PR to clean house and establish a clear, fast-moving release strategy:

The Proposed Lifecycle Compromise

  1. Grails 8.0 (The Final Legacy Baseline)

    • Focuses strictly on stabilizing the Hibernate 7 migration.
    • Hibernate 5 is placed on immediate maintenance support. It will receive only critical security patches and small bug fixes—zero feature parity or active development. This gives legacy users a stable runway to plan an upgrade.
  2. Grails 8.5 (The Clean Break & Hibernate 8 Preview)

    • Completely drops support for Hibernate 5. This allows us to fully remove the dynamic dependency substitution configurations and retire the dual-module TCK infrastructure that complicates local development.
    • Introduces Hibernate 8 as the primary, forward-looking ORM baseline.

Why This Splitting of the Difference Works

  • Prevents "Triple Refactoring": Moving to Hibernate 7 required building a complex bridge (HibernateCriteriaBuilder / HibernateQuery) to handle the total removal of the legacy native Criteria API. Since Hibernate 8 will continue to build strictly on top of modern JPA semantics, dropping Hibernate 5 early ensures we don't have to support three distinct architectural eras simultaneously.
  • Prepares the Core Early: The decomposition of GrailsDomainBinder and the tightening of the HibernateMappingContext hierarchy in this PR already move us toward a cleaner, more modular design. This makes swap-in compatibility for Hibernate 8 significantly easier down the road.
  • Unblocks the Build Pipeline: It addresses the structural documentation build issues immediately. We won't have to fight single-pass build constraints to force-compile incompatible Hibernate 5 and Hibernate 7 modules alongside independent drivers like MongoDB.

By establishing this hard cutoff, we protect developer ergonomics, clean up the CI pipeline, and immediately clear the runway to start targeting Hibernate 8 features.

@jdaugherty

Copy link
Copy Markdown
Contributor Author

@borinquenkid until there is wider adoption or a dependency change that forces the retirement of 5.x, I do not see a need to preemptively retire the other code line. We should first release dual code lines and evaluate after.

@borinquenkid

borinquenkid commented Jun 13, 2026

Copy link
Copy Markdown
Member

@borinquenkid until there is wider adoption or a dependency change that forces the retirement of 5.x, I do not see a need to preemptively retire the other code line. We should first release dual code lines and evaluate after.

I think I did not make myself clear: G8 supports 5 and 7, minor patches to 5 no new features. Release quicly a G8.1 with new features and drop H5.. 5 is just our thing for this release. That way we can do things @jamesfredley way just to get it out the door and then cut off immediately and do things your way. Moving forward we should be able to just have one hibernate module once spring 5 comes in the horizon we will have a branch for H8 or whatever is relevant at the time.

@jdaugherty

Copy link
Copy Markdown
Contributor Author

Our release policy forbids dropping support for a feature in a minor release

@borinquenkid

Copy link
Copy Markdown
Member

Our release policy forbids dropping support for a feature in a minor release

Fair enough. So that would mean dropping H5 for Grails 9, SpringBoot 4.1

matrei added 6 commits June 15, 2026 15:49
Merge changed package back to `grails.gorm.tests`.
Align package and imports accordingly.
Merge changed package back to `grails.gorm.tests`.
Align package and imports accordingly.
After a merge, `Hibernate7OptimisticLockingSpec` had two `setupSpec()`
methods.
@testlens-app

testlens-app Bot commented Jun 15, 2026

Copy link
Copy Markdown

🚨 TestLens detected 1 failed test 🚨

Here is what you can do:

  1. Inspect the test failures carefully.
  2. If you are convinced that some of the tests are flaky, you can mute them below.
  3. Finally, trigger a rerun by checking the rerun checkbox.

Test Summary

Check Project/Task Test Runs
CI / Functional Tests (Java 21, indy=false) :grails-test-examples-scaffolding:integrationTest UserControllerSpec > User list

🏷️ Commit: 2b11a80
▶️ Tests: 10698 executed
⚪️ Checks: 43/43 completed

Test Failures

UserControllerSpec > User list (:grails-test-examples-scaffolding:integrationTest in CI / Functional Tests (Java 21, indy=false))
geb.waiting.WaitTimeoutException: condition did not pass in 10 seconds (failed with exception)
	at geb.waiting.Wait.waitFor(Wait.groovy:128)
	at geb.waiting.PotentiallyWaitingExecutor.execute(PotentiallyWaitingExecutor.groovy:31)
	at geb.Page.verifyThisPageAtOnly(Page.groovy:424)
	at geb.Page.getAtVerificationResult(Page.groovy:217)
	at geb.Page.verifyAt(Page.groovy:188)
	at geb.Browser.doAt(Browser.groovy:1208)
	at geb.Browser.at(Browser.groovy:410)
	at geb.Browser.to(Browser.groovy:566)
	at geb.Browser.to(Browser.groovy:543)
	at geb.Browser.to(Browser.groovy:532)
	at grails.plugin.geb.support.delegate.BrowserDelegate$Trait$Helper.to(BrowserDelegate.groovy:160)
	at com.example.UserControllerSpec.User list(UserControllerSpec.groovy:46)
Caused by: Assertion failed: 

title == pageTitle
|     |  |
|     |  'User List'
|     false
'Please sign in'

	at com.example.pages.UserListPage._clinit__closure1(UserListPage.groovy:28)
	at com.example.pages.UserListPage._clinit__closure1(UserListPage.groovy)
	at geb.waiting.Wait.waitFor(Wait.groovy:117)
	... 11 more

Muted Tests

Select tests to mute in this pull request:

  • UserControllerSpec > User list

Reuse successful test results:

  • ♻️ Only rerun the tests that failed or were muted before

Click the checkbox to trigger a rerun:

  • Rerun jobs

Learn more about TestLens at testlens.app.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

4 participants