-
Notifications
You must be signed in to change notification settings - Fork 0
/
lazy.js
379 lines (350 loc) · 12.7 KB
/
lazy.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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
'use strict'
const express = require('express');
const bodyParser = require('body-parser');
const cookieParser = require('cookie-parser');
const cors = require('cors');
const path = require('path');
const http = require('http');
const fs = require("fs");
const LazyDB = require("./lazy.db");
const LazyEndpoint = require('./lazy.controller');
const LazyIO = require('./lazy.io');
const {LazyTestEnv} = require('./lazy.test');
const {LazyTypes} = require('./lazy.utils')
const TINY_DEFAULTS = {
RUNNING_PORT: 4000,
SEARCH_PATH: "/endpoint",
ALLOWED_ORIGINS: []
}
/**
* @class
* Describes Lazy framework environment
*/
class Lazy{
/**
* @constructor
* Constructs Lazy Class
*/
constructor(){
if(!instance){
this._endpoints = {};
this.app = express();
instance = this;
}
return instance;
}
set port(port = TINY_DEFAULTS.RUNNING_PORT){
if(!LazyTypes.isNumber(port)){
throw new Error(`Lazy's "port" parameter should be a number. got ${LazyTypes.getFullType(port)}.`);
}
this._port = port;
}
set searchPath(searchPath = TINY_DEFAULTS.CONTROLLERS_PATH){
if(!LazyTypes.isString(searchPath)){
throw new Error(`Lazy's "searchPath" parameter should be a string. got ${LazyTypes.getFullType(searchPath)}.`);
}
this._searchPath = searchPath;
}
set allowedOrigins(allowedOrigins = TINY_DEFAULTS.ORIGIN_WHITELIST){
if(!LazyTypes.isArray(allowedOrigins)){
throw new Error(`Lazy's "whitelist" parameter should be an array. got ${LazyTypes.getFullType(allowedOrigins)}`);
}
this._allowedOrigins = allowedOrigins;
}
set app(app){
if(this._app){
throw new Error(`Cannot reset app at runtime`);
}
LazyTestEnv.app = app;
this._app = app;
}
set server(server){
if(this._server){
throw new Error(`Cannot reset server at runtime`);
}else if(!(server instanceof http.Server)){
throw new Error(`server should be an instabnce of Server. got ${server.constructor.name}`);
}
this._server = server;
}
set serverAuth(serverAuthFunctionHandle){
this._serverAuth = serverAuthFunctionHandle
}
set ioAuth(ioAuthFunctionHandle){
this._ioAuth = ioAuthFunctionHandle;
}
get serverAuth(){
return this._serverAuth ? this._serverAuth.proxiedProp ? this._serverAuth.proxiedProp : this._serverAuth : ((req, res, next)=>{next();});
}
get ioAuth(){
return this._ioAuth ? this._ioAuth.proxiedProp ? this._ioAuth.proxiedProp : this._ioAuth : ((socket, next)=>{next();});;
}
/**
* Lazy API port
* @type {Number}
*/
get port(){
return this._port || TINY_DEFAULTS.RUNNING_PORT;
}
/**
* Lazy files rootpath
* @type {String}
*/
get searchPath(){
return this._searchPath || TINY_DEFAULTS.SEARCH_PATH;
}
/**
* Lazy API server origin whitelist
* @type {String}
*/
get allowedOrigins(){
return this._allowedOrigins || TINY_DEFAULTS.ALLOWED_ORIGINS;
}
/**
* Lazy express app handle
* @type {Object}
*/
get app(){
return this._app;
}
/**
* Lazy server instance
* @type {Server}
*/
get server(){
return this._server;
}
/**
* Lazy endpoint collection
* @type {Object}
*/
get endpoints(){
return this._endpoints;
}
/**
* Dynamically requires an endpoint from the endpoint collection
* @method require
* @public
* @param {String} endpointName the (uniquely identified) name of the endpoint to require
* @returns {Proxy} A javascript proxy handling resource fetching at runtime
*/
require(endpointName){
if(!this.endpoints.hasOwnProperty(endpointName)){
this.endpoints[endpointName] = {};
}
const handler = {
get: (target, prop, receiver) =>{
if(this.endpoints[endpointName].instance){
return this.endpoints[endpointName].instance[prop]
}else{
return new Proxy(this.endpoints[endpointName], {
get: (target, key) => {
switch(key){
case "instance":
return this.endpoints[endpointName].instance;
case "proxiedProp":
return this.endpoints[endpointName].instance[prop];
default:
throw new Error(
`Invalid LazyRequired instance property .
Either user <LazyRequiredObj>.instance to get object
instance or "<LazyRequiredObj>.proxiedProp" to retrieve proxied prop value.`
);
}
}
})
}
}
}
return new Proxy(this.endpoints[endpointName], handler)
}
/**
* Configures and runs Lazy framework
* @method config
* @param {Object} config
* @private
* @async
*/
async config(config){
try{
if(!config.searchPath){
throw new Error(`Lazy configuration is lacking an "endpoints" configuration object.`)
}else if(!config.server){
throw new Error(`Lazy configuration is lacking a "server" configuration object.`)
}else if(!config.db){
throw new Error(`Lazy configuration is lacking a "db" configuration object.`)
}
this.searchPath = config.searchPath;
this.port = config.server.port;
this.allowedOrigins = config.server.allowedOrigins;
this.serverAuth = config.server.auth
await LazyDB.init(config.db)
await this._setupServer();
if(config.io){
//Proxying authfunction so Lazy.require can be used TODO: find a way to do that elegantly
this.ioAuth = config.io.auth;
LazyIO.init(
this.server,
this.ioAuth,
config.io.onConnect,
config.io.pingInterval,
config.io.pingTimeout,
config.io.useCookie
);
};
this._printInfo();
}catch(err){
console.log(err);
}
}
/**
* Generates/updates database's models following endpoints descriptions
* @method migrate
* @public
* @async
*/
async migrate(){
for(var i=0; i<Object.keys(this.endpoints).length; i++){
await this.endpoints[Object.keys(this.endpoints)[i]].instance.makeTable()
}
for(var i=0; i<Object.keys(this.endpoints).length; i++){
await this.endpoints[Object.keys(this.endpoints)[i]].instance.makeRelations()
}
}
/**
* Sets up Framework.
* Fetches lazy configuration files.
* Configures app router.
* Generates HTTP server
* @method _setupServer
* @private
* @async
*/
async _setupServer(){
//TODO: check if some of these may be removed/configured furthermore
this.app.options('*', cors({
credentials: true,
preflightContinue: true,
origin: this._setCorsOrigins.bind(this)
}));
this.app.use(function(req, res, next){
if(req.method === 'OPTIONS'){
res.status(204).end(0);
}else{
next();
}
})
this.app.use(cors({
credentials: true,
preflightContinue: true,
origin: this._setCorsOrigins.bind(this)
}))
this.app.use(bodyParser.urlencoded({ extended: true }));
this.app.use(bodyParser.json());
this.app.use(cookieParser());
this.app.use(function(req, res, next){
res.setHeader('X-Content-Type-Options','nosniff');
res.setHeader('X-XSS-Protection','1; mode=block');
res.setHeader('X-Frame-Options','DENY');
res.setHeader('Pragma','no-cache');
res.setHeader('Cache-Control','private, no-cache, no-store, must-revalidate');
next();
});
this._fetchControllers(this.searchPath);
Object.keys(this.endpoints).forEach((name) => {
let config = this.endpoints[name].config
let controller = this.endpoints[name].instance = new LazyEndpoint(config.name, config.model, config.endpoint, config.methods);
if(controller.router){
this.app.use(Lazy._makeMiddlewareContext, controller.router);
}
})
await this.migrate();
this.app.use(LazyEndpoint._fallbackNotFound);
this.app.use(LazyEndpoint._handleError);
this.server = http.createServer(this.app).listen(this.port);
}
/**
* Recursively searches and fetches lazy configuration files
* located within search path.
* @see This is stolen straight from stackoverflow: https://stackoverflow.com/questions/25460574/find-files-by-extension-html-under-a-folder-in-nodejs
* @param {String} rootPath current search path
* @todo This could be improved.
* @todo Find another way to handle protected routes middleware function binding
*/
_fetchControllers(rootPath){
let filter = ".lazy.js"
if (!fs.existsSync(rootPath)){ return; }
var files = fs.readdirSync(rootPath);
for(var i=0; i<files.length; i++){
var filename = path.join(rootPath,files[i]);
var stat = fs.lstatSync(filename);
if (stat.isDirectory()){
this._fetchControllers(filename);
}else if (filename.indexOf(filter) >= 0) {
let config = require(filename);
this.endpoints[config.name] = {
path: filename,
config: config,
instance: {},
}
};
};
}
/**
* Checks if the origin is allowed to emit a request to the server
* @param {string} origin the query originator
* @param {callback} the callback called on function end/result
*/
_setCorsOrigins(origin,callback){
if (this.allowedOrigins.indexOf(origin) !== -1) {
callback(null, true)
} else {
let err = new Error('Forbidden');
err.status = 403;
err.hint = "Origin is not allowed";
callback(err);
}
}
/**
* Prints Framework information following setup.
* @todo Handle tables better ?
* @todo Add configuration option to disable watermark
* @todo Add configuration option to silent print
*/
_printInfo(){
console.log("\n\n██╗ █████╗ ███████╗██╗ ██╗");
console.log("██║ ██╔══██╗╚══███╔╝╚██╗ ██╔╝");
console.log("██║ ███████║ ███╔╝ ╚████╔╝ ");
console.log("██║ ██╔══██║ ███╔╝ ╚██╔╝ ");
console.log("███████╗██║ ██║███████╗ ██║ ");
console.log("╚═WW═══╝╚═╝ ╚═╝╚══════╝ ╚W╝");
console.log(" || ____///__ || ");
console.log(" | | / _______ \\ | |");
console.log(" | | / /_ _\\ \\ | |");
console.log(" | | | _-) o (-_ | | |");
console.log(" | \\____| \\___^___/ |_____/ |");
console.log(" \\ /\n");
console.table([{
version: require('./package.json').version,
searchPath: this.searchPath,
port: this.port,
io: LazyIO.isInit ? 'enabled' : 'disabled'
}]);
console.table(Object.keys(this.endpoints).map(name => {
let endpoint = this.endpoints[name].instance;
return{
name: endpoint.name,
virtual: endpoint.virtual,
protected: endpoint.protected,
methods: endpoint.methods.map(method => method.type.toUpperCase()).join(",")
}
}));
}
static _makeMiddlewareContext(req, res, next){
req.$lazy = {
params: [],
}
next();
}
}
var instance = new Lazy();
module.exports = instance;