forked from trpc/trpc-openapi
-
Notifications
You must be signed in to change notification settings - Fork 1
/
core.ts
226 lines (197 loc) · 6.95 KB
/
core.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
import { AnyProcedure, TRPCError } from '@trpc/server';
import {
NodeHTTPHandlerOptions,
NodeHTTPRequest,
NodeHTTPResponse,
} from '@trpc/server/dist/adapters/node-http';
import cloneDeep from 'lodash.clonedeep';
import { ZodError, z } from 'zod';
import { generateOpenApiDocument } from '../../generator';
import {
OpenApiErrorResponse,
OpenApiMethod,
OpenApiResponse,
OpenApiRouter,
OpenApiSuccessResponse,
} from '../../types';
import { acceptsRequestBody } from '../../utils/method';
import { normalizePath } from '../../utils/path';
import { getInputOutputParsers } from '../../utils/procedure';
import {
instanceofZodTypeCoercible,
instanceofZodTypeLikeVoid,
instanceofZodTypeObject,
unwrapZodType,
zodSupportsCoerce,
} from '../../utils/zod';
import { TRPC_ERROR_CODE_HTTP_STATUS, getErrorFromUnknown } from './errors';
import { getBody, getQuery } from './input';
import { createProcedureCache } from './procedures';
export type CreateOpenApiNodeHttpHandlerOptions<
TRouter extends OpenApiRouter,
TRequest extends NodeHTTPRequest,
TResponse extends NodeHTTPResponse,
> = Pick<
NodeHTTPHandlerOptions<TRouter, TRequest, TResponse>,
'router' | 'createContext' | 'responseMeta' | 'onError' | 'maxBodySize'
>;
export type OpenApiNextFunction = () => void;
export const createOpenApiNodeHttpHandler = <
TRouter extends OpenApiRouter,
TRequest extends NodeHTTPRequest,
TResponse extends NodeHTTPResponse,
>(
opts: CreateOpenApiNodeHttpHandlerOptions<TRouter, TRequest, TResponse>,
) => {
const router = cloneDeep(opts.router);
// Validate router
if (process.env.NODE_ENV !== 'production') {
generateOpenApiDocument(router, { title: '', version: '', baseUrl: '' });
}
const { createContext, responseMeta, onError, maxBodySize } = opts;
const getProcedure = createProcedureCache(router);
return async (req: TRequest, res: TResponse, next?: OpenApiNextFunction) => {
const sendResponse = (
statusCode: number,
headers: Record<string, string>,
body: OpenApiResponse | undefined,
) => {
res.statusCode = statusCode;
// Support sending SSE streams
if (body && typeof body.getReader === 'function') {
const reader = body.getReader();
res.setHeader('Connection', 'keep-alive');
res.setHeader('Content-Type', 'text/event-stream');
res.setHeader('Cache-Control', 'no-cache');
res.flushHeaders();
const processStream = async (reader: ReadableStreamDefaultReader, res: TResponse) => {
try {
let done, value;
do {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
({ done, value } = await reader.read());
if (!done) {
res.write(`data: ${Buffer.from(value.buffer).toString()}\n\n`);
// @ts-expect-error flush is not in the types
res.flush();
}
} while (!done);
} catch (error) {
console.error('Error while reading from stream', error);
} finally {
reader.releaseLock();
res.end();
}
};
void processStream(reader, res);
} else {
res.setHeader('Content-Type', 'application/json');
for (const [key, value] of Object.entries(headers)) {
if (typeof value !== 'undefined') {
res.setHeader(key, value);
}
}
res.end(JSON.stringify(body));
}
};
const method = req.method! as OpenApiMethod & 'HEAD';
const reqUrl = req.url!;
const url = new URL(reqUrl.startsWith('/') ? `http://127.0.0.1${reqUrl}` : reqUrl);
const path = normalizePath(url.pathname);
const { procedure, pathInput } = getProcedure(method, path) ?? {};
let input: any = undefined;
let ctx: any = undefined;
let data: any = undefined;
try {
if (!procedure) {
if (next) {
return next();
}
// Can be used for warmup
if (method === 'HEAD') {
sendResponse(204, {}, undefined);
return;
}
throw new TRPCError({
message: 'Not found',
code: 'NOT_FOUND',
});
}
const useBody = acceptsRequestBody(method);
const schema = getInputOutputParsers(procedure.procedure).inputParser as z.ZodTypeAny;
const unwrappedSchema = unwrapZodType(schema, true);
// input should stay undefined if z.void()
if (!instanceofZodTypeLikeVoid(unwrappedSchema)) {
input = {
...(useBody ? await getBody(req, maxBodySize) : getQuery(req, url)),
...pathInput,
};
}
// if supported, coerce all string values to correct types
if (zodSupportsCoerce) {
if (instanceofZodTypeObject(unwrappedSchema)) {
Object.values(unwrappedSchema.shape).forEach((shapeSchema) => {
const unwrappedShapeSchema = unwrapZodType(shapeSchema, false);
if (instanceofZodTypeCoercible(unwrappedShapeSchema)) {
unwrappedShapeSchema._def.coerce = true;
}
});
}
}
ctx = await createContext?.({ req, res });
const caller = router.createCaller(ctx);
const segments = procedure.path.split('.');
const procedureFn = segments.reduce((acc, curr) => acc[curr], caller as any) as AnyProcedure;
data = await procedureFn(input);
const meta = responseMeta?.({
type: procedure.type,
paths: [procedure.path],
ctx,
data: [data],
errors: [],
});
const statusCode = meta?.status ?? 200;
const headers = meta?.headers ?? {};
const body: OpenApiSuccessResponse<typeof data> = data;
sendResponse(statusCode, headers, body);
} catch (cause) {
const error = getErrorFromUnknown(cause);
onError?.({
error,
type: procedure?.type ?? 'unknown',
path: procedure?.path,
input,
ctx,
req,
});
const meta = responseMeta?.({
type: procedure?.type ?? 'unknown',
paths: procedure?.path ? [procedure?.path] : undefined,
ctx,
data: [data],
errors: [error],
});
const errorShape = router.getErrorShape({
error,
type: procedure?.type ?? 'unknown',
path: procedure?.path,
input,
ctx,
});
const isInputValidationError =
error.code === 'BAD_REQUEST' &&
error.cause instanceof Error &&
error.cause.name === 'ZodError';
const statusCode = meta?.status ?? TRPC_ERROR_CODE_HTTP_STATUS[error.code] ?? 500;
const headers = meta?.headers ?? {};
const body: OpenApiErrorResponse = {
message: isInputValidationError
? 'Input validation failed'
: errorShape?.message ?? error.message ?? 'An error occurred',
code: error.code,
issues: isInputValidationError ? (error.cause as ZodError).errors : undefined,
};
sendResponse(statusCode, headers, body);
}
};
};