Add support for EnableGoogleServicesPlugin

[chemerisuk]

Platforms affected

Android

What does this PR do?

@macdonst proposed to add new preference to the platform, that runs google services plugin.

What testing has been done on this change?

Checked locally.

Checklist

• Reported an issue in the JIRA database
• Commit message follows the format: "CB-3232: (android) Fix bug with resolving file paths", where CB-xxxx is the JIRA ID & "android" is the platform affected.
• Added automated test coverage as appropriate for this change.

[codecov-io]

Codecov Report

Merging #438 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #438   +/-   ##
=======================================
  Coverage   44.16%   44.16%           
=======================================
  Files          17       17           
  Lines        1698     1698           
  Branches      314      314           
=======================================
  Hits          750      750           
  Misses        948      948

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 59e3b90...f2a4d92. Read the comment docs.

[macdonst]

@chemerisuk I've had to make this line:

apply plugin: 'com.google.gms.googleservices.GoogleServicesPlugin'

because the class must be used instead of id(string) to be able to apply plugin from non-root gradle file. I haven't tested the PR yet but I'm assuming the reason you are using the ID is because it is a root gradle file?

[chemerisuk]

Yes, because this is the root Gradle file. Worked fine on my side.

For testing I commented changes from cordova-support-google-services and inserted PR code manually. Then rebuilt the project and tried to start (btw google services v15 trigger error at runtime, if ‘google.services’ was not processed properly while previously it was build time error).

[macdonst]

👍

[macdonst]

@infil00p wanna take a look at this?

[erisu]

Would it be possible to wrap this classpath in an if condition, like how the apply is done?
It would be nice to minimize the amount of downloading of build related libraries if they are not needed.

if (cdvHelpers.getConfigPreference('EnableGoogleServicesPlugin', 'false').toBoolean()) {
  classpath 'com.google.gms:google-services:3.2.1'
}

[chemerisuk]

It looks like the object cdvHelpers is not available at the dependency scope. Project build failed with the error:

Could not get unknown property 'cdvHelpers' for object of type org.gradle.api.internal.artifacts.dsl.dependencies.DefaultDependencyHandler.

Happens when I apply the changes you suggest.

[erisu]

@chemerisuk Yes, it seems cordova.gradle would need to be applied within the scope so it becomes available.

    dependencies {
        apply from: '../CordovaLib/cordova.gradle'

        classpath 'com.android.tools.build:gradle:3.1.0'

        if(cdvHelpers.getConfigPreference('EnableGoogleServicesPlugin', 'false').toBoolean()) {
            println 'Adding classpath "com.google.gms:google-services:3.2.1"'

            classpath 'com.google.gms:google-services:3.2.1'
        }
    }

@dpogue Would you know off-hand if something like this would be problematic? The cordova.gradle content seems to be only helper methods. Adding it seems to solve the desire to make the classpaths conditional.

[dpogue]

I don't know much about Gradle, and my experience consists mostly of swearing at it.

I believe you're correct that cordova.gradle is helper methods, but I don't know anything about scoping or when it's safe to import (apply?) stuff.

[erisu]

@chemerisuk I would like to try and get this PR updated and merged before the upcoming major release.

If possible, could you rebase the PR with master and fix the conflicting files?

Also, as I proposed in a previous comment, could you wrap the classpath 'com.google.gms:google-services:3.2.1' with the EnableGoogleServicesPlugin?

The code snippet that I provided in a previous comment will work as intended.

You will need to add the apply from: '../CordovaLib/cordova.gradle' to the dependencies scope to have access to the helper methods. I had tested this locally and it should not cause any problems.

Lastly, since this PR was created awhile back, I had some other nice to have that could be applied with this PR, if you can do this, it will be great. If you do not have the time, I can do it in a second PR if needed.

1. Bump the Google Services version to a newer version.

I recall that the phonegap-plugin-push plugin had build issues with 4.2.0 so maybe bump the version to 4.1.0 which people reported working.

Actually, with this PR and the phonegap-plugin-push plugin, there is a build issue which will need investigation and I am suspecting it might be related that the phonegap-plugin-push plugin dependency on cordova-support-google-services.

2. Could we introduce a second preference config options: GoogleServicesPluginVersion which would allow users the ability to decide what version they would want to use. (Default to 4.1.0).

Please let me know if you can do this or if I should create a new PR based on your changes and apply the additional changes.

[erisu]

@chemerisuk I went ahead and created a second PR to be able to quickly fix the merge conflicts as well as apply the additional change request that I posted.

This PR will close as soon as my PR is merged. Since I cherry-picked your commit in, it will still contain your contribution.

Thank you for your contribution and sorry that it took this long to merge in your commit.

[chemerisuk]

@erisu thanks for the update. Unfortunately my current environment is a bit different now, so it will be hard to test those changes properly. So please go ahead with the PR, it's a long waited one.

If you have time could you post a link to a compilation problem at phonegap-plugin-push you've mentioned.

[erisu]

@chemerisuk I do not have an issue ticket regarding the issues I described with the phonegap-plugin-push plugin.

But, I pushed a PR that briefly explains changes to the plugin that will be needed to use these new preference options without having a build issue. It removed the enable google services plugin dependency.

The issue the plugin had was a conflict with the new preferences enabling the Google Services in the buildscript while the enable google services plugin dependency did the same thing.

Here is the PR: phonegap/phonegap-plugin-push#2873

It is currently labeled as DRAFT because we will need to first release the major.