Migrate Apple Watch complications from Realm to GRDB #4058

Copilot · 2025-12-07T15:19:46Z

Summary

Migrates Apple Watch complications from Realm to GRDB database. All existing complications are automatically migrated on first app launch after update. New complications are saved directly to GRDB.

Changes:

Created WatchComplicationGRDB struct with all functionality from Realm-based WatchComplication
Added automatic migration in WatchComplicationTable.createIfNeeded() that copies all Realm complications to GRDB on first launch
Updated all complication access points to use GRDB:
- iOS: ComplicationListViewController, ComplicationEditViewController, ComplicationFamilySelectViewController
- watchOS: ComplicationController, ExtensionDelegate
- API: WatchHelpers, WebhookResponseUpdateComplications
Added orphan cleanup that migrates complications with nil/invalid server IDs to first available server
Removed WatchComplication from LegacyModelManager Realm cleanup
Added GRDB tests, kept legacy Realm tests for compatibility
Fixed SwiftFormat lint issues (trailing spaces, line wrapping, extension access control)
Added new GRDB files to Xcode project build configuration

Migration Flow:

// In WatchComplicationTable.createIfNeeded()
if !db.tableExists(GRDBDatabaseTable.watchComplication.rawValue) {
    // Create table
    try db.create(table: GRDBDatabaseTable.watchComplication.rawValue) { ... }
    
    // Migrate from Realm
    let realmComplications = Current.realm().objects(WatchComplication.self)
    let grdbComplications = realmComplications.map { WatchComplicationGRDB(from: $0) }
    try grdbComplications.forEach { try $0.insert(db) }
}

Screenshots

N/A - Backend change with no UI impact

Link to pull request in Documentation repository

Documentation: home-assistant/companion.home-assistant#

Any other notes

Original Realm WatchComplication model remains untouched for migration period
All complications synced between iOS and watchOS now use GRDB
Safe fallbacks implemented for edge cases (empty template arrays, nil server IDs)
New GRDB files (WatchComplicationGRDB.swift, WatchComplicationGRDB+Queries.swift, WatchComplicationTable.swift) are properly registered in Xcode project's build configuration

Original prompt

Create a migration for apple watch complications, moving them from Realm database to GRDB database. All nee complications should also be directly added to GRDB

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: bgoncal <[email protected]>

… initialization Co-authored-by: bgoncal <[email protected]>

bgoncal · 2025-12-07T21:02:08Z

@copilot Fix lint issues:

Running SwiftFormat...
(lint mode - no files will be changed.)
/home/runner/work/iOS/iOS/Sources/Shared/API/WatchHelpers.swift:29:1: warning: (trailingSpace) Remove trailing space at end of a line.
/home/runner/work/iOS/iOS/Sources/Extensions/Watch/Complication/ComplicationController.swift:21:1: warning: (wrapSingleLineComments) Wrap single line // comments that exceed the specified --maxwidth.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:4:1: warning: (extensionAccessControl) Configure the placement of an extension's access control keyword.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:6:1: warning: (extensionAccessControl) Configure the placement of an extension's access control keyword.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:13:1: warning: (extensionAccessControl) Configure the placement of an extension's access control keyword.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:22:1: warning: (extensionAccessControl) Configure the placement of an extension's access control keyword.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:31:1: warning: (extensionAccessControl) Configure the placement of an extension's access control keyword.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:40:1: warning: (extensionAccessControl) Configure the placement of an extension's access control keyword.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:47:1: warning: (extensionAccessControl) Configure the placement of an extension's access control keyword.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:54:1: warning: (extensionAccessControl) Configure the placement of an extension's access control keyword.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:63:1: warning: (extensionAccessControl) Configure the placement of an extension's access control keyword.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:65:1: warning: (extensionAccessControl) Configure the placement of an extension's access control keyword.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:65:1: warning: (trailingSpace) Remove trailing space at end of a line.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:83:1: warning: (extensionAccessControl) Configure the placement of an extension's access control keyword.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB+Queries.swift:83:1: warning: (wrap) Wrap lines that exceed the specified maximum width.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB.swift:42:1: warning: (wrap) Wrap lines that exceed the specified maximum width.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB.swift:1003:1: warning: (blankLinesAroundMark) Insert blank line before and after MARK: comments.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB.swift:1014:1: warning: (trailingSpace) Remove trailing space at end of a line.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB.swift:1021:1: warning: (trailingSpace) Remove trailing space at end of a line.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB.swift:1039:1: warning: (redundantSelf) Insert/remove explicit self where applicable.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB.swift:1041:1: warning: (redundantSelf) Insert/remove explicit self where applicable.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB.swift:1042:1: warning: (redundantSelf) Insert/remove explicit self where applicable.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB.swift:1043:1: warning: (redundantSelf) Insert/remove explicit self where applicable.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB.swift:1044:1: warning: (redundantSelf) Insert/remove explicit self where applicable.
/home/runner/work/iOS/iOS/Sources/Shared/API/Models/WatchComplicationGRDB.swift:1045:1: warning: (trailingSpace) Remove trailing space at end of a line.
/home/runner/work/iOS/iOS/Sources/App/Settings/AppleWatch/ComplicationListViewController.swift:160:1: warning: (trailingSpace) Remove trailing space at end of a line.
/home/runner/work/iOS/iOS/Sources/App/Settings/AppleWatch/ComplicationListViewController.swift:183:1: warning: (wrap) Wrap lines that exceed the specified maximum width.
/home/runner/work/iOS/iOS/Sources/App/Settings/AppleWatch/ComplicationEditViewController.swift:100:1: warning: (trailingSpace) Remove trailing space at end of a line.
SwiftFormat completed in 6.63s.
Source input did not pass lint check.
6/824 files require formatting, 102 files skipped.

…nsion access control Co-authored-by: bgoncal <[email protected]>

Copilot · 2025-12-07T21:05:19Z

@copilot Fix lint issues:
Running SwiftFormat...

...

Fixed all SwiftFormat lint issues in commit 16b7ca6:

Removed trailing spaces
Wrapped long lines to comply with max width
Changed to public extension for better access control placement
Added blank line before MARK comment
Removed redundant self keywords

github-actions · 2025-12-07T21:10:04Z

⚠️ SwiftLint disabled in this PR

The following added lines contain // swiftlint:disable. Please verify this is necessary.

bgoncal · 2025-12-07T21:27:11Z

@copilot fix tests:

<!DOCTYPE html><head></head>
testProcess completed with exit code 1.
--
test: Sources/Shared/API/Webhook/Networking/WebhookResponseUpdateComplications.swift#L27cannot find type 'WatchComplicationGRDB' in scope
test: Sources/Shared/API/Webhook/Networking/WebhookResponseUpdateComplications.swift#L27cannot find type 'WatchComplicationGRDB' in scope
test: Sources/Shared/API/WatchHelpers.swift#L109cannot find 'WatchComplicationGRDB' in scope
test: Sources/Shared/API/WatchHelpers.swift#L107cannot find type 'WatchComplicationGRDB' in scope
test: Sources/Shared/Database/GRDB+Initialization.swift#L55cannot find 'WatchComplicationTable' in scope
test: Sources/Shared/API/Webhook/Networking/WebhookResponseUpdateComplications.swift#L27cannot find type 'WatchComplicationGRDB' in scope

[test](https://github.com/home-assistant/iOS/actions/runs/20010313100/job/57378964286#step:8:11841)
Process completed with exit code 1.
[test: Sources/Shared/API/Webhook/Networking/WebhookResponseUpdateComplications.swift#L27](https://github.com/home-assistant/iOS/pull/4058/files#annotation_42629218091)
cannot find type 'WatchComplicationGRDB' in scope
[test: Sources/Shared/API/Webhook/Networking/WebhookResponseUpdateComplications.swift#L27](https://github.com/home-assistant/iOS/pull/4058/files#annotation_42629218093)
cannot find type 'WatchComplicationGRDB' in scope
[test: Sources/Shared/API/WatchHelpers.swift#L109](https://github.com/home-assistant/iOS/pull/4058/files#annotation_42629218094)
cannot find 'WatchComplicationGRDB' in scope
[test: Sources/Shared/API/WatchHelpers.swift#L107](https://github.com/home-assistant/iOS/pull/4058/files#annotation_42629218095)
cannot find type 'WatchComplicationGRDB' in scope
[test: Sources/Shared/Database/GRDB+Initialization.swift#L55](https://github.com/home-assistant/iOS/pull/4058/files#annotation_42629218097)
cannot find 'WatchComplicationTable' in scope
[test: Sources/Shared/API/Webhook/Networking/WebhookResponseUpdateComplications.swift#L27](https://github.com/home-assistant/iOS/pull/4058/files#annotation_42629218098)
cannot find type 'WatchComplicationGRDB' in scope

Co-authored-by: bgoncal <[email protected]>

Copilot · 2025-12-07T21:33:03Z

@copilot fix tests:

...

Fixed build errors in commit 241ac53. The new GRDB files (WatchComplicationGRDB.swift, WatchComplicationGRDB+Queries.swift, and WatchComplicationTable.swift) weren't included in the Xcode project file. Added them to:

Models and Tables groups for organization
PBXFileReference section for file tracking
PBXSourcesBuildPhase for both Shared target build phases

All types should now be in scope and the build should succeed.

Initial plan

51dd968

Copilot AI assigned Copilot and bgoncal Dec 7, 2025

Copilot started work on behalf of bgoncal December 7, 2025 15:20 View session

Copilot AI and others added 7 commits December 7, 2025 15:26

Add GRDB WatchComplication model and table schema

6c5896a

Co-authored-by: bgoncal <[email protected]>

Update UI and watch controllers to use GRDB complications

0ecfddb

Co-authored-by: bgoncal <[email protected]>

Update LegacyModelManager and add tests for GRDB complications

0ad1cd0

Co-authored-by: bgoncal <[email protected]>

Update watchOS ExtensionDelegate to use GRDB complications

df28c1a

Co-authored-by: bgoncal <[email protected]>

Remove unnecessary Realm imports and old code

8e471af

Co-authored-by: bgoncal <[email protected]>

Fix GRDB table name mapping and orphan cleanup filter

a521312

Co-authored-by: bgoncal <[email protected]>

Address code review feedback: fix force unwrap, improve filtering and…

d5c6fc3

… initialization Co-authored-by: bgoncal <[email protected]>

Copilot AI changed the title ~~[WIP] Create migration for apple watch complications to GRDB~~ Migrate Apple Watch complications from Realm to GRDB Dec 7, 2025

Copilot AI requested a review from bgoncal December 7, 2025 15:44

Copilot finished work on behalf of bgoncal December 7, 2025 15:44

Copilot started work on behalf of bgoncal December 7, 2025 21:02 View session

Fix SwiftFormat lint issues: trailing spaces, line wrapping, and exte…

16b7ca6

…nsion access control Co-authored-by: bgoncal <[email protected]>

Copilot finished work on behalf of bgoncal December 7, 2025 21:06

Copilot started work on behalf of bgoncal December 7, 2025 21:27 View session

Add WatchComplicationGRDB files to Xcode project

241ac53

Co-authored-by: bgoncal <[email protected]>

Copilot finished work on behalf of bgoncal December 7, 2025 21:34

Tweaks

5f3062b

home-assistant bot added the cla-signed label Dec 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Migrate Apple Watch complications from Realm to GRDB #4058

Migrate Apple Watch complications from Realm to GRDB #4058

Copilot AI commented Dec 7, 2025 •

edited

Loading

Uh oh!

bgoncal commented Dec 7, 2025

Uh oh!

Copilot AI commented Dec 7, 2025

Uh oh!

github-actions bot commented Dec 7, 2025 •

edited

Loading

Uh oh!

bgoncal commented Dec 7, 2025

Uh oh!

Copilot AI commented Dec 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Migrate Apple Watch complications from Realm to GRDB #4058

Are you sure you want to change the base?

Migrate Apple Watch complications from Realm to GRDB #4058

Conversation

Copilot AI commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Screenshots

Link to pull request in Documentation repository

Any other notes

Uh oh!

bgoncal commented Dec 7, 2025

Uh oh!

Copilot AI commented Dec 7, 2025

Uh oh!

github-actions bot commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bgoncal commented Dec 7, 2025

Uh oh!

Copilot AI commented Dec 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Dec 7, 2025 •

edited

Loading

github-actions bot commented Dec 7, 2025 •

edited

Loading