Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(DataStore): created and deleted model on one device appears as created on the other #3554

Merged
merged 3 commits into from
Mar 11, 2024
Merged

fix(DataStore): created and deleted model on one device appears as created on the other #3554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e747e76
fix(DataStore): created and deleted model on one device appears as cr…
MuniekMg Mar 6, 2024
6de6294
fix(DataStore): created and deleted model on one device appears as cr…
MuniekMg Mar 7, 2024
4357eb3
fix(DataStore): created and deleted model on one device appears as cr…
MuniekMg Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 25 additions & 10 deletions ...AWSDataStorePlugin/Sync/SubscriptionSync/ReconcileAndLocalSave/RemoteSyncReconciler.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,41 @@ struct RemoteSyncReconciler {
}
}


/// Reconciles the incoming `remoteModels` against the local metadata to get the disposition
///
/// GroupBy the remoteModels by model identifier and apply only the latest version of the remoteModel
///
/// - Parameters:
/// - remoteModels: models retrieved from the remote store
/// - localMetadatas: metadata retrieved from the local store
/// - Returns: disposition of models to apply locally
static func getDispositions(_ remoteModels: [RemoteModel],
localMetadatas: [LocalMetadata]) -> [Disposition] {
guard !remoteModels.isEmpty else {
static func getDispositions(
_ remoteModels: [RemoteModel],
localMetadatas: [LocalMetadata]
) -> [Disposition] {
let remoteModelsGroupByIdentifier = remoteModels.reduce([String: [RemoteModel]]()) {
$0.merging([
$1.model.identifier: ($0[$1.model.identifier] ?? []) + [$1]
], uniquingKeysWith: { $1 })
}

let optimizedRemoteModels = remoteModelsGroupByIdentifier.values.compactMap {
$0.sorted(by: { $0.syncMetadata.version > $1.syncMetadata.version }).first
}

guard !optimizedRemoteModels.isEmpty else {
return []
}

guard !localMetadatas.isEmpty else {
return remoteModels.compactMap { getDisposition($0, localMetadata: nil) }
Copy link
Contributor Author

@MuniekMg MuniekMg Mar 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line was causing the bug:

here we were geting an empty localMetadatas and remoteModels with two elements for the same model (the same ID):
eg. [
ModelA - id: aaa, version: 1, deleted: false,
ModelA - id: aaa, version: 2, deleted: true
]

and then "deleted: true disposition" was dropped so only "create disposition" was returned

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This certainly appears to be a bug. Previously, the reconciliation for remoteModels was executed individually. We've transitioned to batching, but overlooked this particular scenario. I agree with your proposed approach; we should groupBy and optimize the remoteModels accordingly.

Copy link
Member

@lawmicha lawmicha Mar 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me try to summarize this, the reconciliation path for DataStore takes the sync query remote model results and decides to apply the remote model to the local database or drop it. Previously the logic processed one model at a time. We changed this to a batch operation by putting the reconciliation logic under a transaction block, operating on the entire list of remote models. The necessary logic updates to perform the SQL operations more efficiently included constructing a predicate of all the model identifiers as a filter criteria for querying local data that is used for the reconciliation logic. There exists a bug with this optimization when having multiple entries of remote model belong to the same identifier and the changes to the remote model ends up as a deleted model on the latest version.

Bug example
remoteModels = [id=111 version=1 deleted=false, id=111 version=2 deleted=true]

When the disposition of the model is calculated for the create model, it is to create the model with the local database, because there is no local model, nor is there a local model with version less than the remote model.
When the disposition of the model is calculated for the delete model, it is to drop it because no local model yet to exist, so it thinks there is nothing to delete.

The end result is the model is created but not deleted. The fix we are applying in the PR is to optimize the reconciliation by only taking the latest versions of the remote model. In the example, this becomes [id=111 version=2, deleted=true]. The latest version represents the final state of the model that we want applied to the local database. In this case, the remote model will be dropped. There is no create disposition so it will not be created either.

return optimizedRemoteModels.compactMap { getDisposition($0, localMetadata: nil) }
}

let metadataBymodelId = localMetadatas.reduce(into: [:]) { $0[$1.modelId] = $1 }
let dispositions = remoteModels.compactMap { getDisposition($0, localMetadata: metadataBymodelId[$0.model.identifier]) }


let metadataByModelId = localMetadatas.reduce(into: [:]) { $0[$1.modelId] = $1 }
let dispositions = optimizedRemoteModels.compactMap {
getDisposition($0, localMetadata: metadataByModelId[$0.model.identifier])
}

return dispositions
}

Expand Down
27 changes: 27 additions & 0 deletions ...Store/Tests/AWSDataStorePluginTests/Sync/SubscriptionSync/RemoteSyncReconcilerTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,33 @@ class RemoteSyncReconcilerTests: XCTestCase {
}
waitForExpectations(timeout: 1)
}

func testGetDispositions_emptyLocal_singleModelAddedAndDeleted() {
let sameId = UUID().uuidString

let remoteModels = [
makeRemoteModel(modelId: sameId, deleted: false, version: 1),
makeRemoteModel(modelId: sameId, deleted: true, version: 2)
]

let dispositions = RemoteSyncReconciler.getDispositions(remoteModels, localMetadatas: [])

XCTAssertTrue(dispositions.isEmpty)
}

func testGetDispositions_emptyLocal_oneModelAdded_SecondModelAddedAndDeleted() {
let sameId = UUID().uuidString

let remoteModels = [
makeRemoteModel(deleted: false, version: 1),
makeRemoteModel(modelId: sameId, deleted: false, version: 1),
makeRemoteModel(modelId: sameId, deleted: true, version: 2)
]

let dispositions = RemoteSyncReconciler.getDispositions(remoteModels, localMetadatas: [])

XCTAssertTrue(dispositions.count == 1)
}

// MARK: - Utilities

Expand Down
Loading