Gestionar Errores de Sincronización - Swift SDK

Reinicio automático vs. manual del cliente

Los SDK de Realm ofrecen modos de restablecimiento de cliente que gestionan automáticamente la mayoría de los errores de restablecimiento. Los modos de restablecimiento automático de cliente restauran el archivo local de Realm a un estado sincronizable sin cerrarlo ni perder notificaciones.

Todos los modos de reinicio del cliente excepto .manual Realizar un restablecimiento automático del cliente. Las diferencias entre los modos se basan en cómo gestionan los cambios en el dispositivo que aún no se han sincronizado con el backend.

Elige .recoverUnsyncedChanges para gestionar automáticamente la mayoría de los escenarios de restablecimiento del cliente. Esto intenta recuperar los cambios no sincronizados cuando ocurre un restablecimiento del cliente.

En algunos casos, puede que quieras o necesites configurar un controlador de reinicio manual del cliente. Esto es recomendable si tu aplicación requiere una lógica de reinicio específica que no se puede gestionar automáticamente.

Especificar un modo de reinicio del cliente

El SDK de Swift ofrece la opción de especificar un modo de restablecimiento de cliente en SyncConfiguration.Esta es la propiedad `.clientResetMode`.

// Specify the clientResetMode when you create the SyncConfiguration.
// If you do not specify, this defaults to `.recoverUnsyncedChanges` mode.
var configuration = user.flexibleSyncConfiguration(clientResetMode: .recoverUnsyncedChanges())

Esta propiedad toma una enumeración que representa los diferentes modos de reinicio del cliente:

• .recoverUnsyncedChanges

• .recoverOrDiscardUnsyncedChanges

• .discardUnsyncedChanges

• .manual

Si no especifica .clientResetMode en su configuración, el modo de restablecimiento del cliente predeterminado será .recoverUnsyncedChanges.

Puede especificar un bloque before y after para que se ejecute durante el proceso de restablecimiento automático del cliente. Puede usarlo para ejecutar la lógica de recuperación importante para su aplicación.

// 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.
// This is one example, but your usage may vary.
let beforeClientResetBlock: (Realm) -> Void = { before in
    var recoveryConfig = Realm.Configuration()
    recoveryConfig.fileURL = myRecoveryPath
    do {
       try before.writeCopy(configuration: recoveryConfig)
        // The copied realm could be used later for recovery, debugging, reporting, etc.
     } catch {
            // handle error
     }
}
// A block called after the client recovery process has executed.
// This block could be used for custom recovery, reporting, debugging etc.
// This is one example, but your usage may vary.
let afterClientResetBlock: (Realm, Realm) -> Void = { before, after in
    //     let res = after.objects(myClass.self)
    //     if (res.filter("primaryKey == %@", object.primaryKey).first != nil) {
    //         // ...custom recovery logic...
    //     } else {
    //         // ...custom recovery logic...
    //     }
    // }
}
do {
    let app = App(id: YOUR_APP_SERVICES_APP_ID)
    let user = try await app.login(credentials: Credentials.anonymous)
    var configuration = user.flexibleSyncConfiguration(clientResetMode:
                                                        .recoverOrDiscardUnsyncedChanges(
                                                            beforeReset: beforeClientResetBlock,
                                                            afterReset: afterClientResetBlock))
} catch {
    print("Error logging in user: \(error.localizedDescription)")
}

Si su aplicación tiene necesidades específicas de recuperación de clientes, puede especificar el .manual modo de restablecimiento de cliente y configurar un controlador manual de restablecimiento de cliente. Puede hacerlo si su aplicación debe ejecutar una lógica personalizada específica durante un restablecimiento de cliente o si las reglas de recuperación de cliente no funcionan.

Manejar cambios de esquema

La Recuperación de Cliente es una función que se habilita de forma predeterminada al configurar la Sincronización de Dispositivos. Cuando está habilitada, Realm puede administrar automáticamente el proceso de restablecimiento del cliente en la mayoría de los casos. Al realizar cambios en el esquema:

• El cliente puede recuperar cambios no sincronizados cuando no hay cambios de esquema o cambios de esquema que no interrumpan el proceso.

• Al realizar cambios de esquema disruptivos, los modos de restablecimiento automático del cliente recurren a un gestor de errores manual. Puede configurar un gestor de errores de restablecimiento manual del cliente para este caso. La recuperación automática del cliente no puede ocurrir cuando su aplicación realiza cambios de esquema disruptivos.

Para obtener información sobre cambios de esquema disruptivos y no disruptivos, consulte Referencia rápida sobre cambios disruptivos y no disruptivos.

Recuperar cambios no sincronizados

Durante un restablecimiento de cliente, las aplicaciones cliente pueden intentar recuperar datos del dominio local que aún no se hayan sincronizado con el backend. Para recuperar los cambios no sincronizados, laRecuperación de Cliente debe estar habilitada en la aplicación de Servicios de Aplicaciones, como está predeterminado.

Si desea que su aplicación recupere los cambios que aún no se han sincronizado, configure .clientResetMode en SyncConfiguration en uno de los siguientes:

• .recoverUnsyncedChangesAl seleccionar este modo, el cliente intenta recuperar los cambios no sincronizados. Elija este modo si no desea descartar los cambios no sincronizados.

• .recoverOrDiscardUnsyncedChangesEl cliente primero intenta recuperar los cambios que aún no se han sincronizado. Si no puede recuperar los datos no sincronizados, descarta los cambios no sincronizados, pero continúa reiniciando el cliente automáticamente. Seleccione este modo si desea habilitar la recuperación automática del cliente para descartar los cambios no sincronizados.

// Specify the clientResetMode when you create the SyncConfiguration.
// If you do not specify, this defaults to `.recoverUnsyncedChanges` mode.
var configuration = user.flexibleSyncConfiguration(clientResetMode: .recoverUnsyncedChanges())

Es posible que, en ocasiones, la operación de restablecimiento del cliente no pueda completarse en el modo de recuperación de cambios no sincronizados, como cuando hay cambios de esquema importantes o la recuperación del cliente está deshabilitada en la configuración de sincronización de dispositivos. Para solucionar este problema, la aplicación puede implementar una alternativa de restablecimiento manual del cliente.

Descartar cambios no sincronizados

El modo de restablecimiento del cliente para descartar cambios no sincronizados elimina permanentemente todos los cambios locales no sincronizados realizados desde la última sincronización exitosa. Puedes usar este modo cuando tu aplicación requiere una lógica de recuperación del cliente que no coincide con las reglas de recuperación del cliente de sincronización de dispositivos o cuando no deseas recuperar datos no sincronizados.

No utilice el modo de descartar cambios no sincronizados si su aplicación no puede perder datos locales que aún no se han sincronizado con el backend.

Para realizar un restablecimiento automático del cliente que descarte los cambios no sincronizados, configure .clientResetMode en SyncConfiguration .discardUnsyncedChanges en.

do {
    let app = App(id: APP_ID)
    let user = try await app.login(credentials: Credentials.anonymous)
    var config = user.flexibleSyncConfiguration(clientResetMode: .discardUnsyncedChanges())
} catch {
    print("Error logging in user: \(error.localizedDescription)")
}

Puede haber ocasiones en las que la operación de restablecimiento del cliente no pueda completarse en el modo de descartar cambios no sincronizados, como cuando hay cambios de esquema importantes. Para solucionar este caso, la aplicación puede implementar una alternativa de restablecimiento manual del cliente.

Modo de restablecimiento manual del cliente

Cuando especifica .manual para .clientResetMode, debe implementar un controlador de restablecimiento de cliente manual.

En .manual el modo, define su propio controlador de restablecimiento de cliente. Este controlador puede aceptar un valor.ErrorReportingBlock Recomendamos usar los modos de recuperación automática del cliente siempre que sea posible y elegir el .manual modo solo si la lógica de recuperación automática no es adecuada para su aplicación.

do {
    let app = App(id: APP_ID)
    let user = try await app.login(credentials: Credentials.anonymous)
    var config = user.flexibleSyncConfiguration(clientResetMode: .manual())
} catch {
    print("Error logging in user: \(error.localizedDescription)")
}

Restablecimiento manual del cliente

Si la operación de restablecimiento del cliente no puede completarse automáticamente, como cuando se producen cambios importantes en el esquema, el proceso se redirige a un gestor de errores manual. Esto puede ocurrir en cualquiera de estos modos de restablecimiento automático del cliente:

• .recoverUnsyncedChanges

• .recoverOrDiscardUnsyncedChanges

• .discardUnsyncedChanges

RLMApp *app = [RLMApp appWithId:YOUR_APP_ID];
[[app syncManager] setErrorHandler:^(NSError *error, RLMSyncSession *session) {
    if (error.code == RLMSyncErrorClientResetError) {
        // TODO: Invalidate all open realm instances
        // TODO: Restore the local changes backed up at [error rlmSync_clientResetBackedUpRealmPath]
        [RLMSyncSession immediatelyHandleError:[error rlmSync_errorActionToken] syncManager:[app syncManager]];
        return;
    }
    // Handle other errors...
}];

func handleClientReset() {
    // Report the client reset error to the user, or do some custom logic.
}
do {
    let app = App(id: APP_ID)
    let user = try await app.login(credentials: Credentials.anonymous)
    var config = user.flexibleSyncConfiguration(clientResetMode: .recoverOrDiscardUnsyncedChanges())
    // If client recovery fails,
    app.syncManager.errorHandler = { error, session in
        guard let syncError = error as? SyncError else {
            fatalError("Unexpected error type passed to sync error handler! \(error)")
        }
        switch syncError.code {
        case .clientResetError:
            if let (path, clientResetToken) = syncError.clientResetInfo() {
                handleClientReset()
                SyncSession.immediatelyHandleError(clientResetToken, syncManager: app.syncManager)
            }
        default:
            // Handle other errors...
            ()
        }
    }
} catch {
    print("Error: \(error.localizedDescription)")
}

Manejo del restablecimiento del cliente de prueba

Puede probar manualmente el manejo de restablecimiento del cliente de su aplicación finalizando y volviendo a habilitar la sincronización del dispositivo.

Al finalizar y reactivar Sync, los clientes que se conectaron previamente con Sync no podrán hacerlo hasta que restablezcan el cliente. Al finalizar Sync, se eliminan los metadatos del servidor que permiten la sincronización. El cliente debe descargar una nueva copia del dominio desde el servidor. El servidor envía un error de restablecimiento de cliente a estos clientes. Por lo tanto, al finalizar Sync, se activa la condición de restablecimiento de cliente.

Para probar el manejo del restablecimiento del cliente:

1. Escriba datos desde una aplicación cliente y espere a que se sincronicen.

2. Termina y vuelve a habilitar Device Sync.

3. Ejecute la aplicación cliente nuevamente. La aplicación debería mostrar un error de restablecimiento de cliente al intentar conectarse al servidor.