chore(android): enables debugging and inspection of mobile app internal webviews #11215

jahorton · 2024-04-12T01:07:32Z

This PR exists to facilitate diagnosis of #11186 when it occurs.

@keymanapp-test-bot skip

keymanapp-test-bot · 2024-04-12T01:07:40Z

User Test Results

Test specification and instructions

User tests are not required

mcdurdin

Looks good, but I think we should frame this with alpha+beta checks so it doesn't slip into stable

jahorton · 2024-04-12T01:22:19Z

android/KMEA/app/src/main/java/com/keyman/engine/KMKeyboard.java

+
+     if (
+       0 != (context.getApplicationInfo().flags & ApplicationInfo.FLAG_DEBUGGABLE)
+       || KMManager.getTier(null) != KMManager.Tier.STABLE


keyman/android/KMEA/app/src/main/java/com/keyman/engine/KMManager.java

Lines 339 to 348 in 93dc41e

/**

* Extract KMEA tier from versionName. Uses parameter so we can unit test.

* @param versionName String - If not provided, determine tier from

* com.keyman.engine.BuildConfig.KEYMAN_ENGINE_VERSION_NAME

* @return Tier (ALPHA, BETA, STABLE)

*/

public static Tier getTier(String versionName) {

if (versionName == null || versionName.isEmpty()) {

versionName = com.keyman.engine.BuildConfig.KEYMAN_ENGINE_VERSION_NAME;

}

When left null, .getTier uses the current engine version.

jahorton · 2024-04-12T01:56:17Z

Just peachy.

For the iOS build:

2024-04-12 11:39:27.842 xcodebuild[1694:28169924]  DVTPortal: Error:
Error Domain=DVTPortalServiceErrorDomain Code=1100 "Your session has expired. Please log in." [...]

For the Android build:

java.lang.NoSuchMethodError: java.lang.NoSuchMethodError: 'void com.keyman.engine.KMKeyboard.setWebContentsDebuggingEnabled(boolean)'
java.lang.NoSuchMethodError: 'void com.keyman.engine.KMKeyboard.setWebContentsDebuggingEnabled(boolean)'

So... apparently that method isn't available when unit testing. Locally testing, simply blocking the method from being reached during such scenarios is enough, so... I just added an appropriate check on the latest commit.

jahorton · 2024-04-12T03:12:39Z

ios/engine/KMEI/KeymanEngine/Classes/Keyboard/KeymanWebViewController.swift

@@ -130,6 +130,12 @@ class KeymanWebViewController: UIViewController {
    webView!.backgroundColor = UIColor.clear
    webView!.navigationDelegate = self
    webView!.scrollView.isScrollEnabled = false
+
+    if #available(iOSApplicationExtension 16.4, *) {
+      if(Version.current.tier != .stable) {


Potential improvement: also add check for if local or test; those should be allowed to override .stable, since they're inherently less stable by virtue of being development versions.

I don't think our iOS engine's Version class yet exposes those as flags, though...

mcdurdin · 2024-04-12T21:49:02Z

iOS build failure:

12:14:30   keyman/ios/engine/KMEI/KeymanEngine/Classes/Keyboard/KeymanWebViewController.swift:136:18: error: value of type 'KeymanWebView' has no member 'isInspectable'
12:14:30           webView!.isInspectable = true
12:14:30           ~~~~~~~~ ^~~~~~~~~~~~~

jahorton · 2024-04-17T02:01:18Z

iOS build failure:

12:14:30   keyman/ios/engine/KMEI/KeymanEngine/Classes/Keyboard/KeymanWebViewController.swift:136:18: error: value of type 'KeymanWebView' has no member 'isInspectable'
12:14:30           webView!.isInspectable = true
12:14:30           ~~~~~~~~ ^~~~~~~~~~~~~

I've gone ahead and linked this detail to #10671. For the sake of moving ahead with this task for Android, I think I'll do a quick rebase to split the iOS changes off into their own PR that can await it without blocking the Android changes.

…ability

android/KMEA/app/src/main/java/com/keyman/engine/KMKeyboard.java

Co-authored-by: Marc Durdin <marc@durdin.net>

keyman-server · 2024-04-17T18:14:38Z

Changes in this pull request will be available for download in Keyman version 17.0.309-beta

jahorton requested review from sgschantz and darcywong00 as code owners April 12, 2024 01:07

keymanapp-test-bot bot added this to the B17S5 milestone Apr 12, 2024

github-actions bot added android/ ios/ android/engine/ ios/engine/ chore common/ labels Apr 12, 2024

mcdurdin requested changes Apr 12, 2024

View reviewed changes

github-actions bot added common/ and removed common/ labels Apr 12, 2024

jahorton commented Apr 12, 2024

View reviewed changes

jahorton requested a review from mcdurdin April 12, 2024 01:22

github-actions bot added common/ and removed common/ labels Apr 12, 2024

mcdurdin approved these changes Apr 12, 2024

View reviewed changes

github-actions bot added common/ and removed common/ labels Apr 12, 2024

jahorton commented Apr 12, 2024

View reviewed changes

darcywong00 modified the milestones: B17S5, B17S6 Apr 12, 2024

jahorton mentioned this pull request Apr 17, 2024

chore(ios): upgrade iOS SDK to 17 - requires Xcode 15 - by April 29, 2024 #10671

Closed

jahorton marked this pull request as draft April 17, 2024 02:01

jahorton added 2 commits April 17, 2024 09:01

chore(android): sets internal WebView inspectable

c2ba432

change(android): Android app for non-stable version to enable inspect…

6f3c5e0

…ability

jahorton force-pushed the chore/common/enable-webview-debugging branch from 16baa14 to 6f3c5e0 Compare April 17, 2024 02:04

github-actions bot removed ios/ common/ ios/engine/ labels Apr 17, 2024

jahorton marked this pull request as ready for review April 17, 2024 02:04

github-actions bot added common/ ios/ ios/engine/ labels Apr 17, 2024

jahorton removed ios/ ios/engine/ labels Apr 17, 2024

jahorton changed the title ~~chore(common): enables debugging and inspection of mobile app internal webviews~~ chore(android): enables debugging and inspection of mobile app internal webviews Apr 17, 2024

jahorton mentioned this pull request Apr 17, 2024

chore(ios): enable webview debugging #11229

Merged

mcdurdin reviewed Apr 17, 2024

View reviewed changes

android/KMEA/app/src/main/java/com/keyman/engine/KMKeyboard.java Outdated Show resolved Hide resolved

chore(android): applies suggestions per review

9eca52c

Co-authored-by: Marc Durdin <marc@durdin.net>

github-actions bot added common/ and removed common/ labels Apr 17, 2024

jahorton merged commit eaff3a3 into beta Apr 17, 2024
5 checks passed

jahorton deleted the chore/common/enable-webview-debugging branch April 17, 2024 08:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(android): enables debugging and inspection of mobile app internal webviews #11215

chore(android): enables debugging and inspection of mobile app internal webviews #11215

jahorton commented Apr 12, 2024

keymanapp-test-bot bot commented Apr 12, 2024

mcdurdin left a comment

jahorton Apr 12, 2024

jahorton commented Apr 12, 2024

jahorton Apr 12, 2024

mcdurdin commented Apr 12, 2024

jahorton commented Apr 17, 2024

keyman-server commented Apr 17, 2024

	/**
	* Extract KMEA tier from versionName. Uses parameter so we can unit test.
	* @param versionName String - If not provided, determine tier from
	* com.keyman.engine.BuildConfig.KEYMAN_ENGINE_VERSION_NAME
	* @return Tier (ALPHA, BETA, STABLE)
	*/
	public static Tier getTier(String versionName) {
	if (versionName == null \|\| versionName.isEmpty()) {
	versionName = com.keyman.engine.BuildConfig.KEYMAN_ENGINE_VERSION_NAME;
	}

chore(android): enables debugging and inspection of mobile app internal webviews #11215

chore(android): enables debugging and inspection of mobile app internal webviews #11215

Conversation

jahorton commented Apr 12, 2024

keymanapp-test-bot bot commented Apr 12, 2024

User Test Results

mcdurdin left a comment

Choose a reason for hiding this comment

jahorton Apr 12, 2024

Choose a reason for hiding this comment

jahorton commented Apr 12, 2024

jahorton Apr 12, 2024

Choose a reason for hiding this comment

mcdurdin commented Apr 12, 2024

jahorton commented Apr 17, 2024

keyman-server commented Apr 17, 2024