Compare commits
1 Commits
proposal-e
...
proposal-4
| Author | SHA1 | Date | |
|---|---|---|---|
| 7de7632101 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1 +0,0 @@
|
||||
node_modules/
|
||||
27
README.md
27
README.md
@@ -1,28 +1 @@
|
||||
# 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.
|
||||
|
||||
|
||||
31
backend.js
31
backend.js
@@ -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');
|
||||
});
|
||||
});*/
|
||||
196
frontend.html
196
frontend.html
@@ -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>
|
||||
24
p2p-poll/.gitignore
vendored
Normal file
24
p2p-poll/.gitignore
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
# Nuxt dev/build outputs
|
||||
.output
|
||||
.data
|
||||
.nuxt
|
||||
.nitro
|
||||
.cache
|
||||
dist
|
||||
|
||||
# Node dependencies
|
||||
node_modules
|
||||
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
|
||||
# Misc
|
||||
.DS_Store
|
||||
.fleet
|
||||
.idea
|
||||
|
||||
# Local env files
|
||||
.env
|
||||
.env.*
|
||||
!.env.example
|
||||
75
p2p-poll/README.md
Normal file
75
p2p-poll/README.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# Nuxt Minimal Starter
|
||||
|
||||
Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
|
||||
|
||||
## Setup
|
||||
|
||||
Make sure to install dependencies:
|
||||
|
||||
```bash
|
||||
# npm
|
||||
npm install
|
||||
|
||||
# pnpm
|
||||
pnpm install
|
||||
|
||||
# yarn
|
||||
yarn install
|
||||
|
||||
# bun
|
||||
bun install
|
||||
```
|
||||
|
||||
## Development Server
|
||||
|
||||
Start the development server on `http://localhost:3000`:
|
||||
|
||||
```bash
|
||||
# npm
|
||||
npm run dev
|
||||
|
||||
# pnpm
|
||||
pnpm dev
|
||||
|
||||
# yarn
|
||||
yarn dev
|
||||
|
||||
# bun
|
||||
bun run dev
|
||||
```
|
||||
|
||||
## Production
|
||||
|
||||
Build the application for production:
|
||||
|
||||
```bash
|
||||
# npm
|
||||
npm run build
|
||||
|
||||
# pnpm
|
||||
pnpm build
|
||||
|
||||
# yarn
|
||||
yarn build
|
||||
|
||||
# bun
|
||||
bun run build
|
||||
```
|
||||
|
||||
Locally preview production build:
|
||||
|
||||
```bash
|
||||
# npm
|
||||
npm run preview
|
||||
|
||||
# pnpm
|
||||
pnpm preview
|
||||
|
||||
# yarn
|
||||
yarn preview
|
||||
|
||||
# bun
|
||||
bun run preview
|
||||
```
|
||||
|
||||
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
|
||||
152
p2p-poll/app/app.vue
Normal file
152
p2p-poll/app/app.vue
Normal file
@@ -0,0 +1,152 @@
|
||||
|
||||
|
||||
<style>
|
||||
/* Basic styling to make it look clean */
|
||||
body {
|
||||
font-family: system-ui, -apple-system, sans-serif;
|
||||
background-color: #f4f4f9;
|
||||
color: #333;
|
||||
margin: 0;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
padding: 2rem;
|
||||
}
|
||||
|
||||
.poll-container {
|
||||
background: white;
|
||||
padding: 2rem;
|
||||
border-radius: 12px;
|
||||
box-shadow: 0 4px 6px rgba(0,0,0,0.1);
|
||||
width: 100%;
|
||||
max-width: 500px;
|
||||
}
|
||||
|
||||
header {
|
||||
margin-bottom: 2rem;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
h1 { margin: 0 0 0.5rem 0; }
|
||||
|
||||
.status {
|
||||
font-size: 0.85rem;
|
||||
color: #666;
|
||||
}
|
||||
.status .connected { color: #10b981; font-weight: bold; }
|
||||
|
||||
.add-option-form {
|
||||
display: flex;
|
||||
gap: 0.5rem;
|
||||
margin-bottom: 2rem;
|
||||
}
|
||||
|
||||
input {
|
||||
flex-grow: 1;
|
||||
padding: 0.75rem;
|
||||
border: 1px solid #ccc;
|
||||
border-radius: 6px;
|
||||
font-size: 1rem;
|
||||
}
|
||||
|
||||
button {
|
||||
background: #3b82f6;
|
||||
color: white;
|
||||
border: none;
|
||||
padding: 0.75rem 1rem;
|
||||
border-radius: 6px;
|
||||
cursor: pointer;
|
||||
font-weight: bold;
|
||||
transition: background 0.2s;
|
||||
}
|
||||
|
||||
button:hover { background: #2563eb; }
|
||||
|
||||
.poll-list {
|
||||
list-style: none;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.poll-item {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
padding: 1rem;
|
||||
background: #f8fafc;
|
||||
border: 1px solid #e2e8f0;
|
||||
border-radius: 8px;
|
||||
margin-bottom: 0.5rem;
|
||||
}
|
||||
|
||||
.option-name { font-weight: 500; }
|
||||
.vote-section { display: flex; align-items: center; gap: 1rem; }
|
||||
.vote-count { font-size: 0.9rem; color: #475569; }
|
||||
.vote-btn { padding: 0.4rem 0.8rem; background: #10b981; }
|
||||
.vote-btn:hover { background: #059669; }
|
||||
.empty-state { text-align: center; color: #94a3b8; font-style: italic; }
|
||||
</style>
|
||||
<template>
|
||||
<div class="poll-container">
|
||||
<ClientOnly>
|
||||
<header>
|
||||
<h1>P2P Polling App 🗳️</h1>
|
||||
<div class="status">
|
||||
<span :class="{ 'connected': isConnected }">
|
||||
● {{ isConnected ? 'Synced' : 'Connecting...' }}
|
||||
</span>
|
||||
<span> | Peers online: {{ connectedPeers }}</span>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<main>
|
||||
<form @submit.prevent="handleAddNewOption" class="add-option-form">
|
||||
<input
|
||||
v-model="newOption"
|
||||
type="text"
|
||||
placeholder="Enter a new poll option..."
|
||||
required
|
||||
/>
|
||||
<button type="submit">Add Option</button>
|
||||
</form>
|
||||
|
||||
<div v-if="Object.keys(pollData).length === 0" class="empty-state">
|
||||
No options yet. Be the first to add one!
|
||||
</div>
|
||||
|
||||
<ul v-else class="poll-list">
|
||||
<li v-for="(votes, optionName) in pollData" :key="optionName" class="poll-item">
|
||||
<span class="option-name">{{ optionName }}</span>
|
||||
<div class="vote-section">
|
||||
<span class="vote-count">{{ votes }} {{ votes === 1 ? 'vote' : 'votes' }}</span>
|
||||
<button @click="vote(String(optionName))" class="vote-btn">+1</button>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</main>
|
||||
<template #fallback>
|
||||
<div class="empty-state">Loading P2P Node...</div>
|
||||
</template>
|
||||
</ClientOnly>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { ref } from 'vue';
|
||||
// Manually define 'global' for the browser
|
||||
if (process.client) {
|
||||
(window as any).global = window;
|
||||
}
|
||||
import { usePoll } from '../composables/usePoll';
|
||||
|
||||
// Because WebRTC requires the browser environment (window/navigator),
|
||||
// we ensure our composable only runs on the client side in Nuxt.
|
||||
const newOption = ref('');
|
||||
|
||||
// Destructure our P2P logic
|
||||
const { pollData, isConnected, connectedPeers, addOption, vote } = usePoll();
|
||||
|
||||
const handleAddNewOption = () => {
|
||||
addOption(newOption.value);
|
||||
newOption.value = ''; // Reset input
|
||||
};
|
||||
</script>
|
||||
81
p2p-poll/composables/usePoll.ts
Normal file
81
p2p-poll/composables/usePoll.ts
Normal file
@@ -0,0 +1,81 @@
|
||||
// composables/usePoll.ts
|
||||
import { ref, onMounted, onUnmounted } from 'vue';
|
||||
import * as Y from 'yjs';
|
||||
|
||||
export const usePoll = () => {
|
||||
// Reactive Vue state to drive the UI
|
||||
const pollData = ref<Record<string, number>>({});
|
||||
const isConnected = ref(false);
|
||||
const connectedPeers = ref(1); // 1 = just you initially
|
||||
|
||||
let ydoc: Y.Doc;
|
||||
let provider: any;
|
||||
let yMap: Y.Map<number>;
|
||||
|
||||
onMounted(async () => {
|
||||
// 1. Initialize the Yjs document
|
||||
ydoc = new Y.Doc();
|
||||
|
||||
// 2. Connect via WebRTC.
|
||||
// 'nuxt-p2p-poll-demo-room' is the shared room name.
|
||||
// Anyone using this exact string will sync together.
|
||||
const { WebrtcProvider } = await import('y-webrtc');
|
||||
provider = new WebrtcProvider('nuxt-p2p-poll-demo-room', ydoc);
|
||||
|
||||
// Track connection status
|
||||
provider.on('synced', (arg: {synced: boolean}) => {
|
||||
isConnected.value = arg.synced;
|
||||
});
|
||||
|
||||
provider.on('peers', (data: any) => {
|
||||
// data.webrtcPeers contains the connected peer IDs
|
||||
connectedPeers.value = data.webrtcPeers.length + 1; // +1 for self
|
||||
});
|
||||
|
||||
// 3. Define our shared state structure. We'll use a Map
|
||||
// where the Key is the Poll Option (string) and Value is the Vote Count (number)
|
||||
yMap = ydoc.getMap<number>('shared-poll');
|
||||
|
||||
// 4. Listen for changes from other peers and update our Vue reactive state
|
||||
yMap.observe(() => {
|
||||
pollData.value = yMap.toJSON();
|
||||
});
|
||||
|
||||
// Initial load in case data already exists in the room
|
||||
pollData.value = yMap.toJSON();
|
||||
});
|
||||
|
||||
onUnmounted(() => {
|
||||
// Clean up when the component is destroyed
|
||||
if (provider) {
|
||||
provider.disconnect();
|
||||
}
|
||||
if (ydoc) {
|
||||
ydoc.destroy();
|
||||
}
|
||||
});
|
||||
|
||||
// Action: Add a new option to the poll
|
||||
const addOption = (optionName: string) => {
|
||||
const trimmedName = optionName.trim();
|
||||
if (trimmedName && !yMap.has(trimmedName)) {
|
||||
yMap.set(trimmedName, 0); // Initialize with 0 votes
|
||||
}
|
||||
};
|
||||
|
||||
// Action: Vote for an existing option
|
||||
const vote = (optionName: string) => {
|
||||
if (yMap.has(optionName)) {
|
||||
const currentVotes = yMap.get(optionName) || 0;
|
||||
yMap.set(optionName, currentVotes + 1);
|
||||
}
|
||||
};
|
||||
|
||||
return {
|
||||
pollData,
|
||||
isConnected,
|
||||
connectedPeers,
|
||||
addOption,
|
||||
vote
|
||||
};
|
||||
};
|
||||
11
p2p-poll/nuxt.config.ts
Normal file
11
p2p-poll/nuxt.config.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
// https://nuxt.com/docs/api/configuration/nuxt-config
|
||||
export default defineNuxtConfig({
|
||||
compatibilityDate: '2025-07-15',
|
||||
devtools: { enabled: true },
|
||||
ssr: false,
|
||||
vite: {
|
||||
optimizeDeps: {
|
||||
include: ['yjs', 'y-webrtc']
|
||||
}
|
||||
}
|
||||
})
|
||||
9912
p2p-poll/package-lock.json
generated
Normal file
9912
p2p-poll/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
19
p2p-poll/package.json
Normal file
19
p2p-poll/package.json
Normal file
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"name": "p2p-poll",
|
||||
"type": "module",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"build": "nuxt build",
|
||||
"dev": "nuxt dev",
|
||||
"generate": "nuxt generate",
|
||||
"preview": "nuxt preview",
|
||||
"postinstall": "nuxt prepare"
|
||||
},
|
||||
"dependencies": {
|
||||
"nuxt": "^4.1.3",
|
||||
"vue": "^3.5.30",
|
||||
"vue-router": "^5.0.3",
|
||||
"y-webrtc": "^10.3.0",
|
||||
"yjs": "^13.6.30"
|
||||
}
|
||||
}
|
||||
BIN
p2p-poll/public/favicon.ico
Normal file
BIN
p2p-poll/public/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.2 KiB |
2
p2p-poll/public/robots.txt
Normal file
2
p2p-poll/public/robots.txt
Normal file
@@ -0,0 +1,2 @@
|
||||
User-Agent: *
|
||||
Disallow:
|
||||
18
p2p-poll/tsconfig.json
Normal file
18
p2p-poll/tsconfig.json
Normal file
@@ -0,0 +1,18 @@
|
||||
{
|
||||
// https://nuxt.com/docs/guide/concepts/typescript
|
||||
"files": [],
|
||||
"references": [
|
||||
{
|
||||
"path": "./.nuxt/tsconfig.app.json"
|
||||
},
|
||||
{
|
||||
"path": "./.nuxt/tsconfig.server.json"
|
||||
},
|
||||
{
|
||||
"path": "./.nuxt/tsconfig.shared.json"
|
||||
},
|
||||
{
|
||||
"path": "./.nuxt/tsconfig.node.json"
|
||||
}
|
||||
]
|
||||
}
|
||||
144
package-lock.json
generated
144
package-lock.json
generated
@@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
20
package.json
20
package.json
@@ -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"
|
||||
}
|
||||
}
|
||||
291
utils.js
291
utils.js
@@ -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))
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user