-
-
Notifications
You must be signed in to change notification settings - Fork 261
/
server.ts
275 lines (243 loc) · 7.85 KB
/
server.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
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
import { EventEmitter } from "events";
import { Connection } from "./connection";
import { ActionProcessor } from "./actionProcessor";
import { Api } from "./api";
import { log } from "../modules/log";
let api: Api;
interface ServerConfig {
[key: string]: any;
}
/**
* Create a new ActionHero Server. The required properties of an server. These can be defined statically (this.name) or as methods which return a value.
*/
export abstract class Server extends EventEmitter {
/**The name & type of the server. */
type: string;
/**What connection verbs can connections of this type use? */
verbs?: Array<string>;
/**Shorthand for `api.config.servers[this.type]` */
config?: ServerConfig;
options?: {
[key: string]: any;
};
/** attributes of the server */
attributes: {
[key: string]: any;
};
/**Can connections of this server use the chat system? */
canChat: boolean;
/**Should we log every new connection? */
logConnections: boolean;
/**Should we log when a connection disconnects/exits? */
logExits: boolean;
/**Should every new connection of this server type receive the welcome message (defined in locales, `actionhero.welcomeMessage`) */
sendWelcomeMessage: boolean;
/**Methods described by the server to apply to each connection (like connection.setHeader for web connections) */
connectionCustomMethods: {
[key: string]: Function;
};
/**An optional message to send to clients when they disconnect */
goodbye?: Function;
/**A place to store the actually server object you create */
server?: any;
constructor() {
// Only in files required by `index.js` do we need to delay the loading of the API object
// This is due to cyclical require issues
api = require("../index").api;
super();
this.options = {};
this.attributes = {};
this.config = {}; // will be applied by the initializer
this.connectionCustomMethods = {};
const defaultAttributes = this.defaultAttributes();
for (const key in defaultAttributes) {
if (!this.attributes[key]) {
this.attributes[key] = defaultAttributes[key];
}
if (typeof this.attributes[key] === "function") {
this.attributes[key] = this[key]();
}
}
}
/**
* Event called when a formal new connection is created for this server type. This is a response to calling ActionHero.Server#buildConnection
*
* @event ActionHero.Server#connection
*/
/**
* Event called when a an action is complete for a connection created by this server. You may want to send a response to the client as a response to this event.
*
* @event ActionHero.Server#actionComplete
* @property {object} data - The same data from the Action. Includes the connection, response, etc.
*/
/**
* Method run as part of the `initialize` lifecycle of your server. Usually configures the server.
*/
abstract async initialize(): Promise<void>;
/**
* Method run as part of the `start` lifecycle of your server. Usually boots the server (listens on port, etc).
*/
abstract async start(): Promise<void>;
/**
* Method run as part of the `stop` lifecycle of your server. Usually configures the server (disconnects from port, etc).
*/
abstract async stop(): Promise<void>;
/**
* Must be defined explaining how to send a message to an individual connection.
*/
abstract async sendMessage(
connection: Connection,
message: string | object | Array<any>,
messageId?: string
): Promise<void>;
/**
* Must be defined explaining how to send a file to an individual connection. Might be a noop for some connection types.
*/
abstract async sendFile(
connection: Connection,
error: Error,
fileStream: any,
mime: string,
length: number,
lastModified: Date
): Promise<void>;
defaultAttributes() {
return {
type: null,
canChat: true,
logConnections: true,
logExits: true,
sendWelcomeMessage: true,
verbs: []
};
}
validate() {
if (!this.type) {
throw new Error("type is required for this server");
}
[
"start",
"stop",
"sendFile", // connection, error, fileStream, mime, length, lastModified
"sendMessage", // connection, message
"goodbye"
].forEach(method => {
if (!this[method] || typeof this[method] !== "function") {
throw new Error(
`${method} is a required method for the server \`${this.type}\``
);
}
});
}
/**
* * Build a the ActionHero.Connection from the raw parts provided by the server.
* ```js
*this.buildConnection({
* rawConnection: {
* req: req,
* res: res,
* params: {},
* method: method,
* cookies: cookies,
* responseHeaders: responseHeaders,
* responseHttpCode: responseHttpCode,
* parsedURL: parsedURL
* },
* id: fingerprint + '-' + uuid.v4(),
* fingerprint: fingerprint,
* remoteAddress: remoteIP,
* remotePort: remotePort
*})
* ```
*/
async buildConnection(data: any) {
const details = {
type: this.type,
id: data.id,
remotePort: data.remotePort,
remoteIP: data.remoteAddress,
rawConnection: data.rawConnection,
messageId: data.messageId,
canChat: null,
fingerprint: null
};
if (this.attributes.canChat === true) {
details.canChat = true;
}
if (data.fingerprint) {
details.fingerprint = data.fingerprint;
}
const connection = await Connection.createAsync(details);
connection.sendMessage = async message => {
this.sendMessage(connection, message);
};
connection.sendFile = async path => {
connection.params.file = path;
this.processFile(connection);
};
this.emit("connection", connection);
if (this.attributes.logConnections === true) {
this.log("new connection", "info", { to: connection.remoteIP });
}
if (this.attributes.sendWelcomeMessage === true) {
connection.sendMessage({
welcome: connection.localize("actionhero.welcomeMessage"),
context: "api"
});
}
if (typeof this.attributes.sendWelcomeMessage === "number") {
setTimeout(() => {
try {
connection.sendMessage({
welcome: connection.localize("actionhero.welcomeMessage"),
context: "api"
});
} catch (e) {
this.log(e, "error");
}
}, this.attributes.sendWelcomeMessage);
}
}
/**
* When a connection has called an Action command, and all properties are set. Connection should have `params.action` set at least.
* on(event: 'actionComplete', cb: (data: object) => void): this;
*/
async processAction(connection: Connection) {
const actionProcessor = new ActionProcessor(connection);
const data = await actionProcessor.processAction();
this.emit("actionComplete", data);
}
/**
* When a connection has called an File command, and all properties are set. Connection should have `params.file` set at least. Will eventually call ActionHero.Server#sendFile.
*/
async processFile(connection: Connection) {
const results = await api.staticFile.get(connection);
this.sendFile(
results.connection,
results.error,
results.fileStream,
results.mime,
results.length,
results.lastModified
);
}
/**
* Enumerate the connections for this server type on this server.
*/
connections(): Array<Connection> {
const connections = [];
for (const i in api.connections.connections) {
const connection = api.connections.connections[i];
if (connection.type === this.type) {
connections.push(connection);
}
}
return connections;
}
/**
* Log a message from this server type. A wrapper around log() with a server prefix.
*/
log(message: string, severity?: string, data?: any) {
log(`[server: ${this.type}] ${message}`, severity, data);
}
}