restablecimiento del cliente

Overview

A client reset error is a scenario where a client realm cannot sync data with the application backend. Clients in this state may continue to run and save data locally but cannot send or receive sync changesets until they perform a client reset. The Realm SDKs provide methods to automatically handle client resets under most scenarios.

Los reinicios de clientes ocurren cuando el historial del servidor es incompatible con el del cliente. Las causas más comunes son:

• Fallos del servidor de Atlas App Services: Un servidor puede restaurarse desde una copia de seguridad con una versión anterior. En este caso, un restablecimiento del cliente restablecería la versión anterior y perdería los cambios guardados en el cliente pero no sincronizados con el servidor.

• Disabling and re-enabling sync: Turning Sync off and then on again in the App Services UI causes all clients to require a client reset.

• Client/Backend schema mismatch: If a client application attempts to synchronize with the backend while using a Realm Object schema that does not exist in the backend, that client must perform a client reset. This only applies in one direction: if the backend schema contains an Realm Object class not used in a client, that client does not need to client reset.

• Tiempo máximo sin conexión del cliente: Cuando un cliente no se ha sincronizado con el backend durante más de los días indicados, ya no podrá sincronizar los cambios locales no sincronizados con el backend. El cliente debe descartar todos los cambios locales desde la última sincronización y descargar el estado actual del dominio desde el backend.

• Cambios de esquema disruptivos: Un cambio disruptivo o destructivo, como cambiar un tipo de propiedad o una clave principal, requiere que finalice y vuelva a habilitar la sincronización. Esto crea un nuevo archivo de dominio sincronizado con una versión no relacionada con el archivo del cliente. En este caso, el proceso de restablecimiento del cliente no puede completarse automáticamente, y la aplicación debe proporcionar un controlador manual de restablecimiento del cliente.

• Actualización de un clúster compartido a uno dedicado: Al actualizar de un clúster compartido a uno dedicado, debe finalizar la sincronización en el clúster anterior. Después de la actualización, puede volver a habilitar la sincronización. Desactivar y volver a activar la sincronización hace que todos los clientes requieran un reinicio.

• Cambios en el rol de la sesión: Al utilizar Flexible Sync, los cambios en el rol de sesión Flexible Sync de un usuario resultan en un restablecimiento del cliente. Los siguientes escenarios resultan en un restablecimiento del cliente:

  • modificaciones del lado del servidor a la función de sesión

  • cambios en el valor de cualquier expansión en las expresiones "aplicar cuando", leer o escribir

  • changes that qualify the user for a different session role

  Nota

  Los cambios importantes en el esquema requieren una actualización del esquema de la aplicación

  Después de un cambio de esquema importante:

  • Todos los clientes deben realizar un reinicio manual del cliente.

  • Debe actualizar los modelos de cliente afectados por el cambio de esquema importante.

Gestionar un restablecimiento de cliente

Los SDKs detectan automáticamente la necesidad de restablecimiento del cliente. Pueden realizar automáticamente un restablecimiento del cliente en la mayoría de los casos, excepto en el evento de un cambio importante en el esquema.

Durante un restablecimiento automático del cliente, el cliente:

1. Descarga una copia nueva del reino desde el backend.

2. Realiza una comparación para determinar los pasos necesarios para llevar la copia original (local) del reino al mismo estado que la copia nueva del backend.

3. Aplica ese conjunto de pasos para transformar el realm local a un estado donde pueda sincronizarse con el backend.

   Si no hay cambios de esquema, o solo hay cambios de esquema permanentes, el SDK intenta recuperar todos los cambios locales que aún no se han sincronizado con el backend. También aplica las inserciones, actualizaciones y eliminaciones del backend que aún no se han sincronizado con el cliente.

   Si ha optado por descartar los cambios no sincronizados en el SDK, o si el modo de recuperación no puede recuperarlos, el SDK puede descartar los cambios locales que aún no se hayan sincronizado con el backend. A continuación, puede aplicar cualquier inserción, actualización o eliminación del backend que aún no se haya sincronizado con el cliente. Para descartar los cambios locales, elija la versión de su SDK preferida. recoverOrDiscard modo de reinicio del cliente.

4. Descarta la copia nueva. La aplicación continúa usando la copia original del dominio con la diferencia aplicada.

En caso de un cambio de esquema disruptivo, o si falla el restablecimiento automático del cliente, este se ejecuta mediante un controlador manual de restablecimiento que la aplicación debe definir. Los SDK de Realm no pueden realizar automáticamente un restablecimiento del cliente al realizar un cambio de esquema disruptivo.

El modo de reinicio automático del cliente tiene varias ventajas en comparación con la recuperación manual:

• Tu aplicación puede realizar un restablecimiento del cliente sin escribir ninguna lógica personalizada, aparte de especificar el modo. No es necesario iniciar manualmente el restablecimiento del cliente ni interactuar con el objeto de error en absoluto.

• Tu aplicación puede realizar un restablecimiento del cliente sin cerrar ningún reino, desconectarse de la aplicación de backend ni reinicios manuales. Esto significa que no tienes que escribir ninguna lógica para gestionar estas situaciones.

• Los usuarios de la aplicación reciben notificaciones de cambios a medida que el ámbito local se actualiza para coincidir con el estado del ámbito backend.

Habilitar o deshabilitar el modo de recuperación

Recovery Mode is enabled by default in every Device Sync configuration. You can disable Recovery Mode, or re-enable it if you have previously disabled it.