-
Notifications
You must be signed in to change notification settings - Fork 47
/
index.js
296 lines (251 loc) · 6.87 KB
/
index.js
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
"use strict";
const http = require( 'http' )
const socketIO = require( 'socket.io' )
const compose = require( 'koa-compose' )
const Socket = require( './lib/socket' )
/**
* Main IO class that handles the socket.io connections
* @class
*/
module.exports = class IO {
/**
* @constructs
* @param namespace <String> namespace identifier
*/
constructor( opts ) {
if ( opts && !(typeof opts !== 'string' || opts && typeof opts !== 'object' ) ) {
throw new Error( 'Incorrect argument passed to koaSocket constructor' )
}
/**
* List of middlewares, these are composed into an execution chain and
* evaluated with each event
* @type <Array:Function>
*/
this.middleware = []
/**
* Composed middleware stack
* @type <Function>
*/
this.composed = null
/**
* All of the listeners currently added to the IO instance
* event:callback
* @type <Map>
*/
this.listeners = new Map()
/**
* All active connections
* id:Socket
* @type <Map>
*/
this.connections = new Map()
/**
* Configuration options
* @type <Object>
*/
if ( typeof opts === 'string' ) {
opts = {
namespace: opts
}
}
this.opts = Object.assign({
/**
* Namespace id
* @type <String>
* @default null
*/
namespace: null,
/**
* Hidden instances do not append to the koa app, but still require attachment
* @type <Boolean>
* @default false
*/
hidden: false,
/**
* Options to pass when instantiating socket.io
* @type <Object>
* @default {}
*/
ioOptions: {}
}, opts )
/**
* Holds the socketIO connection
* @type <Socket.IO>
*/
this.socket = null
// Bind handlers
this.onConnection = this.onConnection.bind( this )
this.onDisconnect = this.onDisconnect.bind( this )
}
/**
* Attach to a koa application
* @param app <Koa app> the koa app to use
*/
attach( app ) {
if ( app.server && app.server.constructor.name != 'Server' ) {
throw new Error( 'app.server already exists but it\'s not an http server' );
}
if ( !app.server ) {
// Create a server if it doesn't already exists
app.server = http.createServer( app.callback() )
// Patch `app.listen()` to call `app.server.listen()`
app.listen = function listen(){
app.server.listen.apply( app.server, arguments )
return app.server
}
}
if ( app._io ) {
// Without a namespace we’ll use the default, but .io already exists meaning
// the default is taken already
if ( !this.opts.namespace ) {
throw new Error( 'Socket failed to initialise::Instance may already exist' )
}
this.attachNamespace( app, this.opts.namespace )
return
}
if ( this.opts.hidden && !this.opts.namespace ) {
throw new Error( 'Default namespace can not be hidden' )
}
app._io = new socketIO( app.server, this.opts.ioOptions )
if ( this.opts.namespace ) {
this.attachNamespace( app, this.opts.namespace )
return
}
// Attach default namespace
app.io = this
// If there is no namespace then connect using the default
this.socket = app._io
this.socket.on( 'connection', this.onConnection )
}
/**
* Attaches the namespace to the server
* @param app <Koa app> the koa app to use
* @param id <String> namespace identifier
*/
attachNamespace( app, id ) {
if ( !app._io ) {
throw new Error( 'Namespaces can only be attached once a socketIO instance has been attached' )
}
this.socket = app._io.of( id )
this.socket.on( 'connection', this.onConnection )
if ( this.opts.hidden ) {
return
}
if ( app[ id ] ) {
throw new Error( 'Namespace ' + id + ' already attached to koa instance' )
}
app[ id ] = this
}
/**
* Pushes a middleware on to the stack
* @param fn <Function> the middleware function to execute
*/
use( fn ) {
this.middleware.push( fn )
this.composed = compose( this.middleware )
this.updateConnections()
return this
}
/**
* Adds a new listeners to the stack
* @param event <String> the event id
* @param handler <Function> the callback to execute
* @return this
*/
on( event, handler ) {
let listeners = this.listeners.get( event )
// If this is a new event then just set it
if ( !listeners ) {
this.listeners.set( event, [ handler ] )
this.updateConnections()
return this
}
listeners.push( handler )
this.listeners.set( event, listeners )
this.updateConnections()
return this
}
/**
* Removes a listener from the event
* @param event <String> if omitted will remove all listeners
* @param handler <Function> if omitted will remove all from the event
* @return this
*/
off( event, handler ) {
if ( !event ) {
this.listeners = new Map()
this.updateConnections()
return this
}
if ( !handler ) {
this.listeners.delete( event )
this.updateConnections()
return this
}
let listeners = this.listeners.get( event )
let i = listeners.length - 1
while( i ) {
if ( listeners[ i ] === handler ) {
break
}
i--
}
listeners.splice( i, 1 )
this.updateConnections()
return this
}
/**
* Broadcasts an event to all connections
* @param event <String>
* @param data <?>
*/
broadcast( event, data ) {
this.connections.forEach( ( socket, id ) => {
socket.emit( event, data )
})
}
/**
* Triggered for each new connection
* Creates a new Socket instance and adds that to the stack and sets up the
* disconnect event
* @param sock <Socket.io Socket>
* @private
*/
onConnection( sock ) {
// let instance = new Socket( sock, this.listeners, this.middleware )
let instance = new Socket( sock, this.listeners, this.composed )
this.connections.set( sock.id, instance )
sock.on( 'disconnect', () => {
this.onDisconnect( sock )
})
// Trigger the connection event if attached to the socket listener map
let handlers = this.listeners.get( 'connection' )
if ( handlers ) {
handlers.forEach( handler => {
handler({
event: 'connection',
data: instance,
socket: instance.socket
}, instance.id )
})
}
}
/**
* Fired when the socket disconnects, simply reflects stack in the connections
* stack
* @param sock <Socket.io Socket>
* @private
*/
onDisconnect( sock ) {
this.connections.delete( sock.id )
}
/**
* Updates all existing connections with current listeners and middleware
* @private
*/
updateConnections() {
this.connections.forEach( connection => {
connection.update( this.listeners, this.composed )
})
}
}