When running our project build (that makes use of refreshVersions) with --configuration-cache, this is the output:

2: Task failed with an exception.

What went wrong:
Configuration cache problems found in this build.

1 problem was found storing the configuration cache.

Unknown location: registration of listener on 'Gradle.buildFinished' is unsupported
See https://docs.gradle.org/7.0.2/userguide/configuration_cache.html#config_cache:requirements:build_listeners

See the complete report at file:///.../configuration-cache/as0e4uasippp0jkgc90s5xhk-1/configuration-cache-report.html

Listener registration 'Gradle.buildFinished' by build is unsupported.

Note that Gradle is as helpful as ever, and I've had to actually jump into debugging mode with it to learn that it came from this plugin in our project.

When running with configuration cache problems only shown as warnings, it technically caches it, but from experience with the build cache, it'll lead to some tasks not being re-run/run with the same configuration as previously. I am currently investigating how to remove those buildFinished calls, by registering a service with gradle that'll handle it, but since those buildFinished calls come from a place where there is no available Project, but just a ProjectDescriptor, this might get a little bit hairy.

EDIT: nvm, it can be registered through settings too. I'll keep investigating and come back with findings.

EDIT 2: That was surprisingly easy. Taking inspiration from what gradle-doctor did (runningcode/gradle-doctor@120d920), but by passing lambdas instead of requiring everything to be an autocloseable, allowing us to do any needed cleanup

    abstract class StaticStateClearOnBuildFinishedService : BuildService<BuildServiceParameters.None>, AutoCloseable {
        private val closeList = LinkedList<() -> Unit>()

        fun closeMeWhenFinished(lambda: () -> Unit) {
            closeList.push(lambda)
        }

        override fun close() {
            closeList.forEach {
                it()
            }

            closeList.clear()
        }

    }

then, in the places where clearStaticState was called, simply attempt to use that service when gradle allows it.

     if (GradleVersion.version(settings.gradle.gradleVersion) >= GradleVersion.version("6.5")) {
            // Closeable services were integrated in 6.5
            val closeService = settings.gradle.sharedServices
                .registerIfAbsent("close-resources-service", StaticStateClearOnBuildFinishedService::class.java) {}.get()

            closeService.closeMeWhenFinished { httpClient.dispatcher.executorService.shutdown() }
            closeService.closeMeWhenFinished { resettableDelegates.reset() }
        } else {
            settings.gradle.buildFinished {
                clearStaticState()
            }
        }

For tests, I had added a little bit of logging to ensure our lambda gets called, and it does. (Ignore the build failure, no phone plugged in):
./gradlew --configuration-cache application:installDevelopmentDebug

[about 200 modules worth of build info]
> Task :application:installDevelopmentDebug FAILED
Closing!
Closing!

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':application:installDevelopmentDebug'.
> com.android.builder.testing.api.DeviceException: No connected devices!

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 11m 37s
2803 actionable tasks: 1813 executed, 984 from cache, 6 up-to-date
Configuration cache entry stored.

Future runs do seem to reuse that cache:

./gradlew --configuration-cache installDevelopmentDebug
Configuration cache is an incubating feature.
Reusing configuration cache.
> Task :application:installDevelopmentDebug FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':application:installDevelopmentDebug'.
> com.android.builder.testing.api.DeviceException: No connected devices!

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 12s
2803 actionable tasks: 1 executed, 2802 up-to-date
Configuration cache entry reused.

Let me know if you'd like me to make this a pull request, or if you'd rather handle it/test yourself.

Uh oh!

Uh oh!

Support Gradle configuration cache #228

Description

Metadata

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

Issue actions