@furystack/rest/src/deserialize-query-string.spec.ts

Generic REST package

/* eslint-disable @typescript-eslint/ban-ts-comment */
import { describe, expect, it } from 'vitest'
import { decode, deserializeQueryString } from './deserialize-query-string.js'
import { RequestError } from './request-error.js'
import { serializeToQueryString, serializeValue } from './serialize-to-query-string.js'

describe('deserializeQueryString', () => {
  it('Should deserialize a null value', () => {
    // @ts-expect-error
    expect(deserializeQueryString(null)).toEqual({})
  })

  it('Should deserialize an undefined value', () => {
    // @ts-expect-error
    expect(deserializeQueryString(undefined)).toEqual({})
  })

  it('Should deserialize an empty string value', () => {
    expect(deserializeQueryString('')).toEqual({})
  })

  it('Should deserialize a string value with no keys / values', () => {
    expect(deserializeQueryString('?')).toEqual({})
  })

  it('Should deserialize a string with given value but empty key', () => {
    expect(deserializeQueryString('?=alma')).toEqual({})
  })

  it('Should deserialize a string with given key but empty value', () => {
    expect(deserializeQueryString('?alma=')).toEqual({})
  })

  it('Should deserialize a list of primitive values', () => {
    expect(
      deserializeQueryString(`?foo=${serializeValue('value')}&bar=${serializeValue(2)}&baz=${serializeValue(false)}`),
    ).toEqual({
      foo: 'value',
      bar: 2,
      baz: false,
    })
  })

  it('Should override a value if not specified as an array', () => {
    expect(
      deserializeQueryString(
        `?foo=${serializeValue('value')}&foo=${serializeValue(2)}&foo=${serializeValue(false)}&foo=${serializeValue(
          'bar',
        )}`,
      ),
    ).toEqual({ foo: 'bar' })
  })

  it('Should serialize and deserialize an object with primitives', () => {
    const value = { foo: 1, bar: 'foo', baz: false, asd: null }
    expect(deserializeQueryString(serializeToQueryString(value))).toEqual(value)
  })

  it('Should serialize and deserialize an array with primitives', () => {
    const value = { foo: [1, 'foo', false, null] }
    expect(deserializeQueryString(serializeToQueryString(value))).toEqual(value)
  })

  it('Should serialize and deserialize a complex structure', () => {
    const value = { foo: [1, 'foo', false, null], bar: [3, 'bar', true, -3.5], baz: 'no' }
    expect(deserializeQueryString(serializeToQueryString(value))).toEqual(value)
  })

  it('Should serialize and deserialize an encoded string value', () => {
    const value = { foo: [1, 'foo@alma.hu', false, null], bar: [3, 'bar/*-+', true, -3.5], baz: 'no' }
    expect(deserializeQueryString(serializeToQueryString(value))).toEqual(value)
  })

  it('Should deserialize escaped values', () => {
    expect(deserializeQueryString(`?alma=${serializeValue('asd/*-@?')}`)).toEqual({ alma: 'asd/*-@?' })
  })

  describe('decode error handling', () => {
    it('Should throw a RequestError with 400 for invalid base64 input', () => {
      expect(() => decode('not-valid-base64!!!')).toThrowError(RequestError)
      try {
        decode('not-valid-base64!!!')
      } catch (e) {
        expect(e).toBeInstanceOf(RequestError)
        expect((e as RequestError).responseCode).toBe(400)
      }
    })

    it('Should throw a RequestError with 400 for invalid percent-encoding', () => {
      expect(() => decode('%ZZ')).toThrowError(RequestError)
      try {
        decode('%ZZ')
      } catch (e) {
        expect(e).toBeInstanceOf(RequestError)
        expect((e as RequestError).responseCode).toBe(400)
      }
    })

    it('Should throw a RequestError with 400 for invalid JSON after decoding', () => {
      const invalidJsonBase64 = btoa('not-json')
      expect(() => decode(invalidJsonBase64)).toThrowError(RequestError)
      try {
        decode(invalidJsonBase64)
      } catch (e) {
        expect(e).toBeInstanceOf(RequestError)
        expect((e as RequestError).responseCode).toBe(400)
      }
    })
  })

  it('Should throw a RequestError with 400 for malformed query parameter values', () => {
    expect(() => deserializeQueryString('?key=not-valid-base64!!!')).toThrowError(RequestError)
    try {
      deserializeQueryString('?key=not-valid-base64!!!')
    } catch (e) {
      expect(e).toBeInstanceOf(RequestError)
      expect((e as RequestError).responseCode).toBe(400)
    }
  })
})