gradle / api-evolution-demo

Demo of API evolution tricks

Gradle is a build tool with a focus on build automation and support for multi-language development. If you are building, testing, publishing, and deploying software on any platform, Gradle offers a flexible model that can support the entire development lifecycle from compiling and packaging code to publishing websites. Gradle has been designed to support build automation across multiple languages and platforms, including Java, Scala, Android, Kotlin, C/C++, and Groovy, and is closely integrated with development tools and continuous integration servers, including Eclipse, IntelliJ, and Jenkins.

For more information, please visit the official project homepage

Getting Started

• Installing Gradle
• Building Android Apps
• Building Java Applications
• Building Java Libraries
• Building Groovy Applications
• Building Groovy Libraries
• Building Scala Applications
• Building Scala Libraries
• Building Kotlin JVM Applications
• Building Kotlin JVM Libraries
• Building C++ Applications
• Building C++ Libraries
• Building Swift Applications
• Building Swift Libraries
• Creating Build Scans

Stay in Flow

Enjoy first-class Gradle support in your IDE of choice.

• Android Studio
• Eclipse
• IntelliJ IDEA
• NetBeans
• Visual Studio Code

Need Help?

• Get familiar with the Gradle User Manual
• Upcoming trainings
• Ask on the forum or StackOverflow
• Have a look at the Samples
• Checkout the Community Resources as well
• Join our Slack Channel

Contributing

If you're looking to contribute to Gradle or provide a patch/pull request, you can find more info here.

This project adheres to the Gradle Code of Conduct. By participating, you are expected to uphold this code.

api-evolution-demo's Issues

Method replacement: handle `INVOKEINTERFACE`

This is probably very similar to #5.

Replace annotations

This is yet another feature we'd like to demonstrate.

Method replacement: handle replacing super calls ('INVOKESPECIAL')

Consider upgrading this:

class Client extends Server {
    @Override
    String getTestProperty() {
        return super.getTestProperty() + "-overridden"
    }

    @Override
    void setTestProperty(String value) {
        super.setTestProperty("overridden-" + value)
    }
}

When replacing a call like super.setProperty(), the JVM bytecode instruction used is INVOKESPECIAL instead of INVOKEVIRTUAL. Let's handle this use case and add some tests.

Method replacement: support replacing `INVOKEDYNAMIC` calls

Groovy 4 is going indy only: https://groovy-lang.org/releasenotes/groovy-4.0.html#Groovy4.0-indy-only

Replace type

Like move types from one package to another for example.

Making thrown exceptions more general is another example.

Execute only necessary upgrades based on client version

Bind upgrades to a client version and execute only the ones that are required for a particular version of the plugin. Make sure we don't incur overhead when an upgrade is not necessary.

Refactor testing the bytecode upgrades

Currently testing works by executing *Client.main(). This was good for testing the basic functionality, but now we would need more fine-grained test logic. Figure out a way to have some nice syntax over upgraded classes.

Method replacement: handle method references

When passing method references to replaced methods, let's make sure those get converted to their upgraded counterparts.

Allow decorating `System.getProperties()`

This is a special replacement already implemented by gradle/gradle in InstrumentingTransformer. We need to have this functionality working if we want to use this tool in Gradle itself.

Method replacement: add typed method replacers

Currently when replacing a method there is very little type information exposed at registration. We could make it harder to write invalid code by adding replacement builders that work with type information about arguments and the return type.

Fix `double` parameter handling for dynamic Groovy

Dynamic Groovy converts double parameters to BigDecimal internally. This causes the following exception to be thrown when this code is uncommented:

api-evolution-demo/old-client/src/main/groovy/org/gradle/demo/api/evolution/DynamicGroovyClient.groovy

Lines 10 to 12 in 2337013

	// TODO Fix this, apparently Groovy sends double values over as BigDecimal
	// doSetDouble(server)
	// println doGetDouble(server)

java.lang.ClassCastException: java.math.BigDecimal cannot be cast to java.lang.Double
	at org.gradle.demo.api.evolution.ApiUpgradeManager.lambda$addSetterReplacement$2(ApiUpgradeManager.java:110)
	at org.gradle.demo.api.evolution.MethodReplacement$1.call(MethodReplacement.java:125)
	at org.gradle.demo.api.evolution.DynamicGroovyClient.doSetDouble(DynamicGroovyClient.groovy:40)
	at org.gradle.demo.api.evolution.DynamicGroovyClient.main(DynamicGroovyClient.groovy:11)
	at org.gradle.demo.api.evolution.PropertyUpgradeTest.dynamic Groovy client works(PropertyUpgradeTest.groovy:37)