Add remote mapping for Wulkanowy SDK (#2550)

Co-authored-by: Mikołaj Pich <m.pich@outlook.com>

app/build.gradle

@@ -191,7 +191,7 @@ ext {
 }
 
 dependencies {
-    implementation 'io.github.wulkanowy:sdk:2.6.3'
+    implementation 'io.github.wulkanowy:sdk:2.6.4-SNAPSHOT'
 
     coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.0.4'
 

app/src/main/java/io/github/wulkanowy/data/DataModule.kt

@@ -13,8 +13,8 @@ import dagger.Provides
 import dagger.hilt.InstallIn
 import dagger.hilt.android.qualifiers.ApplicationContext
 import dagger.hilt.components.SingletonComponent
-import io.github.wulkanowy.data.api.AdminMessageService
+import io.github.wulkanowy.data.api.services.SchoolsService
-import io.github.wulkanowy.data.api.SchoolsService
+import io.github.wulkanowy.data.api.services.WulkanowyService
 import io.github.wulkanowy.data.db.AppDatabase
 import io.github.wulkanowy.data.db.SharedPrefProvider
 import io.github.wulkanowy.data.repositories.PreferencesRepository
@@ -71,7 +71,7 @@ internal class DataModule {
         okHttpClient: OkHttpClient,
         json: Json,
         appInfo: AppInfo
-    ): AdminMessageService = Retrofit.Builder()
+    ): WulkanowyService = Retrofit.Builder()
         .baseUrl(appInfo.messagesBaseUrl)
         .client(okHttpClient)
         .addConverterFactory(json.asConverterFactory("application/json".toMediaType()))

app/src/main/java/io/github/wulkanowy/data/WulkanowySdkFactory.kt

@@ -5,6 +5,7 @@ import io.github.wulkanowy.data.db.dao.StudentDao
 import io.github.wulkanowy.data.db.entities.Semester
 import io.github.wulkanowy.data.db.entities.Student
 import io.github.wulkanowy.data.db.entities.StudentIsEduOne
+import io.github.wulkanowy.data.repositories.WulkanowyRepository
 import io.github.wulkanowy.sdk.Sdk
 import io.github.wulkanowy.utils.RemoteConfigHelper
 import io.github.wulkanowy.utils.WebkitCookieManagerProxy
@@ -20,6 +21,7 @@ class WulkanowySdkFactory @Inject constructor(
     private val remoteConfig: RemoteConfigHelper,
     private val webkitCookieManagerProxy: WebkitCookieManagerProxy,
     private val studentDb: StudentDao,
+    private val wulkanowyRepository: WulkanowyRepository,
 ) {
 
     private val eduOneMutex = Mutex()
@@ -36,14 +38,29 @@ class WulkanowySdkFactory @Inject constructor(
         addInterceptor(chuckerInterceptor, network = true)
     }
 
-    fun create() = sdk
+    fun createBase() = sdk
+
+    suspend fun create(): Sdk {
+        val mapping = wulkanowyRepository.getMapping()
+
+        return createBase().apply {
+            if (mapping != null) {
+                endpointsMapping = mapping.endpoints
+                vTokenMapping = mapping.vTokens
+            }
+        }
+    }
 
     suspend fun create(student: Student, semester: Semester? = null): Sdk {
         val overrideIsEduOne = checkEduOneAndMigrateIfNecessary(student)
         return buildSdk(student, semester, overrideIsEduOne)
     }
 
-    private fun buildSdk(student: Student, semester: Semester?, isStudentEduOne: Boolean): Sdk {
+    private suspend fun buildSdk(
+        student: Student,
+        semester: Semester?,
+        isStudentEduOne: Boolean
+    ): Sdk {
         return create().apply {
             email = student.email
             password = student.password

app/src/main/java/io/github/wulkanowy/data/api/models/Mapping.kt

@@ -0,0 +1,14 @@
+package io.github.wulkanowy.data.api.models
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+data class Mapping(
+
+    @SerialName("endpoints")
+    val endpoints: Map<String, Map<String, Map<String, String>>>,
+
+    @SerialName("vTokens")
+    val vTokens: Map<String, Map<String, Map<String, String>>>,
+)

app/src/main/java/io/github/wulkanowy/data/api/services/SchoolsService.kt

@@ -1,4 +1,4 @@
-package io.github.wulkanowy.data.api
+package io.github.wulkanowy.data.api.services
 
 import io.github.wulkanowy.data.pojos.IntegrityRequest
 import io.github.wulkanowy.data.pojos.LoginEvent

app/src/main/java/io/github/wulkanowy/data/api/services/WulkanowyService.kt

@@ -1,12 +1,16 @@
-package io.github.wulkanowy.data.api
+package io.github.wulkanowy.data.api.services
 
+import io.github.wulkanowy.data.api.models.Mapping
 import io.github.wulkanowy.data.db.entities.AdminMessage
 import retrofit2.http.GET
 import javax.inject.Singleton
 
 @Singleton
-interface AdminMessageService {
+interface WulkanowyService {
 
     @GET("/v1.json")
     suspend fun getAdminMessages(): List<AdminMessage>
+
+    @GET("/mapping1.json")
+    suspend fun getMapping(): Mapping
 }

app/src/main/java/io/github/wulkanowy/data/repositories/PreferencesRepository.kt

@@ -9,6 +9,7 @@ import com.fredporciuncula.flow.preferences.Preference
 import com.fredporciuncula.flow.preferences.Serializer
 import dagger.hilt.android.qualifiers.ApplicationContext
 import io.github.wulkanowy.R
+import io.github.wulkanowy.data.api.models.Mapping
 import io.github.wulkanowy.data.enums.AppTheme
 import io.github.wulkanowy.data.enums.AttendanceCalculatorSortingMode
 import io.github.wulkanowy.data.enums.GradeColorTheme
@@ -375,6 +376,15 @@ class PreferencesRepository @Inject constructor(
         get() = sharedPref.getString(PREF_KEY_INSTALLATION_ID, null).orEmpty()
         private set(value) = sharedPref.edit { putString(PREF_KEY_INSTALLATION_ID, value) }
 
+    var mapping: Mapping?
+        get() {
+            val value = sharedPref.getString("mapping", null)
+            return value?.let { json.decodeFromString(it) }
+        }
+        set(value) = sharedPref.edit(commit = true) {
+            putString("mapping", value?.let { json.encodeToString(it) })
+        }
+
     init {
         if (installationId.isEmpty()) {
             installationId = UUID.randomUUID().toString()

app/src/main/java/io/github/wulkanowy/data/repositories/SchoolsRepository.kt

@@ -1,7 +1,7 @@
 package io.github.wulkanowy.data.repositories
 
 import io.github.wulkanowy.data.WulkanowySdkFactory
-import io.github.wulkanowy.data.api.SchoolsService
+import io.github.wulkanowy.data.api.services.SchoolsService
 import io.github.wulkanowy.data.db.entities.Semester
 import io.github.wulkanowy.data.db.entities.Student
 import io.github.wulkanowy.data.db.entities.StudentWithSemesters

app/src/main/java/io/github/wulkanowy/data/repositories/WulkanowyRepository.kt

@@ -1,20 +1,23 @@
 package io.github.wulkanowy.data.repositories
 
 import io.github.wulkanowy.data.Resource
-import io.github.wulkanowy.data.api.AdminMessageService
+import io.github.wulkanowy.data.api.models.Mapping
+import io.github.wulkanowy.data.api.services.WulkanowyService
 import io.github.wulkanowy.data.db.dao.AdminMessageDao
 import io.github.wulkanowy.data.db.entities.AdminMessage
 import io.github.wulkanowy.data.networkBoundResource
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.filterNot
 import kotlinx.coroutines.sync.Mutex
+import timber.log.Timber
 import javax.inject.Inject
 import javax.inject.Singleton
 
 @Singleton
-class AdminMessageRepository @Inject constructor(
+class WulkanowyRepository @Inject constructor(
-    private val adminMessageService: AdminMessageService,
+    private val wulkanowyService: WulkanowyService,
     private val adminMessageDao: AdminMessageDao,
+    private val preferencesRepository: PreferencesRepository,
 ) {
 
     private val saveFetchResultMutex = Mutex()
@@ -24,11 +27,28 @@ class AdminMessageRepository @Inject constructor(
             mutex = saveFetchResultMutex,
             isResultEmpty = { false },
             query = { adminMessageDao.loadAll() },
-            fetch = { adminMessageService.getAdminMessages() },
+            fetch = { wulkanowyService.getAdminMessages() },
             shouldFetch = { true },
             saveFetchResult = { oldItems, newItems ->
                 adminMessageDao.removeOldAndSaveNew(oldItems, newItems)
             },
         )
             .filterNot { it is Resource.Intermediate }
+
+    suspend fun getMapping(): Mapping? {
+        var savedMapping = preferencesRepository.mapping
+
+        if (savedMapping == null) {
+            fetchMapping()
+            savedMapping = preferencesRepository.mapping
+        }
+
+        return savedMapping
+    }
+
+    suspend fun fetchMapping() {
+        runCatching { wulkanowyService.getMapping() }
+            .onFailure { Timber.e(it) }
+            .onSuccess { preferencesRepository.mapping = it }
+    }
 }

app/src/main/java/io/github/wulkanowy/domain/adminmessage/GetAppropriateAdminMessageUseCase.kt

@@ -5,14 +5,14 @@ import io.github.wulkanowy.data.db.entities.AdminMessage
 import io.github.wulkanowy.data.db.entities.Student
 import io.github.wulkanowy.data.enums.MessageType
 import io.github.wulkanowy.data.mapResourceData
-import io.github.wulkanowy.data.repositories.AdminMessageRepository
 import io.github.wulkanowy.data.repositories.PreferencesRepository
+import io.github.wulkanowy.data.repositories.WulkanowyRepository
 import io.github.wulkanowy.utils.AppInfo
 import kotlinx.coroutines.flow.Flow
 import javax.inject.Inject
 
 class GetAppropriateAdminMessageUseCase @Inject constructor(
-    private val adminMessageRepository: AdminMessageRepository,
+    private val wulkanowyRepository: WulkanowyRepository,
     private val preferencesRepository: PreferencesRepository,
     private val appInfo: AppInfo
 ) {
@@ -22,7 +22,7 @@ class GetAppropriateAdminMessageUseCase @Inject constructor(
     }
 
     operator fun invoke(scrapperBaseUrl: String, type: MessageType): Flow<Resource<AdminMessage?>> {
-        return adminMessageRepository.getAdminMessages().mapResourceData { adminMessages ->
+        return wulkanowyRepository.getAdminMessages().mapResourceData { adminMessages ->
             adminMessages
                 .asSequence()
                 .filter { it.isNotDismissed() }

app/src/main/java/io/github/wulkanowy/ui/modules/captcha/CaptchaDialog.kt

@@ -59,7 +59,7 @@ class CaptchaDialog : BaseDialogFragment<DialogCaptchaBinding>() {
             webView = this
             with(settings) {
                 javaScriptEnabled = true
-                userAgentString = wulkanowySdkFactory.create().userAgent
+                userAgentString = wulkanowySdkFactory.createBase().userAgent
             }
 
             webViewClient = object : WebViewClient() {

app/src/main/java/io/github/wulkanowy/ui/modules/login/LoginActivity.kt

@@ -118,5 +118,6 @@ class LoginActivity : BaseActivity<LoginPresenter, ActivityLoginBinding>(), Logi
     override fun onResume() {
         super.onResume()
         inAppUpdateHelper.onResume()
+        presenter.updateSdkMappings()
     }
 }

app/src/main/java/io/github/wulkanowy/ui/modules/login/LoginPresenter.kt

@@ -1,12 +1,15 @@
 package io.github.wulkanowy.ui.modules.login
 
 import io.github.wulkanowy.data.repositories.StudentRepository
+import io.github.wulkanowy.data.repositories.WulkanowyRepository
 import io.github.wulkanowy.ui.base.BasePresenter
 import io.github.wulkanowy.ui.base.ErrorHandler
+import kotlinx.coroutines.launch
 import timber.log.Timber
 import javax.inject.Inject
 
 class LoginPresenter @Inject constructor(
+    private val wulkanowyRepository: WulkanowyRepository,
     errorHandler: ErrorHandler,
     studentRepository: StudentRepository
 ) : BasePresenter<LoginView>(errorHandler, studentRepository) {
@@ -16,4 +19,11 @@ class LoginPresenter @Inject constructor(
         view.initView()
         Timber.i("Login view was initialized")
     }
+
+    fun updateSdkMappings() {
+        presenterScope.launch {
+            runCatching { wulkanowyRepository.fetchMapping() }
+                .onFailure { Timber.e(it) }
+        }
+    }
 }

app/src/main/java/io/github/wulkanowy/ui/modules/main/MainActivity.kt

@@ -138,6 +138,7 @@ class MainActivity : BaseActivity<MainPresenter, ActivityMainBinding>(), MainVie
     override fun onResume() {
         super.onResume()
         inAppUpdateHelper.onResume()
+        presenter.updateSdkMappings()
     }
 
     override fun onCreateOptionsMenu(menu: Menu): Boolean {

app/src/main/java/io/github/wulkanowy/ui/modules/main/MainPresenter.kt

@@ -6,6 +6,7 @@ import io.github.wulkanowy.data.onResourceError
 import io.github.wulkanowy.data.onResourceSuccess
 import io.github.wulkanowy.data.repositories.PreferencesRepository
 import io.github.wulkanowy.data.repositories.StudentRepository
+import io.github.wulkanowy.data.repositories.WulkanowyRepository
 import io.github.wulkanowy.data.resourceFlow
 import io.github.wulkanowy.services.sync.SyncManager
 import io.github.wulkanowy.ui.base.BasePresenter
@@ -29,6 +30,7 @@ class MainPresenter @Inject constructor(
     errorHandler: ErrorHandler,
     studentRepository: StudentRepository,
     private val preferencesRepository: PreferencesRepository,
+    private val wulkanowyRepository: WulkanowyRepository,
     private val syncManager: SyncManager,
     private val analytics: AnalyticsHelper,
     private val json: Json,
@@ -199,4 +201,11 @@ class MainPresenter @Inject constructor(
                 .onFailure { errorHandler.dispatch(it) }
         }
     }
+
+    fun updateSdkMappings() {
+        presenterScope.launch {
+            runCatching { wulkanowyRepository.fetchMapping() }
+                .onFailure { Timber.e(it) }
+        }
+    }
 }

app/src/test/java/io/github/wulkanowy/WulkanowySdkFactoryCreator.kt

@@ -8,6 +8,7 @@ import io.mockk.mockk
 
 fun createWulkanowySdkFactoryMock(sdk: Sdk) = mockk<WulkanowySdkFactory>()
     .apply {
-        every { create() } returns sdk
+        every { createBase() } returns sdk
+        coEvery { create() } returns sdk
         coEvery { create(any(), any()) } returns sdk
     }

app/src/test/java/io/github/wulkanowy/data/WulkanowySdkFactoryTest.kt

@@ -11,7 +11,6 @@ import io.github.wulkanowy.sdk.pojo.RegisterStudent
 import io.mockk.Runs
 import io.mockk.coEvery
 import io.mockk.coVerify
-import io.mockk.every
 import io.mockk.just
 import io.mockk.mockk
 import io.mockk.spyk
@@ -40,11 +39,12 @@ class WulkanowySdkFactoryTest {
                 chuckerInterceptor = mockk(),
                 remoteConfig = mockk(relaxed = true),
                 webkitCookieManagerProxy = mockk(),
-                studentDb = studentDao
+                studentDb = studentDao,
+                wulkanowyRepository = mockk(relaxed = true),
             )
         )
 
-        every { wulkanowySdkFactory.create() } returns sdk
+        coEvery { wulkanowySdkFactory.create() } returns sdk
     }
 
     @Test

app/src/test/java/io/github/wulkanowy/ui/modules/main/MainPresenterTest.kt

@@ -3,6 +3,7 @@ package io.github.wulkanowy.ui.modules.main
 import io.github.wulkanowy.MainCoroutineRule
 import io.github.wulkanowy.data.repositories.PreferencesRepository
 import io.github.wulkanowy.data.repositories.StudentRepository
+import io.github.wulkanowy.data.repositories.WulkanowyRepository
 import io.github.wulkanowy.services.sync.SyncManager
 import io.github.wulkanowy.ui.base.ErrorHandler
 import io.github.wulkanowy.utils.AdsHelper
@@ -31,6 +32,9 @@ class MainPresenterTest {
     @MockK
     lateinit var studentRepository: StudentRepository
 
+    @MockK(relaxed = true)
+    lateinit var wulkanowyRepository: WulkanowyRepository
+
     @MockK(relaxed = true)
     lateinit var prefRepository: PreferencesRepository
 
@@ -65,7 +69,8 @@ class MainPresenterTest {
             analytics = analytics,
             json = Json,
             appInfo = appInfo,
-            adsHelper = adsHelper
+            adsHelper = adsHelper,
+            wulkanowyRepository = wulkanowyRepository
         )
         presenter.onAttachView(mainView, null)
     }