(DOCSP-26313): Swift: Add a Handle Sync Errors page for SwiftUI #2524
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| import SwiftUI | ||
| import RealmSwift | ||
| import Foundation | ||
|
|
||
| // :snippet-start: swiftui-app-with-error-handler | ||
| let app = App(id: flexibleSyncAppId) | ||
|
|
||
| // :uncomment-start: | ||
| // @main | ||
| // :uncomment-end: | ||
| struct realmSwiftUIApp: SwiftUI.App { | ||
| // Initialize the error handler | ||
| @StateObject var errorHandler = ErrorHandler(app: app) | ||
|
|
||
| var body: some Scene { | ||
| WindowGroup { | ||
| NextView(app: app) | ||
| // Inject the error handler as an environment object | ||
| .environmentObject(errorHandler) | ||
| // Display an alert to the user containing the error when a Sync error occurs | ||
| .alert(Text("Error"), isPresented: .constant(errorHandler.error != nil)) { | ||
| Button("OK", role: .cancel) { errorHandler.error = nil } | ||
| } message: { | ||
| Text(errorHandler.error?.localizedDescription ?? "") | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // :snippet-end: | ||
|
|
||
| // :snippet-start: swiftui-error-handler | ||
| final class ErrorHandler: ObservableObject { | ||
| @Published var error: Swift.Error? | ||
|
|
||
| init(app: RealmSwift.App) { | ||
| // Sync Manager listens for sync errors. | ||
| app.syncManager.errorHandler = { error, syncSession in | ||
| if let error = error as? SyncError { | ||
| /* Handle specific SyncError cases, or use a switch | ||
| * statement to handle all Sync error codes. | ||
| * In this case, ignore a .connectionFailed error and | ||
| * continue executing the app code. */ | ||
| if error.code == .connectionFailed { | ||
| return | ||
| } | ||
| self.error = error | ||
| } else if let error = error as? POSIXError { | ||
| /* The error handler may also report NSError types to | ||
| * allow for error handling in a platform-idiomatic way. | ||
| * In this case, handle a connection timeout error as | ||
| * an .ETIMEDOUT error in the POSIXError domain. */ | ||
| if error.code == .ETIMEDOUT { | ||
| return | ||
| } | ||
| self.error = error | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // :snippet-end: | ||
|
|
||
| // :snippet-start: use-app-and-error-handler-in-next-view | ||
| struct NextView: View { | ||
| @ObservedObject var app: RealmSwift.App | ||
| // Use the error handler that you injected into the environment | ||
| @EnvironmentObject var errorHandler: ErrorHandler | ||
|
|
||
| var body: some View { | ||
| Text("You might log users in or handle errors in this view") | ||
| } | ||
| } | ||
| // :snippet-end: |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| .. code-block:: swift | ||
| :emphasize-lines: 11-25 | ||
|
|
||
| struct FlexSyncContentView: View { | ||
| // Observe the Realm App object in order to react to login state changes. | ||
| @ObservedObject var app: RealmSwift.App | ||
| // Use the error handler that you've injected into the environment | ||
| // to react to Device Sync errors. | ||
| @EnvironmentObject var errorHandler: ErrorHandler | ||
|
|
||
| var body: some View { | ||
| if let user = app.currentUser { | ||
| let config = user.flexibleSyncConfiguration( | ||
| clientResetMode: .recoverUnsyncedChanges( | ||
| beforeReset: { realm in | ||
| // A block called after a client reset error is detected, but before the | ||
| // client recovery process is executed. | ||
| // This block could be used for any custom logic, reporting, debugging etc. | ||
| // For more information, refer to: https://www.mongodb.com/docs/realm/sdk/swift/sync/handle-sync-errors/ | ||
| print("Before client reset block") | ||
| }, afterReset: { before,after in | ||
| // A block called after the client recovery process has executed. | ||
| // This block could be used for custom recovery, reporting, debugging etc. | ||
| // For SwiftUI, you might modify a @State variable to trigger views to reload | ||
| // or advise the user to restart the app. | ||
| // For more information, refer to: https://www.mongodb.com/docs/realm/sdk/swift/sync/handle-sync-errors/ | ||
| print("After client reset block") | ||
| }), | ||
| initialSubscriptions: { subs in | ||
| let peopleSubscriptionExists = subs.first(named: "people") | ||
| let dogSubscriptionExists = subs.first(named: "dogs") | ||
| // Check whether the subscription already exists. Adding it more | ||
| // than once causes an error. | ||
| if (peopleSubscriptionExists != nil) && (dogSubscriptionExists != nil) { | ||
| // Existing subscriptions found - do nothing | ||
| return | ||
| } else { | ||
| // Add queries for any objects you want to use in the app. | ||
| // Linked objects do not automatically get queried, so you | ||
| // must explicitly query for all linked objects you want to include. | ||
| subs.append(QuerySubscription<Person>(name: "people")) | ||
| subs.append(QuerySubscription<Dog>(name: "dogs")) | ||
| } | ||
| } | ||
| ) | ||
| OpenFlexibleSyncRealmView() | ||
| .environment(\.realmConfiguration, config) | ||
| } else { | ||
| LoginView() | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| let app = App(id: flexibleSyncAppId) | ||
|
|
||
| @main | ||
| struct realmSwiftUIApp: SwiftUI.App { | ||
| // Initialize the error handler | ||
| @StateObject var errorHandler = ErrorHandler(app: app) | ||
|
|
||
| var body: some Scene { | ||
| WindowGroup { | ||
| NextView(app: app) | ||
| // Inject the error handler as an environment object | ||
| .environmentObject(errorHandler) | ||
| // Display an alert to the user containing the error when a Sync error occurs | ||
| .alert(Text("Error"), isPresented: .constant(errorHandler.error != nil)) { | ||
| Button("OK", role: .cancel) { errorHandler.error = nil } | ||
| } message: { | ||
| Text(errorHandler.error?.localizedDescription ?? "") | ||
| } | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| final class ErrorHandler: ObservableObject { | ||
| @Published var error: Swift.Error? | ||
|
|
||
| init(app: RealmSwift.App) { | ||
| // Sync Manager listens for sync errors. | ||
| app.syncManager.errorHandler = { error, syncSession in | ||
| if let error = error as? SyncError { | ||
| /* Handle specific SyncError cases, or use a switch | ||
| * statement to handle all Sync error codes. | ||
| * In this case, ignore a .connectionFailed error and | ||
| * continue executing the app code. */ | ||
| if error.code == .connectionFailed { | ||
| return | ||
| } | ||
| self.error = error | ||
| } else if let error = error as? POSIXError { | ||
| /* The error handler may also report NSError types to | ||
| * allow for error handling in a platform-idiomatic way. | ||
| * In this case, handle a connection timeout error as | ||
| * an .ETIMEDOUT error in the POSIXError domain. */ | ||
| if error.code == .ETIMEDOUT { | ||
| return | ||
| } | ||
| self.error = error | ||
| } | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| struct NextView: View { | ||
| @ObservedObject var app: RealmSwift.App | ||
| // Use the error handler that you injected into the environment | ||
| @EnvironmentObject var errorHandler: ErrorHandler | ||
|
|
||
| var body: some View { | ||
| Text("You might log users in or handle errors in this view") | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.