feat: [FC-0047] xBlock offline mode (#346)

* feat: Confirm and Error Dialogs UI

* feat: Confirm and Error Dialogs UI

* feat: DownloadStorageErrorDialogFragment

* feat: StorageBar

* feat: Download HTML block

* feat: DownloadErrorDialog logic

* feat: updateOutdatedOfflineXBlocks

* feat: Progress of downloaded blocks

* feat: Download all button

* feat: List of the largest downloads

* feat: Remove all downloads

* fix: Fixes according to demo feedback

* feat: Cancel Course Download button

* feat: Sync offline progress to the LMS

* fix: Fixes according to QA feedback

* fix: Fixes according to PR feedback

* feat: NoAvailableUnitFragment

* fix: Fixes according to QA feedback

* fix: Fixes according to QA feedback

* feat: clean offline progress when logging out

* fix: Release R8 build

* refactor: clearTables Dispatchers.IO

* fix: Fixes according to designer feedback

app/build.gradle

@@ -10,7 +10,6 @@ apply plugin: 'com.android.application'
 apply plugin: 'org.jetbrains.kotlin.android'
 apply plugin: 'kotlin-parcelize'
 apply plugin: 'kotlin-kapt'
-apply plugin: 'fullstory'
 
 if (firebaseEnabled) {
     apply plugin: 'com.google.gms.google-services'
@@ -30,6 +29,7 @@ if (firebaseEnabled) {
 }
 
 if (fullstoryEnabled) {
+    apply plugin: 'fullstory'
     def fullstoryOrgId = fullstoryConfig?.get("ORG_ID")
 
     fullstory {
@@ -107,6 +107,7 @@ android {
     }
     kotlinOptions {
         jvmTarget = JavaVersion.VERSION_17
+        freeCompilerArgs = List.of("-Xstring-concat=inline")
     }
     buildFeatures {
         viewBinding true

app/proguard-rules.pro

@@ -1,66 +1,3 @@
-# Add project specific ProGuard rules here.
-# You can control the set of applied configuration files using the
-# proguardFiles setting in build.gradle.
-#
-# For more details, see
-#   http://developer.android.com/guide/developing/tools/proguard.html
-
-# If your project uses WebView with JS, uncomment the following
-# and specify the fully qualified class name to the JavaScript interface
-# class:
-#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
-#   public *;
-#}
-
-# Uncomment this to preserve the line number information for
-# debugging stack traces.
-#-keepattributes SourceFile,LineNumberTable
-
-# If you keep the line number information, uncomment this to
-# hide the original source file name.
-#-renamesourcefileattribute SourceFile
-
-#====================/////Retrofit Rules\\\\\===============
-# Retrofit does reflection on generic parameters. InnerClasses is required to use Signature and
-# EnclosingMethod is required to use InnerClasses.
--keepattributes Signature, InnerClasses, EnclosingMethod
-
-# Retrofit does reflection on method and parameter annotations.
--keepattributes RuntimeVisibleAnnotations, RuntimeVisibleParameterAnnotations
-
-# Keep annotation default values (e.g., retrofit2.http.Field.encoded).
--keepattributes AnnotationDefault
-
-# Retain service method parameters when optimizing.
--keepclassmembers,allowshrinking,allowobfuscation interface * {
-    @retrofit2.http.* <methods>;
-}
-
-# Ignore JSR 305 annotations for embedding nullability information.
--dontwarn javax.annotation.**
-
-# Guarded by a NoClassDefFoundError try/catch and only used when on the classpath.
--dontwarn kotlin.Unit
-
-# Top-level functions that can only be used by Kotlin.
--dontwarn retrofit2.KotlinExtensions
--dontwarn retrofit2.KotlinExtensions$*
-
-# With R8 full mode, it sees no subtypes of Retrofit interfaces since they are created with a Proxy
-# and replaces all potential values with null. Explicitly keeping the interfaces prevents this.
--if interface * { @retrofit2.http.* <methods>; }
--keep,allowobfuscation interface <1>
-
-# Keep generic signature of Call, Response (R8 full mode strips signatures from non-kept items).
--keep,allowobfuscation,allowshrinking interface retrofit2.Call
--keep,allowobfuscation,allowshrinking class retrofit2.Response
-
-# With R8 full mode generic signatures are stripped for classes that are not
-# kept. Suspend functions are wrapped in continuations where the type argument
-# is used.
--keep,allowobfuscation,allowshrinking class kotlin.coroutines.Continuation
-
-#===============/////GSON RULES \\\\\\\============
 ##---------------Begin: proguard configuration for Gson  ----------
 # Gson uses generic type information stored in a class file when working with fields. Proguard
 # removes such information by default, so configure it to keep all of it.
@@ -69,12 +6,8 @@
 # For using GSON @Expose annotation
 -keepattributes *Annotation*
 
-# Gson specific classes
--dontwarn sun.misc.**
-#-keep class com.google.gson.stream.** { *; }
-
 # Application classes that will be serialized/deserialized over Gson
--keep class org.openedx.*.data.model.** { <fields>; }
+-keepclassmembers class org.openedx.**.data.model.** { *; }
 
 # Prevent proguard from stripping interface information from TypeAdapter, TypeAdapterFactory,
 # JsonSerializer, JsonDeserializer instances (so they can be used in @JsonAdapter)
@@ -85,13 +18,13 @@
 
 # Prevent R8 from leaving Data object members always null
 -keepclassmembers,allowobfuscation class * {
+  <init>();
   @com.google.gson.annotations.SerializedName <fields>;
 }
 
 # Retain generic signatures of TypeToken and its subclasses with R8 version 3.0 and higher.
 -keep,allowobfuscation,allowshrinking class com.google.gson.reflect.TypeToken
 -keep,allowobfuscation,allowshrinking class * extends com.google.gson.reflect.TypeToken
-
 ##---------------End: proguard configuration for Gson  ----------
 
 -keepclassmembers class * extends java.lang.Enum {
@@ -108,4 +41,31 @@
 -dontwarn org.conscrypt.ConscryptHostnameVerifier
 -dontwarn org.openjsse.javax.net.ssl.SSLParameters
 -dontwarn org.openjsse.javax.net.ssl.SSLSocket
--dontwarn org.openjsse.net.ssl.OpenJSSE
+-dontwarn org.openjsse.net.ssl.OpenJSSE
+-dontwarn com.google.crypto.tink.subtle.Ed25519Sign$KeyPair
+-dontwarn com.google.crypto.tink.subtle.Ed25519Sign
+-dontwarn com.google.crypto.tink.subtle.Ed25519Verify
+-dontwarn com.google.crypto.tink.subtle.X25519
+-dontwarn com.segment.analytics.kotlin.core.platform.plugins.logger.LogFilterKind
+-dontwarn com.segment.analytics.kotlin.core.platform.plugins.logger.LogTargetKt
+-dontwarn edu.umd.cs.findbugs.annotations.NonNull
+-dontwarn edu.umd.cs.findbugs.annotations.Nullable
+-dontwarn edu.umd.cs.findbugs.annotations.SuppressFBWarnings
+-dontwarn org.bouncycastle.asn1.ASN1Encodable
+-dontwarn org.bouncycastle.asn1.pkcs.PrivateKeyInfo
+-dontwarn org.bouncycastle.asn1.x509.AlgorithmIdentifier
+-dontwarn org.bouncycastle.asn1.x509.SubjectPublicKeyInfo
+-dontwarn org.bouncycastle.cert.X509CertificateHolder
+-dontwarn org.bouncycastle.cert.jcajce.JcaX509CertificateHolder
+-dontwarn org.bouncycastle.crypto.BlockCipher
+-dontwarn org.bouncycastle.crypto.CipherParameters
+-dontwarn org.bouncycastle.crypto.InvalidCipherTextException
+-dontwarn org.bouncycastle.crypto.engines.AESEngine
+-dontwarn org.bouncycastle.crypto.modes.GCMBlockCipher
+-dontwarn org.bouncycastle.crypto.params.AEADParameters
+-dontwarn org.bouncycastle.crypto.params.KeyParameter
+-dontwarn org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider
+-dontwarn org.bouncycastle.jce.provider.BouncyCastleProvider
+-dontwarn org.bouncycastle.openssl.PEMKeyPair
+-dontwarn org.bouncycastle.openssl.PEMParser
+-dontwarn org.bouncycastle.openssl.jcajce.JcaPEMKeyConverter

app/src/main/java/org/openedx/app/AppActivity.kt

@@ -12,10 +12,12 @@ import androidx.core.view.WindowCompat
 import androidx.core.view.WindowInsetsCompat
 import androidx.core.view.WindowInsetsControllerCompat
 import androidx.fragment.app.Fragment
+import androidx.lifecycle.lifecycleScope
 import androidx.window.layout.WindowMetricsCalculator
 import com.braze.support.toStringMap
 import io.branch.referral.Branch
 import io.branch.referral.Branch.BranchUniversalReferralInitListener
+import kotlinx.coroutines.launch
 import org.koin.android.ext.android.inject
 import org.koin.androidx.viewmodel.ext.android.viewModel
 import org.openedx.app.databinding.ActivityAppBinding
@@ -30,6 +32,7 @@ import org.openedx.core.ui.WindowSize
 import org.openedx.core.ui.WindowType
 import org.openedx.core.utils.Logger
 import org.openedx.core.worker.CalendarSyncScheduler
+import org.openedx.course.presentation.download.DownloadDialogManager
 import org.openedx.profile.presentation.ProfileRouter
 import org.openedx.whatsnew.WhatsNewManager
 import org.openedx.whatsnew.presentation.whatsnew.WhatsNewFragment
@@ -51,6 +54,7 @@ class AppActivity : AppCompatActivity(), InsetHolder, WindowSizeHolder {
     private val whatsNewManager by inject<WhatsNewManager>()
     private val corePreferencesManager by inject<CorePreferences>()
     private val profileRouter by inject<ProfileRouter>()
+    private val downloadDialogManager by inject<DownloadDialogManager>()
     private val calendarSyncScheduler by inject<CalendarSyncScheduler>()
 
     private val branchLogger = Logger(BRANCH_TAG)
@@ -163,6 +167,15 @@ class AppActivity : AppCompatActivity(), InsetHolder, WindowSizeHolder {
             profileRouter.restartApp(supportFragmentManager, viewModel.isLogistrationEnabled)
         }
 
+        lifecycleScope.launch {
+            viewModel.downloadFailedDialog.collect {
+                downloadDialogManager.showDownloadFailedPopup(
+                    downloadModel = it.downloadModel,
+                    fragmentManager = supportFragmentManager,
+                )
+            }
+        }
+
         calendarSyncScheduler.scheduleDailySync()
     }
 

app/src/main/java/org/openedx/app/AppViewModel.kt

@@ -9,6 +9,9 @@ import androidx.lifecycle.LiveData
 import androidx.lifecycle.viewModelScope
 import androidx.room.RoomDatabase
 import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.flow.MutableSharedFlow
+import kotlinx.coroutines.flow.SharedFlow
+import kotlinx.coroutines.flow.asSharedFlow
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import org.openedx.app.deeplink.DeepLink
@@ -20,6 +23,8 @@ import org.openedx.core.SingleEventLiveData
 import org.openedx.core.config.Config
 import org.openedx.core.data.model.User
 import org.openedx.core.data.storage.CorePreferences
+import org.openedx.core.system.notifier.DownloadFailed
+import org.openedx.core.system.notifier.DownloadNotifier
 import org.openedx.core.system.notifier.app.AppNotifier
 import org.openedx.core.system.notifier.app.LogoutEvent
 import org.openedx.core.system.notifier.app.SignInEvent
@@ -29,20 +34,26 @@ import org.openedx.core.utils.FileUtil
 @SuppressLint("StaticFieldLeak")
 class AppViewModel(
     private val config: Config,
-    private val notifier: AppNotifier,
+    private val appNotifier: AppNotifier,
     private val room: RoomDatabase,
     private val preferencesManager: CorePreferences,
     private val dispatcher: CoroutineDispatcher,
     private val analytics: AppAnalytics,
     private val deepLinkRouter: DeepLinkRouter,
     private val fileUtil: FileUtil,
+    private val downloadNotifier: DownloadNotifier,
     private val context: Context
 ) : BaseViewModel() {
 
     private val _logoutUser = SingleEventLiveData<Unit>()
     val logoutUser: LiveData<Unit>
         get() = _logoutUser
 
+    private val _downloadFailedDialog = MutableSharedFlow<DownloadFailed>()
+    val downloadFailedDialog: SharedFlow<DownloadFailed>
+        get() = _downloadFailedDialog.asSharedFlow()
+
+
     val isLogistrationEnabled get() = config.isPreLoginExperienceEnabled()
 
     private var logoutHandledAt: Long = 0
@@ -66,14 +77,21 @@ class AppViewModel(
         }
 
         viewModelScope.launch {
-            notifier.notifier.collect { event ->
+            appNotifier.notifier.collect { event ->
                 if (event is SignInEvent && config.getFirebaseConfig().isCloudMessagingEnabled) {
                     SyncFirebaseTokenWorker.schedule(context)
                 } else if (event is LogoutEvent) {
                     handleLogoutEvent(event)
                 }
             }
         }
+        viewModelScope.launch {
+            downloadNotifier.notifier.collect { event ->
+                if (event is DownloadFailed) {
+                    _downloadFailedDialog.emit(event)
+                }
+            }
+        }
     }
 
     fun logAppLaunchEvent() {

app/src/main/java/org/openedx/app/di/AppModule.kt

@@ -35,6 +35,7 @@ import org.openedx.core.data.storage.CorePreferences
 import org.openedx.core.data.storage.InAppReviewPreferences
 import org.openedx.core.module.DownloadWorkerController
 import org.openedx.core.module.TranscriptManager
+import org.openedx.core.module.download.DownloadHelper
 import org.openedx.core.module.download.FileDownloader
 import org.openedx.core.presentation.CoreAnalytics
 import org.openedx.core.presentation.dialog.appreview.AppReviewAnalytics
@@ -57,6 +58,8 @@ import org.openedx.core.worker.CalendarSyncScheduler
 import org.openedx.course.data.storage.CoursePreferences
 import org.openedx.course.presentation.CourseAnalytics
 import org.openedx.course.presentation.CourseRouter
+import org.openedx.course.presentation.download.DownloadDialogManager
+import org.openedx.course.worker.OfflineProgressSyncScheduler
 import org.openedx.dashboard.presentation.DashboardAnalytics
 import org.openedx.dashboard.presentation.DashboardRouter
 import org.openedx.discovery.presentation.DiscoveryAnalytics
@@ -89,6 +92,7 @@ val appModule = module {
     single { AppCookieManager(get(), get()) }
     single { ReviewManagerFactory.create(get()) }
     single { CalendarManager(get(), get()) }
+    single { DownloadDialogManager(get(), get(), get(), get()) }
     single { DatabaseManager(get(), get(), get(), get()) }
     single<IDatabaseManager> { get<DatabaseManager>() }
 
@@ -200,6 +204,9 @@ val appModule = module {
     factory { OAuthHelper(get(), get(), get()) }
 
     factory { FileUtil(get()) }
+    single { DownloadHelper(get(), get()) }
+
+    factory { OfflineProgressSyncScheduler(get()) }
 
     single { CalendarSyncScheduler(get()) }
 }