-
Notifications
You must be signed in to change notification settings - Fork 50
/
SocketControllerExecutor.ts
250 lines (218 loc) · 10.1 KB
/
SocketControllerExecutor.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
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
import { MetadataBuilder } from './metadata-builder/MetadataBuilder';
import { ActionMetadata } from './metadata/ActionMetadata';
import { classToPlain, ClassTransformOptions, plainToClass } from 'class-transformer';
import { ActionTypes } from './metadata/types/ActionTypes';
import { ParamMetadata } from './metadata/ParamMetadata';
import { ParameterParseJsonError } from './error/ParameterParseJsonError';
import { ParamTypes } from './metadata/types/ParamTypes';
import { ControllerMetadata } from './metadata/ControllerMetadata';
import { pathToRegexp } from 'path-to-regexp';
/**
* Registers controllers and actions in the given server framework.
*/
export class SocketControllerExecutor {
// -------------------------------------------------------------------------
// Public properties
// -------------------------------------------------------------------------
/**
* Indicates if class-transformer package should be used to perform message body serialization / deserialization.
* By default its enabled.
*/
useClassTransformer: boolean;
/**
* Global class transformer options passed to class-transformer during classToPlain operation.
* This operation is being executed when server returns response to user.
*/
classToPlainTransformOptions: ClassTransformOptions;
/**
* Global class transformer options passed to class-transformer during plainToClass operation.
* This operation is being executed when parsing user parameters.
*/
plainToClassTransformOptions: ClassTransformOptions;
// -------------------------------------------------------------------------
// Private properties
// -------------------------------------------------------------------------
private metadataBuilder: MetadataBuilder;
// -------------------------------------------------------------------------
// Constructor
// -------------------------------------------------------------------------
constructor(private io: any) {
this.metadataBuilder = new MetadataBuilder();
}
// -------------------------------------------------------------------------
// Public Methods
// -------------------------------------------------------------------------
execute(controllerClasses?: Function[], middlewareClasses?: Function[]) {
this.registerControllers(controllerClasses);
this.registerMiddlewares(middlewareClasses);
}
// -------------------------------------------------------------------------
// Private Methods
// -------------------------------------------------------------------------
/**
* Registers middlewares.
*/
private registerMiddlewares(classes?: Function[]): this {
const middlewares = this.metadataBuilder.buildMiddlewareMetadata(classes);
middlewares
.sort((middleware1, middleware2) => middleware1.priority - middleware2.priority)
.forEach(middleware => {
this.io.use((socket: any, next: (err?: any) => any) => {
middleware.instance.use(socket, next);
});
});
return this;
}
/**
* Registers controllers.
*/
private registerControllers(classes?: Function[]): this {
const controllers = this.metadataBuilder.buildControllerMetadata(classes);
const controllersWithoutNamespaces = controllers.filter(ctrl => !ctrl.namespace);
const controllersWithNamespaces = controllers.filter(ctrl => !!ctrl.namespace);
// register controllers without namespaces
this.io.on('connection', (socket: any) => this.handleConnection(controllersWithoutNamespaces, socket));
// register controllers with namespaces
controllersWithNamespaces.forEach(controller => {
let namespace: string | RegExp = controller.namespace;
if (!(namespace instanceof RegExp)) {
namespace = pathToRegexp(namespace);
}
this.io.of(namespace).on('connection', (socket: any) => this.handleConnection([controller], socket));
});
return this;
}
private handleConnection(controllers: ControllerMetadata[], socket: any) {
controllers.forEach(controller => {
controller.actions.forEach(action => {
if (action.type === ActionTypes.CONNECT) {
this.handleAction(action, { socket: socket })
.then(result => this.handleSuccessResult(result, action, socket))
.catch(error => this.handleFailResult(error, action, socket));
} else if (action.type === ActionTypes.DISCONNECT) {
socket.on('disconnect', () => {
this.handleAction(action, { socket: socket })
.then(result => this.handleSuccessResult(result, action, socket))
.catch(error => this.handleFailResult(error, action, socket));
});
} else if (action.type === ActionTypes.MESSAGE) {
socket.on(action.name, (data: any) => {
// todo get multiple args
this.handleAction(action, { socket: socket, data: data })
.then(result => this.handleSuccessResult(result, action, socket))
.catch(error => this.handleFailResult(error, action, socket));
});
}
});
});
}
private handleAction(action: ActionMetadata, options: { socket?: any; data?: any }): Promise<any> {
// compute all parameters
const paramsPromises = action.params
.sort((param1, param2) => param1.index - param2.index)
.map(param => {
if (param.type === ParamTypes.CONNECTED_SOCKET) {
return options.socket;
} else if (param.type === ParamTypes.SOCKET_IO) {
return this.io;
} else if (param.type === ParamTypes.SOCKET_QUERY_PARAM) {
return options.socket.handshake.query[param.value];
} else if (param.type === ParamTypes.SOCKET_ID) {
return options.socket.id;
} else if (param.type === ParamTypes.SOCKET_REQUEST) {
return options.socket.request;
} else if (param.type === ParamTypes.SOCKET_ROOMS) {
return options.socket.rooms;
} else if (param.type === ParamTypes.NAMESPACE_PARAMS) {
return this.handleNamespaceParams(options.socket, action, param);
} else if (param.type === ParamTypes.NAMESPACE_PARAM) {
const params: any[] = this.handleNamespaceParams(options.socket, action, param);
return params[param.value];
} else {
return this.handleParam(param, options);
}
});
// after all parameters are computed
const paramsPromise = Promise.all(paramsPromises).catch(error => {
console.log('Error during computation params of the socket controller: ', error);
throw error;
});
return paramsPromise.then(params => {
return action.executeAction(params);
});
}
private handleParam(param: ParamMetadata, options: { socket?: any; data?: any }) {
let value = options.data;
if (value !== null && value !== undefined && value !== '') value = this.handleParamFormat(value, param);
// if transform function is given for this param then apply it
if (param.transform) value = param.transform(value, options.socket);
return value;
}
private handleParamFormat(value: any, param: ParamMetadata): any {
const format = param.reflectedType;
const formatName = format instanceof Function && format.name ? format.name : format instanceof String ? format : '';
switch (formatName.toLowerCase()) {
case 'number':
return +value;
case 'string':
return value;
case 'boolean':
if (value === 'true') {
return true;
} else if (value === 'false') {
return false;
}
return !!value;
default:
const isObjectFormat = format instanceof Function || formatName.toLowerCase() === 'object';
if (value && isObjectFormat) value = this.parseParamValue(value, param);
}
return value;
}
private parseParamValue(value: any, paramMetadata: ParamMetadata) {
try {
const parseValue = typeof value === 'string' ? JSON.parse(value) : value;
if (paramMetadata.reflectedType !== Object && paramMetadata.reflectedType && this.useClassTransformer) {
const options = paramMetadata.classTransformOptions || this.plainToClassTransformOptions;
return plainToClass(paramMetadata.reflectedType, parseValue, options);
} else {
return parseValue;
}
} catch (er) {
throw new ParameterParseJsonError(value);
}
}
private handleSuccessResult(result: any, action: ActionMetadata, socket: any) {
if (result !== null && result !== undefined && action.emitOnSuccess) {
const transformOptions = action.emitOnSuccess.classTransformOptions || this.classToPlainTransformOptions;
const transformedResult =
this.useClassTransformer && result instanceof Object ? classToPlain(result, transformOptions) : result;
socket.emit(action.emitOnSuccess.value, transformedResult);
} else if ((result === null || result === undefined) && action.emitOnSuccess && !action.skipEmitOnEmptyResult) {
socket.emit(action.emitOnSuccess.value);
}
}
private handleFailResult(result: any, action: ActionMetadata, socket: any) {
if (result !== null && result !== undefined && action.emitOnFail) {
const transformOptions = action.emitOnSuccess.classTransformOptions || this.classToPlainTransformOptions;
let transformedResult =
this.useClassTransformer && result instanceof Object ? classToPlain(result, transformOptions) : result;
if (result instanceof Error && !Object.keys(transformedResult).length) {
transformedResult = result.toString();
}
socket.emit(action.emitOnFail.value, transformedResult);
} else if ((result === null || result === undefined) && action.emitOnFail && !action.skipEmitOnEmptyResult) {
socket.emit(action.emitOnFail.value);
}
}
private handleNamespaceParams(socket: any, action: ActionMetadata, param: ParamMetadata): any[] {
const keys: any[] = [];
const regexp = pathToRegexp(action.controllerMetadata.namespace, keys);
const parts: any[] = regexp.exec(socket.nsp.name);
const params: any[] = [];
keys.forEach((key: any, index: number) => {
params[key.name] = this.handleParamFormat(parts[index + 1], param);
});
return params;
}
}