동기화된 Realm에 데이터 쓰기 - Swift SDK

App Services 구성

Realm Mobile Sync는 다음과 같은 쿼리 가능 필드로 구성됩니다.

• _id (항상 포함됨)

• complexity

• ownerId

App Services App에는 사용자가 자신의 데이터만 읽고 쓸 수 있도록 구성된 권한이 있습니다.

{
  "name": "owner-read-write",
  "apply_when": {},
  "document_filters": {
    "read": { "ownerId": "%%user.id" },
    "write": { "ownerId": "%%user.id" }
  },
  "read": true,
  "write": true
}

클라이언트 Realm 데이터 모델 및 구성

이 페이지의 예제에서는 다음 객체 모델을 사용합니다.

class Item: Object {
    @Persisted(primaryKey: true) var _id: ObjectId
    @Persisted var ownerId: String
    @Persisted var itemName: String
    @Persisted var complexity: Int
}

동기화된 영역 구성은 해당 객체 모델을 사용하여 complexity 속성 값이 4 보다 작거나 같은 구독 쿼리와 일치하는 객체를 동기화합니다.

let app = App(id: YOUR_APP_ID_HERE)
do {
    let user = try await app.login(credentials: Credentials.anonymous)
    do {
        var flexSyncConfig = user.flexibleSyncConfiguration()
        flexSyncConfig.objectTypes = [Item.self]
        let realm = try await Realm(configuration: flexSyncConfig)
        let subscriptions = realm.subscriptions
        try await subscriptions.update {
            subscriptions.append(
                QuerySubscription<Item>(name: "simple-items") {
                 $0.complexity <= 4
            })
        }
        print("Successfully opened realm: \(realm)")
    } catch {
        print("Failed to open realm: \(error.localizedDescription)")
        // handle error
    }
} catch {
    fatalError("Login failed: \(error.localizedDescription)")
}

어떤 데이터 동기화?

권한과 결합된 구독 쿼리는 동기화된 영역이 다음과 같은 객체만 동기화한다는 것을 MEAN합니다.

• ownerId 는 로그인한 사용자의 user.id 와 일치합니다(권한에 있음).

• complexity 속성 값이 4 보다 작거나 같음(구독 쿼리에서)

ownerId 이 로그인한 사용자의 user.id 와 일치하지 않거나 complexity 속성 값이 4 보다 큰 Atlas collection 객체는 이 영역에 동기화할 수 없습니다.

성공적인 쓰기

쓰기가 클라이언트의 권한 및 Flexible Sync 구독 쿼리 모두와 일치하면 Realm Swift SDK는 동기화된 Realm에 객체를 성공적으로 쓸 수 있습니다. 이 객체는 기기가 네트워크에 연결되어 있을 때 App Services 백엔드와 동기화됩니다.

// This write falls within the subscription query and complies
// with the Device Sync permissions, so this write should succeed.
do {
    let learnRealm = Item()
    learnRealm.ownerId = user.id
    learnRealm.itemName = "Learn Realm CRUD stuff"
    learnRealm.complexity = 3
    try realm.write {
        realm.add(learnRealm)
    }
} catch {
    print("Failed to write to realm: \(error.localizedDescription)")
}

쓰기 보상

경우에 따라서는 처음에는 성공한 것처럼 보이는 쓰기 작업이 실제로는 불법적인 쓰기 작업인 경우도 있습니다. 이 경우 객체는 데이터베이스에 쓰지만 데이터베이스가 백엔드와 동기화되면 Realm은 보상 쓰기라는 치명적이지 않은 오류 작업을 통해 쓰기를 되돌립니다. 보상 쓰기는 다음과 같은 경우에 발생할 수 있습니다.

• 쓰기가 쿼리 구독과 일치하지 않음: 기록된 객체가 사용자의 권한과 일치하지만 쿼리 구독과 일치하지 않습니다.

• 쓰기가 권한과 일치하지 않음: 기록된 객체가 쿼리 구독과 일치하지만 사용자의 권한과 일치하지 않습니다.

좀 더 구체적으로 말하자면, 쿼리 구독의 범위를 벗어나거나 사용자의 권한과 일치하지 않는 데이터를 쓰면 다음과 같은 상황이 발생합니다.

1. 클라이언트 영역에는 '불법적인' 쓰기에 대한 개념이 없기 때문에 영역이 App Services 백 엔드로 변경 집합을 해결할 때까지 처음에는 쓰기가 성공합니다.

2. 동기화되면 서버는 규칙과 권한을 적용합니다. 서버는 사용자에게 쓰기를 수행할 수 있는 권한 부여가 없다고 판단합니다.

3. 서버는 "보상 쓰기(compensating write)"라고 하는 되돌리기 작업을 클라이언트에 다시 보냅니다.

4. 클라이언트의 영역이 잘못된 쓰기 작업을 되돌립니다.

해당 객체에 대한 불법적인 쓰기와 해당 보상 쓰기 사이에 지정된 객체에 대한 모든 클라이언트 사이드 쓰기는 손실됩니다.

실제로 이는 객체가 영역에 기록된 후 서버가 보상 쓰기를 클라이언트에 다시 보낸 후에 사라지는 것처럼 보일 수 있습니다.

권한 거부 오류, 쓰기 오류 보상 및 기타 Device Sync 오류 유형에 대해 자세히 알아보려면 App Services 문서에서 동기화 오류 를 참조하세요.

App Services 로그 에는 보상 쓰기 오류가 발생하는 이유에 대한 자세한 정보가 포함되어 있습니다.

myApp.syncManager.errorHandler = { syncError, session in
    if let thisError = syncError as? SyncError {
        switch thisError.code {
        // ... additional SyncError.code cases ...
        case .writeRejected:
            if let compensatingWriteErrorInfo = thisError.compensatingWriteInfo {
                for anError in compensatingWriteErrorInfo {
                    print("A write was rejected with a compensating write error")
                    print("The write to object type: \(anError.objectType)")
                    print("With primary key of: \(anError.primaryKey)")
                    print("Was rejected because: \(anError.reason)")
                }
            }
        }
    }
}

A write was rejected with a compensating write error
The write to object type: Optional("Item")
With primary key of: objectId(641382026852d9220b2e2bbf)
Was rejected because: Optional("write to \"641382026852d9220b2e2bbf\" in table \"Item\" not
allowed; object is outside of the current query view")

do {
    let fixTheBug = Item()
    fixTheBug.ownerId = user.id
    fixTheBug.itemName = "Fix the bug with the failing method"
    // The complexity of this item is `7`. This is outside the bounds
    // of the subscription query, so this write triggers a compensating write.
    fixTheBug.complexity = 7
    try realm.write {
        realm.add(fixTheBug)
    }
} catch {
    print("Failed to write to realm: \(error.localizedDescription)")
}

Sync: Connection[1]: Session[1]: Received: ERROR "Client attempted a
write that is outside of permissions or query filters; it has been
reverted" (error_code=231, try_again=true, error_action=Warning)

"FlexibleSync_Item": {
    "63bdfc40f16be7b1e8c7e4b7": "write to \"63bdfc40f16be7b1e8c7e4b7\"
    in table \"FlexibleSync_Item\" not allowed; object is outside of
    the current query view"
}

do {
    let itemWithWrongOwner = Item()
    // The `ownerId` of this item does not match the `user.id` of the logged-in
    // user. The user does not have permissions to make this write, so
    // it triggers a compensating write.
    itemWithWrongOwner.ownerId = "This string does not match the user.id"
    itemWithWrongOwner.itemName = "Write code that generates a permission error"
    itemWithWrongOwner.complexity = 1
    try realm.write {
        realm.add(itemWithWrongOwner)
    }
} catch {
    print("Failed to write to realm: \(error.localizedDescription)")
}

Sync: Connection[1]: Session[1]: Received: ERROR "Client attempted a
write that is outside of permissions or query filters; it has been
reverted" (error_code=231, try_again=true, error_action=Warning)

"FlexibleSync_Item": {
    "63bdfc40f16be7b1e8c7e4b8": "write to \"63bdfc40f16be7b1e8c7e4b8\"
    in table \"FlexibleSync_Item\" was denied by write filter in role
    \"owner-read-write\""
}

여러 프로세스에서 동기화된 Realm 열기와 관련된 충돌

공유 확장 프로그램 또는 다른 앱 확장에서 동기화된 영역을 열려고 할 때 해당 영역이 메인 앱에 열려 있지 않은 경우 공유 확장 프로그램에서 쓰기가 성공할 수 있습니다. 그러나 동기화된 영역이 기본 앱에 이미 열려 있거나 백그라운드에서 데이터를 동기화하는 경우 Realm::MultiSyncAgents 과 관련된 충돌이 발생할 수 있습니다. 이 시나리오에서는 장치를 다시 시작해야 할 수 있습니다.

앱 확장에서 동기화된 Realm에 쓰기에 대한 대안

앱 확장에서 동기화된 영역에서 읽거나 동기화된 영역에 쓰기를 수행해야 하는 경우 몇 가지 권장되는 대안이 있습니다.

• 오프라인 우선: 디스크의 데이터를 메인 앱과 주고 받습니다.

• 항상 최신 상태 유지: 네트워크 연결을 통해 지원 Atlas collection과 직접 통신