Excluding the gms play-service-location from maplibre for fdroid builds #6136

ouchadam · 2022-05-24T08:35:32Z

Type of change

Feature
Bugfix
Technical
Other :

Content

Fixes #6100

Excludes the non foss play services location optional transitive dependency from maplibre on fdroid builds.

Motivation and context

To allow the fdroid variant to contain only FOSS code.

Screenshots / GIFs

fdroid Before

+--- org.maplibre.gl:android-sdk:9.5.2
|    +--- org.maplibre.gl:android-sdk-geojson:5.9.0
|    |    \--- com.google.code.gson:gson:2.8.6
|    +--- com.mapbox.mapboxsdk:mapbox-android-gestures:0.7.0
|    |    +--- androidx.core:core:1.0.0 -> 1.7.0 (*)
|    |    \--- androidx.annotation:annotation:1.0.0 -> 1.3.0
|    +--- org.maplibre.gl:android-sdk-turf:5.9.0
|    |    \--- org.maplibre.gl:android-sdk-geojson:5.9.0 (*)
|    +--- androidx.annotation:annotation:1.0.0 -> 1.3.0
|    +--- androidx.fragment:fragment:1.0.0 -> 1.4.1 (*)
|    +--- com.squareup.okhttp3:okhttp:3.12.3 -> 4.9.3
|    |    +--- com.squareup.okio:okio:2.8.0 -> 2.10.0
|    |    |    +--- org.jetbrains.kotlin:kotlin-stdlib:1.4.20 -> 1.6.21 (*)
|    |    |    \--- org.jetbrains.kotlin:kotlin-stdlib-common:1.4.20 -> 1.6.21
|    |    \--- org.jetbrains.kotlin:kotlin-stdlib:1.4.10 -> 1.6.21 (*)
|    \--- com.google.android.gms:play-services-location:16.0.0
|         +--- com.google.android.gms:play-services-base:16.0.1 -> 17.0.0 (*)
|         +--- com.google.android.gms:play-services-basement:16.0.1 -> 17.0.0 (*)
|         +--- com.google.android.gms:play-services-places-placereport:16.0.0
|         |    \--- com.google.android.gms:play-services-basement:16.0.1 -> 17.0.0 (*)
|         \--- com.google.android.gms:play-services-tasks:16.0.1 -> 17.0.0 (*)
+--- org.maplibre.gl:android-plugin-annotation-v9:1.0.0
|    +--- androidx.appcompat:appcompat:1.0.0 -> 1.4.1 (*)
|    \--- org.maplibre.gl:android-sdk:9.4.2 -> 9.5.2 (*)

fdroid After

+--- org.maplibre.gl:android-sdk:9.5.2
|    +--- org.maplibre.gl:android-sdk-geojson:5.9.0
|    |    \--- com.google.code.gson:gson:2.8.6
|    +--- com.mapbox.mapboxsdk:mapbox-android-gestures:0.7.0
|    |    +--- androidx.core:core:1.0.0 -> 1.7.0 (*)
|    |    \--- androidx.annotation:annotation:1.0.0 -> 1.3.0
|    +--- org.maplibre.gl:android-sdk-turf:5.9.0
|    |    \--- org.maplibre.gl:android-sdk-geojson:5.9.0 (*)
|    +--- androidx.annotation:annotation:1.0.0 -> 1.3.0
|    +--- androidx.fragment:fragment:1.0.0 -> 1.4.1 (*)
|    \--- com.squareup.okhttp3:okhttp:3.12.3 -> 4.9.3 (*)
+--- org.maplibre.gl:android-plugin-annotation-v9:1.0.0
|    +--- androidx.appcompat:appcompat:1.0.0 -> 1.4.1 (*)
|    \--- org.maplibre.gl:android-sdk:9.4.2 -> 9.5.2 (*)
+--- io.jsonwebtoken:jjwt-impl:0.11.5
|    \--- io.jsonwebtoken:jjwt-api:0.11.5
\--- io.jsonwebtoken:jjwt-orgjson:0.11.5
     \--- io.jsonwebtoken:jjwt-api:0.11.5

FDROID LOCATION

Tests

print out dependency graph with ./gradlew vector:dependencies
Notice fdroid variants exclude play-services-location from maplibre's transitive dependencies
Launch the fdroid app
Enable location sharing via settings -> preferences
Share a location

Tested devices

Physical
Emulator
OS version(s): 28

…cy for the fdroid variant - fixes fdroid being unable to compile the project due to a non foss dependency

ouchadam · 2022-05-24T09:14:21Z

vector/build.gradle

-    implementation 'org.maplibre.gl:android-plugin-annotation-v9:1.0.0'
-
+    fdroidImplementation(libs.maplibre.androidSdk) {
+        exclude group: 'com.google.android.gms', module: 'play-services-location'


we should be safe to exclude this due to maplibre doing a runtime check for play services location classes when attempting to create a location provider https://github.com/maplibre/maplibre-gl-native/blob/ea234edf67bb3aec75f077e15c1c30c99756b926/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/location/engine/LocationEngineProvider.java#L59

Thanks for checking. For my understanding, Is it mandatory to specify the module here?

not mandatory, I can reduce the explicitness if wanted

I chose to target only the location module as that's the module maplibre is doing the runtime check against

OK, also this seems to be the only imported module, see:

https://github.com/maplibre/maplibre-gl-native/blob/ea234edf67bb3aec75f077e15c1c30c99756b926/platform/android/MapboxGLAndroidSDK/build.gradle#L16

https://github.com/maplibre/maplibre-gl-native/blob/ea234edf67bb3aec75f077e15c1c30c99756b926/platform/android/gradle/dependencies.gradle#L68

No need to reduce the explicitness.

Thanks!

github-actions · 2022-05-24T09:51:04Z

Unit Test Results

124 files ±0 124 suites ±0 2m 32s ⏱️ +16s
220 tests ±0 220 ✔️ ±0 0 💤 ±0 0 ❌ ±0
726 runs ±0 726 ✔️ ±0 0 💤 ±0 0 ❌ ±0

Results for commit bec7226. ± Comparison against base commit a59b8bf.

bmarty

Perfect, thanks!

bmarty · 2022-05-24T10:32:28Z

vector/build.gradle

-    implementation 'org.maplibre.gl:android-plugin-annotation-v9:1.0.0'
-
+    fdroidImplementation(libs.maplibre.androidSdk) {
+        exclude group: 'com.google.android.gms', module: 'play-services-location'


Thanks for checking. For my understanding, Is it mandatory to specify the module here?

bmarty · 2022-05-24T10:33:03Z

vector/build.gradle

+        exclude group: 'com.google.android.gms', module: 'play-services-location'
+    }
+    fdroidImplementation(libs.maplibre.pluginAnnotation) {
+        exclude group: 'com.google.android.gms', module: 'play-services-location'


I am pretty sure you have checked that, but does libs.maplibre.pluginAnnotation also bring this module?

it depends on maplibre-android-sdk which I was then seeing pull back in the transitive dependency 🤔

OK, thanks!

bmarty

Can be merged!

github-actions · 2022-05-25T08:56:34Z

Matrix SDK

Integration Tests Results:

[org.matrix.android.sdk.session]
= passed=20 failures=0 errors=0 skipped=3
[org.matrix.android.sdk.account]
= passed=3 failures=0 errors=0 skipped=2
[org.matrix.android.sdk.internal]
= passed=53 failures=2 errors=0 skipped=1
[org.matrix.android.sdk.ordering]
= passed=16 failures=0 errors=0 skipped=0
[org.matrix.android.sdk.PermalinkParserTest]
= passed=2 failures=0 errors=0 skipped=0

excluding the gms play-service-location optional transistive dependen…

bec7226

…cy for the fdroid variant - fixes fdroid being unable to compile the project due to a non foss dependency

ouchadam force-pushed the feature/adm/foss-avoid-gms-location-provider branch from a1bbdd3 to bec7226 Compare May 24, 2022 09:10

ouchadam marked this pull request as ready for review May 24, 2022 09:10

ouchadam requested review from a team, bmarty and Claire1817 and removed request for a team May 24, 2022 09:10

ouchadam added A-Location PR-Small PR with less than 20 updated lines labels May 24, 2022

ouchadam commented May 24, 2022

View reviewed changes

bmarty approved these changes May 24, 2022

View reviewed changes

Claire1817 approved these changes May 24, 2022

View reviewed changes

bmarty approved these changes May 25, 2022

View reviewed changes

ouchadam merged commit ae9922a into develop May 25, 2022

ouchadam deleted the feature/adm/foss-avoid-gms-location-provider branch May 25, 2022 07:59

TheLastProject mentioned this pull request May 28, 2022

FOSS flavor maplibre/maplibre-native#288

Closed

birkskyum mentioned this pull request Sep 18, 2022

Separate build flavor to avoid any references to non-FLOSS software maplibre/maplibre-native#379

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Excluding the gms play-service-location from maplibre for fdroid builds #6136

Excluding the gms play-service-location from maplibre for fdroid builds #6136

ouchadam commented May 24, 2022 •

edited

ouchadam May 24, 2022

bmarty May 24, 2022

ouchadam May 24, 2022 •

edited

bmarty May 25, 2022

github-actions bot commented May 24, 2022

bmarty left a comment

bmarty May 24, 2022

bmarty May 24, 2022

ouchadam May 24, 2022

bmarty May 25, 2022

bmarty left a comment

github-actions bot commented May 25, 2022

Excluding the gms play-service-location from maplibre for fdroid builds #6136

Excluding the gms play-service-location from maplibre for fdroid builds #6136

Conversation

ouchadam commented May 24, 2022 • edited

Type of change

Content

Motivation and context

Screenshots / GIFs

fdroid Before

fdroid After

Tests

Tested devices

ouchadam May 24, 2022

Choose a reason for hiding this comment

bmarty May 24, 2022

Choose a reason for hiding this comment

ouchadam May 24, 2022 • edited

Choose a reason for hiding this comment

bmarty May 25, 2022

Choose a reason for hiding this comment

github-actions bot commented May 24, 2022

Unit Test Results

bmarty left a comment

Choose a reason for hiding this comment

bmarty May 24, 2022

Choose a reason for hiding this comment

bmarty May 24, 2022

Choose a reason for hiding this comment

ouchadam May 24, 2022

Choose a reason for hiding this comment

bmarty May 25, 2022

Choose a reason for hiding this comment

bmarty left a comment

Choose a reason for hiding this comment

github-actions bot commented May 25, 2022

Matrix SDK

Integration Tests Results:

ouchadam commented May 24, 2022 •

edited

ouchadam May 24, 2022 •

edited