Tutorial: Atlas Device Sync para Swift con Swift Interfaz de Usuario

Agregar una propiedad al modelo

Now that you have confirmed everything is working as expected, we can add changes. In this tutorial, we have decided that we want to add a "priority" property to each Item so that we can filter Items by their priorities. The priority property uses a PriorityLevel enum to constrain the possible values.

Para ello siga estos pasos:

1. Abre el App.xcodeproj en Xcode.

2. Abra el archivo de clase Item.swift.

3. Agregue la siguiente propiedad a la clase Item:

   @Persisted var priority: PriorityLevel

4. Agregue también un PriorityLevel PersistableEnum debajo de la clase Item:

   class Item: Object, ObjectKeyIdentifiable {
      @Persisted(primaryKey: true) var _id: ObjectId
      @Persisted var isComplete = false
      @Persisted var summary: String
      @Persisted var owner_id: String
      @Persisted var priority: PriorityLevel
   }
   enum PriorityLevel: Int, PersistableEnum, CaseIterable {
      case severe = 0
      case high = 1
      case medium = 2
      case low = 3
      var description: String {
         switch self {
         case .severe: return "Severe"
         case .high: return "High"
         case .medium: return "Medium"
         case .low: return "Low"
         }
      }
   }

   PersistableEnum es el protocolo que marca los tipos de enumeración como persistentes directamente en Realm. Aquí, el tipo de la enumeración se establece como Int en lugar de String para poder realizar consultas posteriormente según un nivel de prioridad numérico. Usamos la description propiedad calculada para mostrar una representación de cadena de la prioridad en la interfaz de usuario.

Establecer la prioridad al crear un nuevo elemento

1. In the Views directory, go to CreateItemView.swift. Add a new @State property under the existing itemSummary property. For now, set the default value to medium priority:

   @State var itemSummary = ""
   @State var priority = PriorityLevel.medium

2. Now, in the Form body, add a Picker that enables the user to choose which priority level to set on the new Item. Locate the Section that contains the buttons, and insert the following code above it:

   Section(header: Text("Priority")) {
       Picker(selection: $priority, label: Text("Set priority")) {
           ForEach(PriorityLevel.allCases, id: \.self) { priority in
               Text(priority.description)
           }
       }
   }

3. Ahora, pasa al Button(action: que configura los valores de los newItem cuando el usuario presiona el botón Save. Agrega una línea debajo de newItem.summary para configurar también la propiedad priority:

   newItem.summary = itemSummary
   newItem.priority = priority

Ejecutar y probar

En este punto, puede volver a ejecutar la aplicación. Inicie sesión con la cuenta que creó anteriormente en este tutorial. Verá el elemento que creó anteriormente. Añada un nuevo elemento y verá que ahora puede establecer la prioridad. Seleccione High como prioridad y guarde el elemento.

Ahora, regrese a la página de datos del Atlas en su navegador y actualice la Item colección. Debería ver el nuevo elemento con el priority campo agregado y configurado en 1. El elemento existente no tiene el priority campo.

haga clic para ampliar

Update the subscription

In the ContentView.swift file, we create the Flexible Sync subscription that defines which documents we sync with the user's device & account. Look for the let config = user.flexibleSyncConfiguration(initialSubscriptions: variable where we set the initial subscriptions. Within the subscriptions.append() method, you can see that we are currently subscribing to all documents where the owner_id property matches the authenticated user's id. We want to maintain that, but only sync Items that are marked as High or Severe priority.

Por esto, establecemos el enum de PriorityLevel al tipo Int, donde la máxima prioridad (grave) tiene un valor de 0, y la prioridad más baja (baja) tiene un valor de 3. Podemos hacer comparaciones directas entre un Int y la propiedad de prioridad. Para ello, actualiza la instrucción de query para incluir documentos cuya prioridad sea igual o inferior a PriorityLevel.High (o a 1), como se muestra aquí.

También agregaremos el valor booleano reRunOnOpen y lo estableceremos en true para forzar la consulta de suscripción a recalcular qué documentos sincronizar cada vez que abramos la aplicación.

let config = user.flexibleSyncConfiguration(initialSubscriptions: { subs in
   if let foundSubscription = subs.first(named: Constants.myItems) {
      foundSubscription.updateQuery(toType: Item.self, where: {
         $0.owner_id == user.id && $0.priority <= PriorityLevel.high
      })
   } else {
      // No subscription - create it
      subs.append(QuerySubscription<Item>(name: Constants.myItems) {
         $0.owner_id == user.id && $0.priority <= PriorityLevel.high
      })
   }
}, rerunOnOpen: true)

Ejecutar y probar

Ejecute la aplicación de nuevo. Inicie sesión con la cuenta que creó anteriormente en este tutorial. Dado que añadimos reRunOnOpen, la aplicación debería resincronizar solo los documentos que coincidan con la consulta de sincronización flexible. Tras un momento inicial, cuando Realm resincroniza la colección de documentos, solo verá el nuevo elemento de alta prioridad que creó.

El documento de elemento que creó inicialmente no está sincronizado porque no tiene el campo priority. Si desea que este elemento se sincronice, puede editarlo en la interfaz de usuario de Atlas y agregar un valor al campo de prioridad.

Si desea probar la funcionalidad con más detalle, puede crear elementos con diferentes prioridades. Verá que un nuevo elemento con menor prioridad aparece brevemente en la lista de elementos y luego desaparece. El gestor de errores de sincronización proporciona un mensaje que describe este comportamiento:

ERROR
"Client attempted a write that is outside
of permissions or query filters; it has been reverted"

También puedes ver este mensaje en el registro de la consola.

En este escenario, Realm crea el elemento localmente, lo sincroniza con el backend y luego revierte la escritura porque no cumple con las reglas de suscripción.