feat(android): add keyman-version to package-version check#16139
Open
mcdurdin wants to merge 1 commit into
Open
feat(android): add keyman-version to package-version check#16139mcdurdin wants to merge 1 commit into
mcdurdin wants to merge 1 commit into
Conversation
For Keyman for Android, add the new `keyman-version` parameter to the api.keyman.com/package-version call so that updates to packages that are not supported on the current version of Keyman will not be offered. This supports the scenario where an updated keyboard or lexical model depends on a newer version of Keyman. Note that an older version of the keyboard or lexical model package will not be offered (the user can still download and install an older version manually, but generally, the recommended solution is to upgrade Keyman; there would be significant cost to add support for querying and installation of older version keyboards on the server side, for limited benefit). Relates-to: keymanapp/api.keyman.com#325
User Test ResultsTest specification and instructions
Results TemplateTest Artifacts |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
For Keyman for Android, add the new
keyman-versionparameter to the api.keyman.com/package-version call so that updates to packages that are not supported on the current version of Keyman will not be offered. This supports the scenario where an updated keyboard or lexical model depends on a newer version of Keyman. Note that an older version of the keyboard or lexical model package will not be offered (the user can still download and install an older version manually, but generally, the recommended solution is to upgrade Keyman; there would be significant cost to add support for querying and installation of older version keyboards on the server side, for limited benefit).Relates-to: keymanapp/api.keyman.com#325
User Testing
TEST_UPGRADE: Install an older version of a keyboard and lexical model from downloads.keyman.com, and then check for updates, and verify that the packages are updated successfully.
TEST_MISSING_KEYBOARD: Create a keyboard package with an id that is not on Keyman Cloud, and install it. Check for updates and verify that the app functions correctly and does not offer updates for the keyboard.
TEST_MISSING_MODEL: Create a model package with an id that is not on Keyman Cloud, and install it. Check for updates and verify that the app functions correctly and does not offer updates for the keyboard.
(It is not currently possible to test the scenario where a keyboard/model requires a newer Keyman version in the app, but the outcome should be identical to the missing keyboard/model outcome.)