fix(ios): load host page, keyboards through a consistent WKURLSchemeHandler by jahorton · Pull Request #16136 · keymanapp/keyman

jahorton · 2026-06-24T21:03:18Z

These changes bypass any need to modify KMW keyboard loading (say, via .fetch), instead forcing all engine files and resources to load via the new scheme/protocol in order to accomplish its goal.

Alternate approaches considered:

monkeypatching fetches on file:// protocol calls to ping Swift for a file load, then pass the results back via JS call that resolves the associated fetch Promise.
- Would require fewer changes, but would require that one point of monkeypatching.

Build-bot: skip release:ios,web

User Testing

TEST_IOS:

Install Keyman for iPhone and iPad from this PR
Verify that a keyboard properly shows
Verify that the predictive-text banner shows suggestions (use a keyboard/language with an associated lexical model)

TEST_WEB:

Open KeymanWeb test page, navigate to any test
Select a keyboard and verify that it displays the OSK and that the console window doesn't show errors

TEST_WEB_KBD_DOCS:

Open KeymanWeb test page titled "Tests keyboard documentation rendering"
Verify that all keyboard renders load correctly and lack any obvious visual errors.

keymanapp-test-bot · 2026-06-24T21:03:23Z

User Test Results

Test specification and instructions

⬜ TEST_IOS (OPEN)
⬜ TEST_WEB (OPEN)
⬜ TEST_WEB_KBD_DOCS (OPEN)

Results Template

# Test Results

* **TEST_IOS (OPEN):** notes
* **TEST_WEB (OPEN):** notes
* **TEST_WEB_KBD_DOCS (OPEN):** notes

Test Artifacts

iOS
Web
- KeymanWeb Test Home

mcdurdin

I like where this is going, some feedback and thoughts on how to tighten it up.

mcdurdin · 2026-06-25T04:35:38Z

    sourcePath = addDelimiter(sourcePath);
    this.sourcePath = sourcePath;
-    this.protocol = sourcePath.replace(/(.{3,5}:)(.*)/,'$1');
+    this.protocol = sourceURL.protocol;


Sometimes a little bit of cleanup just makes things so much prettier

mcdurdin · 2026-06-25T04:42:03Z

  }

  updateFromOptions(pathSpec: Required<PathOptionSpec>) {
    const _rootPath = this.sourcePath.replace(/(https?:\/\/)([^\/]*)(.*)/,'$1$2/');


Will this also need fixup?

Not exactly sure what it's doing, and I didn't need to change it, so I decided to leave this be.

mcdurdin · 2026-06-25T04:42:06Z


  // Local function to convert relative to absolute URLs
  // with respect to the source path, server root and protocol
  fixPath(p: string) {


Could this whole function be replaced with new URL(p, this.sourcePath)?

I'd want to test that out more thoroughly as its own PR, rather than rolling it in here.

mcdurdin · 2026-06-25T05:12:15Z

@@ -36,12 +36,14 @@
   ```
   */


Suggested change

*/

Legacy comment!

mcdurdin · 2026-06-25T05:13:56Z

+      // +1:  include the ':' that likely exists
+      pathComponent = String(components.path.dropFirst(KeymanWebViewController.SCHEME.count + 1))
+    }
+


I'm confused about this piece of code. Surely pathComponent should never include keyman-engine:? That would be components.scheme?

Also, I think this would be a good place to collapse repeated slashes, both at start of string and beyond, because repeated slashes when building paths is a common bug and I think we can be resilient to it without real penalty.

That also removes the need to do that work in pathConfiguration.ts.

pathComponent = components.path.replacingOccurrences(of: "/+", with: "/", options: .regularExpression) if pathComponent.hasPrefix("/") { pathComponent = pathComponent.dropFirst() }

Something like that?

This was an earlier attempt to work around issues in which URLs like the following appeared: keyman-engine:/keyman-engine:/kmwosk.css

It didn't work, which led to resolving things in Web engine code - the changes to pathConfiguration.ts, oskView.ts, and visualKeyboard.ts.

Will clean up now.

That also removes the need to do that work in pathConfiguration.ts.

pathComponent = components.path.replacingOccurrences(of: "/+", with: "/", options: .regularExpression) if pathComponent.hasPrefix("/") { pathComponent = pathComponent.dropFirst() }

... about that. If there are repeated leading slashes, URLComponents will consider the 'path' as the host, not a path! For most of our resources, this then results in a nil path, which is very much something we don't want. Some of the changes seen in pathConfiguration.ts were made b/c they're the easiest workaround... or were at the time.

... and fortunately, the fixes in OSK code resolved the cases that were causing this, so we can still knock the pathConfiguration.ts double-slash handling out!

mcdurdin · 2026-06-25T05:16:13Z

One more thought; can we base this on #16132 so that we are looking at a consolidated fix for both platforms?

jahorton · 2026-06-25T15:46:55Z

One more thought; can we base this on #16132 so that we are looking at a consolidated fix for both platforms?

Work is still ongoing there, and there's been at least one force-push to that branch since the quoted comment was posted. I'd have to re-force-push this branch every time a force-push happens there.

…andler This bypasses any need to modify KMW keyboard loading (say, via .fetch), though it does require a number of collateral changes to be made in order for CORS, etc to be satisfied. Build-bot: skip build:ios

Pretty much just what the title says; it's been silently missing this whole time. This doesn't fix iOS keyboard's display by itself, but it is a prerequisite for the full solution offered by #16136. Build-bot: skip build:ios Test-bot: skip

github-project-automation Bot added this to Keyman Jun 24, 2026

github-project-automation Bot moved this to Todo in Keyman Jun 24, 2026

keymanapp-test-bot Bot added the user-test-missing User tests have not yet been defined for the PR label Jun 24, 2026

keymanapp-test-bot Bot added this to the A19S32 milestone Jun 24, 2026

github-actions Bot added web/ ios/ ios/engine/ fix labels Jun 24, 2026

mcdurdin reviewed Jun 25, 2026

View reviewed changes

jahorton force-pushed the fix/ios/load-via-scheme-handler branch from 2e9568e to b9a3c11 Compare June 25, 2026 15:47

keymanapp-test-bot Bot added has-user-test user-test-required User tests have not been completed and removed user-test-missing User tests have not yet been defined for the PR labels Jun 25, 2026

jahorton force-pushed the fix/ios/load-via-scheme-handler branch from b9a3c11 to 1f99b2d Compare June 25, 2026 16:07

fix(ios): load host page, keyboards through a consistent WKURLSchemeH…

08c2f25

…andler This bypasses any need to modify KMW keyboard loading (say, via .fetch), though it does require a number of collateral changes to be made in order for CORS, etc to be satisfied. Build-bot: skip build:ios

jahorton mentioned this pull request Jun 25, 2026

fix(ios): bundle in KMW's globe-hint.css #16142

Draft

jahorton changed the base branch from master to fix/ios/bundle-globe-hint June 25, 2026 18:23

jahorton force-pushed the fix/ios/load-via-scheme-handler branch from 1f99b2d to 08c2f25 Compare June 25, 2026 18:23

Uh oh!

Uh oh!

Conversation

jahorton commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User Testing

Uh oh!

keymanapp-test-bot Bot commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User Test Results

Test Artifacts

Uh oh!

mcdurdin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jahorton Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mcdurdin commented Jun 25, 2026

Uh oh!

jahorton commented Jun 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jahorton commented Jun 24, 2026 •

edited

Loading

keymanapp-test-bot Bot commented Jun 24, 2026 •

edited

Loading

jahorton Jun 25, 2026 •

edited

Loading