File size: 3,016 Bytes
dcedb25 | 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 | import { afterEach, describe, expect, it } from 'vitest';
import type { NextFunction, Request, Response } from 'express';
import { clientContextMiddleware, getClientContext } from '../../lib/client-context.js';
// Minimal fake req: the middleware only touches headers, socket, and req.ip.
// `ip` is what Express resolves from the socket peer address (or from the
// X-Forwarded-For chain when `trust proxy` is enabled) — the middleware reads
// req.ip rather than re-implementing the trust chain itself (#1024).
function fakeReq(headers: Record<string, string | string[]>, remoteAddress?: string, ip?: string): Request {
return { headers, socket: { remoteAddress }, ip } as unknown as Request;
}
// Run the middleware and capture the context visible to downstream code
// (i.e. what logRequest would read inside the request's async scope).
function contextFor(req: Request): ReturnType<typeof getClientContext> {
let seen = getClientContext();
clientContextMiddleware(req, {} as Response, (() => { seen = getClientContext(); }) as NextFunction);
return seen;
}
describe('clientContextMiddleware', () => {
afterEach(() => {
delete process.env.REQUEST_ANALYTICS_LOG_CLIENT;
});
it('captures the socket peer address and user agent', () => {
const ctx = contextFor(fakeReq({ 'user-agent': 'curl/8.6.0' }, '192.168.0.42'));
expect(ctx).toEqual({ ip: '192.168.0.42', userAgent: 'curl/8.6.0', agent: 'unknown' });
});
it('uses Express-resolved req.ip (trust-proxy chain) when available', () => {
// With TRUST_PROXY enabled, Express resolves req.ip to the first untrusted
// hop of the X-Forwarded-For chain; the middleware trusts that resolution.
const ctx = contextFor(fakeReq(
{ 'x-forwarded-for': '10.1.2.3, 172.16.0.1', 'user-agent': 'ua' },
'127.0.0.1',
'10.1.2.3',
));
expect(ctx.ip).toBe('10.1.2.3');
});
it('falls back to the socket peer address when req.ip is absent', () => {
const ctx = contextFor(fakeReq(
{ 'x-forwarded-for': '10.1.2.3, 172.16.0.1', 'user-agent': 'ua' },
'127.0.0.1',
));
// trust proxy disabled → spoofed header ignored, socket address used.
expect(ctx.ip).toBe('127.0.0.1');
});
it('normalizes IPv4-mapped IPv6 addresses', () => {
const ctx = contextFor(fakeReq({}, '::ffff:192.168.0.5'));
expect(ctx.ip).toBe('192.168.0.5');
});
it('truncates oversized user agents to 256 chars', () => {
const ctx = contextFor(fakeReq({ 'user-agent': 'x'.repeat(1000) }, '1.2.3.4'));
expect(ctx.userAgent).toHaveLength(256);
});
it('stores nulls when REQUEST_ANALYTICS_LOG_CLIENT=false', () => {
process.env.REQUEST_ANALYTICS_LOG_CLIENT = 'false';
const ctx = contextFor(fakeReq({ 'user-agent': 'curl/8.6.0' }, '192.168.0.42'));
expect(ctx).toEqual({ ip: null, userAgent: null, agent: null });
});
it('returns nulls outside any request scope', () => {
expect(getClientContext()).toEqual({ ip: null, userAgent: null, agent: null });
});
});
|