Productionised Webview Check using Dialog Boxes #15876

aayush-tripathi · 2024-03-13T18:21:49Z

Purpose / Description

Added dialog boxes which inform the users in older android devices of their old WebView versions (<=77) and also helps them update the WebView to a newer version.

Fixes

Fixes Productionise WebView >= 77 check #15855

Approach

The earlier debug only test informed the devs whether the WebView version was outdated , I have worked on that further and have introduced a dialog box for the users with a link to Wiki (Exact page can be changed by modifying the
const val WEBVIEW_UPDATION_LINK with information regarding updating to the latest version.

Also , I tried to differentiate between the packages com.android.webview and com.google.android.webview as this requires special steps : com.android.webview has to be disabled and com.google.android.webview has to be installed as of #15847 (comment).

How Has This Been Tested?

Unit Tests (./gradlew jacocoUnitTestReport)
Ran on a virtual device (Android 7.0 , API 24 ) containing an older webview version to ensure the dialog box works

( I was unable to test whether the dialog box works for devices having "com.android.webview" )

oldwebviewerror.1.mp4

Checklist

Please, go through these checks before submitting the PR.

You have a descriptive commit message with a short title (first line, max 50 chars).
You have commented your code, particularly in hard-to-understand areas
You have performed a self-review of your own code
UI changes: include screenshots of all affected screens (in particular showing any new or changed strings)
UI Changes: You have tested your change using the Google Accessibility Scanner

github-actions · 2024-03-13T18:22:02Z

Message to maintainers, this PR contains strings changes.

Before merging this PR, it is best to run the "Sync Translations" GitHub action, then make and merge a PR from the i18n_sync branch to get translations cleaned out.
Then merge this PR, and immediately do another translation PR so the huge change made by this PR's key changes are all by themselves.

Read more about updating strings on the wiki,

david-allison · 2024-03-13T18:37:48Z

AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt

@@ -141,6 +144,7 @@ import kotlin.time.measureTimedValue
 const val MIGRATION_WAS_LAST_POSTPONED_AT_SECONDS = "secondWhenMigrationWasPostponedLast"
 const val TIMES_STORAGE_MIGRATION_POSTPONED_KEY = "timesStorageMigrationPostponed"
 const val OLDEST_WORKING_WEBVIEW_VERSION = 77
+const val WEBVIEW_UPDATION_LINK = "https://github.com/ankidroid/Anki-Android/wiki"


use constants.xml

This should link to an actual page with information

Hey! I have been working to fix this, but I was unable to find a page in the wiki relating to updating WebView. So, I was wondering if you had an external wiki in mind.

AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt

…out Older WebView Version and Information to Correct it.

…box code structure and added support for translations

aayush-tripathi · 2024-03-15T14:34:12Z

Hey, I have made some changes. Could you please review them?

…box code structure and added support for translations

david-allison

Initial round of feedback, we'll need some more time on the strings, perhaps bring the conversation to #ankidroid-dev, then detail the results of this conversation on the pull request

AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt

david-allison · 2024-03-18T15:38:48Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

+
+    if (webviewPackageInfo == null) {
+        // User is missing both com.android.webview and com.google.android.webview
+        AlertDialog.Builder(context).show {


Could you extract each of these into methods

It's difficult to follow the dialog selection logic because this method contains both the selection and implementation logc

AnkiDroid/src/main/java/com/ichi2/utils/WebViewUtils.kt

david-allison · 2024-03-18T15:40:38Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

+                    Uri.parse(context.getString(R.string.webview_update_link))
+                context.startActivity(openURL)
+            }
+            neutralButton(R.string.deck_picker_disable_older_webview) {


Is a user going to know what to do here?

david-allison · 2024-03-18T15:41:59Z

AnkiDroid/src/main/res/values/constants.xml

@@ -296,4 +296,5 @@
    <string name="show_onboarding" maxLength="41">Show onboarding walkthrough</string>
    <string name="show_onboarding_desc">Display feature tutorial to learn more about the app</string>
    <string name="reset_onboarding_desc">Show all tutorials again</string>
+    <string name="webview_update_link">https://github.com/ankidroid/Anki-Android/wiki/FAQ#other-questions</string>


This should be a specific page which you have created, don't leave it in the FAQ

david-allison · 2024-03-18T15:42:26Z

AnkiDroid/src/main/res/values/03-dialogs.xml

@@ -260,5 +260,10 @@
    </string>

    <string name="deck_already_exists">Deck already exists</string>
+    <string name="deck_picker_disable_older_webview">Disable WebView</string>
+    <string name="deck_picker_updation_older_webview">Install Now </string>


This should likely be 'learn more', which we already have a string for

david-allison · 2024-03-18T15:43:15Z

AnkiDroid/src/main/res/values/03-dialogs.xml

+    <string name="deck_picker_updation_older_webview">Install Now </string>
+    <string name="webview_update_message">The WebView version %1$s is outdated (less than %2$s). You can update it by following the given link.</string>
+    <string name="missing_webview">"AnkiDroid relies on the System WebView which is unavailable"</string>
+    <string name="older_webview_found_alert">"The WebView Package com.android.webview is not supported.You must disable the existing WebView Package and Install com.google.android.webview ."</string>


Suggested change

<string name="older_webview_found_alert">"The WebView Package com.android.webview is not supported.You must disable the existing WebView Package and Install com.google.android.webview ."</string>

<string name="older_webview_found_alert">"The WebView package com.android.webview is not supported. You must disable the existing WebView package and install com.google.android.webview ."</string>

This string will need a lot more thought to best communicate the problem to a non-technical user

aayush-tripathi · 2024-03-20T13:54:20Z

Is this good as per the discord messages?

…ttons to Help Dialog and A Wiki Page.

david-allison

Much better, thanks!

Probably a couple of rounds of feedback, then let's get this in!

david-allison · 2024-03-20T13:59:33Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

@@ -164,11 +165,20 @@ sealed class AnkiDroidFolder(val permissionSet: PermissionSet) {
 }

 @Parcelize
-enum class PermissionSet(val permissions: List<String>, val permissionsFragment: Class<out PermissionsFragment>?) : Parcelable {
-    LEGACY_ACCESS(Permissions.legacyStorageAccessPermissions, PermissionsUntil29Fragment::class.java),
+enum class PermissionSet(


was this change intentional? If not, please revert

david-allison · 2024-03-20T14:00:05Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

-            }
-            cancelable(false)
-        }
+        // Nothing as already checked inside webViewFailedToLoad


Use val webviewPackageInfo = getAndroidSystemWebViewPackageInfo(packageManager) ?: return

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

david-allison · 2024-03-20T14:03:40Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

+        neutralButton(R.string.help_title_get_help) {
+            // Show the HelpDialog
+            val helpDialog = HelpDialog.newHelpInstance()
+            helpDialog.show(fragmentManager, "HelpDialog")


@lukstbit I'd expect something along the lines of requireAnkiActivity().showDialogFragment() here, did you have an intended pattern for opening the Dialog outside the Help button?

Nothing special, the two factory methods just return a plain instance of the help dialog that can be used with showDialogFragment().

@aayush-tripathi best to provide an AnkiActivity here instead of a Context

Still pending, change also needs to be applied in the other method

david-allison · 2024-03-20T14:04:03Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

+            val openURL = Intent(Intent.ACTION_VIEW)
+            openURL.data =
+                Uri.parse(context.getString(R.string.webview_update_link))
+            context.startActivity(openURL)


use AnkiActivity.openUrl()

david-allison · 2024-03-20T14:06:06Z

AnkiDroid/src/main/res/values/constants.xml

@@ -296,4 +296,5 @@
    <string name="show_onboarding" maxLength="41">Show onboarding walkthrough</string>
    <string name="show_onboarding_desc">Display feature tutorial to learn more about the app</string>
    <string name="reset_onboarding_desc">Show all tutorials again</string>
+    <string name="webview_update_link">https://github.com/ankidroid/Anki-Android/wiki/WebView-Detection-and-Updation</string>


Updation isn't a word.

Try: WebView Package Updates

I'd expect different links for 'Learn more' on the two screens

david-allison · 2024-03-20T14:07:15Z

AnkiDroid/src/main/res/values/03-dialogs.xml

@@ -260,5 +260,7 @@
    </string>

    <string name="deck_already_exists">Deck already exists</string>
+    <string name="webview_update_message">The WebView version is outdated (must be >= %1$s)</string>


Only use positional arg syntax if there's more than 1 arg

Suggested change

<string name="webview_update_message">The WebView version is outdated (must be >= %1$s)</string>

<string name="webview_update_message">The WebView version is outdated (must be >= %s)</string>

david-allison · 2024-03-20T14:08:51Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

@@ -197,11 +220,85 @@ internal fun selectAnkiDroidFolder(
 }

 fun selectAnkiDroidFolder(context: Context): AnkiDroidFolder {
-    val canAccessLegacyStorage = Build.VERSION.SDK_INT < Build.VERSION_CODES.Q || Environment.isExternalStorageLegacy()
-    val currentFolderIsAccessibleAndLegacy = canAccessLegacyStorage && isLegacyStorage(context, setCollectionPath = false) == true
+    val canAccessLegacyStorage =


ditto, please revert if this was an accidental change

david-allison · 2024-03-20T14:10:12Z

AnkiDroid/src/main/res/values/03-dialogs.xml

@@ -260,5 +260,7 @@
    </string>

    <string name="deck_already_exists">Deck already exists</string>
+    <string name="webview_update_message">The WebView version is outdated (must be >= %1$s)</string>
+    <string name="older_webview_found_alert">Android System WebView is out of date. You may need to use com.google.android.webview</string>


I feel these strings should list the current package name and version, as is done on my suggested dialog in Discord

…Added buttons to Help Dialog and A Wiki Page." This reverts commit a0fe9f4.

…ttons to Help Dialog and A Wiki Page.

Detached

aayush-tripathi · 2024-03-21T12:22:59Z

Added the package name and version.

david-allison

Thanks, generally looks good, needs a bit of work on the messages

david-allison · 2024-03-24T17:13:29Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

+        neutralButton(R.string.help_title_get_help) {
+            // Show the HelpDialog
+            val helpDialog = HelpDialog.newHelpInstance()
+            helpDialog.show(fragmentManager, "HelpDialog")


@aayush-tripathi best to provide an AnkiActivity here instead of a Context

david-allison · 2024-03-24T17:15:12Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

+        if (versionCode < OLDEST_WORKING_WEBVIEW_VERSION) {
+            showOutdatedWebViewDialog(context, fragmentManager, webviewPackageInfo.versionName)
+        }


Move this check above if (webviewOlder == null) { and invert it to return early if the condition is met

If a user is using a WebView with a valid version (even if it's an unexpected package), then we shouldn't block the user from using the app

I don't think so that any version of com.android.webview is valid.

From a quick google, this is V92: https://www.apkmirror.com/apk/lineageos/android-system-webview-2/android-system-webview-2-92-0-4515-159-release/android-system-webview-92-0-4515-159-13-android-apk-download/

david-allison · 2024-03-24T17:16:44Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

+ * inform the user with a dialog box containing further instructions.
+ */
+fun checkWebviewVersion(packageManager: PackageManager, context: Context, fragmentManager: FragmentManager) {
+    val webviewPackageInfo = getAndroidSystemWebViewPackageInfo(packageManager) ?: return


Could you add Timber.w warnings if the user does have an outdated WebView

And a Timber.d if the WebView is good

david-allison · 2024-03-24T17:18:01Z

AnkiDroid/src/main/res/values/03-dialogs.xml

@@ -260,5 +260,7 @@
    </string>

    <string name="deck_already_exists">Deck already exists</string>
+    <string name="webview_update_message">The Android System WebView is out of date\n\ncom.google.android.webview : %s</string>
+    <string name="older_native_webview_found_alert">"The WebView Package com.android.webview is not supported.You must disable the existing WebView Package and Install com.google.android.webview\n\ncom.android.webview %s</string>


I'd go back and use the strings I supplied on Discord

Provide the package name as an argument

Add a space after a full stop

david-allison · 2024-03-24T17:18:13Z

AnkiDroid/src/main/res/values/03-dialogs.xml

@@ -260,5 +260,7 @@
    </string>

    <string name="deck_already_exists">Deck already exists</string>
+    <string name="webview_update_message">The Android System WebView is out of date\n\ncom.google.android.webview : %s</string>


ditto, and remove the space before the colon

…fied strings

david-allison

One small change, then good to go I think, looks great!

david-allison · 2024-03-28T11:55:40Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

+        neutralButton(R.string.help_title_get_help) {
+            // Show the HelpDialog
+            val helpDialog = HelpDialog.newHelpInstance()
+            helpDialog.show(fragmentManager, "HelpDialog")


Still pending, change also needs to be applied in the other method

AnkiDroid/src/main/res/values/03-dialogs.xml

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

neeldoshii · 2024-04-02T21:35:11Z

The branch seems to have conflict. Can you try fixing the conflict.

david-allison

Nitpicks only, looks good, thanks!

https://github.com/ankidroid/Anki-Android/wiki/WebView-Detection-and-Package-Updates#outdated-android-native-webview

david-allison · 2024-04-02T21:40:02Z

AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt

+        // In case the user returns to the App without making the required updates to WebView
+        // As without a "onResume()" , the dialog box is removed on resume.


move the comment above the line

david-allison · 2024-04-02T21:41:00Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

+    }
+}
+
+private fun showOutdatedWebViewDialog(context: AnkiActivity, webview: PackageInfo) {


rename context -> activity

david-allison · 2024-04-02T21:41:08Z

AnkiDroid/src/main/java/com/ichi2/anki/InitialActivity.kt

+    }
+}
+
+private fun showNativeOutdatedWebViewDialog(context: AnkiActivity, webview: PackageInfo) {


…nges

neeldoshii · 2024-04-04T19:45:14Z

Just a feedback @aayush-tripathi, next time instead of using [Merge branch 'main' into main] use git rebase.

david-allison

Build is failing

Pretty much there, thanks!

One minor comment-based change on the XML, then let's get this in

david-allison · 2024-04-14T08:53:18Z

AnkiDroid/src/main/res/values/03-dialogs.xml

    <string name="answering_error_report">Report error</string>
-   <string name="storage_full_message">There is not enough free storage space to open AnkiDroid. Free up some space to continue. </string>
+    <string name="storage_full_message">There is not enough free storage space to open AnkiDroid. Free up some space to continue. </string>
    <string name="repair_deck_dialog">Do you really want to try to repair the database?\n\nBefore starting the attempt, a copy will be created in subfolder “%s”.</string>
    <string name="intent_aedict_empty">Category “default” is empty</string>


Revert this, it'll ping our translators unnecessarily

david-allison · 2024-04-14T08:53:58Z

AnkiDroid/src/main/res/values/03-dialogs.xml

@@ -271,3 +275,4 @@ also changes the interval of the card"
    <string name="range_delimiter" comment="Placed between two input boxes to denote a range">–</string>

 </resources>
+


Revert - it'll be picked up by our translation sync

github-actions · 2024-04-28T09:36:40Z

Hello 👋, this PR has had no activity for more than 2 weeks and needs a reply from the author. If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing! You have 7 days until this gets closed automatically

github-actions bot added the Strings label Mar 13, 2024

david-allison requested changes Mar 13, 2024

View reviewed changes

aayush-tripathi closed this Mar 13, 2024

aayush-tripathi force-pushed the main branch from fcbbbeb to 3d8e8c6 Compare March 13, 2024 19:39

aayush-tripathi added 4 commits March 15, 2024 19:38

[Productionize Webview >=77]Alert Dialog Box Added to Inform Users ab…

7abd092

…out Older WebView Version and Information to Correct it.

[Productionize Webview >=77]Alert Dialog Box Added to Inform Users ab…

af2763a

…out Older WebView Version and Information to Correct it.

[Productionize Webview >=77]Alert Dialog Box Added to Inform Users ab…

85c0ae9

…out Older WebView Version and Information to Correct it.

[Productionize Webview >=77] Added modifications to the alert dialog …

21c9de0

…box code structure and added support for translations

aayush-tripathi reopened this Mar 15, 2024

[Productionize Webview >=77] Added modifications to the alert dialog …

5a7a751

…box code structure and added support for translations

aayush-tripathi requested a review from david-allison March 17, 2024 05:38

david-allison requested changes Mar 18, 2024

View reviewed changes

[Productionize Webview >=77] Modified the code structure and Added bu…

a0fe9f4

…ttons to Help Dialog and A Wiki Page.

david-allison requested changes Mar 20, 2024

View reviewed changes

aayush-tripathi and others added 3 commits March 20, 2024 22:11

Revert "[Productionize Webview >=77] Modified the code structure and …

2e8e05b

…Added buttons to Help Dialog and A Wiki Page." This reverts commit a0fe9f4.

[Productionize Webview >=77] Modified the code structure and Added bu…

e3f11b2

…ttons to Help Dialog and A Wiki Page.

Merge pull request #1 from aayush-tripathi/detached

2969ae9

Detached

aayush-tripathi requested a review from david-allison March 21, 2024 20:44

david-allison requested changes Mar 24, 2024

View reviewed changes

david-allison added the Needs Author Reply Waiting for a reply from the original author label Mar 24, 2024

aayush-tripathi and others added 3 commits March 25, 2024 16:09

Merge branch 'ankidroid:main' into main

cd0bd61

[Productionize Webview >=77] Updated the checkWebviewVersion and modi…

3407641

…fied strings

[Productionize Webview >=77] Updated the checkWebviewVersion

68c4b74

david-allison requested changes Mar 28, 2024

View reviewed changes

[Productionize Webview >=77] HelpDialog/String Changes

6a1b3c3

aayush-tripathi requested a review from david-allison April 2, 2024 18:08

github-actions bot added the Has Conflicts label Apr 2, 2024

david-allison added the GSoC Pull requests authored by a Google Summer of Code participant [Candidate/Selected], for GSoC mentors label Apr 2, 2024

david-allison approved these changes Apr 2, 2024

View reviewed changes

david-allison added the Needs Second Approval Has one approval, one more approval to merge label Apr 2, 2024

aayush-tripathi and others added 2 commits April 4, 2024 20:34

[Productionize Webview >=77] Branch Conflict Resolution and Minor cha…

a0bf3b4

…nges

Merge branch 'main' into main

a083667

github-actions bot removed the Has Conflicts label Apr 4, 2024

david-allison added squash-merge The pull request currently requires maintainers to "Squash Merge" and removed Needs Author Reply Waiting for a reply from the original author labels Apr 5, 2024

github-actions bot added the Has Conflicts label Apr 7, 2024

Merge branch 'main' into main

2d8a399

david-allison requested changes Apr 14, 2024

View reviewed changes

david-allison added Needs Author Reply Waiting for a reply from the original author and removed Has Conflicts labels Apr 14, 2024

github-actions bot added the Stale label Apr 28, 2024

david-allison added Keep Open avoids the stale bot Needs a new dev For PR that were good start but the original dev' left. Any dev can take over and finish it. labels Apr 28, 2024

github-actions bot added the Has Conflicts label Jun 3, 2024

RobozinhoD mentioned this pull request Jun 4, 2024

Productionise webview ≥ 77 check #16550

Merged

5 tasks

mikehardy closed this in #16550 Jun 5, 2024

	<string name="older_webview_found_alert">"The WebView Package com.android.webview is not supported.You must disable the existing WebView Package and Install com.google.android.webview ."</string>
	<string name="older_webview_found_alert">"The WebView package com.android.webview is not supported. You must disable the existing WebView package and install com.google.android.webview ."</string>

	<string name="webview_update_message">The WebView version is outdated (must be >= %1$s)</string>
	<string name="webview_update_message">The WebView version is outdated (must be >= %s)</string>

		// In case the user returns to the App without making the required updates to WebView
		// As without a "onResume()" , the dialog box is removed on resume.

		@@ -271,3 +275,4 @@ also changes the interval of the card"
		<string name="range_delimiter" comment="Placed between two input boxes to denote a range">–</string>

		</resources>

Productionised Webview Check using Dialog Boxes #15876

Productionised Webview Check using Dialog Boxes #15876

Conversation

aayush-tripathi commented Mar 13, 2024 • edited

Purpose / Description

Fixes

Approach

How Has This Been Tested?

Checklist

github-actions bot commented Mar 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aayush-tripathi commented Mar 15, 2024

david-allison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aayush-tripathi commented Mar 20, 2024

david-allison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

david-allison Mar 20, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aayush-tripathi commented Mar 21, 2024

david-allison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

david-allison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neeldoshii commented Apr 2, 2024

david-allison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neeldoshii commented Apr 4, 2024 • edited

david-allison left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Apr 28, 2024

aayush-tripathi commented Mar 13, 2024 •

edited

david-allison Mar 20, 2024 •

edited

neeldoshii commented Apr 4, 2024 •

edited

david-allison left a comment •

edited