Find a way to determine whether a third-party library should be jetified [119135578]

Fixed

Bug

Reviewed (L1)

Status Update

No update yet.

Description

hu...@google.com

created issue #1

Nov 6, 2018 10:45PM

Jetifier is supposed to work on third-party libraries that do not yet support AndroidX. However, if a library has already been updated to support AndroidX, or if it is not using AndroidX/support libraries at all, then it is not necessary to run Jetifier to convert it, and doing so may even result in incorrect rewritten binaries.

Example failures:

(1)

http://issuetracker.google.com/118658603#comment1
Execution failed for task ':app:kaptGenerateStubsDebugKotlin'.
> Could not resolve all files for configuration ':app:kapt'.
> Failed to transform file 'butterknife-compiler-9.0.0-SNAPSHOT.jar' to match attributes {artifactType=processed-jar} using transform JetifyTransform
> Failed to transform '...\.gradle\caches\modules-2\files-2.1\com.jakewharton\butterknife-compiler\9.0.0-SNAPSHOT\d5efd0795737d4523044335a7faa82b0e3d984c9\butterknife-compiler-9.0.0-SNAPSHOT.jar' using Jetifier.
Reason: The given artifact contains a string literal with a package reference 'android.support.v4.content' that cannot be safely rewritten. Libraries using reflection such as annotation processors need to be updated manually to add support for androidx.

(2)

http://issuetracker.google.com/113224601#comment13
Execution failed for task ':app:kaptGenerateStubsDebugKotlin'.
> Could not resolve all files for configuration ':app:kapt'.
> Failed to transform file 'jetifier-core-1.0.0-alpha10.jar' to match attributes {artifactType=processed-jar} using transform JetifyTransform
> Failed to transform '/Users/nkotula/.gradle/caches/modules-2/files-2.1/com.android.tools.build.jetifier/jetifier-core/1.0.0-alpha10/9eb7027c383061de12f93aae7a22cbeb97832d2a/jetifier-core-1.0.0-alpha10.jar' using Jetifier. Reason: The given artifact contains a string literal with a package reference 'android/support/v4' that cannot be safely rewritten. Libraries using reflection such as annotation processors need to be updated manually to add support for androidx.

(In this example, Jetifier even tries to jetify itself!)

(3)

http://issuetracker.google.com/113880420
Execution failed for task ':app:kaptGenerateStubsDebugKotlin'.
> Could not resolve all files for configuration ':app:kapt'.
> Failed to transform file 'kotlin-compiler-embeddable-1.2.21.jar' to match attributes {artifactType=processed-jar} using transform JetifyTransform
> Failed to transform '/root/.gradle/caches/modules-2/files-2.1/org.jetbrains.kotlin/kotlin-compiler-embeddable/1.2.21/39456b64a42dc359e385697e2e93b5cba52e197f/kotlin-compiler-embeddable-1.2.21.jar' using Jetifier.
Reason: Malformed input or input contains unmappable characters: javaslang/?.class.

(In this example, kotlin-compiler-embeddable-1.2.21.jar does not need to be jetified but was jetified and then failed.)

We need a way to determine whether a third-party library should be jetified or not. There are a couple of approaches:
1. The library adds some metadata stating that it is AndroidX-ready and therefore should not be jetified. (The Android Gradle plugin can also help to add this information automatically for libraries that are built using the AGP.)
2. Jetifier automatically detects the presence of AndroidX (e.g., import statements and strings containing references to AndroidX), and if AndroidX is present, assumes that the library is AndroidX-ready and skips converting it.
3. The users need to specify a blacklist of libraries that should not be jetified.

We'll need to weigh the pros and cons of these approaches and select the best one (or a combination of them).

Comments

xa...@google.com <xa...@google.com> #2Nov 7, 2018 12:04AM

pa...@google.com <pa...@google.com> #3Nov 8, 2018 06:55PM

lblb636@ Thanks for reporting this bug. I just want to confirm that the issue is the call device button being not responsive according to the uploaded video. It seems like this issue only happened on Windows.

Message last modified on Nov 8, 2018 06:56PM

hu...@google.com <hu...@google.com> #4Nov 8, 2018 06:59PM

@3 Why does it occur?
And why only from specific API of Android?
On API 28 for example, it doesn't occur...

Please fix this issue for all API versions of the emulator.

hu...@google.com <hu...@google.com> #5Nov 18, 2018 05:31AM

Another similar issue that's related https://b.corp.google.com/issues/226426377

[Deleted User] <[Deleted User]> #6Nov 22, 2018 11:47PM

RE#4 I need to try this on Windows laptop first and I couldn't repro on MacOS or Linux. But I think this is most likely related to the modem simulator we introduced for API 31. Will need to further investigate.

hu...@google.com <hu...@google.com> #7Dec 4, 2018 04:49PM

@6 There are plenty of issues on emulator API 31 (and on Android 13 emulator). Many glitches. Spend 5 minutes on it and you will notice.
Why isn't the emulator tested more on Windows OS?
Windows OS is more popular than Linux and MacOS combined (on desktop) ...

jt...@temp.thunderhead.com <jt...@temp.thunderhead.com> #8Dec 7, 2018 03:30PM

@6 Also please check on all versions of the emulator, to see when this issue started, and fix from there.

ms...@gmail.com <ms...@gmail.com> #9Dec 14, 2018 06:58PM

I reproduced this bug on Windows with emulator version 31.2.10-8420304

pa...@google.com <pa...@google.com> #10Dec 18, 2018 12:17PM

@9 Please test on more API versions.

hu...@google.com <hu...@google.com> #11Dec 18, 2018 02:05PM

Found the root cause when the "call device" button was unresponsive. It became unresponsive because the inbound call failed to initialize. Basically, the modem simulator's shared FD failed. When receive_inbound_call is invoked, it is supposed to make connection to the "host server" via a shared fd but it is flaky on Windows unfortunately.

modem-simulator: receive_inbound_call:101 inbound call from 6505551212
modem-simulator: process_msgs:296 waiting for new messages ...
modem-simulator: main_host_thread:501 got connection at host server at 65094
modem-simulator: start_calling_thread:254 making a connection to main host server 65094
modem-simulator: main_host_thread:507 Detected close from the other side
modem-simulator: start_calling_thread:262 nothing read quit
modem-simulator: main_host_thread:494 looping at main host server at 65094
modem-simulator: start_calling_thread:284 done with this thread

st...@gmail.com <st...@gmail.com> #12Jan 3, 2019 10:46PM

@5 I can't reach the link you've provided.

@11 So it could be the same reason that this bug occurs:

https://issuetracker.google.com/issues/233123301
?

im...@google.com <im...@google.com> #13Jan 4, 2019 11:26AM

RE#12 I have uploaded a patch to fix this issue. I don't think it's the same reason for https://issuetracker.google.com/issues/233123301

st...@gmail.com <st...@gmail.com> #14Jan 4, 2019 03:31PM

@13 OK thanks.
Have you tested it on all API versions, to make sure that it doesn't cause new issues, and also fixes the issue on other places in case it's there too?

jt...@temp.thunderhead.com <jt...@temp.thunderhead.com> #15Jan 22, 2019 05:31PM

RE#14 This issue is for API 31+, I will check for API 32 and API 33. Thanks for reminding me.

hu...@google.com <hu...@google.com> #16Jan 23, 2019 11:33AM

@15 Please check before too, to make sure it doesn't cause new issues

ne...@gmail.com <ne...@gmail.com> #17Feb 3, 2019 12:46PM

Please fix it for all Android emulator versions.
When will the fix be available?

hu...@google.com <hu...@google.com> #18Feb 4, 2019 10:37AM

The fix has been merged in both 31 release and 32 release for since 05/2022.

ne...@gmail.com <ne...@gmail.com> #19Feb 4, 2019 02:05PM

@18 Merged, but is it available for all using the normal updates?
On which version ?

hu...@google.com <hu...@google.com> #20Feb 5, 2019 03:47PM

I see, but again I'm afraid it is too late for 3.2 at this point. One thing you could try is to disable Jetifier (set android.enableJetifier=false), and run the Jetifier standalone tool (

https://developer.android.com/studio/command-line/jetifier) on individual libraries and import the jetified ones instead of the original ones. I know it's not pretty, but hopefully it will work for you.

ri...@gmail.com <ri...@gmail.com> #21Feb 21, 2019 02:14PM

Any ideas about this one -
org.gradle.api.tasks.TaskExecutionException: Execution failed for task ':app:kaptGenerateStubsDebugKotlin'
...
Caused by: java.lang.RuntimeException: Failed to transform '/Users/user/.gradle/caches/modules-2/files-2.1/org.xerial/sqlite-jdbc/3.20.1/df3068e837e9490a9554212fcab40a2c55faf0a3/sqlite-jdbc-3.20.1.jar' using Jetifier. Reason: invalid entry size (expected 618164 but got 636977 bytes). (Run with --stacktrace for more details.) To disable Jetifier, set android.enableJetifier=false in your gradle.properties file.
at com.android.build.gradle.internal.dependency.JetifyTransform.transform(JetifyTransform.kt:204)

hu...@google.com <hu...@google.com> #22Feb 21, 2019 02:21PM

Can you please file a new bug with us and link it here so I can follow up?

ri...@gmail.com <ri...@gmail.com> #23Feb 21, 2019 02:26PM

Sure

ri...@gmail.com <ri...@gmail.com> #24Feb 22, 2019 06:29AM

Hey, deleting and cloning the repo again fixes this issue, do you still want me to file this?

hu...@google.com <hu...@google.com> #25Feb 22, 2019 11:37AM

No need for now (as there is too little information for it to be actionable), but we'll keep that in mind and please do file a bug if you see it again. Thanks!

em...@gmail.com <em...@gmail.com> #26Mar 12, 2019 04:12PM

Hi,

I have this error but I cannot fix if with blacklist, is it the same issue ? Could `android.jetifier.blacklist` property fix it ?

09:08:56 > Could not resolve all files for configuration ':app:releaseUnitTestCompileClasspath'.
09:08:56 > Failed to transform artifact 'full.jar (project :api)' to match attributes {artifactType=processed-jar, com.android.build.api.attributes.BuildTypeAttr=release, com.android.build.api.attributes.VariantAttr=release, com.android.build.gradle.internal.dependency.AndroidTypeAttr=Aar, org.gradle.usage=java-api, org.jetbrains.kotlin.platform.type=androidJvm}

Thanks

hu...@google.com <hu...@google.com> #27Mar 13, 2019 11:50AM

This is a different issue. Please file a new bug and let me know the bug ID. Thanks!

eb...@netflix.com <eb...@netflix.com> #28Mar 13, 2019 03:46PM

Done here :

https://issuetracker.google.com/issues/128469625

me...@thomaskeller.biz <me...@thomaskeller.biz> #29Nov 25, 2019 06:07PM

Jetifier really brings up some headaches. We upgraded AGP from 3.5.2 to 3.6.0-beta04 and found our Cucumber tests failing afterwards. The issue Cucumber reports was

cucumber.runtime.CucumberException: No backends were found. Please make sure you have a backend module on your CLASSPATH.

Cucumber reports that when an artifact like `cucumber-java` (or any other language backend) is not present. Cucumber tries to service-load this automatically when present in the classpath (see

https://github.com/cucumber/cucumber-jvm/search?q=JavaBackendProviderService&unscoped_q=JavaBackendProviderService for references), but apparently fails.

Interestingly, the tests continued to run without issues in Android Studio, they were just failing when executed from command line. A test run with --debug showed me that the Gradle run however used jetified versions of the cucumber libraries in the application classpath. Adding `.*cucumber.*` to the jetifier blacklist solved the issue.

I'm completely unaware of the black magic that Jetifier involves, but I see that it has some very serious consequences when applied broadly on a project, things that are rather hard to track down because subtle things like service locators suddenly stop working.

hu...@google.com <hu...@google.com> #30Nov 28, 2019 12:36PM

Thank you for the feedback! We are looking to remove edge cases like this one, and bug reports like this help us do that.

If possible, could you attach the original version of the cucumber library and the jetified version, so that we can investigate what was actually modified by Jetifier?

hu...@google.com <hu...@google.com> #31Dec 6, 2019 03:13PM

Marked as fixed.

Starting with AGP 4.0.0-alpha07 (using Jetifier 1.0.0-beta06+), Jetifier will not jetify libraries that already support AndroidX:

https://android-review.googlesource.com/c/platform/frameworks/support/+/952620/. The blacklist workaround shouldn't be needed anymore.

After updating to AGP 4.0.0-alpha07+, please remove the android.jetifier.blacklist property if you have been using it. And if you still run into issues after doing that, please file a bug with us at

http://issuetracker.google.com/issues/new?component=460323.

To close the loop on the 3 different approaches outlined at

comment #1

:

> We need a way to determine whether a third-party library should be jetified or not. There are a couple of approaches:
> 1. The library adds some metadata stating that it is AndroidX-ready and therefore should not be jetified.
=> Infeasible

> 2. Jetifier automatically detects the presence of AndroidX (e.g., import statements and strings containing references to AndroidX), and if AndroidX is present, assumes that the library is AndroidX-ready and skips converting it.
=> Implemented

> 3. The users need to specify a blacklist of libraries that should not be jetified.
=> Used previously as a workaround (see

comment #5

), but not recommended now, as approach #2 should remove the need for this workaround. If you still find yourself having to use the blacklist, it is most likely a bug, please tell us at

http://issuetracker.google.com/issues/new?component=460323.

Message last modified on Dec 13, 2019 10:50AM