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

Add Operation Transformation approach #7

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add Operation Transformation approach #7

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
8112369
add OT b4
dmonad Aug 20, 2020
fb361bb
add ot-text-unicode
dmonad Aug 20, 2020
43e5c0a
OT [b4x100]
dmonad Aug 20, 2020
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
116 changes: 115 additions & 1 deletion benchmarks/b1.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@

import * as Y from 'yjs'
import { setBenchmarkResult, gen, N, benchmarkTime, disableAutomergeBenchmarks, disablePeersCrdtsBenchmarks, disableYjsBenchmarks, logMemoryUsed, getMemUsed, deltaDeleteHelper, deltaInsertHelper } from './utils.js'
import { setBenchmarkResult, gen, N, benchmarkTime, disableAutomergeBenchmarks, disableOTBenchmarks, disablePeersCrdtsBenchmarks, disableYjsBenchmarks, logMemoryUsed, getMemUsed, deltaDeleteHelper, deltaInsertHelper } from './utils.js'
import * as prng from 'lib0/prng.js'
import * as math from 'lib0/math.js'
import * as t from 'lib0/testing.js'
import Automerge from 'automerge'
import { insert } from 'ot-text-unicode'
import { OTDoc } from './otHelpers.js'
import DeltaCRDT from 'delta-crdts'
import deltaCodec from 'delta-crdts-msgpack-codec'
const DeltaRGA = DeltaCRDT('rga')
Expand Down Expand Up @@ -50,6 +52,46 @@ const benchmarkYjs = (id, inputData, changeFunction, check) => {
})
}

/**
* Helper function to run a B1 benchmark in Yjs.
*
* @template T
* @param {string} id name of the benchmark e.g. "[B1.1] Description"
* @param {Array<T>} inputData
* @param {function(any, T, number):void} changeFunction Is called on every element in inputData
* @param {function(any, any):void} check Check if the benchmark result is correct (all clients end up with the expected result)
*/
const benchmarkOT = (id, inputData, changeFunction, check) => {
const startHeapUsed = getMemUsed()

if (disableOTBenchmarks) {
setBenchmarkResult('OT', id, 'skipping')
return
}

const doc1 = new OTDoc('left')
const doc2 = new OTDoc('right')
benchmarkTime('OT', `${id} (time)`, () => {
for (let i = 0; i < inputData.length; i++) {
changeFunction(doc1, inputData[i], i)
}
// here we simulate sending each operation seperately to the other client using JSON encoding
doc1.ops.forEach(op => {
doc2.applyOp(JSON.parse(JSON.stringify(op)))
})
})
check(doc1, doc2)
setBenchmarkResult('OT', `${id} (avgUpdateSize)`, `${math.round(doc1.updatesLen() / inputData.length)} bytes`)
const encodedState = JSON.stringify(insert(0, doc1.docContent()))
const documentSize = encodedState.length
setBenchmarkResult('OT', `${id} (docSize)`, `${documentSize} bytes`)
benchmarkTime('OT', `${id} (parseTime)`, () => {
const doc = new OTDoc()
doc.applyOp(JSON.parse(encodedState))
logMemoryUsed('OT', id, startHeapUsed)
})
}

/**
* Helper function to run a B1 benchmark in delta-crdts.
*
Expand Down Expand Up @@ -145,6 +187,15 @@ const benchmarkAutomerge = (id, init, inputData, changeFunction, check) => {
t.assert(doc1.getText('text').toString() === string)
}
)
benchmarkOT(
benchmarkName,
string.split(''),
(doc, s, i) => { doc.insert(i, s) },
(doc1, doc2) => {
t.assert(doc1.docContent() === doc2.docContent())
t.assert(doc1.docContent() === string)
}
)
benchmarkDeltaCrdts(
benchmarkName,
string.split(''),
Expand Down Expand Up @@ -179,6 +230,15 @@ const benchmarkAutomerge = (id, init, inputData, changeFunction, check) => {
t.assert(doc1.getText('text').toString() === string)
}
)
benchmarkOT(
benchmarkName,
[string],
(doc, s, i) => { doc.insert(i, s) },
(doc1, doc2) => {
t.assert(doc1.docContent() === doc2.docContent())
t.assert(doc1.docContent() === string)
}
)
benchmarkDeltaCrdts(
benchmarkName,
[string],
Expand Down Expand Up @@ -213,6 +273,15 @@ const benchmarkAutomerge = (id, init, inputData, changeFunction, check) => {
t.assert(doc1.getText('text').toString() === string)
}
)
benchmarkOT(
benchmarkName,
reversedString.split(''),
(doc, s, i) => { doc.insert(0, s) },
(doc1, doc2) => {
t.assert(doc1.docContent() === doc2.docContent())
t.assert(doc1.docContent() === string)
}
)
benchmarkDeltaCrdts(
benchmarkName,
reversedString.split(''),
Expand Down Expand Up @@ -254,6 +323,15 @@ const benchmarkAutomerge = (id, init, inputData, changeFunction, check) => {
t.assert(doc1.getText('text').toString() === string)
}
)
benchmarkOT(
benchmarkName,
input,
(doc, op, i) => { doc.insert(op.index, op.insert) },
(doc1, doc2) => {
t.assert(doc1.docContent() === doc2.docContent())
t.assert(doc1.docContent() === string)
}
)
benchmarkDeltaCrdts(
benchmarkName,
input,
Expand Down Expand Up @@ -297,6 +375,15 @@ const benchmarkAutomerge = (id, init, inputData, changeFunction, check) => {
t.assert(doc1.getText('text').toString() === string)
}
)
benchmarkOT(
benchmarkName,
input,
(doc, op, i) => { doc.insert(op.index, op.insert) },
(doc1, doc2) => {
t.assert(doc1.docContent() === doc2.docContent())
t.assert(doc1.docContent() === string)
}
)
benchmarkDeltaCrdts(
benchmarkName,
input,
Expand Down Expand Up @@ -334,6 +421,18 @@ const benchmarkAutomerge = (id, init, inputData, changeFunction, check) => {
t.assert(doc1.getText('text').toString() === '')
}
)
benchmarkOT(
benchmarkName,
[string],
(doc, s, i) => {
doc.insert(i, s)
doc.delete(i, s.length)
},
(doc1, doc2) => {
t.assert(doc1.docContent() === doc2.docContent())
t.assert(doc1.docContent() === '')
}
)
benchmarkDeltaCrdts(
benchmarkName,
[string],
Expand Down Expand Up @@ -390,6 +489,21 @@ const benchmarkAutomerge = (id, init, inputData, changeFunction, check) => {
t.assert(doc1.getText('text').toString() === string)
}
)
benchmarkOT(
benchmarkName,
input,
(doc, op, i) => {
if (op.insert !== undefined) {
doc.insert(op.index, op.insert)
} else {
doc.delete(op.index, op.deleteCount)
}
},
(doc1, doc2) => {
t.assert(doc1.docContent() === doc2.docContent())
t.assert(doc1.docContent() === string)
}
)
benchmarkDeltaCrdts(
benchmarkName,
input,
Expand Down
108 changes: 107 additions & 1 deletion benchmarks/b2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@

import * as Y from 'yjs'
import { setBenchmarkResult, gen, N, benchmarkTime, cpy, disableAutomergeBenchmarks, disableYjsBenchmarks, disablePeersCrdtsBenchmarks, logMemoryUsed, getMemUsed, deltaInsertHelper, deltaDeleteHelper } from './utils.js'
import { setBenchmarkResult, gen, N, benchmarkTime, cpy, disableAutomergeBenchmarks, disableYjsBenchmarks, disableOTBenchmarks, disablePeersCrdtsBenchmarks, logMemoryUsed, getMemUsed, deltaInsertHelper, deltaDeleteHelper } from './utils.js'
import * as prng from 'lib0/prng.js'
import * as math from 'lib0/math.js'
import * as t from 'lib0/testing.js'
import Automerge from 'automerge'
import { insert } from 'ot-text-unicode'
import { OTDoc } from './otHelpers.js'
import DeltaCRDT from 'delta-crdts'
import deltaCodec from 'delta-crdts-msgpack-codec'
const DeltaRGA = DeltaCRDT('rga')
Expand Down Expand Up @@ -63,6 +65,50 @@ const benchmarkYjs = (id, changeDoc1, changeDoc2, check) => {
})
}

const benchmarkOT = (id, changeDoc1, changeDoc2, check) => {
const startHeapUsed = getMemUsed()

if (disableOTBenchmarks) {
setBenchmarkResult('OT', id, 'skipping')
return
}

const doc1 = new OTDoc('left')
const doc2 = new OTDoc('right')
/**
* @type {any}
*/
let update1To2
/**
* @type {any}
*/
let update2To1
doc1.setInitialContent(initText)
doc2.setInitialContent(initText)
benchmarkTime('OT', `${id} (time)`, () => {
changeDoc1(doc1)
changeDoc2(doc2)
// concat history so that merges are faster
// @todo errors are thrown in [B2.3]
// doc1.mergeHistory()
// doc2.mergeHistory()
update1To2 = JSON.stringify(doc1.ops)
update2To1 = JSON.stringify(doc2.ops)
doc1.transformOpsAndApply(JSON.parse(update2To1))
doc2.transformOpsAndApply(JSON.parse(update1To2))
})
check(doc1, doc2)
setBenchmarkResult('OT', `${id} (updateSize)`, `${math.round(update1To2.length + update2To1.length)} bytes`)
const encodedState = JSON.stringify(insert(0, doc1.docContent()))
const documentSize = encodedState.length
setBenchmarkResult('OT', `${id} (docSize)`, `${documentSize} bytes`)
benchmarkTime('OT', `${id} (parseTime)`, () => {
const doc = new OTDoc()
doc.applyOp(JSON.parse(encodedState))
logMemoryUsed('OT', id, startHeapUsed)
})
}

const benchmarkDeltaCrdts = (id, changeDoc1, changeDoc2, check) => {
const startHeapUsed = getMemUsed()

Expand Down Expand Up @@ -157,6 +203,16 @@ const benchmarkAutomerge = (id, changeDoc1, changeDoc2, check) => {
t.assert(doc1.getText('text').toString().length === N * 2 + 100)
}
)
benchmarkOT(
benchmarkName,
doc1 => { doc1.insert(0, string1) },
doc2 => { doc2.insert(0, string2) },
(doc1, doc2) => {
// t.assert(doc1.docContent() === doc2.docContent()) // @TODO fix OT
t.assert(doc1.docContent().length === N * 2 + 100)
t.assert(doc2.docContent().length === N * 2 + 100)
}
)
benchmarkDeltaCrdts(
benchmarkName,
doc1 => deltaInsertHelper(doc1, 0, string1),
Expand Down Expand Up @@ -207,6 +263,20 @@ const benchmarkAutomerge = (id, changeDoc1, changeDoc2, check) => {
t.assert(doc1.getText('text').toString().length === N * 2 + 100)
}
)
benchmarkOT(
benchmarkName,
doc1 => {
input1.forEach(({ index, insert }) => { doc1.insert(index, insert) })
},
doc2 => {
input2.forEach(({ index, insert }) => { doc2.insert(index, insert) })
},
(doc1, doc2) => {
// t.assert(doc1.docContent() === doc2.docContent()) @todo
t.assert(doc1.docContent().length === N * 2 + 100)
t.assert(doc2.docContent().length === N * 2 + 100)
}
)
benchmarkDeltaCrdts(
benchmarkName,
doc1 => input1.map(({ index, insert }) => deltaInsertHelper(doc1, index, insert)).flat(1),
Expand Down Expand Up @@ -260,6 +330,18 @@ const benchmarkAutomerge = (id, changeDoc1, changeDoc2, check) => {
t.assert(doc1.getText('text').toString() === doc2.getText('text').toString())
}
)
benchmarkOT(
benchmarkName,
doc1 => {
input1.forEach(({ index, insert }) => { doc1.insert(index, insert) })
},
doc2 => {
input2.forEach(({ index, insert }) => { doc2.insert(index, insert) })
},
(doc1, doc2) => {
// t.assert(doc1.docContent() === doc2.docContent()) @todo
}
)
benchmarkDeltaCrdts(
benchmarkName,
doc1 => input1.map(({ index, insert }) => deltaInsertHelper(doc1, index, insert)).flat(1),
Expand Down Expand Up @@ -332,6 +414,30 @@ const benchmarkAutomerge = (id, changeDoc1, changeDoc2, check) => {
t.assert(doc1.getText('text').toString() === doc2.getText('text').toString())
}
)
benchmarkOT(
benchmarkName,
doc1 => {
input1.forEach(({ index, insert, deleteCount }) => {
if (insert !== undefined) {
doc1.insert(index, insert)
} else {
doc1.delete(index, deleteCount)
}
})
},
doc2 => {
input2.forEach(({ index, insert, deleteCount }) => {
if (insert !== undefined) {
doc2.insert(index, insert)
} else {
doc2.delete(index, deleteCount)
}
})
},
(doc1, doc2) => {
// t.assert(doc1.docContent() === doc2.docContent()) @todo
}
)
benchmarkDeltaCrdts(
benchmarkName,
doc1 => input1.map(({ index, insert, deleteCount }) => {
Expand Down
Loading