-
Notifications
You must be signed in to change notification settings - Fork 5
/
index.ts
220 lines (202 loc) · 6.6 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
import type { Server as HTTPServer } from 'http'
import { Server, Socket } from 'socket.io'
import { applyAwarenessUpdate, Awareness, encodeAwarenessUpdate, removeAwarenessStates } from 'y-protocols/awareness'
import * as Y from 'yjs'
import { AwarenessChanges, getClients } from '../../awareness'
import type { ClientToServerEvents, ServerToClientEvents } from '../../events'
import type { Persistence } from '../../persistence'
import type { ClientId, DefaultClientData, RoomName } from '../../types'
import type { Room, RoomMap } from './room'
import type { GetUserId, UserId } from './user'
import type { CorsOptions, CorsOptionsDelegate } from 'cors'
import type { ServerOptions } from 'engine.io/build/server'
declare module 'socket.io' {
/**
* Data related to yjs
*/
interface SocketYjsData {
roomMap: RoomMap
roomName: RoomName
clientId: ClientId
}
interface Socket {
yjs: SocketYjsData
userId: UserId
}
}
export interface Options {
/**
* Handle auth and room permission
*/
getUserId?: GetUserId
persistence?: Persistence
/**
* @default false
*/
autoDeleteRoom?: boolean
/**
* cors settings
*/
cors?: CorsOptions | CorsOptionsDelegate
allowRequest?: ServerOptions['allowRequest']
}
type CreateSocketIOServer = <ClientData extends DefaultClientData = DefaultClientData>(
httpServer: HTTPServer,
options?: Options
) => Server<ClientToServerEvents, ServerToClientEvents<ClientData>>
/**
* There are four scenarios:
* 1. Signed User share sheet to specified person with write permission (both side need authorization)
* 2. Signed User share sheet to specified person with only view permission (both side need authorization)
* 3. Signed User share sheet to everyone with write permission (only one side need authorization)
* 4. Signed User share sheet to everyone with only view permission (only one side need authorization)
*
* If sheet owner close sharing (or disable sharing), others won't see the sheet anymore,
* which means we will delete the sheet in their browser.
*
* We only consider scenario 3 for now, because It's easy to implement
*/
export const createSocketIOServer: CreateSocketIOServer = <ClientData extends DefaultClientData = DefaultClientData>(
httpServer: HTTPServer,
{ getUserId, persistence, autoDeleteRoom = false, cors, allowRequest }: Options = {}
) => {
const roomMap: RoomMap = new Map()
const io = new Server<ClientToServerEvents, ServerToClientEvents<ClientData>>(httpServer, {
cors,
allowRequest
})
io.use((socket, next) => {
const { roomName, clientId } = socket.handshake.query
if (typeof roomName !== 'string') {
return next(new Error("wrong type of query parameter 'roomName'"))
}
if (typeof clientId !== 'string' || Number.isNaN(+clientId)) {
return next(new Error("wrong type of query parameter 'clientId'"))
}
socket.yjs = {
roomMap,
roomName,
clientId: Number(clientId)
}
return next()
})
io.use((socket, next) => {
const result = getUserId?.(socket) ?? socket.yjs.clientId
if (result instanceof Error) {
return next(result)
}
socket.userId = result
return next()
})
const { adapter } = io.of('/')
const isDefaultRoom = (roomName: RoomName) => {
return adapter.sids.has(roomName)
// ^^^^ Map<SocketId, Set<RoomName>>
}
adapter.on('create-room', (roomName: RoomName) => {
if (isDefaultRoom(roomName) || roomMap.has(roomName)) {
return
}
const doc = new Y.Doc()
const awareness = new Awareness(doc)
// delete local `clientId` from `awareness.getStates()` Map
awareness.setLocalState(null)
awareness.on('update', (changes: AwarenessChanges, origin: Socket['id']) => {
const changedClients = Object.values(changes).reduce((res, cur) => [...res, ...cur])
const update = encodeAwarenessUpdate(awareness, changedClients)
io.to(roomName).except(origin).emit('awareness:update', update)
})
const prepareDoc = async (): Promise<Y.Doc> => {
await persistence?.bindState(roomName, doc)
doc.on('update', (updateV1: Uint8Array, origin: Socket['id']) => {
const updateV2 = Y.convertUpdateFormatV1ToV2(updateV1)
io.to(roomName).except(origin).emit('doc:update', updateV2)
})
return doc
}
const preparingDoc = prepareDoc()
const room: Room = {
owner: null!,
awareness,
getDoc: () => preparingDoc,
destroy: async () => {
await persistence?.writeState(roomName, doc)
doc.destroy()
awareness.destroy()
}
}
roomMap.set(roomName, room)
})
if (autoDeleteRoom) {
adapter.on('delete-room', (roomName: RoomName) => {
if (isDefaultRoom(roomName) || !roomMap.has(roomName)) {
return
}
const room = roomMap.get(roomName)!
roomMap.delete(roomName)
return room.destroy()
})
}
io.on('connection', (socket) => {
const { roomName } = socket.yjs
socket.join(roomName)
const room = roomMap.get(roomName)!
if (room.owner === null) {
room.owner = socket.userId
}
const clients = getClients(room.awareness)
if (clients.length) {
const awarenessUpdate = encodeAwarenessUpdate(room.awareness, clients)
socket.emit('awareness:update', awarenessUpdate)
}
room.getDoc().then((doc) => {
const docDiff = Y.encodeStateVector(doc)
socket.emit('doc:diff', docDiff)
})
socket.on('room:close', () => {
const room = roomMap.get(roomName)
if (!room || socket.userId !== room.owner) {
return
}
io.to(roomName).disconnectSockets()
roomMap.delete(roomName)
return room.destroy()
})
socket.on('doc:diff', (diff) => {
const room = roomMap.get(roomName)
if (!room) {
return
}
room.getDoc().then((doc) => {
const updateV2 = Y.encodeStateAsUpdateV2(doc, diff)
socket.emit('doc:update', updateV2)
})
})
socket.on('doc:update', (updateV2, callback) => {
const room = roomMap.get(roomName)
if (!room) {
return
}
room.getDoc().then((doc) => {
Y.applyUpdateV2(doc, updateV2, socket.id)
callback?.()
})
})
socket.on('awareness:update', (update) => {
const room = roomMap.get(roomName)
if (!room) {
return
}
applyAwarenessUpdate(room.awareness, update, socket.id)
})
socket.on('disconnect', () => {
const room = roomMap.get(roomName)
if (!room) {
return
}
const { clientId } = socket.yjs
removeAwarenessStates(room.awareness, [clientId], socket.id)
})
})
return io
}