-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathindex.ts
More file actions
467 lines (424 loc) · 17.4 KB
/
index.ts
File metadata and controls
467 lines (424 loc) · 17.4 KB
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
import fastifyCors from '@fastify/cors';
import fastifyMultipart from '@fastify/multipart';
import fastifyStatic from '@fastify/static';
import { ORMError, ORMErrorReason } from '@zenstackhq/orm';
import { Cause, Effect, Exit, Layer, Queue } from 'effect';
import Fastify, { type FastifyReply, type FastifyRequest } from 'fastify';
import os from 'os';
import path from 'path';
import superjson, { type SuperJSONResult } from 'superjson';
import { fileURLToPath } from 'url';
import { AuthContext } from '../Context/Auth';
import { ReqCtxService, type ReqCtx } from '../Context/ReqCtx';
import { AppConfigService } from '../Context/AppConfig';
import { systemLog } from '../Context/SystemLog';
import { GithubAuthLive } from '../OAuth/github';
import { LinuxDoAuthLive } from '../OAuth/linuxdo';
import { apis, type APIRaw } from '../api';
import { appApis } from '../api/appApi';
import { FileWrapItem } from '../util/file-types';
import { verifySignByToken } from '../lib/SessionAuthSign';
import { createRPC } from '../rpc';
import { MsgError, fail, tryOrFail, extractErrorMessage } from '../util/error';
import { FetchWithProxy } from '../util/github-proxy';
import {
createDetailedErrorMessage,
isRecordNotFoundError,
isZenStackPermissionError,
isZenStackValidationError,
} from '../util/zenstack-error';
import { getAuthFromCache } from './authCache';
import { registerWebhookRoutes } from './webhook';
import { CORS_MAX_AGE_SECONDS, MAX_UPLOAD_BYTES, SERVER_PORT, SERVER_HOST, MAX_WAIT_MS, MSG } from '../util/constants';
/** 通用 RPC 调用辅助(消除 app-api/api 两分支的重复 tryPromise+isEffect 模式) */
const callRpc = <T>(rpc: ReturnType<typeof createRPC>, method: string, params: unknown[]) =>
Effect.gen(function* () {
const res = yield* tryOrFail('RPC 调用', () => rpc.RC(method, params));
if (Effect.isEffect(res)) return yield* res as Effect.Effect<T>;
return res as T;
});
/** ESM 模块中获取 __dirname 的替代方案 */
const __dirname = path.dirname(fileURLToPath(import.meta.url));
/** 日志前缀 */
const LOG_PREFIX = '[Server]';
/** 每个 CPU 核心分配的请求并发数 */
const REQUESTS_PER_CPU_CORE = 10;
/** 统一错误序列化函数 */
function handleCause(cause: Cause.Cause<unknown>) {
let err;
function setErr(error: unknown): string {
if (MsgError.isMsgError(error)) {
err = { message: error.message, op: error.op };
} else if (error instanceof ORMError) {
/**
* https://zenstack.dev/docs/orm/access-control/query#setting-auth-user
* Mutation operations that affect a single, unique row, like update and delete, will throw an ORMError with reason set to NOT_FOUND if the target row doesn't meet the "update" or "delete" policies respectively. See Errors for more details.
* Why set reason as NOT_FOUND instead of REJECTED_BY_POLICY? Because the rationale is rows that don't satisfy the policies "don't exist".
*/
if (error.reason === ORMErrorReason.NOT_FOUND) {
err = { message: MSG.NO_ACCESS_OR_NOT_FOUND };
} else if (
/** 检查是否为 Prisma/ZenStack 的 P2004 或 P2025 错误 */
isZenStackPermissionError(error)
) {
err = { message: MSG.ACCESS_DENIED };
} else if (isRecordNotFoundError(error)) {
err = { message: MSG.RECORD_NOT_FOUND };
} else if (isZenStackValidationError(error)) {
err = { message: MSG.VALIDATION_FAILED };
} else {
// 其他错误,使用第一行错误消息
err = { message: error.message.split('\n')[0] };
}
} else {
err = { message: String(error) };
}
return String(error); // Cause.match 回调要求返回 string,值虽不被使用但类型必须匹配
}
const causeMsg = Cause.match(cause, {
onEmpty: '(empty)',
onFail: setErr,
onDie: setErr,
onInterrupt: (fiberId) => `(fiberId: ${fiberId})`,
onSequential: (left, right) => `(onSequential (left: ${left}) (right: ${right}))`,
onParallel: (left, right) => `(onParallel (left: ${left}) (right: ${right}))`,
});
if (err) {
return err;
}
return { message: causeMsg };
}
/**
* 判断请求体是否为 superjson 格式
* superjson 序列化后的结构为 { json: ..., meta?: ... }
*/
function isSuperJsonBody(body: unknown): body is SuperJSONResult {
return typeof body === 'object' && body !== null && 'json' in body;
}
/** 参数解析函数 */
async function parseParams(req: FastifyRequest): Promise<unknown[]> {
const contentType = req.headers['content-type'];
if (contentType?.includes('application/json')) {
/** 兼容 superjson 和普通 JSON 两种格式 */
if (isSuperJsonBody(req.body)) {
const parsed = superjson.deserialize(req.body as SuperJSONResult) as unknown;
if (!Array.isArray(parsed)) {
throw MsgError.msg(MSG.PARAM_FORMAT_ERROR);
}
return parsed;
}
/** 普通 JSON:直接当数组解析 */
if (Array.isArray(req.body)) {
return req.body;
}
throw MsgError.msg(MSG.PARAM_FORMAT_ERROR);
} else if (contentType?.startsWith('multipart/form-data')) {
// 在接口中使用 ReqCtx 获取值(为了文件流的优化)
return [];
} else if (req.method === 'GET') {
const query = req.query as {
args?: string;
sign?: string;
session?: string;
};
if (!query.args) return [];
const parsed = superjson.parse(query.args) as unknown;
if (!Array.isArray(parsed)) {
throw MsgError.msg(MSG.PARAM_FORMAT_ERROR);
}
return parsed;
} else {
throw MsgError.msg(`Unknown content type: ${contentType}`);
}
}
/** 解析参数并通过参数获取鉴权对象 */
function parseParamsAndAuth(req: FastifyRequest) {
return Effect.gen(function* () {
const query = req.query as {
args?: string;
sign?: string;
session?: string;
};
const querySignMode = req.method === 'GET';
const opt: {
userId?: string;
email?: string;
sessionToken?: string;
sessionID?: number;
} = {};
// 只使用安全的认证方式
if (query.session && querySignMode) {
opt.sessionID = Number(query.session);
} else {
// 使用请求头进行认证
const rawToken = req.headers['x-token-id'];
opt.sessionToken = Array.isArray(rawToken) ? rawToken[0] : rawToken;
}
const { db, user } = yield* getAuthFromCache(opt);
if (querySignMode) {
const session = user.userSession[0];
if (!session) {
return yield* Effect.fail(new MsgError(MsgError.op_toLogin, '请提供有效的 session'));
}
const verify = yield* Effect.try({
try: () => verifySignByToken(query.args ?? '', session.token, query.sign ?? ''),
catch: (e) => MsgError.msg(`签名验证失败: ${extractErrorMessage(e)}`),
});
if (!verify) {
return yield* fail(MSG.SIGNATURE_INVALID);
}
}
const params = yield* tryOrFail('参数解析', () => parseParams(req));
return { params, db, user };
});
}
type ApiCtx = {
req: FastifyRequest;
reply: FastifyReply;
pathPrefix: string;
onEnd: () => void;
enqueueTime: number;
};
/** rpc 实例,提到外部可避免每次重新创建 */
const appApisRpc = createRPC('apiProvider', { genApiModule: async () => appApis });
let reqId = 0;
/** 注意,这里必须要等待发送数据完毕,否则 onEnd 之后数据将无法发送 */
function handleReq({ req, reply, pathPrefix, enqueueTime, onEnd }: ApiCtx) {
const startTime = Date.now();
const reqCtx: ReqCtx = {
logs: [],
log(...args) {
reqCtx.logs.push(args);
},
req,
reqId: ++reqId,
};
let method: string;
try {
method = decodeURIComponent(req.url.split('?')[0]?.slice(pathPrefix.length) ?? '');
} catch {
reply.code(400).send({ error: 'Malformed URL encoding' });
onEnd();
return Effect.void;
}
const program = buildReqProgram({ req, reply, pathPrefix, method, enqueueTime });
/** 合成层,避免其他 service 还在依赖 FetchWithProxy */
const unFetchProxyLayer = Layer.provide(GithubAuthLive, FetchWithProxy.Default);
const unLinuxDoLayer = Layer.provide(LinuxDoAuthLive, FetchWithProxy.Default);
const allOAuthLayers = Layer.merge(unFetchProxyLayer, unLinuxDoLayer);
const reqLayer = Layer.succeed(ReqCtxService, reqCtx);
/** 合成层,避免其他 service 还在依赖 ReqCtxService */
const unReqLayer = Layer.provide(allOAuthLayers, reqLayer);
const apiLayer = unReqLayer;
const runnable = Effect.provide(program, [
apiLayer,
/**
Q:为什么这里还要传递 reqLayer,前面已经传递了 unReqLayer (apiLayer) 啊?
A:要注意 unReqLayer 解决的是 unReqLayer 这个声明中的层依赖 ReqCtxService 的问题,但是并没有给 program 提供 ReqCtxService,所以这里主要就是给 program 提供
理论上就可以不要使用 unReqLayer 了,但为了代码逻辑清晰还是使用 unReqLayer
*/ reqLayer,
]);
/** 拦截并处理所有错误 */
return Effect.gen(function* () {
const exit = yield* Effect.exit(runnable);
if (Exit.isFailure(exit)) {
const cause = exit.cause;
/** 记录详细的错误信息 */
if (Cause.isDieType(cause)) {
const defect = cause.defect;
const defectStack = defect instanceof Error
? defect.stack?.split('at Generator.next (<anonymous>)')?.[0]
: String(defect);
reqCtx.log(
'[error Cause]',
/** 裁剪掉 Effect 内部的调用堆栈 */
defectStack ?? 'unknown',
);
// 额外记录 ZenStack/Prisma 错误的详细信息
if (defect) {
const detailedMsg = createDetailedErrorMessage(defect, method);
if (detailedMsg.includes('ZenStack') || detailedMsg.includes('P2025')) {
reqCtx.log('[error details]', detailedMsg);
}
}
} else {
reqCtx.log('[error noCause]', `${cause}`);
}
reply.send(superjson.serialize({ error: handleCause(cause) }));
}
onEnd();
const endTime = Date.now();
return yield* systemLog(
{ level: 'info', message: `${endTime - startTime}ms ${method}` },
reqCtx,
);
});
}
/** 构建请求核心业务逻辑 Effect(等待检查 → 路由分发 → RPC 调用 → 响应序列化) */
function buildReqProgram(opts: { req: FastifyRequest; reply: FastifyReply; pathPrefix: string; method: string; enqueueTime: number }) {
return Effect.gen(function* () {
const waitTime = Date.now() - opts.enqueueTime;
if (waitTime > MAX_WAIT_MS) {
return yield* fail(MSG.SERVER_BUSY);
}
let result: unknown;
if (opts.pathPrefix === '/app-api/') {
const params = yield* tryOrFail('参数解析', () => parseParams(opts.req));
result = yield* callRpc(appApisRpc, opts.method, params);
} else if (opts.pathPrefix === '/api/') {
/** 处理需要鉴权的 API */
const { params, db, user } = yield* parseParamsAndAuth(opts.req);
const apisRpc = createRPC('apiProvider', {
/** apis + db → APIRaw: 动态合并的模块对象无法在编译期精确匹配 APIRaw 接口,运行时结构一致 */
genApiModule: async () => ({ ...apis, db }) as unknown as APIRaw,
});
result = yield* callRpc(apisRpc, opts.method, params)
// 提供 apis 模块所需要的依赖
.pipe(Effect.provideService(AuthContext, { db, user }));
}
if (result instanceof FileWrapItem) {
yield* sendFileResponse(opts.reply, result);
} else {
yield* Effect.promise(async () => opts.reply.send(superjson.serialize({ result })));
}
});
}
/** 发送文件流式响应(支持 HTTP Range 请求) */
function sendFileResponse(reply: FastifyReply, fileItem: FileWrapItem) {
return Effect.gen(function* () {
const fileSize = fileItem.model.size;
const rangeHeader = reply.request.headers['range'];
// 设置公共文件响应头
reply
.type(fileItem.model.mimetype ?? 'application/octet-stream')
.header('Accept-Ranges', 'bytes')
.header('Content-Disposition', `inline; filename="${encodeURIComponent(fileItem.model.filename ?? 'file')}"`);
// 支持 HTTP Range requests(视频分段加载、断点续传)
if (rangeHeader) {
const rangeStr = typeof rangeHeader === 'string' ? rangeHeader : (Array.isArray(rangeHeader) ? rangeHeader[0] : String(rangeHeader));
const parts = rangeStr.replace(/bytes=/, '').split('-');
const start = Math.max(0, parseInt(parts[0] ?? '0', 10) || 0);
const rawEnd = parseInt(parts[1] ?? '', 10);
const end = Math.min(Number.isNaN(rawEnd) ? fileSize - 1 : rawEnd, fileSize - 1);
if (start >= fileSize || end < start) {
reply.code(416).header('Content-Range', `bytes */${fileSize}`).send();
return;
}
const chunkSize = end - start + 1;
reply
.code(206)
.header('Content-Range', `bytes ${start}-${end}/${fileSize}`)
.header('Content-Length', chunkSize);
yield* Effect.promise(async () => reply.send(fileItem.getFileStreamRange(start, end)));
} else {
reply.header('Content-Length', fileSize);
yield* Effect.promise(async () => reply.send(fileItem.getFileStream()));
}
});
}
/** 服务器初始化 */
export const startServer = Effect.gen(function* () {
const fastify = Fastify({ logger: false, bodyLimit: 10 * 1024 * 1024 }); // 10MB JSON body limit
const appConfig = yield* AppConfigService;
//#region fastify 注册中间件:cors Multipart static
/** CORS origin 配置:优先使用配置白名单,未配置或空数组则允许所有来源 */
const corsOrigin = appConfig.corsOrigins && appConfig.corsOrigins.length > 0
? appConfig.corsOrigins
: true; // true 等效于 '*'
if (corsOrigin === true && process.env.NODE_ENV === 'production') {
console.warn('[Server] CORS 允许所有来源(*),建议在 config.json 中配置 corsOrigins 白名单');
}
fastify.register(fastifyCors, {
origin: corsOrigin,
methods: ['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS'],
allowedHeaders: ['Content-Type', 'x-token-id'],
exposedHeaders: ['Content-Length', 'Content-Range', 'Accept-Ranges'],
credentials: false,
maxAge: CORS_MAX_AGE_SECONDS, // 预检请求结果缓存24小时
});
fastify.register(fastifyMultipart, {
limits: { fileSize: MAX_UPLOAD_BYTES }, // 1GB
});
console.log(`${LOG_PREFIX} static files:`, path.join(__dirname, 'frontend'));
fastify.register(fastifyStatic, {
root: path.join(__dirname, 'frontend'),
prefix: '/',
});
//#endregion
/** 创建一个无界队列 */
const queue = yield* Queue.unbounded<ApiCtx>();
/**
* 解决 Effect 的异步边界问题:创建一个普通的回调函数来将数据传递给外层的 Effect 程序,然后外层程序通过消费队列来处理数据。
* emitReq 将请求放入队列,返回 Promise 以支持 await。
*/
const emitReq = (ctx: ApiCtx) => Effect.runPromise(Queue.offer(queue, ctx));
/**
* onEnd 是为了解决 fastify 的回调函数执行完毕后,fastify 会自动结束请求,而我们希望在 Effect Stream 中处理请求,所以需要维持时机到处理完毕。
* 这个 onEnd 实现的比较丑陋,但是没想到什么好方法解决这个问题。
*/
function registerRoute(pathPrefix: string) {
return async function (req: FastifyRequest, reply: FastifyReply) {
let resolved = false;
const p = new Promise<void>((resolve) => {
/** 包装 resolve,防止多次调用 onEnd */
const onceResolve = () => {
if (!resolved) {
resolved = true;
resolve();
}
};
/** 将请求上下文放入队列 */
emitReq({
req,
reply,
pathPrefix,
enqueueTime: Date.now(),
onEnd: onceResolve,
});
});
await p;
};
}
fastify.all('/api/*', registerRoute('/api/'));
fastify.all('/app-api/*', registerRoute('/app-api/'));
/** 注册支付 Webhook 回调路由(不走 RPC 系统,由第三方平台直接调用) */
registerWebhookRoutes(fastify);
/** 处理 SPA 路由回退 */
fastify.setNotFoundHandler((request, reply) => {
if (!request.url.startsWith('/api') && !request.url.startsWith('/app-api')) {
reply.sendFile('index.html');
} else {
reply.code(404).send({ error: 'Not Found' });
}
});
//#region 启动服务器
const address = yield* tryOrFail('服务器启动', () => fastify.listen({ port: SERVER_PORT, host: SERVER_HOST }));
console.log(`${LOG_PREFIX} listening on ${address}`);
//#endregion
/** 创建控制最大并发数的信号量 */
const cpuCount = os.cpus().length;
const recommendedConcurrency = cpuCount * REQUESTS_PER_CPU_CORE;
console.log(`${LOG_PREFIX} 请求并发上限: ${recommendedConcurrency}`);
const semaphore = yield* Effect.makeSemaphore(recommendedConcurrency);
/** 请求队列消费循环 */
while (true) {
const ctx = yield* Queue.take(queue);
/** fork 一个 Fiber 去执行请求处理,确保不会阻塞循环 */
yield* Effect.forkDaemon(
semaphore.withPermits(1)(
handleReq(ctx).pipe(
Effect.catchAll((err) =>
Effect.gen(function* () {
yield* Effect.logError(`[handleReq error] ${String(err)}`);
/** 确保客户端收到响应,避免连接挂起 */
if (!ctx.reply.sent) {
ctx.reply.code(500).send({ error: 'Internal Server Error' });
}
}),
),
Effect.ensuring(Effect.sync(ctx.onEnd)),
),
),
);
}
});