toolkit/packages/http-client/__tests__/basics.test.ts

/* eslint-disable @typescript-eslint/no-explicit-any */

import * as httpm from '..'
import * as path from 'path'
import * as fs from 'fs'

const sampleFilePath: string = path.join(__dirname, 'testoutput.txt')

interface HttpBinData {
  url: string
  data: any
  json: any
  headers: any
  args?: any
}

describe('basics', () => {
  let _http: httpm.HttpClient

  beforeEach(() => {
    _http = new httpm.HttpClient('http-client-tests')
  })

  afterEach(() => {})

  it('constructs', () => {
    const http: httpm.HttpClient = new httpm.HttpClient('thttp-client-tests')
    expect(http).toBeDefined()
  })

  // responses from httpbin return something like:
  // {
  //     "args": {},
  //     "headers": {
  //       "Connection": "close",
  //       "Host": "postman-echo.com",
  //       "user-agent": "typed-test-client-tests"
  //     },
  //     "origin": "173.95.152.44",
  //     "url": "http://postman-echo.com/get"
  //  }

  it('does basic http get request', async () => {
    const res: httpm.HttpClientResponse = await _http.get(
      'http://postman-echo.com/get'
    )
    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    const obj = JSON.parse(body)
    expect(obj.url).toBe('http://postman-echo.com/get')
    expect(obj.headers['user-agent']).toBeTruthy()
  })

  it('does basic http get request with no user agent', async () => {
    const http: httpm.HttpClient = new httpm.HttpClient()
    const res: httpm.HttpClientResponse = await http.get(
      'http://postman-echo.com/get'
    )
    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    const obj = JSON.parse(body)
    expect(obj.url).toBe('http://postman-echo.com/get')
    expect(obj.headers['user-agent']).toBeFalsy()
  })

  /* TODO write a mock rather then relying on a third party
  it('does basic https get request', async () => {
    const res: httpm.HttpClientResponse = await _http.get(
      'http://postman-echo.com/get'
    )
    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    const obj = JSON.parse(body)
    expect(obj.url).toBe('http://postman-echo.com/get')
  })
*/
  it('does basic http get request with default headers', async () => {
    const http: httpm.HttpClient = new httpm.HttpClient(
      'http-client-tests',
      [],
      {
        headers: {
          Accept: 'application/json',
          'Content-Type': 'application/json'
        }
      }
    )
    const res: httpm.HttpClientResponse = await http.get(
      'http://postman-echo.com/get'
    )
    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    const obj = JSON.parse(body)
    expect(obj.headers.accept).toBe('application/json')
    expect(obj.headers['content-type']).toBe('application/json')
    expect(obj.url).toBe('http://postman-echo.com/get')
  })

  it('does basic http get request with merged headers', async () => {
    const http: httpm.HttpClient = new httpm.HttpClient(
      'http-client-tests',
      [],
      {
        headers: {
          Accept: 'application/json',
          'Content-Type': 'application/json'
        }
      }
    )
    const res: httpm.HttpClientResponse = await http.get(
      'http://postman-echo.com/get',
      {
        'content-type': 'application/x-www-form-urlencoded'
      }
    )
    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    const obj = JSON.parse(body)
    expect(obj.headers.accept).toBe('application/json')
    expect(obj.headers['content-type']).toBe(
      'application/x-www-form-urlencoded'
    )
    expect(obj.url).toBe('http://postman-echo.com/get')
  })

  it('pipes a get request', async () => {
    return new Promise<void>(async resolve => {
      const file = fs.createWriteStream(sampleFilePath)
      ;(await _http.get('http://postman-echo.com/get')).message
        .pipe(file)
        .on('close', () => {
          const body: string = fs.readFileSync(sampleFilePath).toString()
          const obj = JSON.parse(body)
          expect(obj.url).toBe('http://postman-echo.com/get')
          resolve()
        })
    })
  })

  it('does basic get request with redirects', async () => {
    const res: httpm.HttpClientResponse = await _http.get(
      `http://postman-echo.com/redirect-to?url=${encodeURIComponent(
        'http://postman-echo.com/get'
      )}`
    )
    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    const obj = JSON.parse(body)
    expect(obj.url).toBe('http://postman-echo.com/get')
  })

  it('does basic get request with redirects (303)', async () => {
    const res: httpm.HttpClientResponse = await _http.get(
      `http://postman-echo.com/redirect-to?url=${encodeURIComponent(
        'http://postman-echo.com/get'
      )}&status_code=303`
    )
    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    const obj = JSON.parse(body)
    expect(obj.url).toBe('http://postman-echo.com/get')
  })

  it('returns 404 for not found get request on redirect', async () => {
    const res: httpm.HttpClientResponse = await _http.get(
      `http://postman-echo.com/redirect-to?url=${encodeURIComponent(
        'http://postman-echo.com/status/404'
      )}&status_code=303`
    )
    expect(res.message.statusCode).toBe(404)
    await res.readBody()
  })

  it('does not follow redirects if disabled', async () => {
    const http: httpm.HttpClient = new httpm.HttpClient(
      'typed-test-client-tests',
      undefined,
      {allowRedirects: false}
    )
    const res: httpm.HttpClientResponse = await http.get(
      `http://postman-echo.com/redirect-to?url=${encodeURIComponent(
        'http://postman-echo.com/get'
      )}`
    )
    expect(res.message.statusCode).toBe(302)
    await res.readBody()
  })

  it('does not pass auth with diff hostname redirects', async () => {
    const headers = {
      accept: 'application/json',
      authorization: 'shhh'
    }
    const res: httpm.HttpClientResponse = await _http.get(
      `http://postman-echo.com/redirect-to?url=${encodeURIComponent(
        'http://www.postman-echo.com/get'
      )}`,
      headers
    )

    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    const obj = JSON.parse(body)
    // httpbin "fixes" the casing
    expect(obj.headers[httpm.Headers.Accept]).toBe('application/json')
    expect(obj.headers['Authorization']).toBeUndefined()
    expect(obj.headers['authorization']).toBeUndefined()
    expect(obj.url).toBe('http://www.postman-echo.com/get')
  })

  it('does not pass Auth with diff hostname redirects', async () => {
    const headers = {
      Accept: 'application/json',
      Authorization: 'shhh'
    }
    const res: httpm.HttpClientResponse = await _http.get(
      `http://postman-echo.com/redirect-to?url=${encodeURIComponent(
        'http://www.postman-echo.com/get'
      )}`,
      headers
    )

    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    const obj = JSON.parse(body)
    // httpbin "fixes" the casing
    expect(obj.headers[httpm.Headers.Accept]).toBe('application/json')
    expect(obj.headers['Authorization']).toBeUndefined()
    expect(obj.headers['authorization']).toBeUndefined()
    expect(obj.url).toBe('http://www.postman-echo.com/get')
  })

  it('does basic head request', async () => {
    const res: httpm.HttpClientResponse = await _http.head(
      'http://postman-echo.com/get'
    )
    expect(res.message.statusCode).toBe(200)
  })

  it('does basic http delete request', async () => {
    const res: httpm.HttpClientResponse = await _http.del(
      'http://postman-echo.com/delete'
    )
    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    JSON.parse(body)
  })

  it('does basic http post request', async () => {
    const b = 'Hello World!'
    const res: httpm.HttpClientResponse = await _http.post(
      'http://postman-echo.com/post',
      b
    )
    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    const obj = JSON.parse(body)
    expect(obj.data).toBe(b)
    expect(obj.url).toBe('http://postman-echo.com/post')
  })

  it('does basic http patch request', async () => {
    const b = 'Hello World!'
    const res: httpm.HttpClientResponse = await _http.patch(
      'http://postman-echo.com/patch',
      b
    )
    expect(res.message.statusCode).toBe(200)
    const body: string = await res.readBody()
    const obj = JSON.parse(body)
    expect(obj.data).toBe(b)
    expect(obj.url).toBe('http://postman-echo.com/patch')
  })

  it('does basic http options request', async () => {
    const res: httpm.HttpClientResponse = await _http.options(
      'http://postman-echo.com'
    )
    expect(res.message.statusCode).toBe(200)
    await res.readBody()
  })

  it('returns 404 for not found get request', async () => {
    const res: httpm.HttpClientResponse = await _http.get(
      'http://postman-echo.com/status/404'
    )
    expect(res.message.statusCode).toBe(404)
    await res.readBody()
  })

  it('gets a json object', async () => {
    const jsonObj = await _http.getJson<HttpBinData>(
      'http://postman-echo.com/get'
    )
    expect(jsonObj.statusCode).toBe(200)
    expect(jsonObj.result).toBeDefined()
    expect(jsonObj.result?.url).toBe('http://postman-echo.com/get')
    expect(jsonObj.result?.headers[httpm.Headers.Accept]).toBe(
      httpm.MediaTypes.ApplicationJson
    )
    expect(jsonObj.headers['content-type']).toContain(
      httpm.MediaTypes.ApplicationJson
    )
  })

  it('getting a non existent json object returns null', async () => {
    const jsonObj = await _http.getJson<HttpBinData>(
      'http://postman-echo.com/status/404'
    )
    expect(jsonObj.statusCode).toBe(404)
    expect(jsonObj.result).toBeNull()
  })

  it('posts a json object', async () => {
    const res = {name: 'foo'}
    const restRes = await _http.postJson<HttpBinData>(
      'http://postman-echo.com/post',
      res
    )
    expect(restRes.statusCode).toBe(200)
    expect(restRes.result).toBeDefined()
    expect(restRes.result?.url).toBe('http://postman-echo.com/post')
    expect(restRes.result?.json.name).toBe('foo')
    expect(restRes.result?.headers[httpm.Headers.Accept]).toBe(
      httpm.MediaTypes.ApplicationJson
    )
    expect(restRes.result?.headers['content-type']).toBe(
      httpm.MediaTypes.ApplicationJson
    )
    expect(restRes.headers['content-type']).toContain(
      httpm.MediaTypes.ApplicationJson
    )
  })

  it('puts a json object', async () => {
    const res = {name: 'foo'}
    const restRes = await _http.putJson<HttpBinData>(
      'http://postman-echo.com/put',
      res
    )
    expect(restRes.statusCode).toBe(200)
    expect(restRes.result).toBeDefined()
    expect(restRes.result?.url).toBe('http://postman-echo.com/put')
    expect(restRes.result?.json.name).toBe('foo')

    expect(restRes.result?.headers[httpm.Headers.Accept]).toBe(
      httpm.MediaTypes.ApplicationJson
    )
    expect(restRes.result?.headers['content-type']).toBe(
      httpm.MediaTypes.ApplicationJson
    )
    expect(restRes.headers['content-type']).toContain(
      httpm.MediaTypes.ApplicationJson
    )
  })

  it('patch a json object', async () => {
    const res = {name: 'foo'}
    const restRes = await _http.patchJson<HttpBinData>(
      'http://postman-echo.com/patch',
      res
    )
    expect(restRes.statusCode).toBe(200)
    expect(restRes.result).toBeDefined()
    expect(restRes.result?.url).toBe('http://postman-echo.com/patch')
    expect(restRes.result?.json.name).toBe('foo')
    expect(restRes.result?.headers[httpm.Headers.Accept]).toBe(
      httpm.MediaTypes.ApplicationJson
    )
    expect(restRes.result?.headers['content-type']).toBe(
      httpm.MediaTypes.ApplicationJson
    )
    expect(restRes.headers['content-type']).toContain(
      httpm.MediaTypes.ApplicationJson
    )
  })
})