-
Notifications
You must be signed in to change notification settings - Fork 568
/
framework.ts
358 lines (316 loc) · 9.78 KB
/
framework.ts
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
import {
BaseFramework,
CommonFilterUnion,
CommonMiddlewareUnion,
HTTP_SERVER_KEY,
IMidwayBootstrapOptions,
MidwayFrameworkType,
PathFileUtil,
RouterInfo,
WebControllerGenerator,
MidwayConfigMissingError,
httpError,
MidwayWebRouterService,
Framework,
Types,
} from '@midwayjs/core';
import { Cookies } from '@midwayjs/cookies';
import {
Context,
IMidwayKoaApplication,
IMidwayKoaConfigurationOptions,
IMidwayKoaContext,
IWebMiddleware,
} from './interface';
import * as Router from '@koa/router';
import type { DefaultState, Middleware, Next } from 'koa';
import * as koa from 'koa';
import { Server } from 'http';
import { setupOnError } from './onerror';
import * as qs from 'qs';
import * as querystring from 'querystring';
const COOKIES = Symbol('context#cookies');
class KoaControllerGenerator extends WebControllerGenerator<Router> {
constructor(readonly app, readonly webRouterService: MidwayWebRouterService) {
super(app, webRouterService);
}
createRouter(routerOptions: any): Router {
const router = new Router(routerOptions);
router.prefix(routerOptions.prefix);
return router;
}
generateController(routeInfo: RouterInfo) {
return this.generateKoaController(routeInfo);
}
}
@Framework()
export class MidwayKoaFramework extends BaseFramework<
IMidwayKoaApplication,
IMidwayKoaContext,
IMidwayKoaConfigurationOptions,
Next
> {
private server: Server;
private generator: KoaControllerGenerator;
private webRouterService: MidwayWebRouterService;
configure(): IMidwayKoaConfigurationOptions {
return this.configService.getConfiguration('koa');
}
async applicationInitialize(options: Partial<IMidwayBootstrapOptions>) {
const appKeys =
this.configService.getConfiguration('keys') ||
this.configurationOptions['keys'];
if (!appKeys) {
throw new MidwayConfigMissingError('config.keys');
}
const cookieOptions = this.configService.getConfiguration('cookies');
this.app = new koa<DefaultState, IMidwayKoaContext>({
keys: [].concat(appKeys),
proxy: this.configurationOptions.proxy,
proxyIpHeader: this.configurationOptions.proxyIpHeader,
subdomainOffset: this.configurationOptions.subdomainOffset,
maxIpsCount: this.configurationOptions.maxIpsCount,
}) as IMidwayKoaApplication;
Object.defineProperty(this.app.context, 'cookies', {
get() {
if (!this[COOKIES]) {
this[COOKIES] = new Cookies(this, this.app.keys, cookieOptions);
}
return this[COOKIES];
},
enumerable: true,
});
Object.defineProperty(this.app.context, 'locals', {
get() {
return this.state;
},
set(value) {
this.state = value;
},
});
Object.defineProperty(this.app.context, 'forward', {
get() {
return async function (this: Context, url: string) {
const routerService = this.requestContext.get(MidwayWebRouterService);
const matchedUrlRouteInfo = await routerService.getMatchedRouterInfo(
url,
this.method
);
if (matchedUrlRouteInfo) {
if (matchedUrlRouteInfo.controllerClz) {
// normal class controller router
const controllerInstance = await this.requestContext.getAsync(
matchedUrlRouteInfo.controllerClz
);
return controllerInstance[matchedUrlRouteInfo.method as string](
this
);
} else if (typeof matchedUrlRouteInfo.method === 'function') {
// dynamic router
return matchedUrlRouteInfo.method(this);
}
} else {
throw new httpError.NotFoundError(`Forward url ${url} Not Found`);
}
};
},
});
const converter =
this.configurationOptions.queryParseMode === 'strict'
? function (value) {
return !Array.isArray(value) ? [value] : value;
}
: this.configurationOptions.queryParseMode === 'first'
? function (value) {
return Array.isArray(value) ? value[0] : value;
}
: undefined;
// eslint-disable-next-line @typescript-eslint/no-this-alias
const self = this;
// fix query with array params
Object.defineProperty(this.app.request, 'query', {
get() {
const str = this.querystring;
const c = (this._querycache = this._querycache || {});
// find cache
if (c[str]) return c[str];
if (self.configurationOptions.queryParseMode) {
// use qs module to parse query
c[str] = qs.parse(
str,
self.configurationOptions.queryParseOptions || {}
);
} else {
// use querystring to parse query by default
c[str] = querystring.parse(str);
}
if (converter) {
for (const key in c[str]) {
c[str][key] = converter(c[str][key]);
}
}
return c[str];
},
set(value) {
this._querycache = this._querycache || {};
this._querycache[this.querystring] = value;
},
});
const onerrorConfig = this.configService.getConfiguration('onerror');
setupOnError(this.app, onerrorConfig, this.logger);
// not found middleware
const notFound = async (ctx, next) => {
await next();
if (!ctx._matchedRoute && ctx.body === undefined) {
throw new httpError.NotFoundError(`${ctx.path} Not Found`);
}
};
// root middleware
const midwayRootMiddleware = async (ctx, next) => {
this.app.createAnonymousContext(ctx);
await (
await this.applyMiddleware(notFound)
)(ctx, next);
if (
ctx.body === undefined &&
!ctx.response._explicitStatus &&
ctx._matchedRoute
) {
// 如果进了路由,重新赋值,防止 404
ctx.body = undefined;
}
};
this.app.use(midwayRootMiddleware);
this.webRouterService = await this.applicationContext.getAsync(
MidwayWebRouterService,
[
{
globalPrefix: this.configurationOptions.globalPrefix,
},
]
);
this.generator = new KoaControllerGenerator(
this.app,
this.webRouterService
);
this.defineApplicationProperties();
// hack use method
(this.app as any).originUse = this.app.use;
this.app.use = this.app.useMiddleware as any;
}
async loadMidwayController() {
await this.generator.loadMidwayController(newRouter => {
const dispatchFn = newRouter.middleware();
dispatchFn._name = `midwayController(${newRouter?.opts?.prefix || '/'})`;
this.app.use(dispatchFn);
});
}
/**
* wrap controller string to middleware function
*/
public generateController(
routeInfo: RouterInfo
): Middleware<DefaultState, IMidwayKoaContext> {
return this.generator.generateKoaController(routeInfo);
}
/**
* @deprecated
* @param middlewareId
*/
public async generateMiddleware(middlewareId: any) {
const mwIns = await this.getApplicationContext().getAsync<IWebMiddleware>(
middlewareId
);
return mwIns.resolve();
}
public async run(): Promise<void> {
// load controller
await this.loadMidwayController();
// restore use method
this.app.use = (this.app as any).originUse;
const serverOptions = {
...this.configurationOptions,
...this.configurationOptions.serverOptions,
};
// https config
if (serverOptions.key && serverOptions.cert) {
serverOptions.key = PathFileUtil.getFileContentSync(serverOptions.key);
serverOptions.cert = PathFileUtil.getFileContentSync(serverOptions.cert);
serverOptions.ca = PathFileUtil.getFileContentSync(serverOptions.ca);
if (serverOptions.http2) {
this.server = require('http2').createSecureServer(
serverOptions,
this.app.callback()
);
} else {
this.server = require('https').createServer(
serverOptions,
this.app.callback()
);
}
} else {
if (serverOptions.http2) {
this.server = require('http2').createServer(
serverOptions,
this.app.callback()
);
} else {
this.server = require('http').createServer(
serverOptions,
this.app.callback()
);
}
}
// register httpServer to applicationContext
this.applicationContext.registerObject(HTTP_SERVER_KEY, this.server);
// server timeout
if (Types.isNumber(this.configurationOptions.serverTimeout)) {
this.server.setTimeout(this.configurationOptions.serverTimeout);
}
// set port and listen server
const customPort =
process.env.MIDWAY_HTTP_PORT ?? this.configurationOptions.port;
if (customPort) {
new Promise<void>(resolve => {
const args: any[] = [customPort];
if (this.configurationOptions.hostname) {
args.push(this.configurationOptions.hostname);
}
args.push(() => {
resolve();
});
this.server.listen(...args);
process.env.MIDWAY_HTTP_PORT = String(customPort);
});
}
}
public async beforeStop() {
if (this.server) {
new Promise(resolve => {
this.server.close(resolve);
});
}
}
public getFrameworkType(): MidwayFrameworkType {
return MidwayFrameworkType.WEB_KOA;
}
public getFrameworkName() {
return 'web:koa';
}
public getServer() {
return this.server;
}
public getPort() {
return process.env.MIDWAY_HTTP_PORT;
}
public useMiddleware(
Middleware: CommonMiddlewareUnion<IMidwayKoaContext, Next, unknown>
) {
this.middlewareManager.insertLast(Middleware);
}
public useFilter(
Filter: CommonFilterUnion<IMidwayKoaContext, Next, unknown>
) {
this.filterManager.useFilter(Filter);
}
}