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 incorrect calculation in indexTree.treePosToPath operation #751

Merged
merged 5 commits into from
Feb 21, 2024
Merged

Fix incorrect calculation in indexTree.treePosToPath operation #751

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8973169
Handle cases with text children only in `treePosToPath`
raararaara Feb 20, 2024
79ee99e
Fix test code
raararaara Feb 20, 2024
3a543ee
Lint
raararaara Feb 20, 2024
b11609b
Update test/integration/tree_test.ts
hackerwins Feb 21, 2024
a600dda
Update src/util/index_tree.ts
hackerwins Feb 21, 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
14 changes: 11 additions & 3 deletions src/util/index_tree.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,10 +252,12 @@ export abstract class IndexTreeNode<T extends IndexTreeNode<T>> {
}

/**
* `hasTextChild` returns true if the node has an text child.
* `hasTextChild` returns true if the node's children consist of only text children.
*/
hasTextChild(): boolean {
return this.children.some((child) => child.isText);
return (
this.children.length > 0 && this.children.every((child) => child.isText)
);
}

/**
Expand Down Expand Up @@ -804,8 +806,14 @@ export class IndexTree<T extends IndexTreeNode<T>> {
node.parent! as T,
offset,
);
node = node.parent!;
path.push(sizeOfLeftSiblings + treePos.offset);
node = node.parent!;
} else if (node.hasTextChild()) {
const sizeOfLeftSiblings = addSizeOfLeftSiblings(
hackerwins marked this conversation as resolved.
Show resolved Hide resolved
hackerwins marked this conversation as resolved.
Show resolved Hide resolved
node! as T,
treePos.offset,
);
path.push(sizeOfLeftSiblings);
} else {
path.push(treePos.offset);
}
Expand Down
148 changes: 148 additions & 0 deletions test/integration/tree_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1333,6 +1333,154 @@ describe('Tree.style', function () {
);
});
});

it('Should return correct range path within doc.subscribe', async function ({
task,
}) {
await withTwoClientsAndDocuments<{ t: Tree }>(async (c1, d1, c2, d2) => {
d1.update((root) => {
root.t = new Tree({
type: 'r',
children: [
{
type: 'c',
children: [
{
type: 'u',
children: [
{
type: 'p',
children: [
{
type: 'n',
children: [],
},
],
},
],
},
],
},
{
type: 'c',
children: [
{
type: 'p',
children: [
{
type: 'n',
children: [],
},
],
},
],
},
],
});
});
await c1.sync();
await c2.sync();
assert.equal(
d1.getRoot().t.toXML(),
/*html*/ `<r><c><u><p><n></n></p></u></c><c><p><n></n></p></c></r>`,
);
assert.equal(
d2.getRoot().t.toXML(),
/*html*/ `<r><c><u><p><n></n></p></u></c><c><p><n></n></p></c></r>`,
);

d2.update((r) =>
r.t.editByPath([1, 0, 0, 0], [1, 0, 0, 0], {
type: 'text',
value: '1',
}),
);
d2.update((r) =>
r.t.editByPath([1, 0, 0, 1], [1, 0, 0, 1], {
type: 'text',
value: '2',
}),
);
d2.update((r) =>
r.t.editByPath([1, 0, 0, 2], [1, 0, 0, 2], {
type: 'text',
value: '3',
}),
);
await c2.sync();
await c1.sync();
assert.equal(
d1.getRoot().t.toXML(),
/*html*/ `<r><c><u><p><n></n></p></u></c><c><p><n>123</n></p></c></r>`,
);
assert.equal(
d2.getRoot().t.toXML(),
/*html*/ `<r><c><u><p><n></n></p></u></c><c><p><n>123</n></p></c></r>`,
);

d1.update((r) =>
r.t.editByPath([1, 0, 0, 1], [1, 0, 0, 1], {
type: 'text',
value: 'abcdefgh',
}),
);
await c1.sync();
await c2.sync();
assert.equal(
d1.getRoot().t.toXML(),
/*html*/ `<r><c><u><p><n></n></p></u></c><c><p><n>1abcdefgh23</n></p></c></r>`,
);
assert.equal(
d2.getRoot().t.toXML(),
/*html*/ `<r><c><u><p><n></n></p></u></c><c><p><n>1abcdefgh23</n></p></c></r>`,
);

d2.update((r) =>
r.t.editByPath([1, 0, 0, 5], [1, 0, 0, 5], {
type: 'text',
value: '4',
}),
);
d2.update((r) => r.t.editByPath([1, 0, 0, 6], [1, 0, 0, 7]));
d2.update((r) =>
r.t.editByPath([1, 0, 0, 6], [1, 0, 0, 6], {
type: 'text',
value: '5',
}),
);
await c2.sync();
await c1.sync();

const eventCollector = new EventCollector<{ type: DocEventType }>();
const unsub = d2.subscribe((event) => {
if (event.type === 'local-change' || event.type === 'remote-change') {
const operation = event.value.operations[0] as TreeEditOpInfo;
const { fromPath, toPath } = operation;
assert.deepEqual(fromPath, [1, 0, 0, 7]);
assert.deepEqual(toPath, [1, 0, 0, 8]);
eventCollector.add({ type: event.type });
}
});

d2.update((r) => r.t.editByPath([1, 0, 0, 7], [1, 0, 0, 8]));

await c2.sync();
await c1.sync();
assert.equal(
d1.getRoot().t.toXML(),
/*html*/ `<r><c><u><p><n></n></p></u></c><c><p><n>1abcd45gh23</n></p></c></r>`,
);
assert.equal(
d2.getRoot().t.toXML(),
/*html*/ `<r><c><u><p><n></n></p></u></c><c><p><n>1abcd45gh23</n></p></c></r>`,
);

await eventCollector.waitAndVerifyNthEvent(1, {
type: DocEventType.LocalChange,
});
unsub();
}, task.name);
});
});

describe('Tree.edit(concurrent overlapping range)', () => {
Expand Down
Loading