mapbox/mapbox-base-android

Filter module creation exceptions

LukasPaczos opened this issue · 0 comments

LukasPaczos commented

There are currently 4 possible ways to create an instance of a module:

mapbox-base-android/common/src/main/java/com/mapbox/common/module/provider/MapboxModuleProvider.kt

Lines 102 to 155 in c16916e

/**
* Try to invoke a no-arg, public constructor.
*/
private val noArgConstructorCreator = object : ModuleInstanceProvider {
override fun getInstance(implClass: Class<*>, type: MapboxModuleType, paramsProvider: (MapboxModuleType) -> Array<ModuleProviderArgument>): Any? {
val constructor = implClass.getConstructor()
return constructor.newInstance()
}
}
/**
* Try to get the instance of a Kotlin object.
*/
private val kotlinObjectReferenceProvider = object : ModuleInstanceProvider {
override fun getInstance(implClass: Class<*>, type: MapboxModuleType, paramsProvider: (MapboxModuleType) -> Array<ModuleProviderArgument>): Any? {
return implClass.getField("INSTANCE").get(null)
}
}
/**
* Try to get the instance of a singleton.
*/
private val singletonReferenceProvider = object : ModuleInstanceProvider {
override fun getInstance(implClass: Class<*>, type: MapboxModuleType, paramsProvider: (MapboxModuleType) -> Array<ModuleProviderArgument>): Any? {
return implClass.getMethod("getInstance").invoke(null)
}
}
/**
* Try to use default arguments for and create a Mapbox default module.
*/
private val defaultMapboxModuleCreator = object : ModuleInstanceProvider {
override fun getInstance(implClass: Class<*>, type: MapboxModuleType, paramsProvider: (MapboxModuleType) -> Array<ModuleProviderArgument>): Any? {
val params = paramsProvider.invoke(type)
val constructor =
implClass.getConstructor(*params.map { it.expectedArgumentClass }.toTypedArray())
return constructor.newInstance(*params.map { it.argumentInstance }.toTypedArray())
}
}
/**
* Instance creators are called in order until the first one returns a non-null value.
*
* 1. Create using no-ard constructor
* 2. Get Kotlin `object` ref
* 3. Get singleton instance ref
* 4. Create using Mapbox default params
*/
private val instanceCreators: Array<ModuleInstanceProvider> = arrayOf(
noArgConstructorCreator,
kotlinObjectReferenceProvider,
singletonReferenceProvider,
defaultMapboxModuleCreator
)

Any of those 4 could be the expected one by the consumer, so if module creation fails, we collect the exception for all of the tries and report them together. As an example, here the telemtry module creation fails:

2021-01-05 17:59:09.891 23655-23655/com.test.minimaptest E/MapboxModuleProvider: Module loading failed
    java.lang.NoSuchMethodException: com.mapbox.maps.module.telemetry.MapTelemetryImpl.<init> []
        at java.lang.Class.getConstructor0(Class.java:2332)
        at java.lang.Class.getConstructor(Class.java:1728)
        at com.mapbox.common.module.provider.MapboxModuleProvider$noArgConstructorCreator$1.getInstance(MapboxModuleProvider.kt:107)
        at com.mapbox.common.module.provider.MapboxModuleProvider.createModule(MapboxModuleProvider.kt:69)
        at com.mapbox.maps.MapView.dispatchTelemetryTurnstileEvent(MapView.kt:279)
        at com.mapbox.maps.MapView.<init>(MapView.kt:124)
        at com.mapbox.maps.MapView.<init>(MapView.kt:100)
        at com.mapbox.maps.MapView.<init>(MapView.kt:82)
        at com.mapbox.maps.MapView.<init>(MapView.kt:76)
        at java.lang.reflect.Constructor.newInstance0(Native Method)
        at java.lang.reflect.Constructor.newInstance(Constructor.java:343)
        at android.view.LayoutInflater.createView(LayoutInflater.java:852)
        at android.view.LayoutInflater.createViewFromTag(LayoutInflater.java:1004)
        at android.view.LayoutInflater.createViewFromTag(LayoutInflater.java:959)
        at android.view.LayoutInflater.rInflate(LayoutInflater.java:1121)
        at android.view.LayoutInflater.rInflateChildren(LayoutInflater.java:1082)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:680)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:532)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:479)
        at androidx.appcompat.app.AppCompatDelegateImpl.setContentView(AppCompatDelegateImpl.java:696)
        at androidx.appcompat.app.AppCompatActivity.setContentView(AppCompatActivity.java:170)
        at com.test.minimaptest.MainActivity.onCreate(MainActivity.kt:22)
        at android.app.Activity.performCreate(Activity.java:8000)
        at android.app.Activity.performCreate(Activity.java:7984)
        at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1309)
        at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3422)
        at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:3601)
        at android.app.servertransaction.LaunchActivityItem.execute(LaunchActivityItem.java:85)
        at android.app.servertransaction.TransactionExecutor.executeCallbacks(TransactionExecutor.java:135)
        at android.app.servertransaction.TransactionExecutor.execute(TransactionExecutor.java:95)
        at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2066)
        at android.os.Handler.dispatchMessage(Handler.java:106)
        at android.os.Looper.loop(Looper.java:223)
        at android.app.ActivityThread.main(ActivityThread.java:7656)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:592)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:947)
2021-01-05 17:59:09.892 23655-23655/com.test.minimaptest E/MapboxModuleProvider: Module loading failed
    java.lang.NoSuchFieldException: INSTANCE
        at java.lang.Class.getField(Class.java:1604)
        at com.mapbox.common.module.provider.MapboxModuleProvider$kotlinObjectReferenceProvider$1.getInstance(MapboxModuleProvider.kt:117)
        at com.mapbox.common.module.provider.MapboxModuleProvider.createModule(MapboxModuleProvider.kt:69)
        at com.mapbox.maps.MapView.dispatchTelemetryTurnstileEvent(MapView.kt:279)
        at com.mapbox.maps.MapView.<init>(MapView.kt:124)
        at com.mapbox.maps.MapView.<init>(MapView.kt:100)
        at com.mapbox.maps.MapView.<init>(MapView.kt:82)
        at com.mapbox.maps.MapView.<init>(MapView.kt:76)
        at java.lang.reflect.Constructor.newInstance0(Native Method)
        at java.lang.reflect.Constructor.newInstance(Constructor.java:343)
        at android.view.LayoutInflater.createView(LayoutInflater.java:852)
        at android.view.LayoutInflater.createViewFromTag(LayoutInflater.java:1004)
        at android.view.LayoutInflater.createViewFromTag(LayoutInflater.java:959)
        at android.view.LayoutInflater.rInflate(LayoutInflater.java:1121)
        at android.view.LayoutInflater.rInflateChildren(LayoutInflater.java:1082)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:680)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:532)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:479)
        at androidx.appcompat.app.AppCompatDelegateImpl.setContentView(AppCompatDelegateImpl.java:696)
        at androidx.appcompat.app.AppCompatActivity.setContentView(AppCompatActivity.java:170)
        at com.test.minimaptest.MainActivity.onCreate(MainActivity.kt:22)
        at android.app.Activity.performCreate(Activity.java:8000)
        at android.app.Activity.performCreate(Activity.java:7984)
        at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1309)
        at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3422)
        at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:3601)
        at android.app.servertransaction.LaunchActivityItem.execute(LaunchActivityItem.java:85)
        at android.app.servertransaction.TransactionExecutor.executeCallbacks(TransactionExecutor.java:135)
        at android.app.servertransaction.TransactionExecutor.execute(TransactionExecutor.java:95)
        at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2066)
        at android.os.Handler.dispatchMessage(Handler.java:106)
        at android.os.Looper.loop(Looper.java:223)
        at android.app.ActivityThread.main(ActivityThread.java:7656)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:592)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:947)
2021-01-05 17:59:09.893 23655-23655/com.test.minimaptest E/MapboxModuleProvider: Module loading failed
    java.lang.NoSuchMethodException: com.mapbox.maps.module.telemetry.MapTelemetryImpl.getInstance []
        at java.lang.Class.getMethod(Class.java:2072)
        at java.lang.Class.getMethod(Class.java:1693)
        at com.mapbox.common.module.provider.MapboxModuleProvider$singletonReferenceProvider$1.getInstance(MapboxModuleProvider.kt:126)
        at com.mapbox.common.module.provider.MapboxModuleProvider.createModule(MapboxModuleProvider.kt:69)
        at com.mapbox.maps.MapView.dispatchTelemetryTurnstileEvent(MapView.kt:279)
        at com.mapbox.maps.MapView.<init>(MapView.kt:124)
        at com.mapbox.maps.MapView.<init>(MapView.kt:100)
        at com.mapbox.maps.MapView.<init>(MapView.kt:82)
        at com.mapbox.maps.MapView.<init>(MapView.kt:76)
        at java.lang.reflect.Constructor.newInstance0(Native Method)
        at java.lang.reflect.Constructor.newInstance(Constructor.java:343)
        at android.view.LayoutInflater.createView(LayoutInflater.java:852)
        at android.view.LayoutInflater.createViewFromTag(LayoutInflater.java:1004)
        at android.view.LayoutInflater.createViewFromTag(LayoutInflater.java:959)
        at android.view.LayoutInflater.rInflate(LayoutInflater.java:1121)
        at android.view.LayoutInflater.rInflateChildren(LayoutInflater.java:1082)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:680)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:532)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:479)
        at androidx.appcompat.app.AppCompatDelegateImpl.setContentView(AppCompatDelegateImpl.java:696)
        at androidx.appcompat.app.AppCompatActivity.setContentView(AppCompatActivity.java:170)
        at com.test.minimaptest.MainActivity.onCreate(MainActivity.kt:22)
        at android.app.Activity.performCreate(Activity.java:8000)
        at android.app.Activity.performCreate(Activity.java:7984)
        at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1309)
        at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3422)
        at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:3601)
        at android.app.servertransaction.LaunchActivityItem.execute(LaunchActivityItem.java:85)
        at android.app.servertransaction.TransactionExecutor.executeCallbacks(TransactionExecutor.java:135)
        at android.app.servertransaction.TransactionExecutor.execute(TransactionExecutor.java:95)
        at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2066)
        at android.os.Handler.dispatchMessage(Handler.java:106)
        at android.os.Looper.loop(Looper.java:223)
        at android.app.ActivityThread.main(ActivityThread.java:7656)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:592)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:947)
2021-01-05 17:59:09.894 23655-23655/com.test.minimaptest E/MapboxModuleProvider: Module loading failed
    com.mapbox.maps.MapboxConfigurationException: Using MapView requires providing a valid access token when inflating or creating the view.
    Provide the token by creating a mapbox_access_token string resource or by passing it using MapView's 'mapbox_accessToken' XML attribute.
    The access token parameter is required when using a Mapbox service.
    Please see https://www.mapbox.com/help/create-api-access-token/ to learn how to create one.
    More information in this guide https://www.mapbox.com/help/first-steps-android-sdk/#access-tokens.
        at com.mapbox.maps.MapboxMapOptions.getResourceOptions(MapboxMapOptions.kt:38)
        at com.mapbox.maps.MapView.paramsProvider(MapView.kt:304)
        at com.mapbox.maps.MapView.access$paramsProvider(MapView.kt:52)
        at com.mapbox.maps.MapView$dispatchTelemetryTurnstileEvent$telemetry$1.invoke(MapView.kt:280)
        at com.mapbox.maps.MapView$dispatchTelemetryTurnstileEvent$telemetry$1.invoke(MapView.kt:52)
        at com.mapbox.common.module.provider.MapboxModuleProvider$defaultMapboxModuleCreator$1.getInstance(MapboxModuleProvider.kt:135)
        at com.mapbox.common.module.provider.MapboxModuleProvider.createModule(MapboxModuleProvider.kt:69)
        at com.mapbox.maps.MapView.dispatchTelemetryTurnstileEvent(MapView.kt:279)
        at com.mapbox.maps.MapView.<init>(MapView.kt:124)
        at com.mapbox.maps.MapView.<init>(MapView.kt:100)
        at com.mapbox.maps.MapView.<init>(MapView.kt:82)
        at com.mapbox.maps.MapView.<init>(MapView.kt:76)
        at java.lang.reflect.Constructor.newInstance0(Native Method)
        at java.lang.reflect.Constructor.newInstance(Constructor.java:343)
        at android.view.LayoutInflater.createView(LayoutInflater.java:852)
        at android.view.LayoutInflater.createViewFromTag(LayoutInflater.java:1004)
        at android.view.LayoutInflater.createViewFromTag(LayoutInflater.java:959)
        at android.view.LayoutInflater.rInflate(LayoutInflater.java:1121)
        at android.view.LayoutInflater.rInflateChildren(LayoutInflater.java:1082)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:680)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:532)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:479)
        at androidx.appcompat.app.AppCompatDelegateImpl.setContentView(AppCompatDelegateImpl.java:696)
        at androidx.appcompat.app.AppCompatActivity.setContentView(AppCompatActivity.java:170)
        at com.test.minimaptest.MainActivity.onCreate(MainActivity.kt:22)
        at android.app.Activity.performCreate(Activity.java:8000)
        at android.app.Activity.performCreate(Activity.java:7984)
        at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1309)
        at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3422)
        at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:3601)
        at android.app.servertransaction.LaunchActivityItem.execute(LaunchActivityItem.java:85)
        at android.app.servertransaction.TransactionExecutor.executeCallbacks(TransactionExecutor.java:135)
        at android.app.servertransaction.TransactionExecutor.execute(TransactionExecutor.java:95)
        at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2066)
        at android.os.Handler.dispatchMessage(Handler.java:106)
        at android.os.Looper.loop(Looper.java:223)
        at android.app.ActivityThread.main(ActivityThread.java:7656)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:592)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:947)
2021-01-05 17:59:09.921 23655-23655/com.test.minimaptest E/AndroidRuntime: FATAL EXCEPTION: main
    Process: com.test.minimaptest, PID: 23655
    java.lang.RuntimeException: Unable to start activity ComponentInfo{com.test.minimaptest/com.test.minimaptest.MainActivity}: android.view.InflateException: Binary XML file line #10 in com.test.minimaptest:layout/activity_main: Binary XML file line #10 in com.test.minimaptest:layout/activity_main: Error inflating class com.mapbox.maps.MapView
        at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3449)
        at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:3601)
        at android.app.servertransaction.LaunchActivityItem.execute(LaunchActivityItem.java:85)
        at android.app.servertransaction.TransactionExecutor.executeCallbacks(TransactionExecutor.java:135)
        at android.app.servertransaction.TransactionExecutor.execute(TransactionExecutor.java:95)
        at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2066)
        at android.os.Handler.dispatchMessage(Handler.java:106)
        at android.os.Looper.loop(Looper.java:223)
        at android.app.ActivityThread.main(ActivityThread.java:7656)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:592)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:947)
     Caused by: android.view.InflateException: Binary XML file line #10 in com.test.minimaptest:layout/activity_main: Binary XML file line #10 in com.test.minimaptest:layout/activity_main: Error inflating class com.mapbox.maps.MapView
     Caused by: android.view.InflateException: Binary XML file line #10 in com.test.minimaptest:layout/activity_main: Error inflating class com.mapbox.maps.MapView
     Caused by: java.lang.reflect.InvocationTargetException
        at java.lang.reflect.Constructor.newInstance0(Native Method)
        at java.lang.reflect.Constructor.newInstance(Constructor.java:343)
        at android.view.LayoutInflater.createView(LayoutInflater.java:852)
        at android.view.LayoutInflater.createViewFromTag(LayoutInflater.java:1004)
        at android.view.LayoutInflater.createViewFromTag(LayoutInflater.java:959)
        at android.view.LayoutInflater.rInflate(LayoutInflater.java:1121)
        at android.view.LayoutInflater.rInflateChildren(LayoutInflater.java:1082)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:680)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:532)
        at android.view.LayoutInflater.inflate(LayoutInflater.java:479)
        at androidx.appcompat.app.AppCompatDelegateImpl.setContentView(AppCompatDelegateImpl.java:696)
        at androidx.appcompat.app.AppCompatActivity.setContentView(AppCompatActivity.java:170)
        at com.test.minimaptest.MainActivity.onCreate(MainActivity.kt:22)
        at android.app.Activity.performCreate(Activity.java:8000)
        at android.app.Activity.performCreate(Activity.java:7984)
        at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1309)
        at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:3422)
        at android.app.ActivityThread.handleLaunchActivity(ActivityThread.java:3601)
        at android.app.servertransaction.LaunchActivityItem.execute(LaunchActivityItem.java:85)
        at android.app.servertransaction.TransactionExecutor.executeCallbacks(TransactionExecutor.java:135)
        at android.app.servertransaction.TransactionExecutor.execute(TransactionExecutor.java:95)
        at android.app.ActivityThread$H.handleMessage(ActivityThread.java:2066)
        at android.os.Handler.dispatchMessage(Handler.java:106)
        at android.os.Looper.loop(Looper.java:223)
        at android.app.ActivityThread.main(ActivityThread.java:7656)
        at java.lang.reflect.Method.invoke(Native Method)
        at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:592)
        at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:947)
     Caused by: MapboxInvalidModuleException(type=MapTelemetry)
        at com.mapbox.common.module.provider.MapboxModuleProvider.createModule(MapboxModuleProvider.kt:88)
        at com.mapbox.maps.MapView.dispatchTelemetryTurnstileEvent(MapView.kt:279)
2021-01-05 17:59:09.921 23655-23655/com.test.minimaptest E/AndroidRuntime:     at com.mapbox.maps.MapView.<init>(MapView.kt:124)
        at com.mapbox.maps.MapView.<init>(MapView.kt:100)
        at com.mapbox.maps.MapView.<init>(MapView.kt:82)
        at com.mapbox.maps.MapView.<init>(MapView.kt:76)
        	... 28 more

but the actually relevant part of the exception is only:

2021-01-05 17:59:09.894 23655-23655/com.test.minimaptest E/MapboxModuleProvider: Module loading failed
    com.mapbox.maps.MapboxConfigurationException: Using MapView requires providing a valid access token when inflating or creating the view.
    Provide the token by creating a mapbox_access_token string resource or by passing it using MapView's 'mapbox_accessToken' XML attribute.
    The access token parameter is required when using a Mapbox service.
    Please see https://www.mapbox.com/help/create-api-access-token/ to learn how to create one.
    More information in this guide https://www.mapbox.com/help/first-steps-android-sdk/#access-tokens.
        at com.mapbox.maps.MapboxMapOptions.getResourceOptions(MapboxMapOptions.kt:38)

from the last creation method.

It'd be great to find a way to understand which creation method is expected, and only note that specific error in case of failure.

/cc @tobrun