Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/remove-deprecated-remote-ip-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"nostream": minor
---

refactor(http): remove deprecated network.remote_ip_header fallback and rely on network.remoteIpHeader
23 changes: 14 additions & 9 deletions src/utils/http.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,21 @@ const isTrustedProxy = (ipAddress: string, settings: Settings): boolean => {
})
}

export const getRemoteAddress = (request: IncomingMessage, settings: Settings): string => {
let header: string | undefined
// TODO: Remove deprecation warning
if ('network' in settings && 'remote_ip_header' in settings.network) {
logger.warn(`WARNING: Setting network.remote_ip_header is deprecated and will be removed in a future version.
Use network.remoteIpHeader instead.`)
header = settings.network['remote_ip_header'] as string
} else {
header = settings.network.remoteIpHeader as string
const warnIfDeprecatedRemoteIpHeaderIsConfigured = (settings: Settings): void => {
const networkSettings = settings.network as Record<string, unknown> | undefined
const deprecatedHeader = networkSettings?.remote_ip_header

if (typeof deprecatedHeader === 'string' && deprecatedHeader.trim() !== '') {
logger.warn(
'WARNING: network.remote_ip_header is deprecated and no longer used. Rename it to network.remoteIpHeader to restore forwarded header handling.',
)
}
}

export const getRemoteAddress = (request: IncomingMessage, settings: Settings): string => {
Comment thread
Ferryx349 marked this conversation as resolved.
warnIfDeprecatedRemoteIpHeaderIsConfigured(settings)

const header = settings.network?.remoteIpHeader as string

const trustedProxies = settings.network?.trustedProxies
if (header && (!Array.isArray(trustedProxies) || trustedProxies.length === 0)) {
Expand Down
6 changes: 3 additions & 3 deletions test/unit/utils/http.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ describe('getRemoteAddress', () => {
} as any
})

it('returns address using network.remote_ip_address when set', () => {
it('returns address using network.remoteIpHeader when set', () => {
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could just remove this test case.

expect(
getRemoteAddress(
request,
{ network: { 'remote_ip_header': header, trustedProxies: [socketAddress] } } as any,
{ network: { remoteIpHeader: header, trustedProxies: [socketAddress] } } as any,
)
).to.equal(address)
})

it('returns address using network.remoteIpAddress when set', () => {
it('returns address using network.remoteIpHeader when set (duplicate shape)', () => {
expect(
getRemoteAddress(
request,
Expand Down
Loading