Debug-panel

Библиотека для отладки приложений.

Changelog | Миграция на новые версии

Тебе надоело пересобирать приложение для того чтобы поменять сервер в настройках или переключить feature toggle? Эта библиотека разрабатывается с идеей решить эти и другие проблемы, и сделать процесс отладки приложения более удобным.

В данный момент библиотека предоставляет следующий функционал:

1. Добавление, редактирование и выбор сервера.
2. Управление feature-toggles и remote config на основе Konfeature.
3. Отображение информации о приложении.

Библиотека разрабатывается используя подход работы с плагинами, когда каждый функционал подключается отдельным модулем в зависимостях.

Подключение библиотеки

Для работы с библиотекой необходимо:

1. Подключить Core модуль для работы самой панели:

dependencies {
    // Core модуль панели
   debugImplementation("com.redmadrobot.debug:panel-core:${debug_panel_version}")
}

2. Подключить необходимые плагины

dependencies {
    // Плагин для работы с серверами
    debugImplementation("com.redmadrobot.debug:plugin-servers:${debug_panel_version}")

    // Плагин для работы с remote config на основе Konfeature
    debugImplementation("com.redmadrobot.debug:plugin-konfeature:${debug_panel_version}")
    // Так же необходимо подключить саму библиотеку konfeature
    debugImplementation("com.redmadrobot.konfeature:konfeature:${konfeature_version}")

    // Плагин для отображения информации о приложении
    debugImplementation("com.redmadrobot.debug:plugin-about-app:${debug_panel_version}")
}

3. Для того чтобы библиотека не попала в релизную сборку необходимо подключить no-op версию библиотеки

   releaseImplementation("com.redmadrobot.debug:panel-no-op:${debug_panel_version}")

Использование библиотеки в коде

Общий принцип подключения библиотеки в коде выглядит так:

class App : Application() {

    override fun onCreate() {
        super.onCreate()

        DebugPanel.initialize(
            application = this,
            plugins = listOf(
                ServersPlugin(/*arguments*/),
                KonfeaturePlugin(/*arguments*/),
                AboutAppPlugin(/*arguments*/),
            )
        )
    }
}

Для того чтобы открыть DebugPanel, нужно вызвать в коде:

fun openDebugPanel() {
    DebugPanel.showPanel(activity)
}

Так же в панель можно войти через уведомление которое появляется при запуске приложения использующее библиотеку. Через это же уведомление можно перейти в ручную настройку панели. Для этого нужно нажать кнопку SETTINGS в раскрытом уведомлении.

Работа с плагинами

ServersPlugin

Используется для работы с тестовыми серверами

Можно задать список предустановленных серверов

ServersPlugin(
    preInstalledServers = listOf(
        DebugServer(
            name = "server_name",
            url = "https://debug_server.com",
            isDefault = true /*!!!Обязательно должен быть указан хотя бы один сервер по умолчанию*/
        )
    )
)

И подписаться на событие смены сервера

DebugPanel.subscribeToEvents(lifecycleOwner = this) { event ->
    when (event) {
        is ServerSelectedEvent -> {
            val debugServer = event.debugServer
            // логика переключения сервера
        }
    }
}

Для получения выбранного сервера или default сервера из кода:

   val selectedServer = ServersPlugin.getSelectedServer()
   val defaultServer = ServersPlugin.getDefaultServer()

Так же если вы используете OkHttp в своем сетевом стеке то можете использовать DebugServerInterceptor который будет автоматически подменять хост в запросах на выбранный вами.

OkHttpClient.Builder()
    .addInterceptor(DebugServerInterceptor())
    .build()

Если запросы должны еще как то модифицироваться, например добавляться Header'ы то это можно сделать используя метод modifyRequest

OkHttpClient.Builder()
   .addInterceptor(
       DebugServerInterceptor().modifyRequest { request, server ->
           if (server.name == "Test") {
               request.newBuilder()
                   .addHeader("Authorization", "testToken")
                   .build()
           } else {
               request
           }
       }
   )
   .build()

Текущий выбранный сервер можно получить следующим образом

val selectedServer = getPlugin<ServersPlugin>().getSelectedServer()

Konfeature Plugin

В основе плагина лежит библиотека Konfeature, которая позволяет:

• отображать конфигурации feature, которые используются в konfeature
• видеть источник каждого элемента конфигурации (Default, Firebase, AppGallery и т.д.)
• переопределять значение элементов конфигурации с типом Boolean, String, Long, Double

Для подключения плагина, необходимо передать в него объект класса KonfeatureDebugPanelInterceptor и Konfeature

val debugPanelInterceptor = KonfeatureDebugPanelInterceptor(context)

val konfeatureInstance = konfeature {
    if (isDebug) {
        addIntercepot(debugPanelInterceptor)
    }
}

KonfeaturePlugin(
    debugPanelInterceptor = debugPanelInterceptor,
    konfeature = konfeatureInstance,
)

В builder konfeture можно настроить следующее:

• добавить config конкретной фичи - register(FeatureConfigN())
• настроить работу с remote config через реализацию интерфейса FeatureSource - addSource(featureSource)
• настроить логирование - setLogger(logger)

AboutApp Plugin

Используется для отображения информации о приложении: версии, номера билда и других произвольных данных.

Для подключения плагина необходимо передать список AboutAppInfo. Требуется хотя бы один элемент:

AboutAppPlugin(
    aboutAppInfo = listOf(
        AboutAppInfo(
            title = "Версия",
            value = BuildConfig.VERSION_NAME
        ),
        AboutAppInfo(
            title = "Номер билда",
            value = BuildConfig.VERSION_CODE.toString()
        )
    )
)

Каждый AboutAppInfo содержит:

• title — название поля (например, «Версия»)
• value — значение поля (например, «1.0.0»)

Безопасность!

Для того чтобы тестовые данные не попали в релизные сборки рекомендуется не задавать их явно в Application классе, а использовать реализации DebugDataProvider, которые можно разнести по разным buildType. Для release версии следует сделать пустую реализацию.

buildType debug

class DebugServersProvider : DebugDataProvider<List<DebugServer>> {

    override fun provideData(): List<DebugServer> {
        return listOf(
            DebugServer(name = "debug 1", url = "https://testserver1.com")
        )
    }
}

buildType release

class DebugServersProvider : DebugDataProvider<List<DebugServer>> {

    override fun provideData(): List<DebugServer> {
        return emptyList()
    }
}

Добавление в плагин

ServersPlugin(
    preInstalledServers = DebugServersProvider()
)