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 miscalculation of tree size in concurrent editing #183

Merged
merged 7 commits into from
Jun 12, 2024
Merged

Fix miscalculation of tree size in concurrent editing #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
be72465
Fix incorrect indexes in TreeChange
humdrum Jun 11, 2024
bbf2058
Update swift-integration.yml
humdrum Jun 11, 2024
75aad2e
Update swift-integration.yml
humdrum Jun 11, 2024
bcbb1b2
Update swift-integration.yml
humdrum Jun 11, 2024
969e8a9
Add RHTNode removal to converter for consistency
humdrum Jun 11, 2024
aeff425
Fix miscalculation of tree size in concurrent editing
humdrum Jun 11, 2024
d1cd951
Merge branch 'main' into tree-size
humdrum Jun 12, 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
6 changes: 1 addition & 5 deletions Sources/Document/CRDT/CRDTTree.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,11 +351,7 @@ final class CRDTTreeNode: IndexTreeNode {
}

if alived {
if self.parent?.removedAt == nil {
self.updateAncestorsSize()
} else {
self.parent?.size -= self.paddedSize
}
self.updateAncestorsSize()
}
}

Expand Down
19 changes: 11 additions & 8 deletions Sources/Util/IndexTree.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,9 @@ extension IndexTreeNode {

while parent != nil {
parent?.size += self.paddedSize * sign
if parent!.isRemoved {
break
}
parent = parent?.parent
}
}
Expand All @@ -155,17 +158,17 @@ extension IndexTreeNode {
*/
@discardableResult
func updateDescendantsSize() -> Int {
if self.isRemoved {
self.size = 0
return 0
}

var sum = 0
var size = 0
for child in self.children {
sum += child.updateDescendantsSize()
let childSize = child.updateDescendantsSize()
if child.isRemoved {
continue
}

size += childSize
}

self.size += sum
self.size += size

return self.paddedSize
}
Expand Down
137 changes: 137 additions & 0 deletions Tests/Integration/TreeIntegrationTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3248,6 +3248,143 @@ final class TreeIntegrationEdgeCases: XCTestCase {
}
}

func test_can_calculate_size_of_index_tree_correctly_during_concurrent_editing() async throws {
try await withTwoClientsAndDocuments(self.description) { c1, d1, c2, d2 in
try await d1.update { root, _ in
root.t = JSONTree(initialRoot:
JSONTreeElementNode(type: "doc",
children: [
JSONTreeElementNode(type: "p", children: [
JSONTreeTextNode(value: "hello")
])
])
)
}

try await c1.sync()
try await c2.sync()

var d1XML = await(d1.getRoot().t as? JSONTree)?.toXML()
var d2XML = await(d2.getRoot().t as? JSONTree)?.toXML()
XCTAssertEqual(d1XML, /* html */ "<doc><p>hello</p></doc>")
XCTAssertEqual(d2XML, /* html */ "<doc><p>hello</p></doc>")

try await d1.update { root, _ in
try (root.t as? JSONTree)?.edit(0, 7)
}

try await d2.update { root, _ in
try (root.t as? JSONTree)?.edit(1, 2, JSONTreeTextNode(value: "p"))
}

d1XML = await(d1.getRoot().t as? JSONTree)?.toXML()
XCTAssertEqual(d1XML, /* html */ "<doc></doc>")

var sized1 = try await(d1.getRoot().t as? JSONTree)?.getSize()
XCTAssertEqual(0, sized1)

d2XML = await(d2.getRoot().t as? JSONTree)?.toXML()
XCTAssertEqual(d2XML, /* html */ "<doc><p>pello</p></doc>")

var sized2 = try await(d2.getRoot().t as? JSONTree)?.getSize()
XCTAssertEqual(7, sized2)

try await c1.sync()
try await c2.sync()
try await c1.sync()

d1XML = await(d1.getRoot().t as? JSONTree)?.toXML()
d2XML = await(d2.getRoot().t as? JSONTree)?.toXML()
XCTAssertEqual(d1XML, /* html */ "<doc></doc>")
XCTAssertEqual(d2XML, /* html */ "<doc></doc>")

sized1 = try await(d1.getRoot().t as? JSONTree)?.getSize()
sized2 = try await(d2.getRoot().t as? JSONTree)?.getSize()
XCTAssertEqual(sized1, sized2)
}
}

func test_can_keep_index_tree_consistent_from_snapshot() async throws {
try await withTwoClientsAndDocuments(self.description) { c1, d1, c2, d2 in
try await d1.update { root, _ in
root.t = JSONTree(initialRoot:
JSONTreeElementNode(type: "r",
children: [
JSONTreeElementNode(type: "p", children: [])
])
)
}

try await c1.sync()
try await c2.sync()

var d1XML = await(d1.getRoot().t as? JSONTree)?.toXML()
var d2XML = await(d2.getRoot().t as? JSONTree)?.toXML()
XCTAssertEqual(d1XML, /* html */ "<r><p></p></r>")
XCTAssertEqual(d2XML, /* html */ "<r><p></p></r>")

try await d1.update { root, _ in
try (root.t as? JSONTree)?.edit(0, 2)
}

try await d2.update { root, _ in
try (root.t as? JSONTree)?.edit(1, 1, JSONTreeElementNode(type: "i", children: [JSONTreeTextNode(value: "a")]))
try (root.t as? JSONTree)?.edit(2, 3, JSONTreeTextNode(value: "b"))
}

d1XML = await(d1.getRoot().t as? JSONTree)?.toXML()
XCTAssertEqual(d1XML, /* html */ "<r></r>")
let sized1 = try await(d1.getRoot().t as? JSONTree)?.getSize()
XCTAssertEqual(0, sized1)
d2XML = await(d2.getRoot().t as? JSONTree)?.toXML()
XCTAssertEqual(d2XML, /* html */ "<r><p><i>b</i></p></r>")
let sized2 = try await(d2.getRoot().t as? JSONTree)?.getSize()
XCTAssertEqual(5, sized2)

try await c1.sync()
try await c2.sync()
try await c1.sync()

d1XML = await(d1.getRoot().t as? JSONTree)?.toXML()
XCTAssertEqual(d1XML, /* html */ "<r></r>")
d2XML = await(d2.getRoot().t as? JSONTree)?.toXML()
XCTAssertEqual(d1XML, /* html */ "<r></r>")

var d1Nodes = [(String, Int, Bool)]()
var d2Nodes = [(String, Int, Bool)]()
var sNodes = [(String, Int, Bool)]()

try await(d1.getRoot().t as? JSONTree)?.getIndexTree().traverseAll { node, _ in
d1Nodes.append((node.toJSONString, node.size, node.isRemoved))
}
try await(d2.getRoot().t as? JSONTree)?.getIndexTree().traverseAll { node, _ in
d2Nodes.append((node.toJSONString, node.size, node.isRemoved))
}

let sRoot = try await Converter.bytesToObject(bytes: Converter.objectToBytes(obj: d1.getRootObject()))

(sRoot.get(key: "t") as? CRDTTree)?.indexTree.traverseAll { node, _ in
sNodes.append((node.toJSONString, node.size, node.isRemoved))
}

XCTAssertEqual(d1Nodes.count, d2Nodes.count)

for index in 0 ..< d1Nodes.count {
XCTAssertEqual(d1Nodes[index].0, d2Nodes[index].0)
XCTAssertEqual(d1Nodes[index].1, d2Nodes[index].1)
XCTAssertEqual(d1Nodes[index].2, d2Nodes[index].2)
}

XCTAssertEqual(d1Nodes.count, sNodes.count)

for index in 0 ..< d1Nodes.count {
XCTAssertEqual(d1Nodes[index].0, sNodes[index].0)
XCTAssertEqual(d1Nodes[index].1, sNodes[index].1)
XCTAssertEqual(d1Nodes[index].2, sNodes[index].2)
}
}
}

func test_can_split_and_merge_with_empty_paragraph_left() async throws {
try await withTwoClientsAndDocuments(self.description) { c1, d1, c2, d2 in
try await d1.update { root, _ in
Expand Down