OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.
import { describe, expect, it } from 'bun:test';
import type { IpHeaderConfig } from '../config';
import {
getClientIpFromHeaders,
getTrustedIpFromHeaders,
} from './get-client-ip';
/** IP_HEADER_ORDER / TRUSTED_IP_HEADER_ORDER unset: the shipped orders stand. */
const DEFAULT_ORDERS: IpHeaderConfig = {
attributionOrder: undefined,
trustedOrder: undefined,
};
describe('getTrustedIpFromHeaders', () => {
it('prefers cf-connecting-ip over anything the caller can set', () => {
// Verified against production: Cloudflare overwrites cf-connecting-ip, but
// passes a forged x-forwarded-for / x-client-ip straight through.
const headers = {
'x-client-ip': '9.9.9.9',
'x-forwarded-for': '8.8.8.8',
'cf-connecting-ip': '98.128.229.56',
};
expect(getTrustedIpFromHeaders(DEFAULT_ORDERS, headers)).toEqual({
ip: '98.128.229.56',
header: 'cf-connecting-ip',
});
// The analytics resolver deliberately trusts the caller - that is the
// difference the two functions exist for.
expect(getClientIpFromHeaders(DEFAULT_ORDERS, headers).ip).toBe('9.9.9.9');
});
it('never returns a client-forwarded header', () => {
expect(
getTrustedIpFromHeaders(DEFAULT_ORDERS, {
'openpanel-client-ip': '9.9.9.9',
'x-client-ip': '7.7.7.7',
'true-client-ip': '6.6.6.6',
}).ip
).toBe('');
});
it('takes the last x-forwarded-for entry, the one the proxy appended', () => {
expect(
getTrustedIpFromHeaders(DEFAULT_ORDERS, {
'x-forwarded-for': '8.8.8.8, 1.2.3.4',
})
).toEqual({ ip: '1.2.3.4', header: 'x-forwarded-for' });
});
it('falls back to the socket address, private ranges included', () => {
expect(getTrustedIpFromHeaders(DEFAULT_ORDERS, {}, '127.0.0.1')).toEqual({
ip: '127.0.0.1',
header: 'socket',
});
});
it('returns nothing when there is neither a trusted header nor a socket', () => {
expect(getTrustedIpFromHeaders(DEFAULT_ORDERS, {})).toEqual({
ip: '',
header: '',
});
});
});