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
|
/*
Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
Copyright (C) 2023 Spacebar and Spacebar Contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import { DiscordApiErrors, EVENT, FieldErrors, PermissionResolvable, Permissions, RightResolvable, Rights, SpacebarApiErrors, getPermission, getRights } from "@spacebar/util";
import { AnyValidateFunction } from "ajv/dist/core";
import { NextFunction, Request, Response } from "express";
import { ajv } from "@spacebar/schemas";
import { BigNumber } from "bignumber.js";
const ignoredRequestSchemas = [
// skip validation for settings proto JSON updates - TODO: figure out if this even possible to fix?
"SettingsProtoUpdateJsonSchema",
];
declare global {
// TODO: fix this
// eslint-disable-next-line @typescript-eslint/no-namespace
namespace Express {
interface Request {
permission?: Permissions;
}
}
}
export type RouteResponse = {
status?: number;
body?: `${string}Response`;
headers?: Record<string, string>;
};
export type stripNulls = { [key: string]: true | stripNulls };
export interface RouteOptions {
permission?: PermissionResolvable;
right?: RightResolvable;
requestBody?: `${string}Schema`; // typescript interface name
responses?: {
[status: number]: {
// body?: `${string}Response`;
body?: string;
};
};
stripNulls?: stripNulls | true;
event?: EVENT | EVENT[];
summary?: string;
description?: string;
query?: {
[key: string]: {
type: string;
required?: boolean;
description?: string;
values?: string[];
};
};
deprecated?: boolean;
spacebarOnly?: boolean;
// test?: {
// response?: RouteResponse;
// body?: unknown;
// path?: string;
// event?: EVENT | EVENT[];
// headers?: Record<string, string>;
// };
}
export function stripNull(obj: object) {
for (const [key, value] of Object.entries(obj)) {
if (value instanceof Object || (value && !value.__proto__)) {
stripNull(value);
} else if (value === null) {
//@ts-expect-error this is fine
delete obj[key];
}
}
}
// eslint-disable-next-line
export function followNullPath(obj1: any, nullObj: stripNulls) {
for (const [key, value] of Object.entries(nullObj)) {
if (key in obj1)
if (value instanceof Object) {
if (obj1[key] instanceof Object)
//@ts-expect-error this works lol
followNullPath(obj1[key], nullObj[key]);
else delete obj1[key];
} else if (obj1[key] instanceof Object) {
stripNull(obj1[key]);
}
}
}
//It's pretty safe to assume numbers over the number limit aren't really meant to be numbers, so we turn them to strings.
export function bigNumberToString(obj1: unknown) {
if (obj1 && typeof obj1 === "object") {
for (const [key, value] of Object.entries(obj1)) {
if (typeof value === "object") {
if (value instanceof BigNumber) {
//@ts-expect-error this is fine lol
obj1[key] = value.toString();
}
bigNumberToString(value);
}
}
}
}
export function route(opts: RouteOptions) {
let validate: AnyValidateFunction | undefined;
if (opts.requestBody) {
try {
validate = ajv.getSchema(opts.requestBody);
} catch (e) {
console.error("AJV getSchema failed!");
throw e;
}
if (!validate) throw new Error(`Body schema ${opts.requestBody} not found`);
}
return async (req: Request, res: Response, next: NextFunction) => {
if (opts.permission) {
const { guild_id, channel_id } = req.params as { [key: string]: string };
req.permission = await getPermission(req.user_id, guild_id, channel_id);
const requiredPerms = Array.isArray(opts.permission) ? opts.permission : [opts.permission];
requiredPerms.forEach((perm) => {
// bitfield comparison: check if user lacks certain permission
if (!req.permission!.has(new Permissions(perm))) {
throw DiscordApiErrors.MISSING_PERMISSIONS.withParams(perm as string);
}
});
}
if (opts.right) {
const required = new Rights(opts.right);
req.rights = await getRights(req.user_id);
if (!req.rights || !req.rights.has(required)) {
throw SpacebarApiErrors.MISSING_RIGHTS.withParams(opts.right as string);
}
}
bigNumberToString(req.body);
if (validate && !ignoredRequestSchemas.includes(opts.requestBody!)) {
if (opts.stripNulls) {
if (opts.stripNulls === true) stripNull(req.body);
else followNullPath(req.body, opts.stripNulls);
}
const valid = validate(req.body);
if (!valid) {
const fields: Record<string, { code?: string; message: string }> = {};
validate.errors?.forEach(
(x) =>
(fields[x.instancePath.slice(1)] = {
code: x.keyword,
message: x.message || "",
}),
);
if (process.env.LOG_VALIDATION_ERRORS) console.log(`[VALIDATION ERROR] ${req.method} ${req.originalUrl} - SCHEMA='${opts.requestBody}' -`, validate?.errors);
throw FieldErrors(fields, validate.errors!);
}
}
next();
};
}
|
