-
-
Notifications
You must be signed in to change notification settings - Fork 108
Expand file tree
/
Copy pathindex.js
More file actions
866 lines (752 loc) · 27.9 KB
/
Copy pathindex.js
File metadata and controls
866 lines (752 loc) · 27.9 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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
'use strict'
const { setTimeout: wait } = require('node:timers/promises')
const From = require('@fastify/reply-from')
const { ServerResponse } = require('node:http')
const WebSocket = require('ws')
const { convertUrlToWebSocket, sanitizeHeaders } = require('./utils')
const fp = require('fastify-plugin')
const qs = require('fast-querystring')
const { validateOptions } = require('./src/options')
const defaultRoutes = ['/', '/*']
const defaultHttpMethods = ['DELETE', 'GET', 'HEAD', 'PATCH', 'POST', 'PUT', 'OPTIONS']
const urlPattern = /^https?:\/\//
const absoluteUrlPattern = /^[a-zA-Z][a-zA-Z\d+.-]*:/
const kWs = Symbol('ws')
const kWsHead = Symbol('wsHead')
const kWsRewritePrefix = Symbol('wsRewritePrefix')
const kWsUpgradeListener = Symbol('wsUpgradeListener')
const kWsPrefixes = Symbol('wsPrefixes')
function liftErrorCode (code) {
/* c8 ignore start */
if (typeof code !== 'number') {
// Sometimes "close" event emits with a non-numeric value
return 1011
} else if (code === 1004 || code === 1005 || code === 1006) {
// ws module forbid those error codes usage, lift to "application level" (4xxx)
return 3000 + code
} else {
return code
}
/* c8 ignore stop */
}
function closeWebSocket (socket, code, reason) {
socket.isAlive = false
if (socket.readyState === WebSocket.OPEN) {
socket.close(liftErrorCode(code), reason)
}
}
function waitConnection (socket, write) {
if (socket.readyState === WebSocket.CONNECTING) {
socket.once('open', write)
} else {
write()
}
}
function waitForConnection (target, timeout) {
return new Promise((resolve, reject) => {
const timeoutId = setTimeout(() => {
/* c8 ignore start */
reject(new Error('WebSocket connection timeout'))
/* c8 ignore stop */
}, timeout)
/* c8 ignore start */
if (target.readyState === WebSocket.OPEN) {
clearTimeout(timeoutId)
return resolve()
}
/* c8 ignore stop */
if (target.readyState === WebSocket.CONNECTING) {
target.once('open', () => {
clearTimeout(timeoutId)
resolve()
})
target.once('error', (err) => {
clearTimeout(timeoutId)
reject(err)
})
/* c8 ignore start */
} else {
clearTimeout(timeoutId)
reject(new Error('WebSocket is closed'))
}
/* c8 ignore stop */
})
}
function isExternalUrl (url) {
return urlPattern.test(url)
}
function noop () { }
function noopPreRewrite (url) {
return url
}
function invalidDestination () {
const err = new Error('source/request contain invalid characters')
err.statusCode = 400
return err
}
function validateDestination (dest) {
const normalizedReference = dest
.replaceAll('\t', '')
.replaceAll('\n', '')
.replaceAll('\r', '')
.replaceAll('\0', '')
.trimStart()
.replaceAll('\\', '/')
if (absoluteUrlPattern.test(normalizedReference) || normalizedReference.startsWith('//')) {
throw invalidDestination()
}
let decoded
try {
decoded = decodeURIComponent(normalizedReference)
} catch {
throw invalidDestination()
}
if (decoded === '..' || decoded.includes('/..') || decoded.includes('../')) {
throw invalidDestination()
}
}
function resolveDestination (dest, rewritePrefix, upstream = 'http://fastify-http-proxy.invalid') {
validateDestination(dest)
const base = new URL(upstream)
const target = new URL(dest, base)
const prefix = new URL(rewritePrefix, base)
const prefixBoundary = prefix.pathname.endsWith('/')
? prefix.pathname
: `${prefix.pathname}/`
const isWithinPrefix = target.pathname === prefix.pathname || target.pathname.startsWith(prefixBoundary)
if (target.origin !== base.origin || prefix.origin !== base.origin || !isWithinPrefix) {
throw invalidDestination()
}
return target
}
function createContext (logger) {
return { log: logger }
}
function proxyWebSockets (logger, source, target, hooks) {
const context = createContext(logger)
function close (code, reason) {
if (hooks.onDisconnect) {
waitConnection(target, () => {
try {
hooks.onDisconnect(context, source)
} catch (err) {
logger.error({ err }, 'proxy ws error from onDisconnect hook')
}
})
}
closeWebSocket(source, code, reason)
closeWebSocket(target, code, reason)
}
source.on('message', (data, binary) => {
if (hooks.onIncomingMessage) {
try {
hooks.onIncomingMessage(context, source, target, { data, binary })
} catch (err) {
logger.error({ err }, 'proxy ws error from onIncomingMessage hook')
}
}
waitConnection(target, () => target.send(data, { binary }))
})
/* c8 ignore start */
source.on('ping', data => waitConnection(target, () => target.ping(data)))
source.on('pong', data => waitConnection(target, () => target.pong(data)))
/* c8 ignore stop */
source.on('close', close)
/* c8 ignore start */
source.on('error', error => close(1011, error.message))
source.on('unexpected-response', () => close(1011, 'unexpected response'))
/* c8 ignore stop */
// source WebSocket is already connected because it is created by ws server
target.on('message', (data, binary) => {
if (hooks.onOutgoingMessage) {
try {
hooks.onOutgoingMessage(context, source, target, { data, binary })
} catch (err) {
logger.error({ err }, 'proxy ws error from onOutgoingMessage hook')
}
}
source.send(data, { binary })
})
/* c8 ignore start */
target.on('ping', data => source.ping(data))
/* c8 ignore stop */
target.on('pong', data => source.pong(data))
target.on('close', close)
/* c8 ignore start */
target.on('error', error => close(1011, error.message))
target.on('unexpected-response', () => close(1011, 'unexpected response'))
/* c8 ignore stop */
if (hooks.onConnect) {
waitConnection(target, () => {
try {
hooks.onConnect(context, source, target)
} catch (err) {
logger.error({ err }, 'proxy ws error from onConnect hook')
}
})
}
}
async function reconnect (logger, source, reconnectOptions, hooks, targetParams) {
const { url, subprotocols, optionsWs } = targetParams
let attempts = 0
let target
do {
const reconnectWait = reconnectOptions.reconnectInterval * (reconnectOptions.reconnectDecay * attempts || 1)
reconnectOptions.logs && logger.warn({ target: targetParams.url }, `proxy ws reconnect in ${reconnectWait} ms`)
await wait(reconnectWait)
try {
target = new WebSocket(url, subprotocols, optionsWs)
await waitForConnection(target, reconnectOptions.connectionTimeout)
} catch (err) {
reconnectOptions.logs && logger.error({ target: targetParams.url, err, attempts }, 'proxy ws reconnect error')
attempts++
target = undefined
}
// stop if the source connection is closed during the reconnection
} while (source.isAlive && !target && attempts < reconnectOptions.maxReconnectionRetries)
/* c8 ignore start */
if (!source.isAlive) {
reconnectOptions.logs && logger.info({ target: targetParams.url, attempts }, 'proxy ws abort reconnect due to source is closed')
source.close()
return
}
/* c8 ignore stop */
if (!target) {
logger.error({ target: targetParams.url, attempts }, 'proxy ws failed to reconnect! No more retries')
source.close()
return
}
reconnectOptions.logs && logger.info({ target: targetParams.url, attempts }, 'proxy ws reconnected')
proxyWebSocketsWithReconnection(logger, source, target, reconnectOptions, hooks, targetParams, true)
}
function proxyWebSocketsWithReconnection (logger, source, target, options, hooks, targetParams, isReconnecting = false) {
const context = createContext(logger)
function close (code, reason) {
target.pingTimer && clearInterval(target.pingTimer)
target.pingTimer = undefined
closeWebSocket(target, code, reason)
// reconnect target as long as the source connection is active
if (source.isAlive && (target.broken || options.reconnectOnClose)) {
// clean up the target and related source listeners
target.isAlive = false
target.removeAllListeners()
reconnect(logger, source, options, hooks, targetParams)
return
}
if (hooks.onDisconnect) {
try {
hooks.onDisconnect(context, source)
} catch (err) {
options.logs && logger.error({ target: targetParams.url, err }, 'proxy ws error from onDisconnect hook')
}
}
options.logs && logger.info({ msg: 'proxy ws close link' })
closeWebSocket(source, code, reason)
closeWebSocket(target, code, reason)
}
function removeSourceListeners (source) {
source.off('message', sourceOnMessage)
source.off('ping', sourceOnPing)
source.off('pong', sourceOnPong)
source.off('close', sourceOnClose)
source.off('error', sourceOnError)
source.off('unexpected-response', sourceOnUnexpectedResponse)
}
/* c8 ignore start */
function sourceOnMessage (data, binary) {
source.isAlive = true
if (hooks.onIncomingMessage) {
try {
hooks.onIncomingMessage(context, source, target, { data, binary })
} catch (err) {
logger.error({ target: targetParams.url, err }, 'proxy ws error from onIncomingMessage hook')
}
}
waitConnection(target, () => target.send(data, { binary }))
}
function sourceOnPing (data) {
source.isAlive = true
waitConnection(target, () => target.ping(data))
}
function sourceOnPong (data) {
source.isAlive = true
waitConnection(target, () => target.pong(data))
}
function sourceOnClose (code, reason) {
source.isAlive = false
options.logs && logger.warn({ target: targetParams.url, code, reason }, 'proxy ws source close event')
close(code, reason)
}
function sourceOnError (error) {
source.isAlive = false
options.logs && logger.warn({ target: targetParams.url, error: error.message }, 'proxy ws source error event')
close(1011, error.message)
}
function sourceOnUnexpectedResponse () {
source.isAlive = false
options.logs && logger.warn({ target: targetParams.url }, 'proxy ws source unexpected-response event')
close(1011, 'unexpected response')
}
/* c8 ignore stop */
// need to specify the listeners to remove
removeSourceListeners(source)
// source is alive since it is created by the proxy service
// the pinger is not set since we can't reconnect from here
source.isAlive = true
source.on('message', sourceOnMessage)
source.on('ping', sourceOnPing)
source.on('pong', sourceOnPong)
source.on('close', sourceOnClose)
source.on('error', sourceOnError)
source.on('unexpected-response', sourceOnUnexpectedResponse)
// source WebSocket is already connected because it is created by ws server
/* c8 ignore start */
target.on('message', (data, binary) => {
target.isAlive = true
if (hooks.onOutgoingMessage) {
try {
hooks.onOutgoingMessage(context, source, target, { data, binary })
} catch (err) {
logger.error({ target: targetParams.url, err }, 'proxy ws error from onOutgoingMessage hook')
}
}
source.send(data, { binary })
})
target.on('ping', data => {
target.isAlive = true
source.ping(data)
})
target.on('pong', data => {
target.isAlive = true
if (hooks.onPong) {
try {
hooks.onPong(context, source, target)
} catch (err) {
logger.error({ target: targetParams.url, err }, 'proxy ws error from onPong hook')
}
}
source.pong(data)
})
/* c8 ignore stop */
target.on('close', (code, reason) => {
options.logs && logger.warn({ target: targetParams.url, code, reason }, 'proxy ws target close event')
close(code, reason)
})
/* c8 ignore start */
target.on('error', error => {
options.logs && logger.warn({ target: targetParams.url, error: error.message }, 'proxy ws target error event')
close(1011, error.message)
})
target.on('unexpected-response', () => {
options.logs && logger.warn({ target: targetParams.url }, 'proxy ws target unexpected-response event')
close(1011, 'unexpected response')
})
/* c8 ignore stop */
waitConnection(target, () => {
target.isAlive = true
target.pingTimer = setInterval(() => {
if (target.isAlive === false) {
target.broken = true
options.logs && logger.warn({ target: targetParams.url }, 'proxy ws connection is broken')
target.pingTimer && clearInterval(target.pingTimer)
target.pingTimer = undefined
return target.terminate()
}
target.isAlive = false
target.ping()
}, options.pingInterval).unref()
// call onConnect and onReconnect callbacks after the events are bound
if (isReconnecting && hooks.onReconnect) {
try {
hooks.onReconnect(context, source, target)
} catch (err) {
options.logs && logger.error({ target: targetParams.url, err }, 'proxy ws error from onReconnect hook')
}
} else if (hooks.onConnect) {
try {
hooks.onConnect(context, source, target)
} catch (err) {
options.logs && logger.error({ target: targetParams.url, err }, 'proxy ws error from onConnect hook')
}
}
})
}
function isUpgradeWithinPrefixes (rawRequest, prefixes) {
const pathname = rawRequest.url.split('?', 1)[0]
for (const prefix of prefixes) {
// Normalise the prefix to its path without a trailing slash. A proxy
// mounted at the root ('' or '/') owns every upgrade.
const base = prefix.endsWith('/') ? prefix.slice(0, -1) : prefix
if (base === '' || pathname === base || pathname.startsWith(`${base}/`)) {
return true
}
}
return false
}
function handleUpgrade (fastify, rawRequest, socket, head) {
// Save a reference to the socket and then dispatch the request through the normal fastify router so that it will invoke hooks and then eventually a route handler that might upgrade the socket.
rawRequest[kWs] = socket
rawRequest[kWsHead] = head
const rawResponse = new ServerResponse(rawRequest)
rawResponse.assignSocket(socket)
fastify.routing(rawRequest, rawResponse)
rawResponse.on('finish', () => {
socket.destroy()
})
}
class WebSocketProxy {
constructor (fastify, { wsReconnect, wsHooks, wsServerOptions, wsClientOptions, upstream, wsUpstream, replyOptions: { getUpstream } = {} }) {
this.logger = fastify.log
this.wsClientOptions = {
rewriteRequestHeaders: defaultWsHeadersRewrite,
headers: {},
...wsClientOptions
}
this.upstream = upstream ? convertUrlToWebSocket(upstream) : ''
this.wsUpstream = wsUpstream ? convertUrlToWebSocket(wsUpstream) : ''
this.getUpstream = getUpstream
this.wsReconnect = wsReconnect
this.wsHooks = wsHooks
const wss = new WebSocket.Server({
noServer: true,
...wsServerOptions
})
if (!fastify.server[kWsUpgradeListener]) {
// A single 'upgrade' listener is shared by every proxy registered on
// this server. When the proxy coexists with other 'upgrade' listeners
// (e.g. @fastify/websocket), it must only handle upgrades that target
// one of the registered proxy prefixes, otherwise it would hijack
// WebSocket endpoints it does not own. When the proxy is the only
// 'upgrade' listener, every upgrade is dispatched as before so that
// out-of-prefix requests are still routed (and rejected) normally.
const prefixes = fastify.server[kWsPrefixes] = []
fastify.server[kWsUpgradeListener] = (rawRequest, socket, head) => {
if (
fastify.server.listenerCount('upgrade') === 1 ||
isUpgradeWithinPrefixes(rawRequest, prefixes)
) {
handleUpgrade(fastify, rawRequest, socket, head)
}
}
fastify.server.on('upgrade', fastify.server[kWsUpgradeListener])
}
fastify.server[kWsPrefixes].push(fastify.prefix)
this.handleUpgrade = (request, dest, cb) => {
wss.handleUpgrade(request.raw, request.raw[kWs], request.raw[kWsHead], (socket) => {
this.handleConnection(socket, request, dest)
cb()
})
}
// To be able to close the HTTP server,
// all WebSocket clients need to be disconnected.
// Fastify is missing a pre-close event, or the ability to
// add a hook before the server.close call. We need to resort
// to monkeypatching for now.
{
const oldClose = fastify.server.close
fastify.server.close = function (done) {
wss.close(() => {
oldClose.call(this, (err) => {
done && done(err)
})
})
for (const client of wss.clients) {
client.close()
}
}
}
/* c8 ignore start */
wss.on('error', (err) => {
this.logger.error(err)
})
/* c8 ignore stop */
this.wss = wss
this.prefixList = []
}
findUpstream (request, dest) {
const { search } = new URL(request.url, 'ws://127.0.0.1')
const rewritePrefix = request.raw[kWsRewritePrefix] || '/'
if (typeof this.wsUpstream === 'string' && this.wsUpstream !== '') {
const target = resolveDestination(dest, rewritePrefix, this.wsUpstream)
target.search = search
return target
}
if (typeof this.upstream === 'string' && this.upstream !== '') {
const target = resolveDestination(dest, rewritePrefix, this.upstream)
target.search = search
return target
}
const upstream = this.getUpstream(request, '')
const target = resolveDestination(dest, rewritePrefix, upstream)
/* c8 ignore next */
target.protocol = upstream.indexOf('http:') === 0 ? 'ws:' : 'wss'
target.search = search
return target
}
handleConnection (source, request, dest) {
const url = this.findUpstream(request, dest)
const queryString = getQueryString(url.search, request.url, this.wsClientOptions, request)
url.search = queryString
const rewriteRequestHeaders = this.wsClientOptions.rewriteRequestHeaders
const headersToRewrite = this.wsClientOptions.headers
const subprotocols = []
if (source.protocol) {
subprotocols.push(source.protocol)
}
const headers = rewriteRequestHeaders(headersToRewrite, request)
const optionsWs = { ...this.wsClientOptions, headers }
const target = new WebSocket(url, subprotocols, optionsWs)
this.logger.debug({ url: url.href }, 'proxy websocket')
if (this.wsReconnect) {
const targetParams = { url, subprotocols, optionsWs }
proxyWebSocketsWithReconnection(this.logger, source, target, this.wsReconnect, this.wsHooks, targetParams)
} else {
proxyWebSockets(this.logger, source, target, this.wsHooks)
}
}
}
function getQueryString (search, reqUrl, opts, request) {
if (typeof opts.queryString === 'function') {
return '?' + opts.queryString(search, reqUrl, request)
}
if (opts.queryString) {
return '?' + qs.stringify(opts.queryString)
}
if (search.length > 0) {
return search
}
return ''
}
function defaultWsHeadersRewrite (headers, request) {
if (request.headers.cookie) {
return { ...headers, cookie: request.headers.cookie }
}
return { ...headers }
}
function generateRewritePrefix (prefix, opts) {
let rewritePrefix = opts.rewritePrefix || (opts.upstream ? new URL(opts.upstream).pathname : '/')
if (!prefix.endsWith('/') && rewritePrefix.endsWith('/')) {
rewritePrefix = rewritePrefix.slice(0, -1)
}
return rewritePrefix
}
// Find the raw path boundary matching the router-normalized prefix without decoding the suffix.
function getRawPrefixLength (path, prefix, options) {
if (options.ignoreDuplicateSlashes) {
prefix = prefix.replace(/\/\/+/g, '/')
}
if (!options.caseSensitive) {
prefix = prefix.toLowerCase()
}
if (prefix.length === 0) {
return 0
}
let pathIndex = 0
let decodedPrefix = ''
let previousWasSlash = false
while (pathIndex < path.length) {
const isSlash = path[pathIndex] === '/'
if (options.ignoreDuplicateSlashes && isSlash && previousWasSlash) {
pathIndex++
continue
}
let rawLength = 1
let decodedCharacter
if (path[pathIndex] === '%') {
rawLength = 3
// A percent-encoded UTF-8 character can contain up to four byte triplets.
while (true) {
try {
decodedCharacter = decodeURI(path.slice(pathIndex, pathIndex + rawLength))
break
} catch (error) {
if (rawLength === 12 || path[pathIndex + rawLength] !== '%') {
throw error
}
rawLength += 3
}
}
} else {
rawLength = path.codePointAt(pathIndex) > 0xFFFF ? 2 : 1
decodedCharacter = path.slice(pathIndex, pathIndex + rawLength)
}
decodedPrefix += decodedCharacter
pathIndex += rawLength
previousWasSlash = isSlash
const normalizedDecodedPrefix = options.caseSensitive ? decodedPrefix : decodedPrefix.toLowerCase()
if (normalizedDecodedPrefix === prefix) {
return pathIndex
}
if (normalizedDecodedPrefix.length >= prefix.length) {
return -1
}
}
return -1
}
async function fastifyHttpProxy (fastify, opts) {
opts = validateOptions(opts)
const replyHandler = opts.handler ?? function replyHandler (_, reply, dest, options) {
return reply.from(dest, options)
}
const preHandler = opts.preHandler || opts.beforeHandler
const preRewrite = typeof opts.preRewrite === 'function' ? opts.preRewrite : noopPreRewrite
const rewritePrefix = generateRewritePrefix(fastify.prefix, opts)
const initialConfig = fastify.initialConfig
const routerOptions = initialConfig.routerOptions || {}
const prefixMatchingOptions = {
caseSensitive: routerOptions.caseSensitive ?? initialConfig.caseSensitive,
ignoreDuplicateSlashes: routerOptions.ignoreDuplicateSlashes ?? initialConfig.ignoreDuplicateSlashes,
ignoreTrailingSlash: routerOptions.ignoreTrailingSlash ?? initialConfig.ignoreTrailingSlash
}
const fromOpts = Object.assign({}, opts)
fromOpts.base = opts.upstream
fromOpts.prefix = undefined
const internalRewriteLocationHeader = opts.internalRewriteLocationHeader ?? true
const oldRewriteHeaders = (opts.replyOptions || {}).rewriteHeaders
const replyOpts = Object.assign({}, opts.replyOptions, {
rewriteHeaders
})
fromOpts.rewriteHeaders = rewriteHeaders
fastify.register(From, fromOpts)
if (opts.preValidation) {
fastify.addHook('preValidation', opts.preValidation)
} else if (opts.proxyPayloads !== false) {
fastify.addContentTypeParser('application/json', bodyParser)
fastify.addContentTypeParser('*', bodyParser)
}
function rewriteHeaders (headers, req) {
const location = headers.location
if (location && !isExternalUrl(location) && internalRewriteLocationHeader) {
headers.location = location.replace(rewritePrefix, fastify.prefix)
}
if (oldRewriteHeaders) {
headers = oldRewriteHeaders(headers, req)
}
// Sanitize header values so an upstream reply with an invalid header
// does not crash the whole request.
headers = sanitizeHeaders(headers)
return headers
}
function bodyParser (_req, payload, done) {
done(null, payload)
}
const method = opts.httpMethods || defaultHttpMethods
const config = opts.config || {}
const constraints = opts.constraints || {}
for (const url of opts.routes || defaultRoutes) {
fastify.route({ url, method, preHandler, config, constraints, handler })
}
let wsProxy
if (opts.websocket) {
wsProxy = new WebSocketProxy(fastify, opts)
}
function extractUrlComponents (urlString) {
const [path, queryString] = urlString.split('?', 2)
const components = {
path,
queryParams: null
}
if (queryString) {
components.queryParams = qs.parse(queryString)
}
return components
}
function fromParametersWithRewritePrefix (url, params = {}, prefix = '/') {
url = preRewrite(url, params, prefix)
const { path, queryParams } = extractUrlComponents(url)
let dest = path
let effectiveRewritePrefix = rewritePrefix
if (prefix.includes(':')) {
let normalizedPath = path
let normalizedPrefix = prefix
if (prefixMatchingOptions.ignoreDuplicateSlashes) {
normalizedPath = normalizedPath.replace(/\/\/+/g, '/')
normalizedPrefix = normalizedPrefix.replace(/\/\/+/g, '/')
}
const requestedPathElements = normalizedPath.split('/')
const prefixPathWithVariables = normalizedPrefix.split('/').map((_, index) => requestedPathElements[index]).join('/')
const decodedPrefixPath = decodeURI(prefixPathWithVariables)
let rewritePrefixWithVariables = rewritePrefix
for (const [name, value] of Object.entries(params)) {
rewritePrefixWithVariables = rewritePrefixWithVariables.replace(`:${name}`, value)
}
let rawPrefixLength = getRawPrefixLength(dest, decodedPrefixPath, prefixMatchingOptions)
if (rawPrefixLength === -1 && prefixMatchingOptions.ignoreTrailingSlash && decodedPrefixPath.endsWith('/')) {
const lengthWithoutTrailingSlash = getRawPrefixLength(dest, decodedPrefixPath.slice(0, -1), prefixMatchingOptions)
if (lengthWithoutTrailingSlash === dest.length) {
rawPrefixLength = lengthWithoutTrailingSlash
}
}
if (rawPrefixLength !== -1) {
dest = rewritePrefixWithVariables + dest.slice(rawPrefixLength)
effectiveRewritePrefix = rewritePrefixWithVariables
}
} else {
let rawPrefixLength = getRawPrefixLength(dest, prefix, prefixMatchingOptions)
let normalizedPrefix = prefix
if (prefixMatchingOptions.ignoreDuplicateSlashes) {
normalizedPrefix = normalizedPrefix.replace(/\/\/+/g, '/')
}
if (rawPrefixLength === -1 && prefixMatchingOptions.ignoreTrailingSlash && normalizedPrefix.length > 1 && normalizedPrefix.endsWith('/')) {
const lengthWithoutTrailingSlash = getRawPrefixLength(dest, normalizedPrefix.slice(0, -1), prefixMatchingOptions)
if (lengthWithoutTrailingSlash === dest.length) {
rawPrefixLength = lengthWithoutTrailingSlash
}
}
if (rawPrefixLength !== -1) {
dest = rewritePrefix + dest.slice(rawPrefixLength)
}
}
if (queryParams) {
dest += `?${qs.stringify(queryParams)}`
}
return { url: dest || '/', options: replyOpts, rewritePrefix: effectiveRewritePrefix }
}
function fromParameters (url, params = {}, prefix = '/') {
const result = fromParametersWithRewritePrefix(url, params, prefix)
// Reject traversal escapes (including backslash dot-segments) so callers that
// proxy the returned url via reply.from() get the same protection as the handler.
validateDestination(result.url.split('?', 1)[0])
return { url: result.url, options: result.options }
}
function handler (request, reply) {
const { url, options, rewritePrefix: effectiveRewritePrefix } = fromParametersWithRewritePrefix(request.url, request.params, this.prefix)
const dest = url.split('?', 1)[0]
if (request.raw[kWs]) {
// Validate before hijacking so Fastify can return a 400 response.
request.raw[kWsRewritePrefix] = effectiveRewritePrefix
resolveDestination(dest, effectiveRewritePrefix)
reply.hijack()
try {
wsProxy.handleUpgrade(request, dest, noop)
} /* c8 ignore start */ catch (err) {
request.log.warn({ err }, 'websocket proxy error')
} /* c8 ignore stop */
return
}
let upstream = opts.upstream
let handlerOptions = options
if (typeof options.getUpstream === 'function') {
upstream = options.getUpstream(request, upstream)
handlerOptions = { ...options, getUpstream: () => upstream }
}
resolveDestination(dest, effectiveRewritePrefix, upstream || undefined)
return replyHandler(request, reply, dest, handlerOptions)
}
fastify.decorateReply('fromParameters', fromParameters)
fastify.decorateReply('wsProxy', {
/* c8 ignore next 3 */
getter () {
return wsProxy
}
})
}
module.exports = fp(fastifyHttpProxy, {
fastify: '5.x',
name: '@fastify/http-proxy',
encapsulate: true
})
module.exports.default = fastifyHttpProxy
module.exports.defaultRoutes = defaultRoutes
module.exports.defaultHttpMethods = defaultHttpMethods
module.exports.fastifyHttpProxy = fastifyHttpProxy