koa.test.js

/* global describe, test, expect */
'use strict'

const Koa = require('koa')
const request = require('supertest')

const rTracer = require('../index')

describe('cls-rtracer for Koa', () => {
  test('does not return id outside of request', () => {
    const id = rTracer.id()
    expect(id).toBeUndefined()
  })

  test('generates id for request', () => {
    const app = new Koa()
    app.use(rTracer.koaMiddleware())

    let id

    app.use((ctx) => {
      id = rTracer.id()
      ctx.body = { id }
    })

    return request(app.callback()).get('/')
      .then(res => {
        expect(res.statusCode).toBe(200)
        expect(res.body.id).toEqual(id)
        expect(res.body.id.length).toBeGreaterThan(0)
      })
  })

  test('ignores header by default', () => {
    const app = new Koa()
    app.use(rTracer.koaMiddleware())

    const idInHead = 'id-from-header'

    app.use((ctx) => {
      const id = rTracer.id()
      ctx.body = { id }
    })

    return request(app.callback()).get('/')
      .set('X-Request-Id', idInHead)
      .then(res => {
        expect(res.statusCode).toBe(200)
        expect(res.body.id.length).toBeGreaterThan(0)
        expect(res.body.id).not.toEqual(idInHead)
      })
  })

  test('uses default header in case of override', () => {
    const app = new Koa()
    app.use(rTracer.koaMiddleware({ useHeader: true }))

    const idInHead = 'id-from-header'

    app.use((ctx) => {
      const id = rTracer.id()
      ctx.body = { id }
    })

    return request(app.callback()).get('/')
      .set('X-Request-Id', idInHead)
      .then(res => {
        expect(res.statusCode).toBe(200)
        expect(res.body.id).toEqual(idInHead)
      })
  })

  test('uses different header in case of override', () => {
    const app = new Koa()
    app.use(rTracer.koaMiddleware({
      useHeader: true,
      headerName: 'x-another-req-id'
    }))

    const idInHead = 'id-from-header'

    app.use((ctx) => {
      const id = rTracer.id()
      ctx.body = { id }
    })

    return request(app.callback()).get('/')
      .set('x-another-req-id', idInHead)
      .then(res => {
        expect(res.statusCode).toBe(200)
        expect(res.body.id).toEqual(idInHead)
      })
  })

  test('ignores header if empty', () => {
    const app = new Koa()
    app.use(rTracer.koaMiddleware({ useHeader: true }))

    app.use((ctx) => {
      const id = rTracer.id()
      ctx.body = { id }
    })

    return request(app.callback()).get('/')
      .set('X-Request-Id', '')
      .then(res => {
        expect(res.statusCode).toBe(200)
        expect(res.body.id.length).toBeGreaterThan(0)
      })
  })

  test('ignores header if disabled', () => {
    const app = new Koa()
    app.use(rTracer.koaMiddleware({ useHeader: false }))

    const idInHead = 'id-from-header'

    app.use((ctx) => {
      const id = rTracer.id()
      ctx.body = { id }
    })

    return request(app.callback()).get('/')
      .set('X-Request-Id', idInHead)
      .then(res => {
        expect(res.statusCode).toBe(200)
        expect(res.body.id).not.toEqual(idInHead)
        expect(res.body.id.length).toBeGreaterThan(0)
      })
  })

  test('generates id for request with promise', () => {
    const app = new Koa()
    app.use(rTracer.koaMiddleware())

    let id

    app.use(async (ctx) => {
      return new Promise((resolve) => setTimeout(resolve, 0))
        .then(() => {
          id = rTracer.id()
          ctx.body = { id }
        })
    })

    return request(app.callback()).get('/')
      .then(res => {
        expect(res.statusCode).toBe(200)
        expect(res.body.id).toEqual(id)
        expect(res.body.id.length).toBeGreaterThan(0)
      })
  })

  test('generates different ids for concurrent requests with promises', () => {
    const app = new Koa()
    app.use(rTracer.koaMiddleware())

    const ids = {}
    app.use(async (ctx) => {
      return new Promise((resolve) => setTimeout(resolve, 0))
        .then(() => {
          const id = rTracer.id()
          ids[ctx.request.query.reqName] = id
          ctx.body = { id }
        })
    })

    const server = request(app.callback())
    return Promise.all([
      server.get('/')
        .query({ reqName: 'id1' })
        .then(res => {
          expect(res.statusCode).toBe(200)
          expect(res.body.id.length).toBeGreaterThan(0)
          return res.body.id
        }),
      server.get('/')
        .query({ reqName: 'id2' })
        .then(res => {
          expect(res.statusCode).toBe(200)
          expect(res.body.id.length).toBeGreaterThan(0)
          return res.body.id
        })
    ]).then(([ id1, id2 ]) => {
      expect(id1).toEqual(ids['id1'])
      expect(id2).toEqual(ids['id2'])
      expect(id1).not.toEqual(id2)
    })
  })

  test('generates different ids for concurrent requests with async/await', () => {
    const app = new Koa()
    app.use(rTracer.koaMiddleware())

    const ids = {}
    app.use(async (ctx) => {
      await new Promise((resolve) => setTimeout(resolve, 0))
      const id = rTracer.id()
      ids[ctx.request.query.reqName] = id
      ctx.body = { id }
    })

    const server = request(app.callback())
    return Promise.all([
      server.get('/')
        .query({ reqName: 'id1' })
        .then(res => {
          expect(res.statusCode).toBe(200)
          expect(res.body.id.length).toBeGreaterThan(0)
          return res.body.id
        }),
      server.get('/')
        .query({ reqName: 'id2' })
        .then(res => {
          expect(res.statusCode).toBe(200)
          expect(res.body.id.length).toBeGreaterThan(0)
          return res.body.id
        })
    ]).then(([ id1, id2 ]) => {
      expect(id1).toEqual(ids['id1'])
      expect(id2).toEqual(ids['id2'])
      expect(id1).not.toEqual(id2)
    })
  })

  test('generates custom namespace property for request', () => {
    const app = new Koa()
    const propertyName = 'originalUrl'

    app.use(rTracer.koaMiddleware({
      customNamespacePropertiesBuilder: (request, namespace) => {
        namespace.set(propertyName, request.url)
      }
    }))

    let propertyValue

    const requestUrl = '/test'
    app.use((ctx) => {
      propertyValue = rTracer.getNamespaceProperty(propertyName)
      ctx.body = { propertyValue }
    })

    return request(app.callback()).get(requestUrl)
      .then(res => {
        expect(res.statusCode).toBe(200)
        expect(propertyValue).toEqual(requestUrl)
        expect(res.body.propertyValue).toEqual(requestUrl)
        expect(res.body.propertyValue.length).toBeGreaterThan(0)
      })
  })
})