-
Notifications
You must be signed in to change notification settings - Fork 0
/
app.js
757 lines (662 loc) · 17.4 KB
/
app.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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
require("dotenv").config();
const crypto = require("crypto");
const compression = require("compression");
const cors = require("cors");
const express = require("express");
const helmet = require("helmet");
const morgan = require("morgan");
const postgres = require("postgres");
const app = express();
// Database connection.
const sql = postgres({
host: process.env.DB_HOST,
port: process.env.DB_PORT,
database: process.env.DB_NAME,
username: process.env.DB_USER,
password: process.env.DB_PASS,
types: {
date: {
to: 1184,
from: [1082, 1083, 1114, 1184],
serialize: (date) => date,
parse: (date) => new Date(date).toLocaleDateString(),
},
},
debug: console.log,
});
// Middleware.
app.use(morgan("tiny"));
app.use(cors());
app.use(helmet());
app.use(compression());
app.use(express.json());
// Custom middleware.
// Auth: Check if the user is authenticated
// or not via passed header token - Authorization.
const auth = async (req, res, next) => {
const authorization = req.get("Authorization");
if (!authorization) {
return res.status(400).json({ error: "Authorization token is required" });
}
const [token, userId] = authorization.split("-");
if (!token || !userId) {
return res.status(400).json({ error: "Corrupted token" });
}
try {
const user = await sql`
select
*
from
tokens
where
"userId" = ${userId} and
token = ${token}
`.then(([x]) => x);
if (!user) {
return res.status(400).json({ error: "Invalid token" });
}
req.userId = user.id;
next();
} catch (err) {
next(err);
}
};
// Middleware: Get the org level permission.
const org = async (req, res, next) => {
try {
const org = await sql`
select
*
from
orgs
where
"isActive" = true
`.then(([x]) => x);
if (!org) {
return res.status(403).json({
error: "Permission denied",
});
}
// Do the required adjustments to shape the
// org.module.action object.
req.org = {
companies: {
access: org.canAccessCompanies,
read: org.canReadCompanies,
create: org.canCreateCompanies,
update: org.canUpdateCompanies,
remove: org.canRemoveCompanies,
},
};
next();
} catch (err) {
next(err);
}
};
// Middleware: Get the user level permission.
const permission = async (req, res, next) => {
try {
const permission = await sql`
select
*
from
permissions
where
"isActive" = true
`.then(([x]) => x);
if (!permission) {
return res.status(403).json({
error: "Permission denied",
});
}
// Do the required adjustments to shape the
// permission.module.action object.
req.permission = {
companies: {
access: permission.canAccessCompanies,
read: permission.canReadCompanies,
create: permission.canCreateCompanies,
update: permission.canUpdateCompanies,
remove: permission.canRemoveCompanies,
},
};
next();
} catch (err) {
next(err);
}
};
// Middleware: Get the active fields for companies.
const fields = (module) => {
return async (req, res, next) => {
try {
const moduleFields = await sql`
select
*
from
fields
where
"isActive" = true and
module = ${module}
`;
// Do the required adjustments to fetch
// the fields in pattern of
// req.fields.module.name
let fields = {};
for (const moduleField of moduleFields) {
fields[moduleField.name] = moduleField.displayName;
}
req.fields = {
companies: fields,
};
next();
} catch (err) {
next(err);
}
};
};
// Middleware: Check if the org has permission to
// run the "action" on given "module"
const orgCan = (action, module) => {
return (req, res, next) => {
// As both "module" and "action" are dynamic,
// can't use . notation to get the values.
if (!req.org[module][action]) {
return res.status(403).json({
error: `Permission denied: org can't ${action} ${module}`,
});
}
next();
};
};
// Middleware: Check if the user has permission to
// run the "action" on given "module"
const userCan = (action, module) => {
return (req, res, next) => {
// As both "module" and "action" are dynamic,
// can't use . notation to get the values.
if (!req.permission[module][action]) {
return res.status(403).json({
error: `Permission denied: user can't ${action} ${module}`,
});
}
next();
};
};
// Helpers
// Helper: Check if the given parameter
// is number or not.
const isNum = (id) => {
if (isNaN(id) || parseInt(id, 10) !== +id) {
return false;
}
return true;
};
// Helper: Check if the company
// exists or not based on passed id.
const isCompanyExists = async (id) => {
return await sql`
select
id
from
companies
where
id = ${id}
`.then(([x]) => x);
};
// Helper: Generate SHA256 has for the given value.
const generateSHA256 = (value) => {
return crypto.createHash("sha256").update(value).digest("hex");
};
// Helper: Generate random string of length 2 * size.
const generateRandom = (size) => {
return crypto.randomBytes(size).toString("hex");
};
// Routes.
app.get("/", (req, res) => {
res.json({ message: "Application is up and running!" });
});
// Auth.
app.use("/auth", (req, res, next) => {
console.log("[auth]: accessing auth protected end-points");
next();
});
// POST http://localhost:3000/auth/login
app.post("/auth/login", async (req, res, next) => {
const { email, password } = req.body;
// Single and guided validation.
if (!email) {
return res.status(400).json({ error: "Email is required" });
}
if (!password) {
return res.status(400).json({ error: "Password is required" });
}
const passwordHash = generateSHA256(password);
try {
// Check first the email.
// User with given email is exist or not.
const user = await sql`
select
*
from
users
where
email = ${email}
`.then(([x]) => x);
if (!user) {
return res.status(400).json({ error: "Email is incorrect" });
}
// If user is found with given email,
// then check for the hashed password
// and then generate token.
if (user.password === passwordHash) {
const token = generateRandom(32);
// Save the created token into database
// for future check up to validate the
// protected route requests.
await sql`
insert into tokens (
"userId",
token
) values (
${user.id},
${token}
) returning id
`.then(([x]) => x);
return res.json({ token: `${token}-${user.id}` });
} else {
return res.status(400).json({ error: "Password is incorrect" });
}
} catch (err) {
next(err);
}
});
// POST http://localhost:3000/auth/register
app.post("/auth/register", async (req, res, next) => {
const { email, password } = req.body;
// Single and guided validation.
if (!email) {
return res.status(400).json({ error: "Email is required" });
}
if (!password) {
return res.status(400).json({ error: "Password is required" });
}
if (password.length < 6) {
return res.status(400).json({ error: "Password must be at least 6 characters long" });
}
const passwordHash = generateSHA256(password);
try {
const user = await sql`
insert into users (
email,
password
) values (
${email},
${passwordHash}
) returning id
`.then(([x]) => x);
const token = generateRandom(32);
// Save the created token into database
// for future check up to validate the
// protected route requests.
await sql`
insert into tokens (
"userId",
token
) values (
${user.id},
${token}
) returning id
`.then(([x]) => x);
return res.json({ token: `${token}-${user.id}` });
} catch (err) {
next(err);
}
});
app.use("/", auth, org, permission, (req, res, next) => {
console.log("[org]: accessing org protected end-points");
console.log("[permission]: accessing user protected end-points");
next();
});
// Companies.
app.use(
"/companies",
orgCan("access", "companies"),
userCan("access", "companies"),
fields("companies"),
(req, res, next) => {
console.log("[companies]: accessing companies end-points");
next();
},
);
// GET http://localhost:3000/companies
app.get("/companies", orgCan("read", "companies"), userCan("read", "companies"), async (req, res, next) => {
const { limit, page, name, withHeaders } = req.query;
// 'take' per page.
// We should not allow user to pass negative
// number of records. Also, for the better
// performance, we have set the upper limit to
// 100.
let take = limit || 10;
if (limit < 0 || limit > 100) {
take = 10;
}
// Search by name.
let whereQuery = sql``;
if (name && req.fields.companies.name) {
whereQuery = sql`where name ilike ${name + "%"}`;
}
// The fields in list of companies
// now fetched from 'views'.
let columns = [];
// TODO: conditionally add headers. As of now,
// without withHeaders also run the headers related code.
let headers = [];
try {
const views = await sql`
select
field
from
views
where
module = 'companies'
`;
for (const view of views) {
if (view.field === "id") {
if (req.fields.companies.id) {
columns.push("id");
headers.push(req.fields.companies.id);
}
}
if (view.field === "name") {
if (req.fields.companies.name) {
columns.push("name");
headers.push(req.fields.companies.name);
}
}
if (view.field === "createdAt") {
if (req.fields.companies.createdAt) {
columns.push("createdAt");
headers.push(req.fields.companies.createdAt);
}
}
if (view.field === "updatedAt") {
if (req.fields.companies.updatedAt) {
columns.push("updatedAt");
headers.push(req.fields.companies.updatedAt);
}
}
if (view.field === "createdBy") {
if (req.fields.companies.createdBy) {
columns.push("createdBy");
headers.push(req.fields.companies.createdBy);
}
}
}
} catch (err) {
next(err);
}
// if no fields are active, return
// an error.
if (columns.length === 0) {
return res.status(400).json({
error: "Terminated request: No fields are there to display",
});
}
// The default page starts from 1 and due to this,
// we're doing "-1" to offset 0 for the first page
// and so on.
const skip = ((page || 1) - 1) * take;
try {
const companies = await sql`
select
${sql(columns)}
from
companies
${whereQuery}
limit ${take}
offset ${skip}
`;
return res.json({
data: companies,
// add headers in res. if 'withHeaders' is passed as query string.
// The value of this query string can be anything to become true.
// but suggested to use 'true' value e.g. withHeaders=true
...(withHeaders && headers),
});
} catch (err) {
next(err);
}
});
// GET http://localhost:3000/companies/:id
app.get("/companies/:id", orgCan("read", "companies"), userCan("read", "companies"), async (req, res, next) => {
const { id } = req.params;
// Check if the passed 'id' is number or not.
if (!isNum(id)) {
return res.status(400).json({
error: "Id must be number",
});
}
// active fields are going to be
// fetched from the database.
// TODO: Improve the implementation logic.
let columns = [];
if (req.fields.companies.id) {
columns.push("id");
}
if (req.fields.companies.name) {
columns.push("name");
}
if (req.fields.companies.createdAt) {
columns.push("createdAt");
}
if (req.fields.companies.updatedAt) {
columns.push("updatedAt");
}
if (req.fields.companies.createdBy) {
columns.push("createdBy");
}
// if no fields are active, return
// an error.
if (columns.length === 0) {
return res.status(400).json({
error: "Request terminated: No fields are not activate",
});
}
try {
const company = await sql`
select
${sql(columns)}
from
companies
where
id = ${id}
`.then(([x]) => x);
if (!company) {
return res.status(404).json({
error: `Company with id #${id} doesn't exists`,
});
}
return res.json({
data: company,
});
} catch (err) {
next(err);
}
});
// POST http://localhost:3000/companies
app.post("/companies", orgCan("create", "companies"), userCan("create", "companies"), async (req, res, next) => {
// Check the "body" fields. If unknown field
// exist in req.body, return error.
const fields = ["name"];
const body = req.body || {};
for (const [key, _] of Object.entries(body)) {
if (!fields.includes(key)) {
return res.status(400).json({
error: `Bad request: ${key} doesn't exist`,
});
}
}
const { name } = req.body;
// active fields are going to be
// fetched from the database.
// TODO: Improve the implementation logic.
let companyObj = {};
if (name) {
if (req.fields.companies.name) {
companyObj["name"] = name;
} else {
return res.status(400).json({
error: `Request terminated: name field is not activate`,
});
}
}
// if no fields are active, return an error.
// TODO: Improve the implementation logic.
if (Object.keys(companyObj).length === 0) {
return res.status(400).json({
error: `Request terminated: No fields are not activate`,
});
} else {
// If we have field(s) to create, add createdBy
// when it is created.
companyObj["createdBy"] = req.userId;
}
try {
const company = await sql`
insert into companies
${sql(companyObj)}
returning id
`.then(([x]) => x);
return res.status(201).json({
data: company,
});
} catch (err) {
next(err);
}
});
// PATCH http://localhost:3000/companies/:id
app.patch("/companies/:id", orgCan("update", "companies"), userCan("update", "companies"), async (req, res, next) => {
// Check the "body" fields. If unknown field
// exist in req.body, return error.
const fields = ["name"];
const body = req.body || {};
for (const [key, _] of Object.entries(body)) {
if (!fields.includes(key)) {
return res.status(400).json({
error: `Bad request: ${key} doesn't exist`,
});
}
}
const { id } = req.params;
const { name } = req.body;
// Check if the passed 'id' is number or not.
if (!isNum(id)) {
return res.status(400).json({
error: "Id must be number",
});
}
// Before updating the company,
// check if the company exists or not.
try {
const company = await isCompanyExists(id);
if (!company) {
return res.status(404).json({
error: `Company with id #${id} doesn't exists`,
});
}
} catch (err) {
next(err);
}
// active fields are going to be
// fetched from the database.
// TODO: Improve the implementation logic.
let companyObj = {};
if (name) {
if (req.fields.companies.name) {
companyObj["name"] = name;
} else {
return res.status(400).json({
error: `Request terminated: name field is not activate`,
});
}
}
// if no fields are active, return an error.
// TODO: Improve the implementation logic.
if (Object.keys(companyObj).length === 0) {
return res.status(400).json({
error: `Request terminated: No fields are not activate`,
});
} else {
// If we have field(s) to update, add timestamp when it
// is updated.
companyObj["updatedAt"] = sql`now()`;
// TODO: Uncomment this when we added updatedBy
// column in database to track the updatedBy details.
// companyObj["updatedBy"] = req.userId;
}
try {
const company = await sql`
update
companies
set
${sql(companyObj)}
where
id = ${id}
returning id
`.then(([x]) => x);
return res.json({
data: company,
});
} catch (err) {
next(err);
}
});
// DELETE http://localhost:3000/companies/:id
app.delete("/companies/:id", orgCan("remove", "companies"), userCan("remove", "companies"), async (req, res, next) => {
const { id } = req.params;
// Check if the passed 'id' is number or not.
if (!isNum(id)) {
return res.status(400).json({
error: "Id must be number",
});
}
// Before deleting the company,
// check if the company exists or not.
try {
const company = await isCompanyExists(id);
if (!company) {
return res.status(404).json({
error: `Company with id #${id} doesn't exists`,
});
}
} catch (err) {
next(err);
}
try {
const company = await sql`
delete from
companies
where
id = ${id}
returning id
`.then(([x]) => x);
return res.json({
data: company,
});
} catch (err) {
next(err);
}
});
// 404 error Handler.
app.all("*", (req, res) => {
res.status(404).json({ error: "4-0-4" });
});
// Default error handler.
app.use((err, req, res, next) => {
console.log(err);
res.status(500).json({ error: "Internal server error" });
});
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
console.log(`Application is up and running on ${PORT} port!`);
});