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

Fix parent node id remapping (#198) #199

Merged
merged 1 commit into from
Sep 3, 2024
Merged

Fix parent node id remapping (#198) #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 1 deletion packages/networked-dom-document/src/NetworkedDOM.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,11 @@ export class NetworkedDOM {
if (parentNodeId === undefined) {
throw new Error("Parent node ID not found");
}
return this.getStaticVirtualDOMElementByInternalNodeIdOrThrow(parentNodeId);
const node = this.nodeIdToNode.get(parentNodeId);
if (!node) {
throw new Error("Parent node not found:" + parentNodeId);
}
return node;
}

private registerWebsocket(
Expand Down
248 changes: 248 additions & 0 deletions packages/networked-dom-document/test/regression.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
import { RemoteEvent } from "@mml-io/networked-dom-protocol";
import { LocalObservableDOMFactory } from "networked-dom-server";

import { EditableNetworkedDOM } from "../src";
import { MockWebsocket } from "./mock.websocket";

let currentDoc: EditableNetworkedDOM | null = null;
afterEach(() => {
if (currentDoc) {
currentDoc.dispose();
currentDoc = null;
}
});

describe("regression tests", () => {
test("remapping issue (#198)", async () => {
/*
This is a test added to fix an issue discovered with remapping ids on
reload and is kept as a regression test.
*/
const doc = new EditableNetworkedDOM("file://test.html", LocalObservableDOMFactory);
currentDoc = doc;
doc.load(
`<m-plane id="plane"></m-plane>
<m-cube id="my-cube"></m-cube>
<m-cube></m-cube>
<script>
const myCube = document.getElementById("my-cube");
const cube = document.createElement("m-cube"); // 7
myCube.appendChild(cube);
</script>
`,
);

const clientOneWs = new MockWebsocket();
doc.addWebSocket(clientOneWs as unknown as WebSocket);

expect(await clientOneWs.waitForTotalMessageCount(1)).toEqual([
[
{
documentTime: expect.any(Number),
snapshot: {
attributes: {},
children: [
{
attributes: {},
children: [
{
attributes: {},
children: [],
nodeId: 3,
tag: "HEAD",
type: "element",
},
{
attributes: {},
children: [
{
attributes: {
id: "plane",
},
children: [],
nodeId: 5,
tag: "M-PLANE",
type: "element",
},
{
attributes: {
id: "my-cube",
},
children: [
{
attributes: {},
children: [],
nodeId: 7,
tag: "M-CUBE",
type: "element",
},
],
nodeId: 6,
tag: "M-CUBE",
type: "element",
},
{
attributes: {},
children: [],
nodeId: 8,
tag: "M-CUBE",
type: "element",
},
],
nodeId: 4,
tag: "BODY",
type: "element",
},
],
nodeId: 2,
tag: "HTML",
type: "element",
},
],
nodeId: 1,
tag: "DIV",
type: "element",
},
type: "snapshot",
},
],
]);

doc.load(
`<m-plane id="plane"></m-plane>
<m-plane id="plane-2"></m-plane>

<m-cube id="my-cube"></m-cube>
<m-cube></m-cube>

<script>
const myCube = document.getElementById("my-cube");
const cube = document.createElement("m-cube"); // 10
myCube.appendChild(cube);

myCube.addEventListener("click", () => {
cube.remove();

const plane = document.createElement("m-plane");
myCube.appendChild(plane);
plane.setAttribute("foo","bar");
});
</script>
`,
);

expect(await clientOneWs.waitForTotalMessageCount(2, 1)).toEqual([
[
{
addedNodes: [],
documentTime: expect.any(Number),
nodeId: 4, // body
previousNodeId: 5, // m-plane
removedNodes: [6], // m-cube (my-cube)
type: "childrenChanged",
},
{
addedNodes: [
{
attributes: {
id: "plane-2",
},
children: [],
nodeId: 6, // m-plane
tag: "M-PLANE",
type: "element",
},
],
nodeId: 4, // body
previousNodeId: 5, // m-plane
removedNodes: [],
type: "childrenChanged",
},
{
attribute: "id",
newValue: "my-cube",
nodeId: 8, // m-cube
type: "attributeChange",
},
{
addedNodes: [
{
attributes: {},
children: [],
nodeId: 10, // m-cube
tag: "M-CUBE",
type: "element",
},
],
nodeId: 8, // m-cube
previousNodeId: null,
removedNodes: [],
type: "childrenChanged",
},
{
addedNodes: [
{
attributes: {},
children: [],
nodeId: 9, // m-cube
tag: "M-CUBE",
type: "element",
},
],
nodeId: 4, // body
previousNodeId: null,
removedNodes: [],
type: "childrenChanged",
},
],
]);

const clickEvent: RemoteEvent = {
type: "event",
name: "click",
nodeId: 8,
params: {},
bubbles: true,
};
clientOneWs.sendToServer(clickEvent);

expect(await clientOneWs.waitForTotalMessageCount(5, 2)).toEqual([
[
{
addedNodes: [],
nodeId: 8,
previousNodeId: null,
removedNodes: [10],
type: "childrenChanged",
},
],
[
{
addedNodes: [
{
attributes: {
foo: "bar",
},
children: [],
nodeId: 11,
tag: "M-PLANE",
type: "element",
},
],
nodeId: 8,
previousNodeId: null,
removedNodes: [],
type: "childrenChanged",
},
],
[
{
attribute: "foo",
newValue: "bar",
nodeId: 11,
type: "attributeChange",
},
],
]);
});
});
Loading