index.test.js

'use strict'
const { faker } = require('@faker-js/faker')
const tap = require('tap')
const fastify = require('fastify')

const plugin = require('../')

tap.plan(2)

tap.test('Plugin#Decoration', scope => {
  scope.plan(5)

  scope.test('Should decorate the request', async t => {
    const app = fastify()

    app.register(plugin)

    app.get('/', (req, reply) => {
      t.type(req.isIP, 'function')
      t.type(req.isIPv4, 'function')
      t.type(req.isIPv6, 'function')
      t.type(req.inferIPVersion, 'function')
      t.type(req._fastifyip, 'string')

      reply.send('')
    })

    t.plan(5)

    await app.inject('/')
  })

  scope.test('#isIP - Should return boolean', async t => {
    const app = fastify()

    app.register(plugin)

    app.get('/', (req, reply) => {
      t.ok(req.isIP(faker.internet.ipv4()))
      t.ok(req.isIP(faker.internet.ipv6()))
      t.notOk(req.isIP('xyz'))

      reply.send('')
    })

    t.plan(3)

    await app.inject({
      path: '/'
    })
  })

  scope.test('#isIPv4 - Should return boolean', async t => {
    const app = fastify()

    app.register(plugin)

    app.get('/', (req, reply) => {
      t.ok(req.isIPv4(faker.internet.ipv4()))
      t.notOk(req.isIPv4(faker.internet.ipv6()))
      t.notOk(req.isIPv4('xyz'))

      reply.send('')
    })

    t.plan(3)

    await app.inject({
      path: '/'
    })
  })

  scope.test('#isIPv6 - Should return boolean IP', async t => {
    const app = fastify()

    app.register(plugin)

    app.get('/', (req, reply) => {
      t.ok(req.isIPv6(faker.internet.ipv6()))
      t.notOk(req.isIPv6(faker.internet.ipv4()))
      t.notOk(req.isIPv6('xyz'))

      reply.send('')
    })

    t.plan(3)

    await app.inject({
      path: '/'
    })
  })

  scope.test('#inferIPVersion - Should return boolean IP', async t => {
    const app = fastify()

    app.register(plugin)

    app.get('/', (req, reply) => {
      t.equal(req.inferIPVersion(faker.internet.ipv6()), 6)
      t.equal(req.inferIPVersion(faker.internet.ipv4()), 4)
      t.equal(req.inferIPVersion('zsdc'), 0)

      reply.send('')
    })

    t.plan(3)

    await app.inject({
      path: '/'
    })
  })
})

tap.test('Plugin#Request IP', scope => {
  scope.plan(10)

  scope.test('Should infer the header based on default priority', async t => {
    const app = fastify()
    const expectedIP = faker.internet.ip()
    const secondaryIP = faker.internet.ip()

    app.register(plugin)

    app.get('/', (req, reply) => {
      t.equal(req.ip, expectedIP)
      t.equal(req._fastifyip, expectedIP)

      reply.send('')
    })

    t.plan(2)

    await app.inject({
      path: '/',
      headers: {
        'x-client-ip': expectedIP,
        'cf-connecting-ip': secondaryIP
      }
    })
  })

  scope.test('Fallback behavior on AWS Context', async t => {
    const app = fastify()
    const expectedIP = faker.internet.ip()
    const secondaryIP = faker.internet.ip()
    const childscope1 = (instance, _, done) => {
      instance.register(plugin, { isAWS: true, order: ['x-custom-remote-ip'] })

      instance.get('/first', (req, reply) => {
        t.equal(req.ip, expectedIP)
        t.equal(req._fastifyip, expectedIP)

        reply.send('')
      })

      instance.get('/second', (req, reply) => {
        t.equal(req.ip, secondaryIP)
        t.equal(req._fastifyip, secondaryIP)

        reply.send('')
      })

      done()
    }
    const childscope2 = (instance, _, done) => {
      instance.register(plugin, { isAWS: true, strict: true })

      instance.get('/', (req, reply) => {
        t.equal(req.ip, '')
        t.equal(req._fastifyip, '')

        reply.send('')
      })

      done()
    }
    const childscope3 = (instance, _, done) => {
      instance.register(plugin, { isAWS: true })

      instance.get('/', (req, reply) => {
        t.equal(req.ip, expectedIP)
        t.equal(req._fastifyip, expectedIP)

        reply.send('')
      })

      instance.get('/none', (req, reply) => {
        t.equal(req.ip, '')
        t.equal(req._fastifyip, '')

        reply.send('')
      })

      done()
    }

    t.plan(10)

    app.register(childscope1, { prefix: '/fallback' })
    app.register(childscope2, { prefix: '/no-fallback' })
    app.register(childscope3, { prefix: '/soft' })

    await app.inject({
      path: '/fallback/first',
      headers: {
        'x-custom-remote-ip': expectedIP,
        'x-forwarded-for': secondaryIP
      }
    })

    await app.inject({
      path: '/fallback/second',
      headers: {
        'x-forwarded-for': secondaryIP
      }
    })

    await app.inject({
      path: '/no-fallback',
      headers: {
        'x-custom-remote-ip': expectedIP,
        'x-forwarded-for': secondaryIP
      }
    })

    await app.inject({
      path: '/soft',
      headers: {
        'x-appengine-user-ip': secondaryIP,
        'x-real-ip': expectedIP
      }
    })

    await app.inject({
      path: '/soft/none'
    })
  })

  scope.test('Should infer the header based on if is AWS context', async t => {
    const app = fastify()
    const expectedIP = faker.internet.ip()
    const fallbackIP = faker.internet.ipv6()

    app.register(plugin, { isAWS: true })

    app.get(
      '/',
      {
        preHandler: function (req, reply, done) {
          req.raw.requestContext = {
            identity: {
              sourceIp: expectedIP
            }
          }
          done()
        }
      },
      (req, reply) => {
        t.equal(req.ip, expectedIP)
        t.equal(req._fastifyip, expectedIP)

        reply.send('')
      }
    )

    t.plan(2)

    await app.inject({
      path: '/',
      headers: {
        'cf-connecting-ip': fallbackIP,
        'x-client-ip': faker.internet.ipv6(),
        'x-custom-remote-ip': expectedIP
      }
    })
  })

  scope.test(
    'Should infer the header based on custom priority <Array>',
    async t => {
      const app = fastify()
      const expectedIP = faker.internet.ip()
      const fallbackIP = faker.internet.ipv6()

      app.register(plugin, { order: ['x-custom-remote-ip'] })

      app.get('/', (req, reply) => {
        t.equal(req.ip, expectedIP)
        t.equal(req._fastifyip, expectedIP)

        reply.send('')
      })

      app.get('/fallback', (req, reply) => {
        t.equal(req.ip, fallbackIP)
        t.equal(req._fastifyip, fallbackIP)

        reply.send('')
      })

      t.plan(4)

      await app.inject({
        path: '/',
        headers: {
          'cf-connecting-ip': fallbackIP,
          'x-client-ip': faker.internet.ipv6(),
          'x-custom-remote-ip': expectedIP
        }
      })

      await app.inject({
        path: '/fallback',
        headers: {
          'cf-connecting-ip': fallbackIP
        }
      })
    }
  )

  scope.test(
    'Should infer the header based on custom priority <Array> (strict)',
    async t => {
      const app = fastify()
      const expectedIP = faker.internet.ip()
      const fallbackIP = faker.internet.ipv6()

      app.register(plugin, { order: ['x-custom-remote-ip'], strict: true })

      app.get('/', (req, reply) => {
        t.equal(req.ip, expectedIP)
        t.equal(req._fastifyip, expectedIP)

        reply.send('')
      })

      app.get('/fallback', (req, reply) => {
        t.equal(req.ip, '')
        t.equal(req._fastifyip, '')

        reply.send('')
      })

      t.plan(4)

      await app.inject({
        path: '/',
        headers: {
          'cf-connecting-ip': fallbackIP,
          'x-client-ip': faker.internet.ipv6(),
          'x-custom-remote-ip': expectedIP
        }
      })

      await app.inject({
        path: '/fallback',
        headers: {
          'x-client-ip': faker.internet.ipv6(),
          'cf-connecting-ip': fallbackIP
        }
      })
    }
  )

  scope.test(
    'Should infer the header based on custom priority <String>',
    async t => {
      const app = fastify()
      const expectedIP = faker.internet.ip()
      const fallbackIP = faker.internet.ipv6()

      app.register(plugin, { order: 'x-custom-remote-ip' })

      app.get('/', (req, reply) => {
        t.equal(req.ip, expectedIP)
        t.equal(req._fastifyip, expectedIP)

        reply.send('')
      })

      app.get('/fallback', (req, reply) => {
        t.equal(req.ip, fallbackIP)
        t.equal(req._fastifyip, fallbackIP)

        reply.send('')
      })

      t.plan(4)

      await app.inject({
        path: '/',
        headers: {
          'cf-connecting-ip': fallbackIP,
          'x-client-ip': faker.internet.ipv6(),
          'x-custom-remote-ip': expectedIP
        }
      })

      await app.inject({
        path: '/fallback',
        headers: {
          'cf-connecting-ip': fallbackIP
        }
      })
    }
  )

  scope.test(
    'Should infer the header based on custom priority <String> (strict)',
    async t => {
      const app = fastify()
      const expectedIP = faker.internet.ip()
      const fallbackIP = faker.internet.ipv6()

      app.register(plugin, { order: 'x-custom-remote-ip', strict: true })

      app.get('/', (req, reply) => {
        t.equal(req.ip, expectedIP)
        t.equal(req._fastifyip, expectedIP)

        reply.send('')
      })

      app.get('/fallback', (req, reply) => {
        t.equal(req.ip, '')
        t.equal(req._fastifyip, '')

        reply.send('')
      })

      t.plan(4)

      await app.inject({
        path: '/',
        headers: {
          'cf-connecting-ip': fallbackIP,
          'x-client-ip': faker.internet.ipv6(),
          'x-custom-remote-ip': expectedIP
        }
      })

      await app.inject({
        path: '/fallback',
        headers: {
          'cf-connecting-ip': fallbackIP
        }
      })
    }
  )

  scope.test(
    'Should discard the IP if invalid format and fallback into the following in the order',
    async t => {
      const app = fastify()
      const expectedIP = faker.internet.ip()
      const fallbackIP = 'abc'

      app.register(plugin)

      app.get('/', (req, reply) => {
        t.equal(req.ip, expectedIP)
        t.equal(req._fastifyip, expectedIP)

        reply.send('')
      })

      t.plan(2)

      await app.inject({
        path: '/',
        headers: {
          'x-appengine-user-ip': expectedIP,
          'x-real-ip': fallbackIP
        }
      })
    }
  )

  scope.test('Should replace the IP even if trustProxy option is set to true', async t => {
    const app = fastify({ trustProxy: true })
    const localIP = '127.0.0.1'
    const expectedIP = faker.internet.ip()

    async function withoutPlugin (instance) {
      instance.get('/withoutPlugin', async (req) => {
        t.equal(req.ip, localIP)
      })
    }

    async function withPlugin (instance) {
      instance.register(plugin)
      instance.get('/withPlugin', async (req) => {
        t.equal(req.ip, expectedIP)
        t.equal(req._fastifyip, expectedIP)
      })
    }

    app.register(withoutPlugin)
    app.register(withPlugin)

    t.plan(3)

    await app.inject('/withoutPlugin')
    await app.inject({
      path: '/withPlugin',
      headers: {
        'x-client-ip': expectedIP
      }
    })
  })

  scope.test('Should set the IP in the "onRequest" hook when trustProxy option is set to true', async t => {
    const app = fastify({ trustProxy: true })
    const expectedIP = faker.internet.ip()

    app.register(plugin)
    app.addHook('onRequest', async (req) => {
      t.equal(req.ip, expectedIP)
    })
    app.get('/', async (req) => {
      t.equal(req.ip, expectedIP)
    })

    t.plan(2)

    await app.inject({
      path: '/',
      headers: {
        'x-client-ip': expectedIP
      }
    })
  })
})