Load NavGraph asynchronously to improve start up time (Offense) #16900

MarcLeclair · 2020-12-07T20:41:18Z

Loading the NavGraph takes ~ 50ms on the G5+. We can remove our NavGraph from the XML and instantiate it asynchronously to try to gain some time on start up ( should be 30-40 ms since starting the async stuff can take up to 10ms)

┆Issue is synchronized with this Jira Task

mcomella · 2021-01-12T21:59:52Z

PR is here: #16908

For mozilla-mobile#18900: inflate navGraph programatically For #169000: Made NavGraph inflation asynchronous For mozilla-mobile#16900: Changed to block with runBlocking For mozilla-mobile#16900: Refactored blocking call into a function

For mozilla-mobile#18900: inflate navGraph programatically For #169000: Made NavGraph inflation asynchronous For mozilla-mobile#16900: Changed to block with runBlocking For mozilla-mobile#16900: Refactored blocking call into a function For 16900: NavGraph inflation is now async We now attach the nav graph (or check if its attached) on every nav call ( an extension function for NavController). This is done by checking the value of the job stored in PerfNavController.map which keeps track of the job with the NavController as a Key. If the job hasn't been completed, it will block the main thread until the job is done. The job itself is responsible for attaching the navgraph to the navcontroller (and the inflation of the latter too) For 16900: Changed other calls of navigate to loadNavGraphBeforeNavigate Some navigation methods are directly called from the NavController instead of the extension function .nav. Therefore, we need to make sure the navgraph is loaded before we can call those navigation methods For 16900: Rebase on master

…s for performance purposes For mozilla-mobile#18900: inflate navGraph programatically For #169000: Made NavGraph inflation asynchronous For mozilla-mobile#16900: Changed to block with runBlocking For mozilla-mobile#16900: Refactored blocking call into a function For 16900: NavGraph inflation is now async We now attach the nav graph (or check if its attached) on every nav call ( an extension function for NavController). This is done by checking the value of the job stored in PerfNavController.map which keeps track of the job with the NavController as a Key. If the job hasn't been completed, it will block the main thread until the job is done. The job itself is responsible for attaching the navgraph to the navcontroller (and the inflation of the latter too) For 16900: Changed other calls of navigate to loadNavGraphBeforeNavigate Some navigation methods are directly called from the NavController instead of the extension function .nav. Therefore, we need to make sure the navgraph is loaded before we can call those navigation methods For 16900: Rebase on master

…comments. 1)The Asynchronous method is now found in NavGraphProvider.kt. It creates a job on the IO dispatcher 2)The Job is tracked through a WeakHashMap from Controller --> NavGraph 3)The Coroutine scope doesn't use MainScope() anymore 4)The Coroutine is cancelled if the Activity is destroyed 5)The tests mockk the blockForNavGraphInflation method through the FenixReoboelectricTestApplication instead of calling the mock every setup()

We need linting rules to make sure no one calls the NavController.navigate() methods

…n the code

For mozilla-mobile#18900: inflate navGraph programatically For #169000: Made NavGraph inflation asynchronous For mozilla-mobile#16900: Changed to block with runBlocking For mozilla-mobile#16900: Refactored blocking call into a function

…comments. 1)The Asynchronous method is now found in NavGraphProvider.kt. It creates a job on the IO dispatcher 2)The Job is tracked through a WeakHashMap from Controller --> NavGraph 3)The Coroutine scope doesn't use MainScope() anymore 4)The Coroutine is cancelled if the Activity is destroyed 5)The tests mockk the blockForNavGraphInflation method through the FenixReoboelectricTestApplication instead of calling the mock every setup()

…t rule for MozillaNavigateCheck

For mozilla-mobile#16900: removed nav graph from xml For mozilla-mobile#16900: inflate navGraph programatically For mozilla-mobile#16900: Made NavGraph inflation asynchronous For mozilla-mobile#16900: Changed to block with runBlocking For mozilla-mobile#16900: Refactored blocking call into a function For 16900: NavGraph inflation is now async We now attach the nav graph (or check if its attached) on every nav call ( an extension function for NavController). This is done by checking the value of the job stored in PerfNavController.map which keeps track of the job with the NavController as a Key. If the job hasn't been completed, it will block the main thread until the job is done. The job itself is responsible for attaching the navgraph to the navcontroller (and the inflation of the latter too) For 16900: rebased upstream master For 16900: Rebase on master For mozilla-mobile#16900: Fixed Async Navgraph navigation per review comments. 1)The Asynchronous method is now found in NavGraphProvider.kt. It creates a job on the IO dispatcher 2)The Job is tracked through a WeakHashMap from Controller --> NavGraph 3)The Coroutine scope doesn't use MainScope() anymore 4)The Coroutine is cancelled if the Activity is destroyed 5)The tests mockk the blockForNavGraphInflation method through the FenixReoboelectricTestApplication instead of calling the mock every setup() For mozilla-mobile#16900: inflateNavGraphAsync now takes navController For mozilla-mobile#16900: Pass lifecycleScope to NavGraphProvider For mozilla-mobile#16900: removed unused mock For mozilla-mobile#16900: Added linter rules for navigate calls We need linting rules to make sure no one calls the NavController.navigate() methods For mozilla-mobile#16900: Added TestRule to help abstract the mocks in the code For 16900: Fix linting problems For mozilla-mobile#16900: Cleaned duplicated code in tests For mozilla-mobile#16900: cleaned up NavGraphTestRule for finished test For mozilla-mobile#16900: had to revert an accidentally edited file For mozilla-mobile#16900: rebased master

This is composed of squash commits, the original messages can be found below: -> DisableNavGraphProviderAssertionRule + kdoc. Use test rule in RobolectricApplication. Fix failing CrashReporterControllerTest Fix blame by -> navigate in tests. This commit was generated by the following commands only: ``` find app/src/test -type f -exec sed -i '' "/import org.mozilla.fenix.ext.navigateBlockingForAsyncNavGraph/d" {} \; find app/src/test -type f -exec sed -i "" "s/navigateBlockingForAsyncNavGraph/navigate/g" {} \; git checkout app/src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker ``` Fix various blame This is expected to be squashed into the first commit so, if so, it'd fix the blame. Move test rule to helpers pkg. add missing license header Add import change I missed fix unused imports Replace robolectricTestrunner with test rule. Improve navGraphProvider docs Remove unnecessary rule as defined by robolectric. add clarifying comment to robolectric remove unnecessary space

… fixes 3 squash commits: *Changed violation message and fixed the lint rule for MozillaNavigateCheck *Added suppression to NavController.kt *Fixed detekt violations