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.

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

Support concurrent formatting of Text #138

Merged
merged 20 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ android.suppressUnsupportedOptionWarnings=android.suppressUnsupportedOptionWarni
kotlin.code.style=official
kotlin.mpp.stability.nowarn=true
GROUP=dev.yorkie
VERSION_NAME=0.4.6
VERSION_NAME=0.4.7
POM_DESCRIPTION=Document store for building collaborative editing applications.
POM_INCEPTION_YEAR=2022
POM_URL=https://github.com/yorkie-team/yorkie-android-sdk
Expand Down
1 change: 1 addition & 0 deletions yorkie/proto/src/main/proto/yorkie/v1/resources.proto
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ message Operation {
TextNodePos to = 3;
map<string, string> attributes = 4;
TimeTicket executed_at = 5;
map<string, TimeTicket> created_at_map_by_actor = 6;
}
message Increase {
TimeTicket parent_created_at = 1;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package dev.yorkie.document.json

import androidx.test.ext.junit.runners.AndroidJUnit4
import dev.yorkie.assertJsonContentEquals
import dev.yorkie.core.withTwoClientsAndDocuments
import org.junit.Test
import org.junit.runner.RunWith

@RunWith(AndroidJUnit4::class)
class JsonTextTest {

@Test
fun test_concurrent_insertion_and_deletion() {
withTwoClientsAndDocuments(realTimeSync = false) { c1, c2, d1, d2, _ ->
d1.updateAsync { root, _ ->
root.setNewText("k1").apply {
edit(0, 0, "AB")
}
}.await()

c1.syncAsync().await()
c2.syncAsync().await()

assertJsonContentEquals("""{"k1":[{"val":"AB"}]}""", d1.toJson())
assertJsonContentEquals(d1.toJson(), d2.toJson())

d1.updateAsync { root, _ ->
root.getAs<JsonText>("k1").edit(0, 2, "")
}.await()
assertJsonContentEquals("""{"k1":[]}""", d1.toJson())

d2.updateAsync { root, _ ->
root.getAs<JsonText>("k1").edit(1, 1, "C")
}.await()
assertJsonContentEquals("""{"k1":[{"val":"A"},{"val":"C"},{"val":"B"}]}""", d2.toJson())

c1.syncAsync().await()
c2.syncAsync().await()
c1.syncAsync().await()

assertJsonContentEquals("""{"k1":[{"val":"C"}]}""", d1.toJson())
assertJsonContentEquals(d1.toJson(), d2.toJson())
}
}
}
7 changes: 7 additions & 0 deletions yorkie/src/main/kotlin/dev/yorkie/api/OperationConverter.kt
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ internal fun List<PBOperation>.toOperations(): List<Operation> {
attributes = it.style.attributesMap,
parentCreatedAt = it.style.parentCreatedAt.toTimeTicket(),
executedAt = it.style.executedAt.toTimeTicket(),
maxCreatedAtMapByActor = it.style.createdAtMapByActorMap.entries
.associate { (actorID, createdAt) ->
ActorID(actorID) to createdAt.toTimeTicket()
},
)

it.hasTreeEdit() -> TreeEditOperation(
Expand Down Expand Up @@ -189,6 +193,9 @@ internal fun Operation.toPBOperation(): PBOperation {
to = operation.toPos.toPBTextNodePos()
executedAt = operation.executedAt.toPBTimeTicket()
operation.attributes.forEach { attributes[it.key] = it.value }
operation.maxCreatedAtMapByActor.forEach {
createdAtMapByActor[it.key.value] = it.value.toPBTimeTicket()
}
}
}
}
Expand Down
30 changes: 25 additions & 5 deletions yorkie/src/main/kotlin/dev/yorkie/document/crdt/CrdtText.kt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ internal data class CrdtText(
executedAt: TimeTicket,
attributes: Map<String, String>? = null,
latestCreatedAtMapByActor: Map<ActorID, TimeTicket>? = null,
): Triple<Map<ActorID, TimeTicket>, List<TextChange>, RgaTreeSplitPosRange> {
): TextOperationResult {
val textValue = if (value.isNotEmpty()) {
TextValue(value).apply {
attributes?.forEach { setAttribute(it.key, it.value, executedAt) }
Expand Down Expand Up @@ -63,7 +63,7 @@ internal data class CrdtText(
if (value.isNotEmpty() && attributes != null) {
changes[changes.lastIndex] = changes.last().copy(attributes = attributes)
}
return Triple(latestCreatedAtMap, changes, caretPos to caretPos)
return TextOperationResult(latestCreatedAtMap, changes, caretPos to caretPos)
}

/**
Expand All @@ -75,14 +75,32 @@ internal data class CrdtText(
range: RgaTreeSplitPosRange,
attributes: Map<String, String>,
executedAt: TimeTicket,
): List<TextChange> {
latestCreatedAtMapByActor: Map<ActorID, TimeTicket>? = null,
): TextOperationResult {
// 1. Split nodes with from and to.
val toRight = rgaTreeSplit.findNodeWithSplit(range.second, executedAt).second
val fromRight = rgaTreeSplit.findNodeWithSplit(range.first, executedAt).second

// 2. Style nodes between from and to.
return rgaTreeSplit.findBetween(fromRight, toRight)
.filterNot { it.isRemoved }
val nodes = rgaTreeSplit.findBetween(fromRight, toRight)
val createdAtMapByActor = mutableMapOf<ActorID, TimeTicket>()
val toBeStyleds = nodes.mapNotNull { node ->
val actorID = node.createdAt.actorID
val latestCreatedAt = if (latestCreatedAtMapByActor?.isNotEmpty() == true) {
latestCreatedAtMapByActor[actorID] ?: TimeTicket.InitialTimeTicket
} else {
TimeTicket.MaxTimeTicket
}

node.takeIf { it.canStyle(executedAt, latestCreatedAt) }?.also {
val updatedLatestCreatedAt = createdAtMapByActor[actorID]
val updatedCreatedAt = node.createdAt
if (updatedLatestCreatedAt == null || updatedLatestCreatedAt < updatedCreatedAt) {
createdAtMapByActor[actorID] = updatedCreatedAt
}
}
}
val changes = toBeStyleds.filterNot { it.isRemoved }
.map { node ->
val (fromIndex, toIndex) = rgaTreeSplit.findIndexesFromRange(node.createPosRange())
attributes.forEach { node.value.setAttribute(it.key, it.value, executedAt) }
Expand All @@ -95,6 +113,8 @@ internal data class CrdtText(
attributes,
)
}

return TextOperationResult(createdAtMapByActor, changes)
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,13 @@ internal data class RgaTreeSplitNode<T : RgaTreeSplitValue<T>>(
return createdAt <= latestCreatedAt && (isRemoved || _removedAt < executedAt)
}

/**
* Checks if node is able to set style.
*/
fun canStyle(executedAt: TimeTicket, latestCreatedAt: TimeTicket): Boolean {
return createdAt <= latestCreatedAt && removedAt < executedAt
}

/**
* Removes this [RgaTreeSplitNode] at the given [executedAt].
*/
Expand Down
6 changes: 6 additions & 0 deletions yorkie/src/main/kotlin/dev/yorkie/document/crdt/TextInfo.kt
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,9 @@ public value class TextWithAttributes(private val value: Pair<String, Map<String
val attributes: Map<String, String>
get() = value.second
}

internal data class TextOperationResult(
val createdAtMapByActor: Map<ActorID, TimeTicket>,
val textChanges: List<TextChange>,
val posRange: RgaTreeSplitPosRange? = null,
)
25 changes: 13 additions & 12 deletions yorkie/src/main/kotlin/dev/yorkie/document/json/JsonText.kt
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public class JsonText internal constructor(
if (range.first != range.second) {
context.registerElementHasRemovedNodes(target)
}
return target.findIndexesFromRange(rangeAfterEdit)
return rangeAfterEdit?.let(target::findIndexesFromRange)
}

/**
Expand All @@ -100,7 +100,18 @@ public class JsonText internal constructor(

val executedAt = context.issueTimeTicket()
runCatching {
target.style(range, attributes, executedAt)
val maxCreatedAtMapByActor =
target.style(range, attributes, executedAt).createdAtMapByActor
context.push(
StyleOperation(
parentCreatedAt = target.createdAt,
fromPos = range.first,
toPos = range.second,
attributes = attributes,
executedAt = executedAt,
maxCreatedAtMapByActor = maxCreatedAtMapByActor,
),
)
}.getOrElse {
when (it) {
is NoSuchElementException, is IllegalArgumentException -> {
Expand All @@ -111,16 +122,6 @@ public class JsonText internal constructor(
else -> throw it
}
}

context.push(
StyleOperation(
parentCreatedAt = target.createdAt,
fromPos = range.first,
toPos = range.second,
attributes = attributes,
executedAt = executedAt,
),
)
return true
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ internal data class EditOperation(
executedAt,
attributes,
maxCreatedAtMapByActor,
).second
).textChanges
if (fromPos != toPos) {
root.registerElementHasRemovedNodes(parentObject)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ import dev.yorkie.document.crdt.CrdtRoot
import dev.yorkie.document.crdt.CrdtText
import dev.yorkie.document.crdt.RgaTreeSplitPos
import dev.yorkie.document.crdt.RgaTreeSplitPosRange
import dev.yorkie.document.time.ActorID
import dev.yorkie.document.time.TimeTicket
import dev.yorkie.util.YorkieLogger

internal data class StyleOperation(
val fromPos: RgaTreeSplitPos,
val toPos: RgaTreeSplitPos,
val maxCreatedAtMapByActor: Map<ActorID, TimeTicket>,
val attributes: Map<String, String>,
override val parentCreatedAt: TimeTicket,
override var executedAt: TimeTicket,
Expand All @@ -21,8 +23,12 @@ internal data class StyleOperation(
override fun execute(root: CrdtRoot): List<OperationInfo> {
val parentObject = root.findByCreatedAt(parentCreatedAt)
return if (parentObject is CrdtText) {
val changes =
parentObject.style(RgaTreeSplitPosRange(fromPos, toPos), attributes, executedAt)
val changes = parentObject.style(
RgaTreeSplitPosRange(fromPos, toPos),
attributes,
executedAt,
maxCreatedAtMapByActor,
).textChanges
changes.map {
OperationInfo.StyleOpInfo(
it.from,
Expand Down
1 change: 1 addition & 0 deletions yorkie/src/test/kotlin/dev/yorkie/api/ConverterTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,7 @@ class ConverterTest {
val styleOperation = StyleOperation(
nodePos,
nodePos,
emptyMap(),
mapOf("style" to "bold"),
InitialTimeTicket,
InitialTimeTicket,
Expand Down
Loading