yonote/yjs
24
0
Fork 0
Code Pull Requests 1 Releases Activity

simplified model for weak links

Browse Source
This commit is contained in:
Bartosz Sypytkowski 2023-06-02 20:02:28 +02:00
parent 93a65faf0a
commit 7c3af93fa9
5 changed files with 65 additions and 164 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

144
src/structs/ContentLink.js
View File

@ -15,12 +15,14 @@ import {
export class ContentLink { export class ContentLink {
/** /**
* @param {WeakLink<any>|null} link * @param {WeakLink<any>} link
* @param {{type:ID|null,tname:string|null,item:ID|null,key:string|null}|null} raw
*/ */
constructor (link, raw) { constructor (link) {
this.link = link this.link = link
this.raw = raw /**
* @type {Item|null}
*/
this._item = null
} }
/** /**
@ -48,7 +50,7 @@ import {
* @return {ContentLink} * @return {ContentLink}
*/ */
copy () { copy () {
return new ContentLink(this.link, this.raw) return new ContentLink(this.link)
} }
/** /**
@ -72,40 +74,24 @@ import {
* @param {Item} item * @param {Item} item
*/ */
integrate (transaction, item) { integrate (transaction, item) {
if (this.raw !== null) { let sourceItem = this.link.item !== null ? this.link.item : getItemCleanStart(transaction, this.link.id)
const { type, tname, key, item } = this.raw if (sourceItem.constructor === Item && sourceItem.parentSub !== null) {
let parent = null // for maps, advance to most recent item
if (type !== null) { while (sourceItem.right !== null) {
const parentItem = find(transaction.doc.store, type) sourceItem = sourceItem.right
if (parentItem.constructor === Item) {
parent = /** @type {ContentType} */ (parentItem.content).type
} else {
parent = null
}
} else {
parent = /** @type {AbstractType<any>} */ (transaction.doc.share.get(/** @type {string} */ (tname)))
} }
let target = null
if (item !== null) {
target = getItemCleanStart(transaction, item)
if (target.length > 1) {
target = getItemCleanEnd(transaction, transaction.doc.store, createID(target.id.client, target.id.clock + 1))
}
} else if (parent !== null) {
target = parent._map.get(/** @type {string} */ (key)) || null
}
const source = (parent !== null && target !== null) ? {parent: parent, item: target, key: key} : null
this.link = new WeakLink(source)
this.raw = null
} }
if (!sourceItem.deleted && sourceItem.length > 1) {
const linked = /** @type {WeakLink<any>} */ (this.link).linkedItem() sourceItem = getItemCleanEnd(transaction, transaction.doc.store, createID(sourceItem.id.client, sourceItem.id.clock + 1))
if (linked !== undefined && linked.constructor === Item) { }
if (linked.linkedBy === null) { this.link.item = sourceItem
linked.linkedBy = new Set() this._item = item
if (!sourceItem.deleted) {
const src = /** @type {Item} */ (sourceItem)
if (src.linkedBy === null) {
src.linkedBy = new Set()
} }
linked.linkedBy.add(/** @type {WeakLink<any>} */ (this.link)) src.linkedBy.add(item)
} }
} }
@ -113,14 +99,12 @@ import {
* @param {Transaction} transaction * @param {Transaction} transaction
*/ */
delete (transaction) { delete (transaction) {
if (this.link !== null && this.link.source !== null) { if (this._item !== null && this.link !== null && this.link.item !== null && !this.link.item.deleted) {
const item = this.link.source.item const item = /** @type {Item} */ (this.link.item)
if (item !== null && item.constructor === Item) { if (item.linkedBy !== null) {
if (item.linkedBy !== null) { item.linkedBy.delete(this._item)
item.linkedBy.delete(this.link)
}
} }
this.link.source = null this.link.item = null
} }
} }
@ -134,49 +118,9 @@ import {
* @param {number} offset * @param {number} offset
*/ */
write (encoder, offset) { write (encoder, offset) {
let type = null const flags = 0 // flags that could be used in the future
let tname = null encoding.writeUint8(encoder.restEncoder, flags)
let item = null encoder.writeLeftID(this.link.id)
let key = null
let flags = 0
if (this.raw !== null) {
type = this.raw.type
tname = this.raw.tname
key = this.raw.key
item = this.raw.item
} else {
const source = /** @type {WeakLink<any>} */ (this.link).source
if (source !== null) {
if (source.parent._item !== null) {
type = source.parent._item.id
} else {
tname = findRootTypeKey(source.parent)
}
if (source.item !== null) {
item = source.item.id
} else {
key = source.key
}
}
}
if (type !== null) {
flags |= 1
}
if (item !== null) {
flags |= 2
}
encoding.writeVarUint(encoder.restEncoder, flags)
if (type !== null) {
encoder.writeLeftID(type)
} else {
encoder.writeString(/** @type {string} */ (tname))
}
if (item !== null) {
encoder.writeLeftID(item)
} else {
encoder.writeString(/** @type {string} */ (key))
}
} }
/** /**
@ -192,22 +136,9 @@ import {
* @return {ContentLink} * @return {ContentLink}
*/ */
export const readContentWeakLink = decoder => { export const readContentWeakLink = decoder => {
const flags = decoding.readVarUint(decoder.restDecoder) const flags = decoding.readUint8(decoder.restDecoder)
let type = null const id = decoder.readLeftID()
let tname = null return new ContentLink(new WeakLink(id, null))
let item = null
let key = null
if ((flags & 1) !== 0) {
type = decoder.readLeftID()
} else {
tname = decoder.readString()
}
if ((flags & 2) !== 0) {
item = decoder.readLeftID()
} else {
key = decoder.readString()
}
return new ContentLink(null, { type, tname, item, key })
} }
const lengthExceeded = error.create('Length exceeded!') const lengthExceeded = error.create('Length exceeded!')
@ -221,12 +152,7 @@ const lengthExceeded = error.create('Length exceeded!')
* @return {WeakLink<any>} * @return {WeakLink<any>}
*/ */
export const arrayWeakLink = (transaction, parent, index) => { export const arrayWeakLink = (transaction, parent, index) => {
const marker = findMarker(parent, index)
let item = parent._start let item = parent._start
if (marker !== null) {
item = marker.p
index -= marker.index
}
for (; item !== null; item = item.right) { for (; item !== null; item = item.right) {
if (!item.deleted && item.countable) { if (!item.deleted && item.countable) {
if (index < item.length) { if (index < item.length) {
@ -236,7 +162,7 @@ export const arrayWeakLink = (transaction, parent, index) => {
if (item.length > 1) { if (item.length > 1) {
item = getItemCleanEnd(transaction, transaction.doc.store, createID(item.id.client, item.id.clock + 1)) item = getItemCleanEnd(transaction, transaction.doc.store, createID(item.id.client, item.id.clock + 1))
} }
return new WeakLink({parent, item, key: null}) return new WeakLink(item.id, item)
} }
index -= item.length index -= item.length
} }
@ -255,7 +181,7 @@ export const arrayWeakLink = (transaction, parent, index) => {
export const mapWeakLink = (parent, key) => { export const mapWeakLink = (parent, key) => {
const item = parent._map.get(key) const item = parent._map.get(key)
if (item !== undefined) { if (item !== undefined) {
return new WeakLink({parent, item, key}) return new WeakLink(item.id, item)
} else { } else {
return undefined return undefined
} }

16
src/structs/Item.js
View File

@ -302,7 +302,7 @@ export class Item extends AbstractStruct {
* If this item was referenced by other weak links, here we keep the references * If this item was referenced by other weak links, here we keep the references
* to these weak refs. * to these weak refs.
* *
* @type {Set<WeakLink<any>> | null} * @type {Set<Item> | null}
*/ */
this.linkedBy = null this.linkedBy = null
/** /**
@ -388,13 +388,8 @@ export class Item extends AbstractStruct {
} }
if (this.content.constructor === ContentLink) { if (this.content.constructor === ContentLink) {
const content = /** @type {ContentLink} */ (this.content) const content = /** @type {ContentLink} */ (this.content)
if (content.raw !== null) { if (content.link.id.client !== this.id.client) {
const { type, item } = content.raw return content.link.id.client
if (type !== null && type.client !== this.id.client) {
return type.client
} else if (item !== null && item.client !== this.id.client) {
return item.client
}
} }
} }
@ -543,6 +538,11 @@ export class Item extends AbstractStruct {
this.content.integrate(transaction, this) this.content.integrate(transaction, this)
// add parent to transaction.changed // add parent to transaction.changed
addChangedTypeToTransaction(transaction, /** @type {AbstractType<any>} */ (this.parent), this.parentSub) addChangedTypeToTransaction(transaction, /** @type {AbstractType<any>} */ (this.parent), this.parentSub)
if (this.linkedBy !== null) {
for (let link of this.linkedBy) {
addChangedTypeToTransaction(transaction, /** @type {AbstractType<any>} */ (link.parent), this.parentSub)
}
}
if ((/** @type {AbstractType<any>} */ (this.parent)._item !== null && /** @type {AbstractType<any>} */ (this.parent)._item.deleted) || (this.parentSub !== null && this.right !== null)) { if ((/** @type {AbstractType<any>} */ (this.parent)._item !== null && /** @type {AbstractType<any>} */ (this.parent)._item.deleted) || (this.parentSub !== null && this.right !== null)) {
// delete if parent is deleted or if this is not the current attribute value of parent // delete if parent is deleted or if this is not the current attribute value of parent
this.delete(transaction) this.delete(transaction)

4
src/types/AbstractType.js
View File

@ -670,7 +670,7 @@ export const typeListInsertGenericsAfter = (transaction, parent, referenceItem,
left.integrate(transaction, 0) left.integrate(transaction, 0)
break break
case WeakLink: case WeakLink:
left = new Item(createID(ownClientId, getState(store, ownClientId)), left, left && left.lastId, right, right && right.id, parent, null, new ContentLink(/** @type {WeakLink<any>} */ (c), null)) left = new Item(createID(ownClientId, getState(store, ownClientId)), left, left && left.lastId, right, right && right.id, parent, null, new ContentLink(/** @type {WeakLink<any>} */ (c)))
left.integrate(transaction, 0) left.integrate(transaction, 0)
break break
default: default:
@ -856,7 +856,7 @@ export const typeMapSet = (transaction, parent, key, value) => {
content = new ContentDoc(/** @type {Doc} */ (value)) content = new ContentDoc(/** @type {Doc} */ (value))
break break
case WeakLink: case WeakLink:
content = new ContentLink(/** @type {WeakLink<any>} */ (value), null) content = new ContentLink(/** @type {WeakLink<any>} */ (value))
break; break;
default: default:
if (value instanceof AbstractType) { if (value instanceof AbstractType) {

53
src/types/WeakLink.js
View File

@ -1,5 +1,4 @@
import { AbstractType, GC, Item, createID } from "yjs" import { AbstractType, GC, ID, Item } from "yjs"
import { typeMapGet } from "./AbstractType.js"
/** /**
* @template T * @template T
@ -8,10 +7,12 @@ import { typeMapGet } from "./AbstractType.js"
*/ */
export class WeakLink { export class WeakLink {
/** /**
* @param {{parent:AbstractType<any>,item:Item|GC|null,key:string|null}|null} source * @param {ID} id
* @param {Item|GC|null} item
*/ */
constructor(source) { constructor(id, item) {
this.source = source this.id = id
this.item = item
} }
/** /**
@ -20,37 +21,19 @@ export class WeakLink {
* @return {T|undefined} * @return {T|undefined}
*/ */
deref() { deref() {
const item = this.linkedItem() if (this.item !== null && this.item.constructor === Item) {
if (item !== undefined && !item.deleted) { let item = this.item
return /** @type {Item} */ (item).content.getContent()[0] if (item.parentSub !== null) {
} else { // for map types go to the most recent one
return undefined while (item.right !== null) {
} item = item.right
} }
this.item = item
/** }
* Returns currently linked item to an underlying value existing somewhere on in the document. if (!item.deleted) {
* return item.content.getContent()[0]
* @return {Item|GC|undefined}
*/
linkedItem() {
if (this.source !== null) {
const source = this.source
if (source.key !== null) {
return source.parent._map.get(source.key)
} else if (source.item !== null && !source.item.deleted) {
return source.item
} }
} }
return undefined return undefined;
}
/**
* Checks if a linked content source has been deleted.
*
* @return {boolean}
*/
get deleted() {
return this.source === null || this.source.item === null || this.source.item.deleted
} }
} }

12
tests/weakLinks.tests.js
View File

@ -5,7 +5,7 @@ import { init, compare } from './testHelper.js'
/** /**
* @param {t.TestCase} tc * @param {t.TestCase} tc
*/ */
export const testBasicMap = tc => { const testBasicMap = tc => {
const doc = new Y.Doc() const doc = new Y.Doc()
const map = doc.getMap('map') const map = doc.getMap('map')
@ -24,7 +24,7 @@ export const testBasicMap = tc => {
/** /**
* @param {t.TestCase} tc * @param {t.TestCase} tc
*/ */
export const testBasicArray = tc => { const testBasicArray = tc => {
const { testConnector, array0, array1 } = init(tc, {users:2}) const { testConnector, array0, array1 } = init(tc, {users:2})
array0.insert(0, [1,2,3]) array0.insert(0, [1,2,3])
array0.insert(3, [array0.link(1)]) array0.insert(3, [array0.link(1)])
@ -81,16 +81,12 @@ export const testDeleteWeakLink = tc => {
const l1 = /** @type {Y.Map<any>} */ (link1.deref()) const l1 = /** @type {Y.Map<any>} */ (link1.deref())
const l0 = /** @type {Y.Map<any>} */ (link0.deref()) const l0 = /** @type {Y.Map<any>} */ (link0.deref())
t.compare(l1.get('a1'), l0.get('a1')) t.compare(l1.get('a1'), l0.get('a1'))
t.compare(link0.deleted, false)
t.compare(link1.deleted, false)
map1.delete('b') // delete links map1.delete('b') // delete links
testConnector.flushAllMessages() testConnector.flushAllMessages()
// since links have been deleted, they no longer refer to any content // since links have been deleted, they no longer refer to any content
t.compare(link0.deleted, true)
t.compare(link1.deleted, true)
t.compare(link0.deref(), undefined) t.compare(link0.deref(), undefined)
t.compare(link1.deref(), undefined) t.compare(link1.deref(), undefined)
} }
@ -108,8 +104,6 @@ export const testDeleteSource = tc => {
const link1 = /** @type {Y.WeakLink<Y.Map<any>>} */ (map1.get('b')) const link1 = /** @type {Y.WeakLink<Y.Map<any>>} */ (map1.get('b'))
let l1 = /** @type {Y.Map<any>} */ (link1.deref()) let l1 = /** @type {Y.Map<any>} */ (link1.deref())
let l0 = /** @type {Y.Map<any>} */ (link0.deref()) let l0 = /** @type {Y.Map<any>} */ (link0.deref())
t.compare(link0.deleted, false)
t.compare(link1.deleted, false)
t.compare(l1.get('a1'), l0.get('a1')) t.compare(l1.get('a1'), l0.get('a1'))
map1.delete('a') // delete source of the link map1.delete('a') // delete source of the link
@ -117,8 +111,6 @@ export const testDeleteSource = tc => {
testConnector.flushAllMessages() testConnector.flushAllMessages()
// since source have been deleted, links no longer refer to any content // since source have been deleted, links no longer refer to any content
t.compare(link0.deleted, true)
t.compare(link1.deleted, true)
t.compare(link0.deref(), undefined) t.compare(link0.deref(), undefined)
t.compare(link1.deref(), undefined) t.compare(link1.deref(), undefined)
} }