search

MinecraftForge / Artifactural

A Gradle artifact processing and management tool
GNU Lesser General Public License v2.1
6 stars 14 forks source link

Add compatibility with Gradle 4.10 and above #1

Closed Aaron1011 closed 5 years ago

Aaron1011 commented 5 years ago

This commits adds compatibility for Gradle 4.10 onward (tested on 4.10 and 5,4), while retainting compatibiliy with 4.9

Due to the ABI-incompatible changes in some internal gradle classes, we need to use bytecode manipulation to ensure that our built class files are compatible with both Gradle 4.9 and Gradle >= 4.10

Bytecode manipulation is performed at built time. A custom Gradle task is used to read in the compiled class files from disk, and write out a modified version to the final jar artifact.

In order to make as few bytecode modifications as possible, this commit bumps the Gradle wrapper version to 4.10. This means that we're compiling against Gradle 4.10, and using bytecode manipulation to retain compatibility with 4.9. Doing the reverse (compiling against 4.9) would be significantly more difficult, as we would need to statically reference classes that exist in Gradle 4.10 but not 4.9 (specifically, RepositoryDescriptor)

We perform two different bytecode transformations:

  1. We modify the call to 'super()' in GradleRepositoryAdapter. In Gradle 4.10, the suepr constructor takes one argument, but in 4.9, it takes zero arguments. In order to allow GradleRepositoryAdapter to compile normally, we write a 'fake' call to 'super(null)', and replace with a call to 'super()'.

  2. We delete the method 'getDescriptor' from GradleRepositoryAdapter. In Gradle 4.9, its return type does not exist, and will cause a NoClassDefFoundError when Gradle attempts to classload it via Class#getDeclaredMethods. However, it's necessary to include 'getDescriptor' so that GradleRepositoryAdapter (we need to override the abstract method in a parent class).

williewillus commented 5 years ago

this seems....quite hacky (ASM-ing gradle classes what?)

I'd rather we just pick a day and move to the new gradle versions in one go.

LexManos commented 5 years ago

This is quite hacky, but it was done at my request. All the dirty hacks we do in FG3 are hidden behind this library. So it should be possible to maintain compatibility. IDEALLY we would have gradle select the proper version of Artifactual to use based on it's own version. But I haven't found a way to make that possible. So we are.

Aaron1011 commented 5 years ago

Are there any changes that I should make?

LexManos commented 5 years ago

Not at the moment, I just haven't had time to test this fully and haven't gotten feedback from anyone else.