paricafe/packages/backend/src/server/api/call.ts

132 lines
3.5 KiB
TypeScript
Raw Normal View History

import * as Koa from 'koa';
2019-03-08 05:07:29 -06:00
import { performance } from 'perf_hooks';
2022-01-21 02:15:14 -06:00
import { limiter } from './limiter';
import { User } from '@/models/entities/user';
import endpoints from './endpoints';
import { ApiError } from './error';
import { apiLogger } from './logger';
import { AccessToken } from '@/models/entities/access-token';
const accessDenied = {
message: 'Access denied.',
code: 'ACCESS_DENIED',
2021-12-09 08:58:30 -06:00
id: '56f35758-7dd5-468b-8439-5d6fb8ec9b8e',
};
export default async (endpoint: string, user: User | null | undefined, token: AccessToken | null | undefined, data: any, ctx?: Koa.Context) => {
2020-03-28 04:07:41 -05:00
const isSecure = user != null && token == null;
2018-07-15 13:43:36 -05:00
const ep = endpoints.find(e => e.name === endpoint);
if (ep == null) {
throw new ApiError({
message: 'No such endpoint.',
code: 'NO_SUCH_ENDPOINT',
id: 'f8080b67-5f9c-4eb7-8c18-7f1eeae8f709',
2021-12-09 08:58:30 -06:00
httpStatusCode: 404,
});
}
2018-07-15 13:25:35 -05:00
if (ep.meta.secure && !isSecure) {
throw new ApiError(accessDenied);
}
2018-07-15 13:25:35 -05:00
if (ep.meta.requireCredential && user == null) {
throw new ApiError({
message: 'Credential required.',
code: 'CREDENTIAL_REQUIRED',
id: '1384574d-a912-4b81-8601-c7b1c4085df1',
2021-12-09 08:58:30 -06:00
httpStatusCode: 401,
});
}
if (ep.meta.requireCredential && user!.isSuspended) {
throw new ApiError({
message: 'Your account has been suspended.',
code: 'YOUR_ACCOUNT_SUSPENDED',
id: 'a8c724b3-6e9c-4b46-b1a8-bc3ed6258370',
2021-12-09 08:58:30 -06:00
httpStatusCode: 403,
});
}
if (ep.meta.requireAdmin && !user!.isAdmin) {
throw new ApiError(accessDenied, { reason: 'You are not the admin.' });
2018-08-13 11:05:58 -05:00
}
if (ep.meta.requireModerator && !user!.isAdmin && !user!.isModerator) {
throw new ApiError(accessDenied, { reason: 'You are not a moderator.' });
2018-11-14 13:15:42 -06:00
}
2020-03-28 04:07:41 -05:00
if (token && ep.meta.kind && !token.permission.some(p => p === ep.meta.kind)) {
throw new ApiError({
message: 'Your app does not have the necessary permissions to use this endpoint.',
code: 'PERMISSION_DENIED',
id: '1370e5b7-d4eb-4566-bb1d-7748ee6a1838',
});
}
if (ep.meta.requireCredential && ep.meta.limit && !user!.isAdmin && !user!.isModerator) {
2019-02-21 22:38:12 -06:00
// Rate limit
await limiter(ep, user!).catch(e => {
throw new ApiError({
message: 'Rate limit exceeded. Please try again later.',
code: 'RATE_LIMIT_EXCEEDED',
id: 'd5826d14-3982-4d2e-8011-b9e9f02499ef',
2021-12-09 08:58:30 -06:00
httpStatusCode: 429,
});
2019-02-21 22:38:12 -06:00
});
}
// Cast non JSON input
if (ep.meta.requireFile && ep.meta.params) {
for (const k of Object.keys(ep.meta.params)) {
const param = ep.meta.params[k];
2022-02-06 01:01:54 -06:00
if (['Boolean', 'Number'].includes(param.validator.name) && typeof data[k] === 'string') {
try {
data[k] = JSON.parse(data[k]);
} catch (e) {
throw new ApiError({
message: 'Invalid param.',
code: 'INVALID_PARAM',
id: '0b5f1631-7c1a-41a6-b399-cce335f34d85',
}, {
param: k,
reason: `cannot cast to ${param.validator.name}`,
})
}
}
}
}
// API invoking
2019-03-08 05:07:29 -06:00
const before = performance.now();
return await ep.exec(data, user, token, ctx?.file).catch((e: Error) => {
if (e instanceof ApiError) {
2019-01-23 04:33:29 -06:00
throw e;
} else {
apiLogger.error(`Internal error occurred in ${ep.name}: ${e?.message}`, {
2019-03-02 17:27:30 -06:00
ep: ep.name,
ps: data,
2019-04-11 10:33:26 -05:00
e: {
2020-01-19 10:52:35 -06:00
message: e?.message,
code: e?.name,
2021-12-09 08:58:30 -06:00
stack: e?.stack,
},
2019-03-02 17:27:30 -06:00
});
throw new ApiError(null, {
e: {
2020-01-19 10:52:35 -06:00
message: e?.message,
code: e?.name,
2021-12-09 08:58:30 -06:00
stack: e?.stack,
},
});
2018-10-26 00:38:34 -05:00
}
2019-03-08 05:07:29 -06:00
}).finally(() => {
const after = performance.now();
const time = after - before;
if (time > 1000) {
apiLogger.warn(`SLOW API CALL DETECTED: ${ep.name} (${time}ms)`);
}
2019-02-21 22:38:12 -06:00
});
2019-01-23 04:33:29 -06:00
};