Compare commits

..

2 Commits

12 changed files with 704 additions and 1500 deletions

2
.gitignore vendored
View File

@@ -1 +1 @@
node_modules/ node_modules/

View File

@@ -1,55 +1,28 @@
# P2P Poll App # P2P Poll App
A peer-to-peer polling app built with [Automerge](https://automerge.org/) and Vanilla JS. No backend required — polls sync in real time across browsers using CRDTs and a WebSocket relay. ## Install npm packages
```
## Features npm init -y
npm install
- **Add options** — type an option and press Enter or click "Add Option". Duplicate options (case-insensitive) are rejected with an inline error message. ```
- **Vote on options** — click the vote button next to any option. You can vote on multiple options, but only once per option.
- **Toggle votes** — click your vote again to remove it (the button turns green with a checkmark when you've voted). Note: the frontend obtains the packages `yjs` and `y-websocket` dynamically.
- **Live vote counts** — options are sorted by vote count in descending order and update in real time as votes come in from other users.
- **2-minute countdown timer** — click "Start 2-min Vote" to begin a shared countdown. Voting is open before and during the countdown. Once the timer expires, all vote buttons are disabled. ## Run backend
- **Shared timer** — the deadline is stored in the Automerge document, so all peers see the same countdown and voting closes simultaneously for everyone. ```
- **Copy URL** — click "Copy URL" to copy the poll link to your clipboard. Share it with others to join the same poll. node backend.js
- **P2P sync** — all state (options, votes, timer) syncs across browsers in real time with no central server handling your data. ```
## How it works ### Note on Yjs suggestion
Note that the following server setup is suggested in the Yjs docs (https://docs.yjs.dev/ecosystem/connection-provider/y-websocket):
### Tech stack ```
npm install y-websocket-server
- **[Automerge](https://automerge.org/)** via `@automerge/vanillajs` — a CRDT library that lets multiple clients concurrently edit shared documents and merge changes without conflicts. HOST=localhost PORT=1000 npx y-websocket
- **BroadcastChannelNetworkAdapter** — syncs between tabs in the same browser instantly via the browser's BroadcastChannel API. ```
- **WebSocketClientAdapter** — syncs across different browsers/devices via a WebSocket relay (`wss://sync.automerge.org`). The relay only forwards CRDT messages; it does not store or interpret your data.
- **IndexedDBStorageAdapter** — persists the document locally so it survives page refreshes. However, across a range of npm versions, this does not work.
- **Vite** — bundles the app with WebAssembly support (required by Automerge). Nevertheless, the essential code from the `y-websocket-server` package is used here as provided in `utils.js`.
### Data model ## Run frontend
Open "frontend.html" in browser.
The poll is a single Automerge document with three fields:
```js
{
options: string[], // list of poll options in insertion order
votes: { [option]: number }, // vote count per option
deadline: number | null // Unix timestamp (ms) when voting closes, or null
}
```
### URL-based sharing
Each document gets a unique Automerge URL (e.g. `automerge:abc123...`) stored in the page's URL hash. Opening the same URL in any browser loads and syncs the same document. Creating a new poll generates a new document and updates the hash automatically.
### Voting rules
- Voted options are tracked in `localStorage` (keyed by document URL), so they persist across page refreshes but are isolated per browser.
- One vote per option per user. Votes can be toggled off and back on until the timer expires.
- The timer (`doc.deadline`) is set once by whoever clicks "Start 2-min Vote" and is shared via the Automerge document, so all peers use the same deadline.
## Running locally
```bash
pnpm install
pnpm dev
```
Open the printed localhost URL. To test cross-browser sync, copy the URL (including the `#automerge:...` hash) and open it in a different browser.

214
app.js
View File

@@ -1,214 +0,0 @@
import {
Repo,
BroadcastChannelNetworkAdapter,
WebSocketClientAdapter,
IndexedDBStorageAdapter,
isValidAutomergeUrl,
} from "@automerge/vanillajs";
const REPO = new Repo({
network: [
new BroadcastChannelNetworkAdapter(),
new WebSocketClientAdapter("wss://sync.automerge.org"),
],
storage: new IndexedDBStorageAdapter(),
});
let HANDLE;
function getVotedKey(docUrl) {
return `p2p-poll-voted:${docUrl}`;
}
function getVotedOptions() {
const key = getVotedKey(document.location.hash);
return new Set(JSON.parse(localStorage.getItem(key) || "[]"));
}
function markVoted(opt) {
const key = getVotedKey(document.location.hash);
const voted = getVotedOptions();
voted.add(opt);
localStorage.setItem(key, JSON.stringify([...voted]));
}
function unmarkVoted(opt) {
const key = getVotedKey(document.location.hash);
const voted = getVotedOptions();
voted.delete(opt);
localStorage.setItem(key, JSON.stringify([...voted]));
}
const locationHash = document.location.hash.substring(1);
const statusEl = document.getElementById("status");
const optionsList = document.getElementById("options-list");
const optionInput = document.getElementById("option-input");
const addBtn = document.getElementById("add-btn");
const duplicateMsg = document.getElementById("duplicate-msg");
const copyBtn = document.getElementById("copy-btn");
const timerEl = document.getElementById("timer");
const startVotingBtn = document.getElementById("start-voting-btn");
if (isValidAutomergeUrl(locationHash)) {
statusEl.textContent = "Loading document…";
try {
HANDLE = await REPO.find(locationHash);
statusEl.textContent = "";
} catch (err) {
statusEl.textContent = "Could not load document. Starting a new one.";
HANDLE = REPO.create({ options: [], votes: {}, deadline: null });
document.location.hash = HANDLE.url;
}
} else {
HANDLE = REPO.create({ options: [], votes: {}, deadline: null });
document.location.hash = HANDLE.url;
}
HANDLE.on("change", ({ doc }) => render(doc));
const initialDoc = HANDLE.doc();
if (initialDoc) render(initialDoc);
let timerInterval = null;
function render(doc) {
renderOptions(doc);
renderTimer(doc);
}
function renderOptions(doc) {
const votes = doc.votes || {};
const deadline = doc.deadline ?? null;
const now = Date.now();
const votingClosed = deadline !== null && now >= deadline;
const votedOptions = getVotedOptions();
const sorted = [...(doc.options || [])].sort(
(a, b) => (votes[b] || 0) - (votes[a] || 0),
);
optionsList.innerHTML = "";
sorted.forEach((opt) => {
const count = votes[opt] || 0;
const alreadyVoted = votedOptions.has(opt);
const item = document.createElement("div");
item.className = "option-item";
const label = document.createElement("span");
label.className = "option-label";
label.textContent = opt;
const voteBtn = document.createElement("button");
voteBtn.className = alreadyVoted ? "vote-btn voted" : "vote-btn";
voteBtn.textContent = alreadyVoted ? `${count}` : `${count}`;
voteBtn.disabled = votingClosed;
if (votingClosed) voteBtn.title = "Voting is closed";
else if (alreadyVoted) voteBtn.title = "Click to remove your vote";
voteBtn.addEventListener("click", () => {
if (alreadyVoted) {
unmarkVoted(opt);
HANDLE.change((d) => {
if (!d.votes) d.votes = {};
d.votes[opt] = Math.max(0, (d.votes[opt] || 0) - 1);
});
} else {
markVoted(opt);
HANDLE.change((d) => {
if (!d.votes) d.votes = {};
d.votes[opt] = (d.votes[opt] || 0) + 1;
});
}
});
item.appendChild(label);
item.appendChild(voteBtn);
optionsList.appendChild(item);
});
}
function renderTimer(doc) {
const deadline = doc?.deadline ?? null;
const now = Date.now();
if (deadline === null) {
timerEl.textContent = "";
startVotingBtn.hidden = false;
return;
}
startVotingBtn.hidden = true;
if (now >= deadline) {
timerEl.textContent = "Voting closed.";
timerEl.className = "timer closed";
clearInterval(timerInterval);
timerInterval = null;
return;
}
const remaining = Math.ceil((deadline - now) / 1000);
const mins = Math.floor(remaining / 60);
const secs = remaining % 60;
timerEl.textContent = `Voting closes in ${mins}:${secs.toString().padStart(2, "0")}`;
timerEl.className = "timer active";
if (!timerInterval) {
timerInterval = setInterval(() => {
const d = HANDLE.doc();
if (!d) return;
renderTimer(d);
renderOptions(d);
if (Date.now() >= d.deadline) {
clearInterval(timerInterval);
timerInterval = null;
}
}, 1000);
}
}
startVotingBtn.addEventListener("click", () => {
HANDLE.change((d) => {
d.deadline = Date.now() + 2 * 60 * 1000;
});
});
addBtn.addEventListener("click", () => {
const value = optionInput.value.trim();
if (!value) return;
const doc = HANDLE.doc();
const valueLower = value.toLowerCase();
const isDuplicate = (doc?.options || []).some(
(opt) => opt.toLowerCase() === valueLower,
);
if (isDuplicate) {
duplicateMsg.textContent = `"${value}" is already in the list.`;
duplicateMsg.hidden = false;
return;
}
duplicateMsg.hidden = true;
HANDLE.change((d) => {
if (!d.options) d.options = [];
d.options.push(value);
});
optionInput.value = "";
});
optionInput.addEventListener("keydown", (e) => {
if (e.key === "Enter") addBtn.click();
});
optionInput.addEventListener("input", () => {
duplicateMsg.hidden = true;
});
copyBtn.addEventListener("click", () => {
navigator.clipboard.writeText(window.location.href).then(() => {
copyBtn.textContent = "Copied!";
setTimeout(() => (copyBtn.textContent = "Copy URL"), 1500);
});
});

31
backend.js Normal file
View File

@@ -0,0 +1,31 @@
import { WebSocketServer } from 'ws';
import { setupWSConnection } from './utils.js'
// Create a WebSocket server
const WS_PORT = 8080;
const wss = new WebSocketServer({ port: WS_PORT });
console.log('WebSocket server is running on ws://localhost:' + String(WS_PORT));
// Connection event handler
wss.on('connection', setupWSConnection);
/*
wss.on('connection', (ws) => {
console.log('Client connected');
// Message event handler
ws.on('message', (message) => {
let msg_str = String(message);
console.log("Received: " + msg_str);
// If this is a text or state message (no Yjs logic) - echo the message back to the client
if (msg_str.startsWith("TEXT_MESSAGE") | msg_str.startsWith("STATE_MESSAGE")) {
ws.send(msg_str);
}
});
// Close event handler
ws.on('close', () => {
console.log('Client disconnected');
});
});*/

196
frontend.html Normal file
View File

@@ -0,0 +1,196 @@
<!DOCTYPE html>
<html>
<head>
<title>Poll Client</title>
<style>
body {
font-family: Arial, sans-serif;
max-width: 600px;
margin: 0 auto;
padding: 20px;
}
#messages {
height: 300px;
border: 1px solid #ccc;
overflow-y: auto;
padding: 10px;
margin-bottom: 10px;
}
.message { margin: 5px 0; }
</style>
</head>
<body>
<h1>Poll Client</h1>
<div id="status">Connecting to server...</div>
<div id="status2">Connecting to server...</div>
<div id="messages"></div>
<div>
<input type="text" id="messageInput" placeholder="Type your message">
<!--button onclick="sendMessage()">Send</button-->
<button id="sendBtn">Send</button>
<input id="optionInput" placeholder="Add option">
<button id="addBtn">Add</button>
<ul id="options"></ul>
</div>
<script type="module">
import * as Y from "https://esm.sh/yjs"
import { WebsocketProvider } from "https://esm.sh/y-websocket"
const WS_PORT = 8080;
const ydoc = new Y.Doc();
const status = document.getElementById('status');
const status2 = document.getElementById('status2');
const messages = document.getElementById('messages');
const messageInput = document.getElementById('messageInput');
// Connect to the backend (WebSocket server) via Yjs WebsocketProvider
const wsp = new WebsocketProvider(
'ws://localhost:' + String(WS_PORT), 'poll-room',
ydoc
)
wsp.on('status', event => {
//console.log("event.status =", event.status)
if (event.status == "connected") {
status.textContent = 'Yjs connected to WebSocket server';
status.style.color = 'green';
}
else {
status.textContent = 'Yjs disonnected from WebSocket server';
status.style.color = 'red';
}
})
wsp.onopen = () => {
console.log('connected to y-websocket server');
};
ydoc.on('update', () => {
console.log('Yjs document updated locally');
});
wsp.on('sync', isSynced => {
console.log("isSynced =", isSynced)
})
// Connect to the backend (WebSocket server) via common WebSocket (only for informative messages)
const ws = new WebSocket('ws://localhost:' + String(WS_PORT));
ws.onopen = () => {
status2.textContent = 'WebSocket client connected to WebSocket server';
status2.style.color = 'green';
};
ws.onmessage = (event) => {
const message = document.createElement('div');
message.className = 'message';
message.textContent = event.data;
messages.appendChild(message);
messages.scrollTop = messages.scrollHeight;
};
ws.onerror = (error) => {
status2.textContent = 'Error: ' + error.message;
status2.style.color = 'red';
};
ws.onclose = () => {
status2.textContent = 'WebSocket client disconnected from WebSocket server';
status2.style.color = 'red';
};
// Function to send a message
function sendMessage(command, payload) {
let message = "";
if (command === "TEXT_MESSAGE") {
message = command + ":" + messageInput.value.trim();
messageInput.value = "";
}
else if (command.startsWith("STATE_MESSAGE--")) {
message = command + ":" + payload;
}
else {
console.log("Error: unknown command '" + command + "'")
}
if (message) {
/* To make compatible with y-websocket-server API:
const encoder = encoding.createEncoder()
encoding.writeVarUint(encoder, messageTextMessage)
syncProtocol.writeUpdate(encoder, update)
enc_message = encoding.toUint8Array(encoder)*/
ws.send(message);
}
}
// Send message on button click
document.getElementById("sendBtn").onclick = () => {
sendMessage("TEXT_MESSAGE", "");
};
// Send message on Enter key
messageInput.addEventListener('keypress', (e) => {
if (e.key === 'Enter') {
sendMessage("TEXT_MESSAGE", "");
}
});
// Actual poll logic
const optionsMap = ydoc.getMap("options");
const optionsList = document.getElementById("options");
const input = document.getElementById("optionInput");
function render() {
optionsList.innerHTML = ""
optionsMap.forEach((vote, name) => {
// List element for this option
const li = document.createElement("li")
// Label for this option
const label = document.createElement("span")
label.textContent = name + " — " + vote + " "
// "Vote"/"Unvote" button
const voteBtn = document.createElement("button")
if (vote == false) {
voteBtn.textContent = "Vote"
}
else {
voteBtn.textContent = "Unvote"
}
voteBtn.onclick = () => {
vote = !vote;
optionsMap.set(name, vote);
sendMessage("STATE_MESSAGE--" + (vote ? "VOTE" : "UNVOTE"), name);
}
// "Remove" button
const removeBtn = document.createElement("button")
removeBtn.textContent = "Remove"
removeBtn.onclick = () => {
optionsMap.delete(name);
sendMessage("STATE_MESSAGE--REMOVE", name);
}
li.appendChild(label)
li.appendChild(voteBtn)
li.appendChild(removeBtn)
optionsList.appendChild(li)
})
};
document.getElementById("addBtn").onclick = () => {
const name = input.value.trim()
if (!name) return
if (!optionsMap.has(name)) {
optionsMap.set(name, false);
sendMessage("STATE_MESSAGE--ADD_OPTION", name);
}
input.value = ""
};
optionsMap.observe(render);
render();
</script>
</body>
</html>

View File

@@ -1,31 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>P2P Polling App</title>
<link rel="stylesheet" href="./styles.css" />
</head>
<body>
<div id="app">
<h1>P2P Polling App</h1>
<div id="status"></div>
<div id="add-option">
<input
type="text"
id="option-input"
placeholder="Enter an option..."
/>
<button id="add-btn">Add Option</button>
</div>
<div id="duplicate-msg" hidden></div>
<div id="timer-section">
<div id="timer"></div>
<button id="start-voting-btn">Start 2-min Vote</button>
</div>
<div id="options-list"></div>
<button id="copy-btn">Copy URL</button>
</div>
<script type="module" src="./app.js"></script>
</body>
</html>

144
package-lock.json generated Normal file
View File

@@ -0,0 +1,144 @@
{
"name": "yjs-poll",
"version": "1.0.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "yjs-poll",
"version": "1.0.0",
"license": "ISC",
"dependencies": {
"@y/protocols": "^1.0.6-1",
"lib0": "^0.2.102",
"ws": "^8.19.0",
"yjs": "^14.0.0-7"
}
},
"node_modules/@y/protocols": {
"version": "1.0.6-rc.1",
"resolved": "https://registry.npmjs.org/@y/protocols/-/protocols-1.0.6-rc.1.tgz",
"integrity": "sha512-e/qs7hXcLk/SeNitxMXv2ymozyWFTULwbJEi7cAf/K/iXw9nGwGXHrR5TNluQ/bMwOX1cwuUT0hjEojkfH0gsA==",
"license": "MIT",
"dependencies": {
"lib0": "^1.0.0-rc.1"
},
"engines": {
"node": ">=16.0.0",
"npm": ">=8.0.0"
},
"funding": {
"type": "GitHub Sponsors ❤",
"url": "https://github.com/sponsors/dmonad"
},
"peerDependencies": {
"@y/y": "*"
}
},
"node_modules/@y/protocols/node_modules/lib0": {
"version": "1.0.0-rc.4",
"resolved": "https://registry.npmjs.org/lib0/-/lib0-1.0.0-rc.4.tgz",
"integrity": "sha512-mESL4089ji2HbS19DwAsYJRrtxZDjzMjEzjNR5kpzFBqlhvV0b7F9+SlA2SHOQU1Puu2A9xejKXtElK77swxLA==",
"license": "MIT",
"bin": {
"0ecdsa-generate-keypair": "src/bin/0ecdsa-generate-keypair.js",
"0gentesthtml": "src/bin/gentesthtml.js",
"0serve": "src/bin/0serve.js"
},
"engines": {
"node": ">=16"
},
"funding": {
"type": "GitHub Sponsors ❤",
"url": "https://github.com/sponsors/dmonad"
}
},
"node_modules/@y/y": {
"version": "14.0.0-16",
"resolved": "https://registry.npmjs.org/@y/y/-/y-14.0.0-16.tgz",
"integrity": "sha512-4zwbLnLannzUiEdJn9r3IS2FCVdHqADZHLqAivzAuKeoCGZ55JUFebp/YUtrYuTE2ZaBgctxpzulqAAHaahtIA==",
"license": "MIT",
"peer": true,
"dependencies": {
"lib0": "^0.2.115-6"
},
"engines": {
"node": ">=16.0.0",
"npm": ">=8.0.0"
},
"funding": {
"type": "GitHub Sponsors ❤",
"url": "https://github.com/sponsors/dmonad"
}
},
"node_modules/isomorphic.js": {
"version": "0.2.5",
"resolved": "https://registry.npmjs.org/isomorphic.js/-/isomorphic.js-0.2.5.tgz",
"integrity": "sha512-PIeMbHqMt4DnUP3MA/Flc0HElYjMXArsw1qwJZcm9sqR8mq3l8NYizFMty0pWwE/tzIGH3EKK5+jes5mAr85yw==",
"license": "MIT",
"funding": {
"type": "GitHub Sponsors ❤",
"url": "https://github.com/sponsors/dmonad"
}
},
"node_modules/lib0": {
"version": "0.2.117",
"resolved": "https://registry.npmjs.org/lib0/-/lib0-0.2.117.tgz",
"integrity": "sha512-DeXj9X5xDCjgKLU/7RR+/HQEVzuuEUiwldwOGsHK/sfAfELGWEyTcf0x+uOvCvK3O2zPmZePXWL85vtia6GyZw==",
"license": "MIT",
"dependencies": {
"isomorphic.js": "^0.2.4"
},
"bin": {
"0ecdsa-generate-keypair": "bin/0ecdsa-generate-keypair.js",
"0gentesthtml": "bin/gentesthtml.js",
"0serve": "bin/0serve.js"
},
"engines": {
"node": ">=16"
},
"funding": {
"type": "GitHub Sponsors ❤",
"url": "https://github.com/sponsors/dmonad"
}
},
"node_modules/ws": {
"version": "8.19.0",
"resolved": "https://registry.npmjs.org/ws/-/ws-8.19.0.tgz",
"integrity": "sha512-blAT2mjOEIi0ZzruJfIhb3nps74PRWTCz1IjglWEEpQl5XS/UNama6u2/rjFkDDouqr4L67ry+1aGIALViWjDg==",
"license": "MIT",
"engines": {
"node": ">=10.0.0"
},
"peerDependencies": {
"bufferutil": "^4.0.1",
"utf-8-validate": ">=5.0.2"
},
"peerDependenciesMeta": {
"bufferutil": {
"optional": true
},
"utf-8-validate": {
"optional": true
}
}
},
"node_modules/yjs": {
"version": "14.0.0-16",
"resolved": "https://registry.npmjs.org/yjs/-/yjs-14.0.0-16.tgz",
"integrity": "sha512-n7jMrQz4pgU/NFnf4qY53K2adR/fu6ViQ79qVIw6Og+BtuDs1hx3DjOi3iREVnA6tsxQXXVG3gvG0I2kpmAwoQ==",
"license": "MIT",
"dependencies": {
"lib0": "^0.2.115-6"
},
"engines": {
"node": ">=16.0.0",
"npm": ">=8.0.0"
},
"funding": {
"type": "GitHub Sponsors ❤",
"url": "https://github.com/sponsors/dmonad"
}
}
}
}

View File

@@ -1,23 +1,20 @@
{ {
"name": "p2p-poll-app", "name": "yjs-poll",
"version": "1.0.0",
"main": "index.js",
"type": "module", "type": "module",
"engines": {
"node": ">=24"
},
"scripts": { "scripts": {
"dev": "vite", "test": "echo \"Error: no test specified\" && exit 1",
"build": "vite build", "y-websocket": "y-websocket"
"preview": "vite preview"
}, },
"keywords": [],
"author": "",
"license": "ISC",
"description": "",
"dependencies": { "dependencies": {
"@automerge/automerge-repo": "^2.0.0", "ws": "^8.19.0",
"@automerge/automerge-repo-network-websocket": "^2.0.0", "@y/protocols": "^1.0.6-1",
"@automerge/automerge-repo-storage-indexeddb": "^2.0.0", "lib0": "^0.2.102",
"@automerge/vanillajs": "^2.5.3" "yjs": "^14.0.0-7"
},
"devDependencies": {
"vite": "^6.0.0",
"vite-plugin-top-level-await": "^1.4.0",
"vite-plugin-wasm": "^3.3.0"
} }
} }

1083
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,93 +0,0 @@
body {
font-family: sans-serif;
max-width: 480px;
margin: 40px auto;
padding: 0 16px;
}
#add-option {
display: flex;
gap: 8px;
margin-bottom: 8px;
}
#option-input {
flex: 1;
padding: 8px;
font-size: 1rem;
border: 1px solid #ccc;
border-radius: 4px;
}
#duplicate-msg {
color: #c00;
font-size: 0.9rem;
margin-bottom: 12px;
}
button {
padding: 8px 16px;
font-size: 1rem;
cursor: pointer;
border: 1px solid #ccc;
border-radius: 4px;
background: #fff;
}
button:hover:not(:disabled) {
background: #f0f0f0;
}
button:disabled {
opacity: 0.5;
cursor: default;
}
#timer-section {
display: flex;
align-items: center;
gap: 12px;
margin-bottom: 16px;
}
.timer.active {
font-weight: bold;
color: #1a6e1a;
}
.timer.closed {
font-weight: bold;
color: #c00;
}
.option-item {
display: flex;
align-items: center;
justify-content: space-between;
padding: 10px 12px;
border: 1px solid #ddd;
border-radius: 4px;
margin-bottom: 8px;
}
.option-label {
flex: 1;
}
.vote-btn {
padding: 4px 12px;
font-size: 0.9rem;
white-space: nowrap;
}
.vote-btn.voted {
background: #e6f4e6;
border-color: #4a9e4a;
color: #2a6e2a;
}
#copy-btn {
margin-top: 16px;
width: 100%;
}

291
utils.js Normal file
View File

@@ -0,0 +1,291 @@
/* Adapted from https://github.com/yjs/y-websocket-server/blob/main/src/server.js, version of 2025-04-02
(author: dmonad/Kevin Jahns, MIT license) */
import * as Y from 'yjs'
import * as syncProtocol from '@y/protocols/sync'
import * as awarenessProtocol from '@y/protocols/awareness'
import * as encoding from 'lib0/encoding'
import * as decoding from 'lib0/decoding'
import * as map from 'lib0/map'
import * as eventloop from 'lib0/eventloop'
/*import { callbackHandler, isCallbackSet } from './callback.js'
const CALLBACK_DEBOUNCE_WAIT = parseInt(process.env.CALLBACK_DEBOUNCE_WAIT || '2000')
const CALLBACK_DEBOUNCE_MAXWAIT = parseInt(process.env.CALLBACK_DEBOUNCE_MAXWAIT || '10000')
const debouncer = eventloop.createDebouncer(CALLBACK_DEBOUNCE_WAIT, CALLBACK_DEBOUNCE_MAXWAIT)*/
const wsReadyStateConnecting = 0
const wsReadyStateOpen = 1
const wsReadyStateClosing = 2 // eslint-disable-line
const wsReadyStateClosed = 3 // eslint-disable-line
// disable gc when using snapshots!
const gcEnabled = process.env.GC !== 'false' && process.env.GC !== '0'
// const persistenceDir = process.env.YPERSISTENCE
/**
* @type {{bindState: function(string,WSSharedDoc):void, writeState:function(string,WSSharedDoc):Promise<any>, provider: any}|null}
*/
let persistence = null
/**
* @param {{bindState: function(string,WSSharedDoc):void,
* writeState:function(string,WSSharedDoc):Promise<any>,provider:any}|null} persistence_
*/
export const setPersistence = persistence_ => {
persistence = persistence_
}
/**
* @return {null|{bindState: function(string,WSSharedDoc):void,
* writeState:function(string,WSSharedDoc):Promise<any>}|null} used persistence layer
*/
export const getPersistence = () => persistence
/**
* @type {Map<string,WSSharedDoc>}
*/
export const docs = new Map()
const messageSync = 0
const messageAwareness = 1
// const messageAuth = 2
//const messageTextMessage = 3
//const messageStateMessage = 4
/**
* @param {Uint8Array} update
* @param {any} _origin
* @param {WSSharedDoc} doc
* @param {any} _tr
*/
const updateHandler = (update, _origin, doc, _tr) => {
const encoder = encoding.createEncoder()
encoding.writeVarUint(encoder, messageSync)
syncProtocol.writeUpdate(encoder, update)
const message = encoding.toUint8Array(encoder)
doc.conns.forEach((_, conn) => send(doc, conn, message))
}
/**
* @type {(ydoc: Y.Doc) => Promise<void>}
*/
let contentInitializor = _ydoc => Promise.resolve()
/**
* This function is called once every time a Yjs document is created. You can
* use it to pull data from an external source or initialize content.
*
* @param {(ydoc: Y.Doc) => Promise<void>} f
*/
export const setContentInitializor = (f) => {
contentInitializor = f
}
export class WSSharedDoc extends Y.Doc {
/**
* @param {string} name
*/
constructor (name) {
super({ gc: gcEnabled })
this.name = name
/**
* Maps from conn to set of controlled user ids. Delete all user ids from awareness when this conn is closed
* @type {Map<Object, Set<number>>}
*/
this.conns = new Map()
/**
* @type {awarenessProtocol.Awareness}
*/
this.awareness = new awarenessProtocol.Awareness(this)
this.awareness.setLocalState(null)
/**
* @param {{ added: Array<number>, updated: Array<number>, removed: Array<number> }} changes
* @param {Object | null} conn Origin is the connection that made the change
*/
const awarenessChangeHandler = ({ added, updated, removed }, conn) => {
const changedClients = added.concat(updated, removed)
if (conn !== null) {
const connControlledIDs = /** @type {Set<number>} */ (this.conns.get(conn))
if (connControlledIDs !== undefined) {
added.forEach(clientID => { connControlledIDs.add(clientID) })
removed.forEach(clientID => { connControlledIDs.delete(clientID) })
}
}
// broadcast awareness update
const encoder = encoding.createEncoder()
encoding.writeVarUint(encoder, messageAwareness)
encoding.writeVarUint8Array(encoder, awarenessProtocol.encodeAwarenessUpdate(this.awareness, changedClients))
const buff = encoding.toUint8Array(encoder)
this.conns.forEach((_, c) => {
send(this, c, buff)
})
}
this.awareness.on('update', awarenessChangeHandler)
this.on('update', /** @type {any} */ (updateHandler))
//if (isCallbackSet) {
// this.on('update', (_update, _origin, doc) => {
// debouncer(() => callbackHandler(/** @type {WSSharedDoc} */ (doc)))
// })
//}
this.whenInitialized = contentInitializor(this)
}
}
/**
* Gets a Y.Doc by name, whether in memory or on disk
*
* @param {string} docname - the name of the Y.Doc to find or create
* @param {boolean} gc - whether to allow gc on the doc (applies only when created)
* @return {WSSharedDoc}
*/
export const getYDoc = (docname, gc = true) => map.setIfUndefined(docs, docname, () => {
const doc = new WSSharedDoc(docname)
doc.gc = gc
if (persistence !== null) {
persistence.bindState(docname, doc)
}
docs.set(docname, doc)
return doc
})
/**
* @param {any} conn
* @param {WSSharedDoc} doc
* @param {Uint8Array} message
*/
const messageListener = (conn, doc, message) => {
try {
const encoder = encoding.createEncoder()
const decoder = decoding.createDecoder(new Uint8Array(message))
const messageType = decoding.readVarUint(decoder)
switch (messageType) {
case messageSync:
encoding.writeVarUint(encoder, messageSync)
syncProtocol.readSyncMessage(decoder, encoder, doc, conn)
// If the `encoder` only contains the type of reply message and no
// message, there is no need to send the message. When `encoder` only
// contains the type of reply, its length is 1.
if (encoding.length(encoder) > 1) {
send(doc, conn, encoding.toUint8Array(encoder))
}
break
case messageAwareness: {
awarenessProtocol.applyAwarenessUpdate(doc.awareness, decoding.readVarUint8Array(decoder), conn)
break
}
// If this is a text or a message (no Yjs logic) - echo the message back to the client
default: {
conn.send(String(message))
console.log(String(message))
break
}
}
} catch (err) {
console.error(err)
// @ts-ignore
doc.emit('error', [err])
}
}
/**
* @param {WSSharedDoc} doc
* @param {any} conn
*/
const closeConn = (doc, conn) => {
if (doc.conns.has(conn)) {
/**
* @type {Set<number>}
*/
// @ts-ignore
const controlledIds = doc.conns.get(conn)
doc.conns.delete(conn)
awarenessProtocol.removeAwarenessStates(doc.awareness, Array.from(controlledIds), null)
if (doc.conns.size === 0 && persistence !== null) {
// if persisted, we store state and destroy ydocument
persistence.writeState(doc.name, doc).then(() => {
doc.destroy()
})
docs.delete(doc.name)
}
}
conn.close()
}
/**
* @param {WSSharedDoc} doc
* @param {import('ws').WebSocket} conn
* @param {Uint8Array} m
*/
const send = (doc, conn, m) => {
if (conn.readyState !== wsReadyStateConnecting && conn.readyState !== wsReadyStateOpen) {
closeConn(doc, conn)
}
try {
conn.send(m, {}, err => { err != null && closeConn(doc, conn) })
} catch (e) {
closeConn(doc, conn)
}
}
const pingTimeout = 30000
/**
* @param {import('ws').WebSocket} conn
* @param {import('http').IncomingMessage} req
* @param {any} opts
*/
export const setupWSConnection = (conn, req, { docName = (req.url || '').slice(1).split('?')[0], gc = true } = {}) => {
conn.binaryType = 'arraybuffer'
// get doc, initialize if it does not exist yet
const doc = getYDoc(docName, gc)
doc.conns.set(conn, new Set())
// listen and reply to events
conn.on('message', /** @param {ArrayBuffer} message */ message => messageListener(conn, doc, message))
// Check if connection is still alive
let pongReceived = true
const pingInterval = setInterval(() => {
if (!pongReceived) {
if (doc.conns.has(conn)) {
closeConn(doc, conn)
}
clearInterval(pingInterval)
} else if (doc.conns.has(conn)) {
pongReceived = false
try {
conn.ping()
} catch (e) {
closeConn(doc, conn)
clearInterval(pingInterval)
}
}
}, pingTimeout)
conn.on('close', () => {
closeConn(doc, conn)
clearInterval(pingInterval)
})
conn.on('pong', () => {
pongReceived = true
})
// put the following in a variables in a block so the interval handlers don't keep in in
// scope
{
// send sync step 1
const encoder = encoding.createEncoder()
encoding.writeVarUint(encoder, messageSync)
syncProtocol.writeSyncStep1(encoder, doc)
send(doc, conn, encoding.toUint8Array(encoder))
const awarenessStates = doc.awareness.getStates()
if (awarenessStates.size > 0) {
const encoder = encoding.createEncoder()
encoding.writeVarUint(encoder, messageAwareness)
encoding.writeVarUint8Array(encoder, awarenessProtocol.encodeAwarenessUpdate(doc.awareness, Array.from(awarenessStates.keys())))
send(doc, conn, encoding.toUint8Array(encoder))
}
}
}

View File

@@ -1,7 +0,0 @@
import { defineConfig } from 'vite'
import wasm from 'vite-plugin-wasm'
import topLevelAwait from 'vite-plugin-top-level-await'
export default defineConfig({
plugins: [wasm(), topLevelAwait()]
})