Accessing CKSyncEngine.State for diagnostics

[gigq]

Description

I have a dev debug section in my apps for debugging sync issues. It would be helpful to get some data from CKSyncEngine like pending changes, etc. Any chance those can exposed in a future version.

Checklist

• I wrote this in my own words, and aimed to be as succinct as possible, even if I used AI to help research its content.
• I have determined whether this bug is also reproducible in a vanilla SwiftUI project.
• I have determined whether this bug is also reproducible in a vanilla GRDB project.
• If possible, I've reproduced the issue using the main branch of this package.
• This issue hasn't been addressed in an existing GitHub issue or discussion.

Expected behavior

No response

Actual behavior

No response

Reproducing project

No response

SQLiteData version information

No response

Sharing version information

No response

GRDB version information

No response

Destination operating system

No response

Xcode version information

No response

Swift Compiler version information

[mbrandonw]

Hi @gigq, this is more of a feature request than a bug so I am going to convert it to a discussion.

If you have an idea of how the API should be designed then please do share some details. And feel free to open a draft PR, but also do minimize the AI verbiage and try to get it down to a succinct, minimal API. One thing that isn't clear to me is how to make this state observable so that you can just access the helpers and have the view automatically update when the state changes. I feel like that would be pretty important.

[gigq]

What I primarily need is the pending counts so something like this would work for me.

public struct PendingChangeCounts: Equatable, Sendable {
public let recordSaveCount: Int
public let recordDeleteCount: Int
public let databaseChangeCount: Int
}

public var pendingChangeCounts: PendingChangeCounts? { get }

Could just have it be observable like isSendingChanges. That would work for me to be able to have it in my debugging view. Right now I'm just doing hacks to get it to work. Let me know if this seems ok and I can put a PR together.

[stephencelis]

A PR sounds fine to us! AI-assisted is fine but before submitting we ask that it matches the existing style of the code base and that you understand and own each line.

[gigq]

Ok PR for it here: #500

Let me know if anything looks off or you want changes.