Enabling Gradle configuration cache breaks plugin

[xzel23]

When enabling the Gradle configuration cache, I get errors like this from the plugin:

• What went wrong:
  Execution failed for task ':utility:forbiddenApisMain'.

No signatures were added to task; use properties 'signatures', 'bundledSignatures', 'signaturesURLs', and/or 'signaturesFiles' to define those!

When I either disable the configuration cache or the plugin, the build runs without errors (tested with same results using Gradle 8.14.3 and 9.0.0-rc-3).

I can reproduce this in any of my projects by just passing --configuration-cache on the command line. Please let me know if you cannot reproduce and need a minimal sample.

[dweiss]

I guess the question is how you configure the task (is your project open source)? This configuration cache feature in gradle... Let's say it's controversial (to me).

[xzel23]

@dweiss Yes, it's open source. But the build uses another plugin where the released version also is not yet compatible with the configuration cache - the new version already is, but before I can release, I have to finish migrating from the discontinued OSS-RH to Maven Publish Portal first. It's a busy month, with the OSS-RH migration and making plugins compatible with upcoming Gradle 9...

I'll look into creating a minimal example project for this in the coming days.

[uschindler]

This is new to me, the configuration cache (was) working at some point in the past. But actually I don't have that on my priority list, because I find it not really useful and causing strange results (like this one). I think caching the whole configuration of tasks is likely to break. I am fine if Gradle caches all configuration files in memory and allows to recalculate the config quick enough is much more important than caching the whole (built) config.

Could it be that you were using the extension forbiddenApis for configuration and not the specific tasks like forbiddenApisMain? If it works in the latter case than the issue is with the extension and the convention mapping.

[xzel23]

@uschindler Yes, I'm using the extension:

    forbiddenApis {
        bundledSignatures = setOf("jdk-internal", "jdk-deprecated")
        ignoreFailures = false
    }

I will try with the tasks later.

[xzel23]

Changed it to this and it works:

    tasks.withType(de.thetaphi.forbiddenapis.gradle.CheckForbiddenApis::class).configureEach {
        bundledSignatures = setOf("jdk-internal", "jdk-deprecated")
        ignoreFailures = false
    }

[uschindler]

Ok, so the problem is with the extension. Looks like it is not part of the cache. Maybe some marker annotation or interface is missing. I wonder why the task is cacheable at all, because it is not yet marked as such with @CacheableTask.

[uschindler]

I think the problem is caused by this statement: https://docs.gradle.org/current/userguide/configuration_cache.html#config_cache:requirements:task_extensions

It uses the extension internally to store the information. It looks like the resolving of the convention is not done before task executes, so it is not cached (null values are cached).

[dweiss]

They have made everything very complicated. I am sorry, it is terrible to me.

[uschindler]

They have made everything very complicated. I am sorry, it is terrible to me.

Same here. I don't want to touch it or fix any bugs. Gradle Plugin of forbiddenapis is no longer understandable and therefore not maintained anymore. Standard stuff works but caching is not in my priority list. Sorry!