HHH-14082 Hibernate cannot determine its core version in modular configuration

[mehmetali2003]

HHH-14082 Hibernate cannot determine it's core version in modular configuration

Currently the Version gets the information via: Version.class.getPackage().getImplementationVersion()
But in modular mode it should call this instead: Version.class.getModule().getDescriptor().version()

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
and can be relicensed under the terms of the LGPL v2.1 license in the future at the maintainers' discretion.
For more information on licensing, please check here.

---

https://hibernate.atlassian.net/browse/HHH-14082

[gavinking]

Should there be a fallback to getPackage().getImplementationVersion() somewhere here?

[marko-bekhta]

I was going to suggest that maybe we could do something similar to this version injection into bytecode as it's done for Search e.g. here:

https://github.com/hibernate/hibernate-search/blob/6490598a0ee5895520a5915e53fe4d7af52abed7/engine/pom.xml#L44-L60

But then I notice that there already seems to be an injection gradle plugin:

hibernate-orm/build.gradle

Line 22 in 9361a1b

id "org.hibernate.build.version-injection" version "2.0.0" apply false

Maybe we should just make sure that the plugin is used in this case?

(cc7c7d7 this commit might be related as it seems it "removes" the injection part?)

[mehmetali2003]

Should there be a fallback to getPackage().getImplementationVersion() somewhere here?

Hello Gavin,

Ok, I will look through. Thanks.

[mehmetali2003]

Should there be a fallback to getPackage().getImplementationVersion() somewhere here?

Hello @gavinking,

Is it better to check getPackage() and getImplementationVersion() or to inject "org.hibernate.build.version-injection" in gradle? Which one do you recommend?

Thanks

[gavinking]

@mehmetali2003 I don't know.

[Sanne]

(cc7c7d7 this commit might be related as it seems it "removes" the injection part?)

It's been a while, but I don't think the intent was to remove the bytecode injection part. I think the intent was to make sure the constant would be initialized as a "real constant" when running the native-image compiler.

So I suspect we simply never noticed that the bytecode injection had stopped working, as Version.class.getPackage().getImplementationVersion() has been effective enough (until today..)

+1 to restore the bytecode injection. Perhaps we should do it in such a way to actually cause a hard-failure when it fails, so to notice such defects earlier.

[marko-bekhta]

hmmm so it seems the plugin is just disabled and not configured at the moment 😖

We'd need at minimum:

versionInjection {
    into( 'org.hibernate.Version', 'initVersion' )
}

as an injection plugin config, then

id "org.hibernate.build.version-injection" apply true

actually enable the plugin for the core module (it is disabled in one of the more common build files)

aaaand we'd also need a new release of the plugin... with the current version it is failing with the serialisation exception (+ it won't find the method as it's private so another tiny change to the plugin is needed). I have a fix locally, but looking at the plugin repository, we'd need to update its release process first 🙂 ,

with all that in place, it renders the following version class:

public final class Version {
    private static final String VERSION = initVersion();

    private static String initVersion() {
        return "7.1.1-SNAPSHOT";
    }

    private Version() {
    }

    public static String getVersionString() {
        return VERSION;
    }

    public static void logVersion() {
        ((CoreMessageLogger)Logger.getMessageLogger(MethodHandles.lookup(), CoreMessageLogger.class, Version.class.getName())).version(getVersionString());
    }

    @AllowSysOut
    public static void main(String[] args) {
        System.out.println("Hibernate ORM core version " + getVersionString());
    }
}

[gavinking]

@marko-bekhta But is all this actually better than just using the features that are built into Java?