fix: MainFragment pager memory leaks

Author: PavloNetrebchuk

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

@@ -29,6 +29,7 @@ import org.openedx.core.presentation.global.viewBinding
 import org.openedx.core.system.notifier.app.AppUpgradeEvent
 import org.openedx.discovery.presentation.DiscoveryRouter
 import org.openedx.downloads.presentation.download.DownloadsFragment
+import org.openedx.foundation.system.PreviewFragmentManager.clearFragmentResultListener
 import org.openedx.learn.presentation.LearnFragment
 import org.openedx.learn.presentation.LearnTab
 import org.openedx.profile.presentation.profile.ProfileFragment
@@ -39,8 +40,6 @@ class MainFragment : Fragment(R.layout.fragment_main) {
     private val viewModel by viewModel<MainViewModel>()
     private val router by inject<DiscoveryRouter>()
 
-    private lateinit var adapter: NavigationFragmentAdapter
-
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         lifecycle.addObserver(viewModel)
@@ -50,6 +49,19 @@ class MainFragment : Fragment(R.layout.fragment_main) {
         }
     }
 
+    override fun onDestroyView() {
+        try {
+            binding.viewPager.adapter = null
+        } catch (_: Exception) {
+        }
+        super.onDestroyView()
+    }
+
+    override fun onDestroy() {
+        clearFragmentResultListener(UpgradeRequiredFragment.REQUEST_KEY)
+        super.onDestroy()
+    }
+
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
         super.onViewCreated(view, savedInstanceState)
         handleArguments()
@@ -89,26 +101,28 @@ class MainFragment : Fragment(R.layout.fragment_main) {
         requireArguments().remove(ARG_OPEN_TAB)
     }
 
-    private fun createTabList(openTabArg: String): List<Pair<Int, Fragment>> {
-        val learnFragment = LearnFragment.newInstance(
-            openTab = if (openTabArg == HomeTab.PROGRAMS.name) {
-                LearnTab.PROGRAMS.name
-            } else {
-                LearnTab.COURSES.name
-            }
-        )
+    private fun createTabList(openTabArg: String): List<Pair<Int, () -> Fragment>> {
+        val learnFragmentFactory = {
+            LearnFragment.newInstance(
+                openTab = if (openTabArg == HomeTab.PROGRAMS.name) {
+                    LearnTab.PROGRAMS.name
+                } else {
+                    LearnTab.COURSES.name
+                }
+            )
+        }
 
-        return mutableListOf<Pair<Int, Fragment>>().apply {
-            add(R.id.fragmentLearn to learnFragment)
-            add(R.id.fragmentDiscover to viewModel.getDiscoveryFragment)
+        return mutableListOf<Pair<Int, () -> Fragment>>().apply {
+            add(R.id.fragmentLearn to learnFragmentFactory)
+            add(R.id.fragmentDiscover to { viewModel.getDiscoveryFragment })
             if (viewModel.isDownloadsFragmentEnabled) {
-                add(R.id.fragmentDownloads to DownloadsFragment())
+                add(R.id.fragmentDownloads to { DownloadsFragment() })
             }
-            add(R.id.fragmentProfile to ProfileFragment())
+            add(R.id.fragmentProfile to { ProfileFragment() })
         }
     }
 
-    private fun addMenuItems(menu: Menu, tabList: List<Pair<Int, Fragment>>) {
+    private fun addMenuItems(menu: Menu, tabList: List<Pair<Int, () -> Fragment>>) {
         val tabTitles = mapOf(
             R.id.fragmentLearn to resources.getString(R.string.app_navigation_learn),
             R.id.fragmentDiscover to resources.getString(R.string.app_navigation_discovery),
@@ -128,7 +142,7 @@ class MainFragment : Fragment(R.layout.fragment_main) {
         }
     }
 
-    private fun setupBottomNavListener(tabList: List<Pair<Int, Fragment>>) {
+    private fun setupBottomNavListener(tabList: List<Pair<Int, () -> Fragment>>) {
         val menuIdToIndex = tabList.mapIndexed { index, pair -> pair.first to index }.toMap()
 
         binding.bottomNavView.setOnItemSelectedListener { menuItem ->
@@ -173,21 +187,21 @@ class MainFragment : Fragment(R.layout.fragment_main) {
             } else {
                 R.id.fragmentLearn
             }
+
             HomeTab.PROFILE.name -> R.id.fragmentProfile
             else -> R.id.fragmentLearn
         }
     }
 
-    private fun initViewPager(tabList: List<Pair<Int, Fragment>>) {
+    private fun initViewPager(tabList: List<Pair<Int, () -> Fragment>>) {
         binding.viewPager.orientation = ViewPager2.ORIENTATION_HORIZONTAL
         binding.viewPager.offscreenPageLimit = tabList.size
-
-        adapter = NavigationFragmentAdapter(this).apply {
-            tabList.forEach { (_, fragment) ->
-                addFragment(fragment)
+        binding.viewPager.adapter = NavigationFragmentAdapter(this).apply {
+            tabList.forEach { (_, fragmentFactory) ->
+                // Use fragment factory to prevent memory leaks
+                addFragment { fragmentFactory() }
             }
         }
-        binding.viewPager.adapter = adapter
         binding.viewPager.isUserInputEnabled = false
     }
 

core/src/main/java/org/openedx/core/adapter/NavigationFragmentAdapter.kt

@@ -5,13 +5,13 @@ import androidx.viewpager2.adapter.FragmentStateAdapter
 
 class NavigationFragmentAdapter(fragment: Fragment) : FragmentStateAdapter(fragment) {
 
-    private val fragments = ArrayList<Fragment>()
+    private val fragmentFactories = ArrayList<() -> Fragment>()
 
-    override fun getItemCount(): Int = fragments.size
+    override fun getItemCount(): Int = fragmentFactories.size
 
-    override fun createFragment(position: Int): Fragment = fragments[position]
+    override fun createFragment(position: Int): Fragment = fragmentFactories[position].invoke()
 
-    fun addFragment(fragment: Fragment) {
-        fragments.add(fragment)
+    fun addFragment(fragmentFactory: () -> Fragment) {
+        fragmentFactories.add(fragmentFactory)
     }
 }

dashboard/src/main/java/org/openedx/learn/presentation/LearnFragment.kt

@@ -86,13 +86,21 @@ class LearnFragment : Fragment(R.layout.fragment_learn) {
         }
     }
 
+    override fun onDestroyView() {
+        try {
+            binding.viewPager.adapter = null
+        } catch (_: Exception) {
+        }
+        super.onDestroyView()
+    }
+
     private fun initViewPager() {
         binding.viewPager.orientation = ViewPager2.ORIENTATION_HORIZONTAL
         binding.viewPager.offscreenPageLimit = 2
 
         adapter = NavigationFragmentAdapter(this).apply {
-            addFragment(viewModel.getDashboardFragment)
-            addFragment(viewModel.getProgramFragment)
+            addFragment { viewModel.getDashboardFragment }
+            addFragment { viewModel.getProgramFragment }
         }
         binding.viewPager.adapter = adapter
         binding.viewPager.setUserInputEnabled(false)