Skip to content

feat(ios): add keyman-version to package-version check #16138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mcdurdin wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(ios): add keyman-version to package-version check #16138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions ios/engine/KMEI/KeymanEngine/Classes/Queries/Queries+PackageVersion.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ extension Queries {
func dictionaryReducer(container: KeyedDecodingContainer<Queries.IDCodingKey>, category: String) -> ([String: ResultComponent], Queries.IDCodingKey) throws -> [String: ResultComponent] {
return { (dict, id) -> [String: ResultComponent] in
var dict = dict
if let entry = try? container.decode(ResultEntry.self, forKey: id) {
dict[id.stringValue] = entry
} else if let error = try? container.decode(ResultError.self, forKey: id) {
if let error = try? container.decode(ResultError.self, forKey: id) {

@mcdurdin mcdurdin Jun 25, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check for error results first.

The package-version api could in the past return 'error' values alongside 'kmp' and 'version' properties for some scenarios, e.g. https://api.keyman.com/package-version?platform=ioskeyboard=enhlao:

{
    "keyboards": {
        "enhlao": {
            "version": "1.1",
            "error": "not available for platform",
            "kmp": "https://keyman.com/go/package/download/keyboard/enhlao?version=1.1&update=1"
        }
    }
}

Note that after keymanapp/api.keyman.com#325 merges, it will instead return:

{
    "keyboards": {
        "enhlao": {
            "error": "Not available for platform ios"
        }
    }
}

This was unlikely to ever have arisen in the past because the only errors this could happen for were 'not available for platform' or 'not available as package', and it's hard to see how someone could have installed the keyboard in the first place in that scenario!

But that changes once we have min version checking in place. Consistency in the api response and the processing is neat and tidy, even though fixing just at one end would be sufficient to address the problem.

dict[id.stringValue] = error
} else if let entry = try? container.decode(ResultEntry.self, forKey: id) {
dict[id.stringValue] = entry
} else {
throw FetchError.decodingError(category, id.stringValue)
}
Expand Down Expand Up @@ -116,7 +116,10 @@ extension Queries {
return URLQueryItem(name: resourceField, value: key.id)
}

urlComponents.queryItems = queryItems + [URLQueryItem(name: "platform", value: "ios")]
urlComponents.queryItems = queryItems + [
URLQueryItem(name: "platform", value: "ios"),
URLQueryItem(name: "keyman-version", value: Version.current.plainString)
]
let message = "Querying package versions through API endpoint: \(urlComponents.url!)"
os_log("%{public}s", log:KeymanEngineLogger.resources, type: .info, message)
SentryManager.breadcrumb(message)
Expand Down