Fix generated module configuration files being obfuscated

[kediarov]

https://mapbox.atlassian.net/browse/MAPSAND-2026

First things first: why the @Keep annotation is not working?

The crash is happening when trying to call getDeclaredMethod("create...") of ModuleProvider which is being shrunk because the ModuleProvider is an interface inside, but not a member of Mapbox_ module so it is not affected by the outer @Keep annotation. ModuleProvider is generated when enableConfiguration = true.

Even though the Keep annotation docs say Do not use this within library code the Mapbox_ module is generated by annotation processor and is being added to the module with where the target class annotated with @MapboxModule is located.

The rule -keep @androidx.annotation.Keep class * {*;} to keep annotated targets is added to proguard-android file which is usually always added to every project.

com.mapbox.module.Mapbox_MapTelemetryModuleConfiguration$ModuleProvider
|- is referenced in keep rule:
|  proguard.txt:44:1
com.mapbox.maps.module.MapTelemetry com.mapbox.module.Mapbox_MapTelemetryModuleConfiguration$ModuleProvider.createMapTelemetry()
|- is referenced in keep rule:
|  default_proguard_files/global/proguard-android.txt-7.4.2:85:1

The direct solution is to add the @Keep annotation to the ModuleProvider. The other solution is to add -keep class com.mapbox.module.** {*;} but this rule is less accurate and more vague and might affect other classes in the package.

[kediarov]

I have aligned this version with the mapbox-maps-android project as 0.8.5 version is no longer available

[pengdev]

could you add some code snippets showcasing the generated code before the fix vs after the fix?

[kediarov]

The only change is at

@Keep
interface ModuleProvider

Before

package com.mapbox.module

import androidx.annotation.Keep
import com.mapbox.maps.module.MapTelemetry
import kotlin.Boolean
import kotlin.jvm.JvmStatic

/**
 * Configuration provider for MapTelemetry module.
 */
@Keep
object Mapbox_MapTelemetryModuleConfiguration {
  @JvmStatic
  val enableConfiguration: Boolean = true

  /**
   * Set this dependency provider before initializing any components of the modularized library.
   *
   * When you're not using the library anymore, you should pass `null` to clean up the provider
   * reference and prevent memory leaks.
   */
  @JvmStatic
  var moduleProvider: ModuleProvider? = null

  interface ModuleProvider {
    fun createMapTelemetry(): MapTelemetry
  }
}

After

package com.mapbox.module

import androidx.annotation.Keep
import com.mapbox.maps.module.MapTelemetry
import kotlin.Boolean
import kotlin.jvm.JvmStatic

/**
 * Configuration provider for MapTelemetry module.
 */
@Keep
object Mapbox_MapTelemetryModuleConfiguration {
  @JvmStatic
  val enableConfiguration: Boolean = true

  /**
   * Set this dependency provider before initializing any components of the modularized library.
   *
   * When you're not using the library anymore, you should pass `null` to clean up the provider
   * reference and prevent memory leaks.
   */
  @JvmStatic
  var moduleProvider: ModuleProvider? = null

  @Keep
  interface ModuleProvider {
    fun createMapTelemetry(): MapTelemetry
  }
}

[pengdev]

Thanks! Did you also validate the fix in maps SDK?

[pengdev]

@kediarov please also update the title of the PR with descriptions

[kediarov]

Older version Is not available
Aligned with mapbox-maps-android

[pengdev]

@kediarov it's also good to update the snapshot version in https://github.com/mapbox/mapbox-base-android/blob/master/gradle.properties to 1.12.0-SNAPSHOT since you are going to publish 1.12.0 release

[pengdev]

LGTM, thanks for the fix!

[jush]

out of curiosity, why rename it to baseLibs instead of the its default name?

[jush]

nice catch! 💎