Skip to content

feat(mac): add logging to Keyman Configuration app 馃崕 - #16494

Open
sgschantz wants to merge 8 commits into
epic/mac-configfrom
feat/mac/add-logging
Open

feat(mac): add logging to Keyman Configuration app 馃崕#16494
sgschantz wants to merge 8 commits into
epic/mac-configfrom
feat/mac/add-logging

Conversation

@sgschantz

@sgschantz sgschantz commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Replace print statements with calls to Apple's unified logging system.
Add support for Sentry and add breadcrumbs to provide context to crash reports.

It would be nice to simplify the code and wrap the calls to Apple's logger and Sentry with some utility functions, but Quinn advises against this: Your Friend the System Log

So, instead, there are many places where there is a call to the Apple log followed by a call to Sentry to queue up a breadcrumb in case a crash happens.

Build-bot: release:mac
Test-bot: skip

@sgschantz sgschantz added this to the B19S1 milestone Sep 1, 2026
@sgschantz sgschantz self-assigned this Sep 1, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Keyman Sep 1, 2026
@keymanapp-test-bot

keymanapp-test-bot Bot commented Sep 1, 2026

Copy link
Copy Markdown

User Test Results

Test specification and instructions

User tests are not required

Test Artifacts

@sgschantz
sgschantz changed the base branch from master to feat/mac/download-url September 1, 2026 14:58
@keymanapp-test-bot keymanapp-test-bot Bot changed the title feat(mac): add logging to Keyman Configuration app feat(mac): add logging to Keyman Configuration app 馃崕 Sep 1, 2026
Base automatically changed from feat/mac/download-url to epic/mac-config September 2, 2026 12:38
sgschantz and others added 4 commits September 2, 2026 15:36
@sgschantz
sgschantz marked this pull request as ready for review September 3, 2026 02:30
@sgschantz
sgschantz requested a review from mcdurdin September 3, 2026 02:30
var fullTaskList = neededTasks
Logger.app.debug("completeNewInstallationEvaluation: created new installation state")

var fullTaskList = neededTasks

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Whitespace?

return(nil)
Logger.setup.error("Could not find the specified input source with bundleID: \(bundleId, privacy: .public)")
LogUtil.errorBreadcrumb("Could not find the specified input source with bundleID: \(bundleId)", category: .setup)
return(nil)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

whitespace?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants