Compare commits

..

1 Commits

10 changed files with 373 additions and 711 deletions

1
.gitignore vendored
View File

@@ -1 +0,0 @@
node_modules/

View File

@@ -1,28 +1,14 @@
# P2P Poll App
## Install npm packages
```
npm init -y
npm install
```
Note: the frontend obtains the packages `yjs` and `y-websocket` dynamically.
## Run backend
```
node backend.js
```
### 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):
```
npm install y-websocket-server
HOST=localhost PORT=1000 npx y-websocket
```
However, across a range of npm versions, this does not work.
Nevertheless, the essential code from the `y-websocket-server` package is used here as provided in `utils.js`.
## Run frontend
Open "frontend.html" in browser.
# P2P Poll App
P2P Poll - Minimal GUN-based Scaffolding
What this is
- A tiny peer-to-peer polling app implemented with vanilla JS and GUN (a decentralized, CRDT-friendly database).
- No central server for poll data. Peers connect and synchronize the poll in real-time.
Notes
- This scaffold uses GUNs browser-based peer-to-peer data replication.
- You can extend with:
- Persistent storage on each peer
- Better conflict resolution UI
- Optional signaling server for explicit peer discovery

200
app.js Normal file
View File

@@ -0,0 +1,200 @@
// Minimal GUN-based P2P Poll scaffold (vanilla JS)
(function() {
// Initialize GUN (no server needed; can optionally connect to a relay server)
// If you want a local-only node for prototyping: Gun()
// If you want to use a signaling server for discovery, pass a list of peers to Gun().opt({peers: [...]})
const gun = Gun();
// DOM helpers
const pollSection = document.getElementById('poll');
const pollIdInput = document.getElementById('pollId');
const loadPollBtn = document.getElementById('loadPollBtn');
const createPollBtn = document.getElementById('createPollBtn');
const pollTitleInput = document.getElementById('pollTitle');
const setTitleBtn = document.getElementById('setTitleBtn');
const optionsDiv = document.getElementById('options');
const newOptionInput = document.getElementById('newOption');
const addOptionBtn = document.getElementById('addOptionBtn');
const totalVotesSpan = document.getElementById('totalVotes');
const pollIdDisplay = document.getElementById('pollIdDisplay');
let currentPollId = null;
let pollsRef = null; // Gun node for /polls/{pollId}
let pollData = null; // local cache
// Helpers
function renderOptionList(options) {
optionsDiv.innerHTML = '';
const keys = Object.keys(options || {});
if (keys.length === 0) {
optionsDiv.innerHTML = '<p>No options yet. Add one below.</p>';
return;
}
keys.forEach((optId) => {
const opt = options[optId];
const el = document.createElement('div');
el.className = 'option';
el.innerHTML = `
<span class="text">${opt.text}</span>
<button data-optid="${optId}" class="voteBtn">Vote (${opt.votes || 0})</button>
`;
optionsDiv.appendChild(el);
});
}
function updateTotalVotes() {
const opts = pollData && pollData.options ? pollData.options : {};
const total = Object.values(opts).reduce((sum, o) => sum + (o.votes || 0), 0);
totalVotesSpan.textContent = total;
}
// Load existing poll and subscribe to changes
function loadPoll(pollId) {
if (!pollId) return;
currentPollId = pollId;
pollIdDisplay.textContent = pollId;
pollsRef = gun.get('polls').get(pollId);
// Initialize structure if new poll
pollsRef.get('title').put('Untitled Poll');
pollsRef.get('options').put({}); // ensure map exists
// Real-time updates: listen to changes
pollsRef.get('title').on((title) => {
pollTitleInput.value = title || '';
});
pollsRef.on((data) => {
// data is the entire poll node if subscribed; but we explore explicit fields
});
// For options map
pollsRef.get('options').on((opts) => {
// opts is the entire options map; convert to plain object
const optionsObj = toPlainObject(opts);
pollData = {
title: null,
options: optionsObj
};
renderOptionList(optionsObj);
updateTotalVotes();
});
// Also listen for title changes separately (in case some clients push via title path)
pollsRef.get('title').on((title) => {
pollTitleInput.value = title || '';
});
// Show UI
document.getElementById('setup').style.display = 'none';
pollSection.style.display = 'block';
}
// Create a new poll
function createPoll() {
const pollId = pollIdInput.value.trim();
if (!pollId) {
alert('Please enter a poll ID to create.');
return;
}
currentPollId = pollId;
// Initialize poll
pollsRef = gun.get('polls').get(pollId);
pollsRef.put({
title: 'New Poll',
});
pollsRef.get('options').put({}); // ensure map exists
// reflect in UI
pollIdDisplay.textContent = pollId;
pollTitleInput.value = 'New Poll';
pollSection.style.display = 'block';
document.getElementById('setup').style.display = 'none';
}
// Add option
function addOption() {
if (!pollsRef) {
alert('Load or create a poll first.');
return;
}
const text = newOptionInput.value.trim();
if (!text) return;
const optionId = 'opt_' + Date.now();
pollsRef.get('options').get(optionId).put({ text, votes: 0 });
newOptionInput.value = '';
}
// Set title
function setTitle() {
if (!pollsRef) return;
const title = pollTitleInput.value.trim() || 'Untitled';
pollsRef.get('title').put(title);
}
// Vote handler (delegated)
function handleVoteClick(e) {
if (e.target.classList.contains('voteBtn')) {
const optId = e.target.getAttribute('data-optid');
if (!optId || !pollsRef) return;
const optRef = pollsRef.get('options').get(optId);
// Increment votes locally
optRef.get('votes').once((v) => {
const current = v || 0;
optRef.put({ votes: current + 1 });
});
// UI will update via the on() listener on options map
}
}
// Utilities
function toPlainObject(obj) {
// Gun emits special proxy-like objects; convert to plain object
if (!obj) return {};
// If it's already a plain object, return
if (typeof obj !== 'object') return {};
// Gun events deliver object-like; attempt shallow copy
try {
const copy = JSON.parse(JSON.stringify(obj));
return copy;
} catch (e) {
// Fallback: return as-is if cannot stringify
return obj;
}
}
// Event bindings
loadPollBtn.addEventListener('click', () => {
const id = pollIdInput.value.trim();
if (!id) {
alert('Enter a Poll ID to load.');
return;
}
loadPoll(id);
});
createPollBtn.addEventListener('click', () => {
createPoll();
});
addOptionBtn.addEventListener('click', addOption);
newOptionInput.addEventListener('keydown', (ev) => {
if (ev.key === 'Enter') addOption();
});
setTitleBtn.addEventListener('click', setTitle);
// Delegate vote clicks
optionsDiv.addEventListener('click', handleVoteClick);
// Initialize: optionally auto-create a poll if URL param present
// Example: ?pollId=my-poll-123
const urlParams = new URLSearchParams(window.location.search);
const autoPoll = urlParams.get('pollId');
if (autoPoll) {
pollIdInput.value = autoPoll;
loadPoll(autoPoll);
}
})();

View File

@@ -1,31 +0,0 @@
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');
});
});*/

View File

@@ -1,196 +0,0 @@
<!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>

55
index.html Normal file
View File

@@ -0,0 +1,55 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>P2P Poll</title>
<link rel="stylesheet" href="styles.css" />
<!-- Gun.js via CDN for quick start -->
<script src="https://unpkg.com/gun/gun.js"></script>
</head>
<body>
<div class="container">
<h1>P2P Poll</h1>
<section id="setup" class="card">
<h2>Start or Join Poll</h2>
<div class="field">
<label for="pollId">Poll ID (share with peer):</label>
<input id="pollId" type="text" placeholder="e.g. my-poll-123" />
</div>
<button id="loadPollBtn">Load Poll</button>
<button id="createPollBtn">Create New Poll</button>
<p class="note">Tip: You can run two instances and connect by using the same Poll ID.</p>
</section>
<section id="poll" class="card" style="display:none;">
<h2>Poll</h2>
<div class="field">
<label for="pollTitle">Poll Title</label>
<input id="pollTitle" type="text" placeholder="Poll Title" />
<button id="setTitleBtn">Set Title</button>
</div>
<div id="options" class="options">
<!-- dynamic options will render here -->
</div>
<div class="field">
<input id="newOption" type="text" placeholder="Add a new option" />
<button id="addOptionBtn">Add Option</button>
</div>
<div class="summary">
<p>Total votes: <span id="totalVotes">0</span></p>
</div>
<div class="share">
<p>Share Poll ID with peer: <code id="pollIdDisplay"></code></p>
</div>
</section>
</div>
<script src="app.js"></script>
</body>
</html>

144
package-lock.json generated
View File

@@ -1,144 +0,0 @@
{
"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,20 +0,0 @@
{
"name": "yjs-poll",
"version": "1.0.0",
"main": "index.js",
"type": "module",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"y-websocket": "y-websocket"
},
"keywords": [],
"author": "",
"license": "ISC",
"description": "",
"dependencies": {
"ws": "^8.19.0",
"@y/protocols": "^1.0.6-1",
"lib0": "^0.2.102",
"yjs": "^14.0.0-7"
}
}

104
styles.css Normal file
View File

@@ -0,0 +1,104 @@
:root {
--bg: #0f1220;
--card: #1a1740;
--text: #e8e3ff;
--muted: #b8a7d2;
--accent: #6bd3ff;
}
* {
box-sizing: border-box;
}
html,
body {
margin: 0;
padding: 0;
font-family: sans-serif;
background: #0b0a14;
color: #fff;
height: 100%;
}
.container {
max-width: 700px;
margin: 40px auto;
padding: 0 16px;
}
.card {
background: #1f1740;
border-radius: 12px;
padding: 16px;
margin-bottom: 14px;
border: 1px solid #2a1950;
}
.field {
margin-bottom: 12px;
display: flex;
gap: 8px;
align-items: center;
}
label {
min-width: 180px;
}
input[type="text"] {
flex: 1;
padding: 8px;
border-radius: 6px;
border: 1px solid #5a2d8a;
background: #2a174f;
color: #fff;
}
button {
padding: 8px 12px;
border-radius: 6px;
border: none;
background: #6bd3ff;
color: #04152a;
font-weight: bold;
cursor: pointer;
}
button:hover {
opacity: 0.95;
}
.options {
display: flex;
flex-direction: column;
gap: 8px;
margin-top: 6px;
}
.option {
display: flex;
justify-content: space-between;
align-items: center;
padding: 8px;
background: #2a174f;
border: 1px solid #40217a;
border-radius: 6px;
}
.option .text {
flex: 1;
}
.share {
font-size: 0.9em;
color: var(--muted);
}
.note {
color: #c8b5ff;
font-size: 0.9em;
}
.total {
font-weight: bold;
}

291
utils.js
View File

@@ -1,291 +0,0 @@
/* 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))
}
}
}