AndroidX support #256

timbru31 · 2019-04-10T18:06:42Z

Expected Behaviour

The plugin is compatible with AndroidX (as discussed here: #251 (comment))

Actual Behaviour

Plugin is not compatible with AndroidX.

Reproduce Scenario (including but not limited to)

Steps to Reproduce

Install the plugin and build it for Android.
As cordova-android does not yet support AndroidX (see androidx apache/cordova-android#565), open the project manually with Android Studio.
Manually migrate to AndroidX (see https://developer.android.com/jetpack/androidx/migrate#migrate)
The refactoring has to be done manually:

Platform and Version (eg. Android 5.0 or iOS 9.2.1)

Android

(Android) What device vendor (e.g. Samsung, HTC, Sony...)

n/a

Cordova CLI info

cordova info

Here is the output:

n/a

Plugin version

cordova plugin version | grep cordova-plugin-file-opener2

Here is the output:

2.2.0

Sample Code that illustrates the problem

The current code [...] extends android.support.v4.content.FileProvider {
needs to be updated to androidx.core.content.FileProvider.

This is a breaking change and will require a major version bump.

Logs taken while reproducing problem

n/a

Background info

Sadly, since Cordova plugins ship the .java instead of the .class files the automatic migration (jettifier, see: https://developer.android.com/jetpack/androidx#using_androidx) does not work and the plugin authors need to update their plugins.

The text was updated successfully, but these errors were encountered:

timbru31 · 2019-04-23T18:25:25Z

Good news! dpa99c just released two plugins, one to enable AndroidX support, one to fill in the compatibility gap: dpa99c/cordova-diagnostic-plugin#350 (comment)

pwlin · 2019-04-26T17:41:59Z

hi @timbru31 thanks that's great news! I will try to look into that comment and merge the changes back in here.

mg · 2019-09-19T15:45:49Z

Hi is there any news on this issue?

timbru31 · 2019-09-19T15:48:40Z

You can use the cordova-plugin-androidx-adapter and cordova-plugin-androidx plugins in the meantime to solve this issue

mg · 2019-09-19T17:39:51Z

that solved it for me, thank you

pwlin · 2020-05-13T14:50:16Z

@timbru31, @mg How do you go solving this issue? I have looked into the plugin mentioned but I am not sure what do you. Is this just a matter of changing the FileProvider class to extend androidx.core.content.FileProvider, instead of android.support.v4.content.FileProvider? I appreciate your suggestions.

Update: Is #292 something that would completely fix this issue?

mg · 2020-05-13T14:52:28Z

No, I just installed the 2 plugins, that took care of it for me

timbru31 · 2020-05-13T15:04:24Z

The plugins do two things:

cordova-plugin-androidx enables the AndroidX support in the gradle files: https://github.com/dpa99c/cordova-plugin-androidx/blob/master/scripts/apply-to-gradle.properties.js#L31-L36
cordova-plugin-androidx-adapter replaces all v4 occurrences with the AndroidX equivalent (https://github.com/dpa99c/cordova-plugin-androidx-adapter/blob/master/apply.js#L38-L54) - since Cordova plugins are shipping .java files instead of .class files, the Android Jettifier can't do this automatically.

As a plugin author, I'd do the following:

Wait until cordova-android@9 is released with AndroidX support out of the box (feat: add androidx support apache/cordova-android#901)
Upgrade my plugin code to use only AndroidX
Release a new major version which requires cordova-android@9

Users should be able to either just use cordova-android@9 or cordova-android@8 with cordova-plugin-androidx.

timbru31 · 2020-05-13T15:26:23Z

Update: Is #292 something that would completely fix this issue?

This forces all your users to install two plugins from another author or wait until cordova-android@9 is released - or breaks the plugin for them in case they can't migrate to AndroidX (yet).
But yes, technically it would close this issue.

pwlin · 2020-05-14T08:17:32Z

Thank you for the explanation. I think at the moment the best way to handle this is to add cordova-plugin-androidx and cordova-plugin-androidx-adapter to one's project. I will add a note to readme.md about how to support AndroidX, linking to those 2 plugins.

StefanVanStaden · 2020-05-26T11:19:43Z

Hi, I am having this issue as well but I am using Capacitor not Cordova. So I installed cordova-plugin-androidx and cordova-plugin-androidx-adapter using npm and when I synced with the Android project it still came up with the issue. Every time I make a build I need to manually change

public class FileProvider extends android.support.v4.content.FileProvider { }

to the following

public class FileProvider extends androidx.core.content.FileProvider { }

I would imagine this change will be required for anyone who keeps there projects up to date with the latest technology. If not then they simply need to use the lock file and lock this package to where they need it. I will not be able to compile my application using CI/CD since I will need to manually come and change this code after every Ionic build.

davidmarquis · 2020-07-13T13:53:11Z

@StefanVanStaden Looks like using Jetifier with Capacitor has cut it for me. I just followed the instructions here: https://capacitorjs.com/docs/android/troubleshooting#error-package-android-support-does-not-exist

In short, I ran:

npm install jetifier
npx jetify
npx cap sync android

And the subsequent automated builds ran correctly.

vikshv · 2020-08-20T06:48:29Z

The plugins do two things:

cordova-plugin-androidx enables the AndroidX support in the gradle files: https://github.com/dpa99c/cordova-plugin-androidx/blob/master/scripts/apply-to-gradle.properties.js#L31-L36

cordova-plugin-androidx-adapter replaces all v4 occurrences with the AndroidX equivalent (https://github.com/dpa99c/cordova-plugin-androidx-adapter/blob/master/apply.js#L38-L54) - since Cordova plugins are shipping .java files instead of .class files, the Android Jettifier can't do this automatically.

As a plugin author, I'd do the following:

Wait until cordova-android@9 is released with AndroidX support out of the box (apache/cordova-android#901)

Upgrade my plugin code to use only AndroidX

Release a new major version which requires cordova-android@9

Users should be able to either just use cordova-android@9 or cordova-android@8 with cordova-plugin-androidx.

Cordova 10.0.0 released with cordova-android@9.0.0: https://cordova.apache.org/announcements/2020/07/28/cordova-lib-release-10.0.0.html

Now my build failed with cordova@10.0.0 and cordova-android@9.0.0. Required android.support.v4.content

AndroidXEnabled = true

richardkshergold · 2020-08-24T08:44:54Z

When I build my Ionic 5 Capacitor app locally the app builds ok but when I build up on AppFlow the build fails with the error

android.support.v4.content does not exist against the FileOpener2 plugin.

The ionic docs suggest adding jetifier and running npx jetify so I have installed it and added the following to the package.json scripts section:

"postinstall": "npx jetify"

Unfortunately the builds still fail on AppFlow with an error of:

npm WARN lifecycle myApp@2.9.9~postinstall: cannot run in wd myApp@2.9.9 npx jetify (wd=/builds/myName/myApp)

I then tried with these two plugins instead (as per the docs):

cordova-plugin-androidx
cordova-plugin-androidx-adapter

However when I add these and try to build on AppFlow I get a failure with the original error again:

android.support.v4.content does not exist

Does this mean I am not going to be able to use this plugin with AppFlow?

almothafar · 2020-09-22T13:27:34Z

It is a blocked issue for me now!

> Task :app:compileReleaseJavaWithJavac FAILED
/app/platforms/android/app/src/main/java/io/github/pwlin/cordova/plugins/fileopener2/FileProvider.java:28: error: package android.support.v4.content does not exist
public class FileProvider extends android.support.v4.content.FileProvider {
                                                            ^
/app/platforms/android/app/src/main/java/io/github/pwlin/cordova/plugins/fileopener2/FileOpener2.java:119: error: cannot find symbol
                                                path = FileProvider.getUriForFile(context, cordova.getActivity().getPackageName() + ".fileOpener2.provider", file);
                                                                   ^
  symbol:   method getUriForFile(Context,String,File)
  location: class FileProvider
/app/platforms/android/app/src/main/java/io/github/pwlin/cordova/plugins/fileopener2/FileOpener2.java:127: error: cannot find symbol
                                        Uri path = FileProvider.getUriForFile(context, cordova.getActivity().getPackageName() + ".fileOpener2.provider", file);
                                                               ^
  symbol:   method getUriForFile(Context,String,File)
  location: class FileProvider
Note: Some input files use or override a deprecated API.
Note: Recompile with -Xlint:deprecation for details.
Note: Some input files use unchecked or unsafe operations.
Note: Recompile with -Xlint:unchecked for details.
3 errors

FAILURE: Build failed with an exception.

almothafar · 2020-12-21T14:58:29Z

Any update or better fork for this?

patriciopage · 2021-01-10T20:11:35Z

@StefanVanStaden Looks like using Jetifier with Capacitor has cut it for me. I just followed the instructions here: https://capacitorjs.com/docs/android/troubleshooting#error-package-android-support-does-not-exist

In short, I ran:
npm install jetifier
npx jetify
npx cap sync android
And the subsequent automated builds ran correctly.

This worked for me. Without installing the androidx plugins (cordova-plugin-androidx and cordova-plugin-androidx-adapter) I ran those three commands and now my FileProvider class from cordova FileOpener2 extends androidx.core.content.FileProvider.

Thanks!

tshesko1 · 2021-03-23T15:38:34Z

@StefanVanStaden Looks like using Jetifier with Capacitor has cut it for me. I just followed the instructions here: https://capacitorjs.com/docs/android/troubleshooting#error-package-android-support-does-not-exist
In short, I ran:
npm install jetifier
npx jetify
npx cap sync android
And the subsequent automated builds ran correctly.
This worked for me. Without installing the androidx plugins (cordova-plugin-androidx and cordova-plugin-androidx-adapter) I ran those three commands and now my FileProvider class from cordova FileOpener2 extends androidx.core.content.FileProvider.

These 3 lines of codes from https://capacitorjs.com/docs/android/troubleshooting#error-package-android-support-does-not-exist
just saved my projects. Thank You !

almothafar · 2021-04-04T23:30:45Z

Running npx jetify in ionic cordova project solved my issue, just before I build the app.

@richardkshergold you seems found your solution here: https://forum.ionicframework.com/t/android-support-v4-content-does-not-exist-appflow-build-issue/194978 just need to link this thread :)

KirstenStake · 2021-09-30T07:54:13Z

@richardkshergold did you ever solve this for AppFlow? Am experiencing the same issue. Build manually works with the jetifier plugin etc but AppFlow fails

richardshergold · 2021-09-30T08:10:55Z

Hi Kirsten. Yes I did with the help of an Ionic engineer. The solution was to place a .npmrc file in the root of the project with the following in it:

unsafe-perm=true

I hope that works for you too.

KirstenStake · 2021-10-01T07:36:29Z

@richardshergold thank you for your speedy reply.

for anyone else, to summarise entire steps:

As a workaround, you can patch the plugin using jetifier:

npm install jetifier
npx jetify
npx cap sync android

The jetifier should be in package.json file.

You need to include a postinstall script in package.json for jetifier to run. This can be done as shown below:

"scripts": {
...
"postinstall": "jetifier"
}

In the file named .npmrc (create the file if not already present) in the root of your project, add the following contents. This will give npm running the jetifier script permissions.
unsafe-perm=true

shnist · 2023-01-31T10:46:24Z

androidX is now supported in the latest release

shnist pinned this issue Apr 15, 2019

pwlin unpinned this issue Apr 16, 2019

shnist pinned this issue Apr 23, 2019

pwlin self-assigned this Apr 26, 2019

pwlin added enhancement help-needed need help developing, using, testing this plugin labels Apr 26, 2019

benhtn mentioned this issue Jul 1, 2019

Build fails: D8: Program type already present: android.support.v4.os.ResultReceiver$MyResultReceiver chemerisuk/cordova-plugin-firebase-analytics#118

Closed

PawelGIX mentioned this issue May 25, 2020

Compilation: Program type already present: android.support.v4.app.INotificationSideChannel$Stub$Proxy andrehtissot/cordova-plugin-fcm-with-dependecy-updated#80

Closed

lmsantanam mentioned this issue Mar 22, 2021

Plugin compile Android Error (Ionic Capacitor) katzer/cordova-plugin-printer#274

Open

sahilrajthapa mentioned this issue Dec 12, 2021

android.support.v4.content.FileProvider not found #326

Closed

shnist closed this as completed Jan 31, 2023

shnist unpinned this issue Feb 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AndroidX support #256

AndroidX support #256

timbru31 commented Apr 10, 2019

timbru31 commented Apr 23, 2019

pwlin commented Apr 26, 2019

mg commented Sep 19, 2019

timbru31 commented Sep 19, 2019

mg commented Sep 19, 2019

pwlin commented May 13, 2020 •

edited

Loading

mg commented May 13, 2020

timbru31 commented May 13, 2020

timbru31 commented May 13, 2020

pwlin commented May 14, 2020

StefanVanStaden commented May 26, 2020

davidmarquis commented Jul 13, 2020

vikshv commented Aug 20, 2020 •

edited

Loading

richardkshergold commented Aug 24, 2020

almothafar commented Sep 22, 2020

almothafar commented Dec 21, 2020

patriciopage commented Jan 10, 2021

tshesko1 commented Mar 23, 2021

almothafar commented Apr 4, 2021

KirstenStake commented Sep 30, 2021

richardshergold commented Sep 30, 2021 •

edited

Loading

KirstenStake commented Oct 1, 2021

shnist commented Jan 31, 2023

AndroidX support #256

AndroidX support #256

Comments

timbru31 commented Apr 10, 2019

Expected Behaviour

Actual Behaviour

Reproduce Scenario (including but not limited to)

Steps to Reproduce

Platform and Version (eg. Android 5.0 or iOS 9.2.1)

(Android) What device vendor (e.g. Samsung, HTC, Sony...)

Cordova CLI info

Plugin version

Sample Code that illustrates the problem

Logs taken while reproducing problem

Background info

timbru31 commented Apr 23, 2019

pwlin commented Apr 26, 2019

mg commented Sep 19, 2019

timbru31 commented Sep 19, 2019

mg commented Sep 19, 2019

pwlin commented May 13, 2020 • edited Loading

mg commented May 13, 2020

timbru31 commented May 13, 2020

timbru31 commented May 13, 2020

pwlin commented May 14, 2020

StefanVanStaden commented May 26, 2020

davidmarquis commented Jul 13, 2020

vikshv commented Aug 20, 2020 • edited Loading

richardkshergold commented Aug 24, 2020

almothafar commented Sep 22, 2020

almothafar commented Dec 21, 2020

patriciopage commented Jan 10, 2021

tshesko1 commented Mar 23, 2021

almothafar commented Apr 4, 2021

KirstenStake commented Sep 30, 2021

richardshergold commented Sep 30, 2021 • edited Loading

KirstenStake commented Oct 1, 2021

shnist commented Jan 31, 2023

pwlin commented May 13, 2020 •

edited

Loading

vikshv commented Aug 20, 2020 •

edited

Loading

richardshergold commented Sep 30, 2021 •

edited

Loading