Fix bitmap widgets not rendering or crashing on specific devices #1834

kiryldz · 2022-11-14T15:17:52Z

Summary of changes

Some devices (using Adreno GPUs) could not render bitmap widgets as depth test is enabled and thus widgets are rendered under the map.

The inital fix was to explicitly disable depth test on render thread OpenGL context before drawing the widget - however that just partly fixes the issue.

However correct fix also fixing atmosphere crash on Adreno GPUs is to use shared context when creating MapSurface / MapView with widgets. Both MapSurface / MapView will throw runtime exception now if widgets are trying to be added and MapOptions.contextMode != SHARED.

At the same time for the Mapbox Android Auto extension MapOptions.contextMode = SHARED is enforced in any case as Android Auto introduces compass / bitmap widgets which are most likely used by the user and preventing runtime crashing.

User impact (optional)

Pull request checklist:

Briefly describe the changes in this PR.
Include before/after visuals or gifs if this PR includes visual changes.
Write tests for all new functionality. If tests were not written, please explain why.
Optimize code for java consumption (@JvmOverloads, @file:JvmName, etc).
Add example if relevant.
Document any changes to public APIs.
Run make update-api to update generated api files, if there's public API changes, otherwise the verify-api-* CI steps might fail.
Update CHANGELOG.md or use the label 'skip changelog', otherwise check changelog CI step will fail.
If this PR is a v10.[version] release branch fix / enhancement, merge it to main firstly and then port to v10.[version] release branch.

Fixes: < Link to related issues that will be fixed by this pull request, if they exist >

PRs must be submitted under the terms of our Contributor License Agreement CLA.

sdk/src/main/java/com/mapbox/maps/MapSurface.kt

CHANGELOG.md

sdk/src/main/java/com/mapbox/maps/MapSurface.kt

alexander-kulikovskii · 2022-11-15T15:34:44Z

...auto/src/test/java/com/mapbox/maps/extension/androidauto/MapboxCarMapSessionInstallerTest.kt

+      every { lifecycle } returns lifecycleOwner.lifecycle
+    }
+
+    mockkStatic("com.mapbox.maps.MapboxLogger")


Suggested change

mockkStatic("com.mapbox.maps.MapboxLogger")

mockkStatic(MapboxLoggerClassName)

alexander-kulikovskii · 2022-11-15T15:37:06Z

...auto/src/test/java/com/mapbox/maps/extension/androidauto/MapboxCarMapSessionInstallerTest.kt

+    verify(exactly = 1) {
+      mapboxCarMap.setup(sessionCarContext, capture(mapInitOptions))
+    }
+    assert(mapInitOptions.captured.mapOptions.contextMode == ContextMode.SHARED)


Suggested change

assert(mapInitOptions.captured.mapOptions.contextMode == ContextMode.SHARED)

assertEquals(mapInitOptions.captured.mapOptions.contextMode, ContextMode.SHARED)

...roidauto/src/main/java/com/mapbox/maps/extension/androidauto/MapboxCarMapSessionInstaller.kt

sdk/src/main/java/com/mapbox/maps/MapSurface.kt

pengdev

LGTM with a nit

* MAPSAND-613 disable depth test for widgets * changelog * Use better approach * Add tests * Always throw exception in SDK, update AA extension * Remove warning when no context specified

kiryldz added the bug 🪲 Something isn't working label Nov 14, 2022

kiryldz requested a review from a team as a code owner November 14, 2022 15:17

kiryldz self-assigned this Nov 14, 2022

alexander-kulikovskii approved these changes Nov 15, 2022

View reviewed changes

jush approved these changes Nov 15, 2022

View reviewed changes

kiryldz changed the title ~~Fix bitmap widgets not rendering on specific devices~~ Fix bitmap widgets not rendering or crashing on specific devices Nov 15, 2022

kiryldz requested review from jush and alexander-kulikovskii November 15, 2022 11:53

paulrenn67 self-requested a review November 15, 2022 11:56

paulrenn67 approved these changes Nov 15, 2022

View reviewed changes

jush approved these changes Nov 15, 2022

View reviewed changes

sdk/src/main/java/com/mapbox/maps/MapSurface.kt Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

alexander-kulikovskii reviewed Nov 15, 2022

View reviewed changes

sdk/src/main/java/com/mapbox/maps/MapSurface.kt Outdated Show resolved Hide resolved

pengdev reviewed Nov 15, 2022

View reviewed changes

sdk/src/main/java/com/mapbox/maps/MapSurface.kt Outdated Show resolved Hide resolved

kiryldz force-pushed the kdz-fix-xiaomi-widget-render branch 2 times, most recently from 5f8eb19 to ad2f86a Compare November 15, 2022 15:18

jush reviewed Nov 15, 2022

View reviewed changes

sdk/src/main/java/com/mapbox/maps/MapSurface.kt Outdated Show resolved Hide resolved

jush reviewed Nov 15, 2022

View reviewed changes

sdk/src/main/java/com/mapbox/maps/MapSurface.kt Show resolved Hide resolved

kiryldz force-pushed the kdz-fix-xiaomi-widget-render branch from ad2f86a to d0fcfcc Compare November 15, 2022 15:20

kiryldz requested review from jush, pengdev, alexander-kulikovskii and paulrenn67 November 15, 2022 15:21

kiryldz force-pushed the kdz-fix-xiaomi-widget-render branch from d0fcfcc to 14e3887 Compare November 15, 2022 15:29

kiryldz requested a review from kmadsen November 15, 2022 15:34

alexander-kulikovskii reviewed Nov 15, 2022

View reviewed changes

yunikkk approved these changes Nov 15, 2022

View reviewed changes

kiryldz force-pushed the kdz-fix-xiaomi-widget-render branch from 14e3887 to 0a7f911 Compare November 15, 2022 16:21

kmadsen reviewed Nov 15, 2022

View reviewed changes

...roidauto/src/main/java/com/mapbox/maps/extension/androidauto/MapboxCarMapSessionInstaller.kt Show resolved Hide resolved

kmadsen reviewed Nov 15, 2022

View reviewed changes

...roidauto/src/main/java/com/mapbox/maps/extension/androidauto/MapboxCarMapSessionInstaller.kt Outdated Show resolved Hide resolved

kmadsen approved these changes Nov 15, 2022

View reviewed changes

This was referenced Nov 15, 2022

[Android Auto] Fix example issues mapbox/mapbox-navigation-android#6612

Merged

[Android Auto] Bump car library to 1.2.0 #1828

Merged

jush approved these changes Nov 16, 2022

View reviewed changes

kiryldz added 5 commits November 16, 2022 11:09

MAPSAND-613 disable depth test for widgets

3b9bcb0

changelog

c12912c

Use better approach

397004d

Add tests

2222971

Always throw exception in SDK, update AA extension

b06340a

kiryldz force-pushed the kdz-fix-xiaomi-widget-render branch from 2ec199d to 894a03f Compare November 16, 2022 09:11

pengdev reviewed Nov 16, 2022

View reviewed changes

sdk/src/main/java/com/mapbox/maps/MapSurface.kt Outdated Show resolved Hide resolved

pengdev approved these changes Nov 16, 2022

View reviewed changes

Remove warning when no context specified

3ab2bd1

kiryldz force-pushed the kdz-fix-xiaomi-widget-render branch from 894a03f to 3ab2bd1 Compare November 16, 2022 09:50

kiryldz mentioned this pull request Nov 16, 2022

PR #1834 port to release branch #1845

Merged

kiryldz merged commit f05f54d into main Nov 16, 2022

kiryldz deleted the kdz-fix-xiaomi-widget-render branch November 16, 2022 14:56

mapbox-github-ci-writer-public-1 bot pushed a commit that referenced this pull request Jul 13, 2023

Try publishing to closed track. (#1834)

68efe45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix bitmap widgets not rendering or crashing on specific devices #1834

Fix bitmap widgets not rendering or crashing on specific devices #1834

kiryldz commented Nov 14, 2022 •

edited

Loading

alexander-kulikovskii Nov 15, 2022

alexander-kulikovskii Nov 15, 2022

pengdev left a comment

	mockkStatic("com.mapbox.maps.MapboxLogger")
	mockkStatic(MapboxLoggerClassName)

	assert(mapInitOptions.captured.mapOptions.contextMode == ContextMode.SHARED)
	assertEquals(mapInitOptions.captured.mapOptions.contextMode, ContextMode.SHARED)

Fix bitmap widgets not rendering or crashing on specific devices #1834

Fix bitmap widgets not rendering or crashing on specific devices #1834

Conversation

kiryldz commented Nov 14, 2022 • edited Loading

Summary of changes

User impact (optional)

Pull request checklist:

alexander-kulikovskii Nov 15, 2022

Choose a reason for hiding this comment

alexander-kulikovskii Nov 15, 2022

Choose a reason for hiding this comment

pengdev left a comment

Choose a reason for hiding this comment

kiryldz commented Nov 14, 2022 •

edited

Loading