Fix #3800: Mitigate indefinite crashes due to an initial crash or pro…

…cess death in low memory cases (#3860)

* Add support for AABs, build flavors, and proguard.

There are a lot of details to cover here--see the PR for the complete
context.

* Lint & codeowner fixes.

* Fix failures.

- Add missing codeowner
- Add support for configuring base branch reference
- Update CI for dev/alpha AAB builds to use 'develop' since there's no
  origin configured by default in the workflows

* Different attempt to fix bad develop reference in CI.

* Initial commit.

This is needed to open a PR on GitHub. This commit is being made so that
the PR can start off in a broken Actions state.

This also initially disables most non-Bazel workflows to make workflow
iteration faster and less impacting on other team members.

* Introduce infrastructure for batching.

This introduces a new mechanism for passing lists of tests to sharded
test targets in CI, and hooks it up. No actual sharding is occurring
yet. This led to some simplifications in the CI workflow since the
script can be more dynamic in computing the full list of targets (which
also works around a previous bug with instrumentation tests being run).
Java proto lite also needed to be upgraded for the scripts to be able to
use it.

More testing/documentation needed as this functionality continues to
expand.

* Add bucketing strategy.

This simply partitions bucketed groups of targets into chunks of 10 for
each run. Only 3 buckets are currently retained to test sharding in CI
before introducing full support.

* Fix caching & stabilize builds.

Fixes some caching bucket and output bugs. Also, introduces while loop &
keep_going to introduce resilience against app test build failures (or
just test failures in general).

* Increase sharding & add randomization.

Also, enable other workflows.

Note that CI shouldn't fully pass yet since some documentation and
testing needs to be added yet, but this is meant to be a more realistic
test of the CI environment before the PR is finished.

* Improving partitionin & readability.

Adds a human-readable prefix to make the shards look a bit nicer.

Also, adds more fine-tuned partitioning to bucket & reduce shard counts
to improve overall timing. Will need to be tested in CI.

* Add new tests & fix static analysis errors.

* Fix script.

A newly computed variable wasn't updated to be used in an earlier
change.

* Fix broken tests & test configuration.

Add docstrings for proto.

* Fix mistake from earlier commit.

* Try 10 max parallel actions instead.

See
#3757 (comment)
for context.

* Fix another error from an earlier commit.

* Localisation updates from https://translatewiki.net.

* Fix mv command so it works on Linux & OSX.

Neither 'mv -t' nor piping to mv work on OSX so we needed to find an
alternative (in this case just trying to move everything). This actually
works a bit better since it's doing a per-file move rather than
accommodating for files that shouldn't be moved (which isn't an issue
since the destination directory is different than the one containing the
AAB file).

* Introduce initial domain layer for translations.

Documentation, thorough tests, and detailed description of these changes
are still needed.

* Initial app layer implementation for translations.

This demonstrates working string selection for system-based and
overwritten app languages, including necessary activity recreation &
layout direction overwriting.

This also includes a bunch of Dagger infra refactoring so that some app
layer packages can now be modularized (including the new packages).

* Domain changes needed per downstream UI changes.

* Add patterns & fixes.

This involves MANY broad changes to ensure consistent string retrieval
(for arrays and plurals), formatting, and string transformations
throughout the codebase. Some extra patterns to added to fix things that
were needed, and a few issues were fixed along the way.

* Add needed domain changes for downstream branch.

Also includes fixing circular dependency issue by splitting out some of
the locale components to be part of utility rather than domain (so that
utiltiy and other packages can depend on MachineLocale).

* Introduce support for content localization.

This includes a bunch of stuff that'll be described in more detail in
the PR description, but it essentially:
- Adds support for displaying content in explorations, questions,
  concept cards, and revision cards in a non-English language
- Adds support for submitting non-English answers
- Updates test structures to validate everything exception questions is
  working for localization

* Fix structures to work with parsing assumptions.

* Fix regex checks for translated strings.

Also, performance improvements for the regex check.

* Lint-ish fix.

* Fix failing regex checks.

* Add check for nested res subdirectories.

* Add remaining regex patterns & fixes.

* Clean up locale infra.

Add some other needed functionality.

* Attempt to delete strings to force history.

* Gate options behind compile-time flag.

Flag status is off by default until #52 is finished.

* Proguard fixes for Glide.

Update version code since 6 & 7 were shipped.

* Make AAB builds/runs manual-only targets.

* Fix broken tests.

* Fix lint issues & add KDocs.

Also, abstract ContentLocale for consistency & to disallow direct
construction.

* Add 6/11 test suites (& placeholders for other 4).

Silence one file missing a test suite (since it doesn't need one).

Also, some tweaks to the language support definitions.

* Add more test suites for domain layers.

Included introducing a new general purpose utility for testing data
providers + its own test suite.

* Introduce wrapper & fake for bidi wrapping.

Also, add test version of AssetRepository.

Add new placeholder tests & update all tests project-wide to make sure
that they build.

* Add remaining tests.

Included some shadow refactoring, and introducing new test-only
resources.

* Fix Gradle builds.

* Lint fixes.

* Resolve remaining incomplete TODOs.

* Add new codeowners.

* Post-merge fixes.

Make all non-app layer targets build (haven't run tests yet).

Audited existing bidi wrapping cases & converted strings over to being
%s-only.

* Fix most test targets (builds).

All non-app tests confirmed as passing.

* Fix all remaining test builds.

Introduce new TestActivity for scaffolding all non-activity tests.

* Fix all app layer tests.

Add fixes for question player & old answer displaying.

Add fix for guaranteed crash on startup after some changes between now &
the first build of MR3 (dueu to extra updates in
SplashActivityPresenter).

* Fix questions & profile issues.

* Type specifier pattern & fixes.

Address temporary TODO by removing kdoc.

* Add missing KDocs.

* Boilerplate & TODOs for needed tests.

* Add new needed test dep.

Required an update to truth proto lite import (due to an incompatible
update in the common Truth dep).

* Add needed testing coverage.

Other miscellaneous fixes needed to support new tests.

* Two fixes.

1. Introduce proper API compatibility for LocaleController
2. Ensure TranslationController is scoped (breaks test in downstream PR)

* Fix Gradle builds on branch.

* Resolve nearly all pending TODOs.

Only remainder is a test suite whose tests need to be migrated.

* Lint fixes.

* Re-add method removed from merge.

* Lint fixes.

This also fixes broken extra/unused imports from the merge.

Verified that the dev build works as of this commit. Haven't verified
anything else.

* Fix compute affected tests script.

Adds support for very large PR changesets.

* Fix failures found on CI.

* Fix remaining Gradle failures found in CI.

* Fix existing domain + app layer tests.

Some reworking was needed in QuestionAssessmentProgressControllerTest.

* Post-merge fix.

* Gradle Espresso test fix.

* Add missing KDocs, remove extra file, and other cleanups.

* Lint fixes.

* Fix CI & lint checks (except regex).

* Deflake DataProviderTestMonitorTest.

* Address reviewer comments.

* Lint fixes.

* Fix affected tests from earlier changes.

These failures were found from CI test workflows.

* Fix remaining Gradle failures.

This introduces a proper fallback mechanism for content strings that
allows Gradle builds & tests to work properly, and adds more robustness
in case misconfigurations actually happen.

* Add placeholders for new needed tests.

* Fix broken tests.

This came from the earlier commit's fix--the suite hadn't been updated.

* Add needed tests for new behaviors.

* Fix Gradle build & mechanism change failures.

* Lint fixes.

* Undo inadvertent change to Gradle jvmargs.

* Disable most tests on Espresso.

* Test fixes + make monitor Espresso-compatible.

* Fix broken tests.

Refactor how platform parameter module.

Add new options fragment tests.

* Add exemptions & regex check tests.

* Lint fixes.

* Lint fixes.

* Add new ratio input rule classifier.

* Fix broken tests (per CI).

* Add mechanism to recover from crashes.

* Remove malformed TODO.

Co-authored-by: translatewiki.net <[email protected]>

app/src/main/java/org/oppia/android/app/translation/AppLanguageLocaleHandler.kt

@@ -23,14 +23,22 @@ class AppLanguageLocaleHandler @Inject constructor(
 ) {
   private lateinit var displayLocale: OppiaLocale.DisplayLocale
 
+  /**
+   * Returns whether this handler's tracked locale has been initialized, that is, whether
+   * [initializeLocale] has been called.
+   *
+   * Once this method returns true, it's guaranteed to stay true for the lifetime of this class.
+   */
+  fun isInitialized(): Boolean = ::displayLocale.isInitialized
+
   /**
    * Initializes this handler with the specified initial [OppiaLocale.DisplayLocale].
    *
    * This must be called before any other methods in this class, and it must only be called once for
    * the lifetime of the application.
    */
   fun initializeLocale(locale: OppiaLocale.DisplayLocale) {
-    check(!::displayLocale.isInitialized) {
+    check(!isInitialized()) {
       "Expected to initialize the locale for the first time. If this is in a test, did you use" +
         " InitializeDefaultLocaleRule?"
     }
@@ -70,7 +78,7 @@ class AppLanguageLocaleHandler @Inject constructor(
   }
 
   private fun verifyDisplayLocaleIsInitialized() {
-    check(::displayLocale.isInitialized) {
+    check(isInitialized()) {
       "Expected locale to be initialized. If this is in a test, did you remember to include" +
         " InitializeDefaultLocaleRule?"
     }

app/src/main/java/org/oppia/android/app/translation/AppLanguageWatcherMixin.kt

@@ -3,6 +3,7 @@ package org.oppia.android.app.translation
 import androidx.appcompat.app.AppCompatActivity
 import androidx.lifecycle.Observer
 import org.oppia.android.app.model.ProfileId
+import org.oppia.android.domain.locale.LocaleController
 import org.oppia.android.domain.oppialogger.OppiaLogger
 import org.oppia.android.domain.translation.TranslationController
 import org.oppia.android.util.data.AsyncResult
@@ -20,14 +21,46 @@ class AppLanguageWatcherMixin @Inject constructor(
   private val activity: AppCompatActivity,
   private val translationController: TranslationController,
   private val appLanguageLocaleHandler: AppLanguageLocaleHandler,
+  private val localeController: LocaleController,
   private val oppiaLogger: OppiaLogger,
   private val activityRecreator: ActivityRecreator
 ) {
   /**
    * Initializes this mixin by starting language monitoring. This method should only ever be called
    * once for the lifetime of the current activity.
+   *
+   * Note that this method will synchronously ensure that [AppLanguageLocaleHandler] is properly
+   * initialized if previous bootstrapping was lost (e.g. due to process death), so it must be
+   * called before interacting with the locale handler to avoid inadvertent crashes in such
+   * situations.
    */
   fun initialize() {
+    if (!appLanguageLocaleHandler.isInitialized()) {
+      /* The handler might have been de-initialized since bootstrapping. This can generally happen
+       * in two cases:
+       * 1. Upon crash (later versions of Android will reopen the previous activity rather than
+       *   starting from the launcher activity if the crash occurred with the app in the foreground)
+       * 2. Upon low-memory process death (the system will restore from a saved instance Bundle of
+       *   the application's activity stack)
+       *
+       * In both cases, the locale will be lost & can't be determined until the controller provides
+       * the state. Since initialization happens during activity initialization, there's no way to
+       * pass data from a previous instance of the application. Thus, the application can either
+       * block the main thread on waiting for the data provider result (a strict mode violation that
+       * could theoretically cause an ANR) or default the locale and, in the event the default is
+       * wrong, restart the activity after the correct locale is retrieved. For the sake of avoiding
+       * potential ANRs (even at the potential of perceived jank due to activity recreations), the
+       * latter option is used here.
+       */
+      oppiaLogger.e(
+        "AppLanguageWatcherMixin", "Restoring the display locale from de-initialization."
+      )
+      val defaultDisplayLocale = localeController.reconstituteDisplayLocale(
+        localeController.getLikelyDefaultAppStringLocaleContext()
+      )
+      appLanguageLocaleHandler.initializeLocale(defaultDisplayLocale)
+    }
+
     // TODO(#52): Hook this up properly to profiles, and handle the non-profile activity cases.
     val profileId = ProfileId.getDefaultInstance()
     val appLanguageLocaleDataProvider = translationController.getAppLanguageLocale(profileId)

app/src/test/java/org/oppia/android/app/translation/AppLanguageLocaleHandlerTest.kt

@@ -242,6 +242,36 @@ class AppLanguageLocaleHandlerTest {
     assertThat(locales[0].language).isEqualTo("en")
   }
 
+  @Test
+  fun testIsInitialized_initialState_returnsFalse() {
+    val isInitialized = appLanguageLocaleHandler.isInitialized()
+
+    // initializeLocale() hasn't yet been called.
+    assertThat(isInitialized).isFalse()
+  }
+
+  @Test
+  fun testIsInitialized_afterInitialization_returnsTrue() {
+    setAppLanguage(ENGLISH)
+    appLanguageLocaleHandler.initializeLocale(retrieveAppLanguageLocale())
+
+    val isInitialized = appLanguageLocaleHandler.isInitialized()
+
+    // The handler should now (& hereafter) be initialized.
+    assertThat(isInitialized).isTrue()
+  }
+
+  @Test
+  fun testIsInitialized_afterInitialization_andUpdate_returnsTrue() {
+    appLanguageLocaleHandler.initializeLocale(computeNewAppLanguageLocale(ENGLISH))
+    appLanguageLocaleHandler.updateLocale(computeNewAppLanguageLocale(BRAZILIAN_PORTUGUESE))
+
+    val isInitialized = appLanguageLocaleHandler.isInitialized()
+
+    // Updating the locale should keep the handler initialized.
+    assertThat(isInitialized).isTrue()
+  }
+
   private fun forceDefaultLocale(locale: Locale) {
     context.applicationContext.resources.configuration.setLocale(locale)
     Locale.setDefault(locale)

app/src/test/java/org/oppia/android/app/translation/AppLanguageWatcherMixinTest.kt

@@ -110,6 +110,9 @@ class AppLanguageWatcherMixinTest {
   // TODO(#1720): Similar to the above, also add a test to verify that multiple language changes
   //  does not result in multiple recreations for the same activity. It currently will in the test
   //  since two mixins are active, but that won't happen in reality.
+  // TODO(#1720): Similar to the above, also add 2 tests to verify that mixin initialization in
+  //  cases when the locale isn't initialized (such as process death) prints an error & default
+  //  initializes the locale handler.
 
   @get:Rule
   val initializeDefaultLocaleRule = InitializeDefaultLocaleRule()