@orpc/node 2.0.0-beta.48 → 2.0.0-beta.49

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,215 @@
1
+ import { createReadStream } from 'node:fs';
2
+ import { stat } from 'node:fs/promises';
3
+ import path from 'node:path';
4
+ import { getTracer, isAcceptableEncoding, isCompressibleContentType, matchesHttpPathPrefix, mergeHttpPath, parseAcceptEncodingQualities, safeDecodeURIComponent, toArray, } from '@orpc/shared';
5
+ import { flattenStandardHeader, parseStandardUrl } from '@standard-server/core';
6
+ import { toWebReadableStream } from '@standard-server/node';
7
+ import mime from 'mime';
8
+ const UNSAFE_SEGMENT_REGEX = /^[. ]+$|[\0/\\]/;
9
+ const UNSAFE_OR_DOTFILE_SEGMENT_REGEX = /^[. ]+$|^\.|^[^.]{0,6}~\d|[\0/\\]/;
10
+ const PRECOMPRESSED_ENCODINGS = [
11
+ ['br', '.br'],
12
+ ['zstd', '.zst'],
13
+ ['gzip', '.gz'],
14
+ ];
15
+ /**
16
+ * Serves static files from a directory: index files, `ETag`/`Last-Modified`
17
+ * revalidation, range requests, and precompressed sidecars. Files are served
18
+ * as a fallback, so matched procedures always win.
19
+ *
20
+ * @see {@link https://orpc.dev/docs/plugins/static-file | Static File Plugin}
21
+ */
22
+ export class StaticFileHandlerPlugin {
23
+ name = '~static-file';
24
+ after = ['~tracing'];
25
+ before = ['~head-method'];
26
+ rootDir;
27
+ path;
28
+ indexFile;
29
+ fallbackFilePath;
30
+ cacheControl;
31
+ unsafeSegmentRegex;
32
+ precompressed;
33
+ mimeTypes;
34
+ constructor(options) {
35
+ this.rootDir = path.resolve(options.rootDir);
36
+ this.path = stripTrailingSlash(options.path ?? '/');
37
+ this.indexFile = options.indexFile ?? 'index.html';
38
+ this.fallbackFilePath =
39
+ options.fallbackFile === undefined ? undefined : path.join(this.rootDir, options.fallbackFile);
40
+ this.cacheControl = options.cacheControl ?? 'public, max-age=0';
41
+ this.unsafeSegmentRegex = options.dotfiles
42
+ ? UNSAFE_SEGMENT_REGEX
43
+ : UNSAFE_OR_DOTFILE_SEGMENT_REGEX;
44
+ this.precompressed = options.precompressed ?? false;
45
+ this.mimeTypes = Object.assign(Object.create(null), options.mimeTypes);
46
+ }
47
+ init(options) {
48
+ const routingInterceptor = async ({ next, request, prefix, }) => {
49
+ const result = await next();
50
+ if (result.matched || (request.method !== 'GET' && request.method !== 'HEAD')) {
51
+ return result;
52
+ }
53
+ const base = prefix === undefined ? this.path : stripTrailingSlash(mergeHttpPath(prefix, this.path));
54
+ const response = await this.serve(request, base);
55
+ if (response === undefined) {
56
+ return result;
57
+ }
58
+ getTracer()
59
+ ?.getActiveSpan()
60
+ ?.updateName(`${request.method} ${base === '/' ? '' : base}/* (static file)`);
61
+ return { matched: true, response };
62
+ };
63
+ return {
64
+ ...options,
65
+ routingInterceptors: [...toArray(options.routingInterceptors), routingInterceptor],
66
+ };
67
+ }
68
+ async serve(request, base) {
69
+ const [pathname] = parseStandardUrl(request.url);
70
+ if (base !== '/' && !matchesHttpPathPrefix(pathname, base)) {
71
+ return undefined;
72
+ }
73
+ const segments = [];
74
+ let isDirectoryUrl = false;
75
+ for (const rawSegment of pathname.slice(base.length).split('/')) {
76
+ const segment = safeDecodeURIComponent(rawSegment);
77
+ isDirectoryUrl = segment === '' || segment === '.';
78
+ if (isDirectoryUrl) {
79
+ continue;
80
+ }
81
+ if (this.unsafeSegmentRegex.test(segment)) {
82
+ return undefined;
83
+ }
84
+ segments.push(segment);
85
+ }
86
+ let filePath = path.join(this.rootDir, ...segments);
87
+ let stats = isDirectoryUrl ? undefined : await getStats(filePath);
88
+ if (isDirectoryUrl || stats?.isDirectory()) {
89
+ stats = undefined;
90
+ if (this.indexFile !== false) {
91
+ filePath = path.join(filePath, this.indexFile);
92
+ stats = await getStats(filePath);
93
+ }
94
+ }
95
+ if (!stats?.isFile() && this.fallbackFilePath !== undefined) {
96
+ filePath = this.fallbackFilePath;
97
+ stats = await getStats(filePath);
98
+ }
99
+ if (!stats?.isFile()) {
100
+ return undefined;
101
+ }
102
+ const contentType = this.resolveContentType(filePath);
103
+ const headers = {};
104
+ let contentEncoding;
105
+ if (this.precompressed && isCompressibleContentType(contentType)) {
106
+ headers.vary = 'accept-encoding';
107
+ const qualities = parseAcceptEncodingQualities(flattenStandardHeader(request.headers['accept-encoding']));
108
+ for (const [encoding, extension] of PRECOMPRESSED_ENCODINGS) {
109
+ if (!isAcceptableEncoding(qualities, encoding)) {
110
+ continue;
111
+ }
112
+ const variantStats = await getStats(filePath + extension);
113
+ if (variantStats?.isFile()) {
114
+ filePath += extension;
115
+ stats = variantStats;
116
+ contentEncoding = encoding;
117
+ break;
118
+ }
119
+ }
120
+ }
121
+ const size = stats.size;
122
+ const etag = `"${size.toString(16)}-${stats.mtime.getTime().toString(16)}"`;
123
+ const lastModifiedTime = Math.floor(stats.mtime.getTime() / 1000) * 1000;
124
+ headers.etag = etag;
125
+ headers['last-modified'] = stats.mtime.toUTCString();
126
+ headers['accept-ranges'] = 'bytes';
127
+ if (this.cacheControl !== false) {
128
+ headers['cache-control'] = this.cacheControl;
129
+ }
130
+ if (isNotModified(request.headers, etag, lastModifiedTime)) {
131
+ return { status: 304, headers };
132
+ }
133
+ let status = 200;
134
+ let start = 0;
135
+ let end = size - 1;
136
+ const range = request.method === 'GET' ? flattenStandardHeader(request.headers.range) : undefined;
137
+ if (range !== undefined && isRangeApplicable(request.headers, etag, lastModifiedTime)) {
138
+ const parsed = parseByteRange(range, size);
139
+ if (parsed === 'unsatisfiable') {
140
+ return { status: 416, headers: { ...headers, 'content-range': `bytes */${size}` } };
141
+ }
142
+ if (parsed !== undefined) {
143
+ status = 206;
144
+ [start, end] = parsed;
145
+ headers['content-range'] = `bytes ${start}-${end}/${size}`;
146
+ }
147
+ }
148
+ if (contentEncoding !== undefined) {
149
+ headers['content-encoding'] = contentEncoding;
150
+ }
151
+ headers['content-type'] = contentType;
152
+ headers['content-length'] = `${end - start + 1}`;
153
+ const body = request.method === 'HEAD'
154
+ ? new ReadableStream({ start: (controller) => controller.close() })
155
+ : toWebReadableStream(createReadStream(filePath, status === 206 ? { start, end } : undefined));
156
+ return { status, headers, body };
157
+ }
158
+ resolveContentType(filePath) {
159
+ const extension = path.extname(filePath).slice(1).toLowerCase();
160
+ const configured = this.mimeTypes[extension];
161
+ if (configured !== undefined) {
162
+ return configured;
163
+ }
164
+ const contentType = mime.getType(extension);
165
+ if (contentType === null) {
166
+ return 'application/octet-stream';
167
+ }
168
+ return contentType.startsWith('text/') ? `${contentType}; charset=utf-8` : contentType;
169
+ }
170
+ }
171
+ function getStats(filePath) {
172
+ return stat(filePath).catch(() => undefined);
173
+ }
174
+ function stripTrailingSlash(path) {
175
+ return path.length > 1 && path.endsWith('/') ? path.slice(0, -1) : path;
176
+ }
177
+ function isNotModified(requestHeaders, etag, lastModifiedTime) {
178
+ const ifNoneMatch = flattenStandardHeader(requestHeaders['if-none-match']);
179
+ if (ifNoneMatch !== undefined) {
180
+ return (ifNoneMatch.trim() === '*' ||
181
+ ifNoneMatch.split(',').some((tag) => {
182
+ tag = tag.trim();
183
+ return (tag.startsWith('W/') ? tag.slice(2) : tag) === etag;
184
+ }));
185
+ }
186
+ const ifModifiedSince = flattenStandardHeader(requestHeaders['if-modified-since']);
187
+ return ifModifiedSince !== undefined && lastModifiedTime <= Date.parse(ifModifiedSince);
188
+ }
189
+ function isRangeApplicable(requestHeaders, etag, lastModifiedTime) {
190
+ const ifRange = flattenStandardHeader(requestHeaders['if-range']);
191
+ if (ifRange === undefined) {
192
+ return true;
193
+ }
194
+ return ifRange.startsWith('"') || ifRange.startsWith('W/')
195
+ ? ifRange === etag
196
+ : Date.parse(ifRange) === lastModifiedTime;
197
+ }
198
+ function parseByteRange(range, size) {
199
+ const match = range.match(/^bytes=\s*(\d*)-(\d*)$/i);
200
+ if (match === null || (match[1] === '' && match[2] === '')) {
201
+ return undefined;
202
+ }
203
+ if (match[1] === '') {
204
+ const suffixLength = Number(match[2]);
205
+ return suffixLength === 0 || size === 0
206
+ ? 'unsatisfiable'
207
+ : [Math.max(0, size - suffixLength), size - 1];
208
+ }
209
+ const start = Number(match[1]);
210
+ if (start >= size) {
211
+ return 'unsatisfiable';
212
+ }
213
+ const end = match[2] === '' ? size - 1 : Math.min(Number(match[2]), size - 1);
214
+ return end < start ? undefined : [start, end];
215
+ }
@@ -0,0 +1,142 @@
1
+ import type { FilePropertyBag } from 'node:buffer';
2
+ import type { Context } from '@orpc/server';
3
+ import type { StandardHandlerOptions, StandardHandlerPlugin, StandardHandlerRoutingInterceptorOptions } from '@orpc/server/standard';
4
+ import type { Promisable, Value } from '@orpc/shared';
5
+ export interface TmpFileUploadHandlerPluginMaxBodySize {
6
+ /**
7
+ * The maximum size in bytes of request body content buffered into memory:
8
+ * JSON, URL-encoded forms, and the fields, part headers, and in-memory files
9
+ * of a multipart body in total, and each event of an event stream on its
10
+ * own. Exceeding it rejects with `PAYLOAD_TOO_LARGE`, except for uploads,
11
+ * which spool to disk instead once they no longer fit. Usually the lowest of
12
+ * the three limits, because this content cannot stream anywhere.
13
+ */
14
+ memory: number;
15
+ /**
16
+ * The maximum total size in bytes of uploaded file content: file bodies and
17
+ * the file parts of a multipart body combined, whether held in memory or
18
+ * spooled to temporary files. A larger body rejects the request with
19
+ * `PAYLOAD_TOO_LARGE`.
20
+ */
21
+ file: number;
22
+ /**
23
+ * The maximum total size in bytes of a request body that is consumed as a
24
+ * stream: event streams and raw binary streams. Enforced while the stream is
25
+ * consumed, so an oversized stream fails at the reader. Usually the highest
26
+ * of the three limits, but keep it finite so no client can stream
27
+ * indefinitely.
28
+ */
29
+ stream: number;
30
+ }
31
+ export interface TmpFileUploadHandlerPluginOptions<T extends Context> {
32
+ /**
33
+ * The directory temporary files are created under. Each request that spools
34
+ * an upload gets its own subdirectory inside it, removed when the request
35
+ * finishes.
36
+ *
37
+ * @default os.tmpdir()
38
+ */
39
+ tmpDir?: string | undefined;
40
+ /**
41
+ * The size limit for each kind of request body, either fixed or resolved
42
+ * per request, so limits can follow the request itself, such as a larger
43
+ * allowance for an authenticated user than for a guest. Every kind is
44
+ * required when the option is given, so none is left unbounded by accident;
45
+ * set a kind to `Number.POSITIVE_INFINITY` to deliberately leave it
46
+ * unlimited.
47
+ *
48
+ * A resolver runs only when a body is parsed, so a request without one never
49
+ * pays for it, and it receives the request as it arrived, before this plugin
50
+ * wraps its body resolution.
51
+ *
52
+ * @default unlimited for every kind
53
+ */
54
+ maxBodySize?: Value<Promisable<TmpFileUploadHandlerPluginMaxBodySize>, [
55
+ options: StandardHandlerRoutingInterceptorOptions<T>
56
+ ]> | undefined;
57
+ /**
58
+ * The size in bytes an uploaded file must exceed before it is spooled to a
59
+ * temporary file. Smaller files stay in memory as plain `File`s, counted
60
+ * against `maxBodySize.memory`, and spool anyway once they no longer fit.
61
+ * Set to `0` to spool every non-empty upload.
62
+ *
63
+ * @default 64 * 1024
64
+ */
65
+ spoolThreshold?: number | undefined;
66
+ }
67
+ /**
68
+ * A `File` whose content lives in a temporary file on disk and is read lazily,
69
+ * so it can represent an upload far larger than available memory.
70
+ *
71
+ * @remarks
72
+ * Node's `fs.openAsBlob`, which backs this class, has known bugs with files
73
+ * over 2 GiB ({@link https://github.com/nodejs/node/issues/52585}): `size` is
74
+ * truncated above 4 GiB and `slice()` is unreliable above 2 GiB, while
75
+ * whole-file reads like `stream()` stay correct. When size or random access
76
+ * matters for such a file, stat or read {@link path} directly.
77
+ *
78
+ * @see {@link https://orpc.dev/docs/plugins/tmp-file-upload | Tmp File Upload Plugin}
79
+ */
80
+ export declare class TmpFile extends File {
81
+ /**
82
+ * Absolute path of the temporary file holding this file's content.
83
+ * The file is removed when the request finishes, so move or copy it
84
+ * to keep the content. The `File` reads from this path, so it must
85
+ * not be read after the file is moved or removed.
86
+ */
87
+ readonly path: string;
88
+ constructor(blob: Blob,
89
+ /**
90
+ * Absolute path of the temporary file holding this file's content.
91
+ * The file is removed when the request finishes, so move or copy it
92
+ * to keep the content. The `File` reads from this path, so it must
93
+ * not be read after the file is moved or removed.
94
+ */
95
+ path: string, name: string, options?: FilePropertyBag);
96
+ }
97
+ /**
98
+ * Parses file uploads into temporary files instead of memory. Bodies the standard
99
+ * body parser would buffer into an in-memory `File`, and multipart file parts, are
100
+ * streamed to disk once they outgrow the spool threshold and surfaced as lazily read
101
+ * {@link TmpFile} instances, so requests far larger than available memory parse in
102
+ * constant memory. Smaller uploads stay in memory as plain `File`s. Every other body is
103
+ * left to the standard parser.
104
+ *
105
+ * Request body sizes are limited per content category: buffered in memory, uploaded
106
+ * files, and streamed, each limit fixed or resolved per request. This subsumes the
107
+ * request limit plugin while sizing each kind of body to what it actually costs.
108
+ *
109
+ * @remarks
110
+ * Temporary files are removed when the request finishes. A streaming response body,
111
+ * an event iterator or a raw stream, keeps them alive until it completes, so
112
+ * responses that read the upload while streaming work. Any other response is
113
+ * transmitted after removal, so one that embeds the upload itself, as a `File` or
114
+ * inside `FormData`, needs the content copied or the file moved first.
115
+ *
116
+ * @see {@link https://orpc.dev/docs/plugins/tmp-file-upload | Tmp File Upload Plugin}
117
+ */
118
+ export declare class TmpFileUploadHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
119
+ name: string;
120
+ /**
121
+ * Should parse the original request body instead of batched sub-requests.
122
+ */
123
+ after: string[];
124
+ /**
125
+ * Should run inside the limit and compression plugins, so spooling receives
126
+ * the size-checked, decompressed bytes.
127
+ */
128
+ before: string[];
129
+ private readonly tmpDir;
130
+ private readonly maxBodySize;
131
+ private readonly spoolThreshold;
132
+ constructor(options?: TmpFileUploadHandlerPluginOptions<T>);
133
+ init(options: StandardHandlerOptions<T>): StandardHandlerOptions<T>;
134
+ private resolveBody;
135
+ /**
136
+ * Enforces size limits on a body the standard parser handles, counting the
137
+ * raw bytes before handing them back for regular parsing.
138
+ */
139
+ private parseLimitedBody;
140
+ private parseFileBody;
141
+ private parseMultipartBody;
142
+ }