options.dataType.test.ts

import { strict as assert } from 'node:assert';
import { describe, it, beforeAll, afterAll } from 'vitest';
import urllib from '../src/index.js';
import { startServer } from './fixtures/server.js';
import { nodeMajorVersion, readableToBytes } from './utils.js';

describe('options.dataType.test.ts', () => {
  let close: any;
  let _url: string;
  beforeAll(async () => {
    const { closeServer, url } = await startServer();
    close = closeServer;
    _url = url;
  });

  afterAll(async () => {
    await close();
  });

  it('should dataType is buffer', async () => {
    const response = await urllib.request(_url);
    assert.equal(response.status, 200);
    assert.equal(response.headers['content-type'], 'application/json');
    assert(response.headers.date);
    assert(Buffer.isBuffer(response.data));
    assert.match(response.data.toString(), /^{"method":"GET",/);
    assert.equal(response.url, _url);
    assert(!response.redirected);
  });

  it('should work with dataType = buffer', async () => {
    const response = await urllib.request(_url, {
      dataType: 'buffer',
    });
    assert.equal(response.status, 200);
    assert.equal(response.headers['content-type'], 'application/json');
    assert(response.headers.date);
    assert(Buffer.isBuffer(response.data));
    assert.match(response.data.toString(), /^{"method":"GET",/);
    assert.equal(response.url, _url);
    assert(!response.redirected);
  });

  it('should work with dataType = text', async () => {
    const response = await urllib.request(_url, {
      dataType: 'text',
    });
    assert.equal(response.status, 200);
    assert.equal(response.headers['content-type'], 'application/json');
    assert(response.headers.date);
    assert.equal(typeof response.data, 'string');
    assert.match(response.data, /^{"method":"GET",/);
    assert.equal(response.url, _url);
    assert(!response.redirected);
  });

  it('should work with dataType = html', async () => {
    const response = await urllib.request(_url, {
      dataType: 'html',
    });
    assert.equal(response.status, 200);
    assert.equal(response.headers['content-type'], 'application/json');
    assert(response.headers.date);
    assert.equal(typeof response.data, 'string');
    assert.match(response.data, /^{"method":"GET",/);
    assert.equal(response.url, _url);
    assert(!response.redirected);
  });

  it('should work with dataType = json', async () => {
    const response = await urllib.request(_url, {
      dataType: 'json',
    });
    assert.equal(response.status, 200);
    assert.equal(response.headers['content-type'], 'application/json');
    assert.equal(typeof response.data, 'object');
    assert.equal(response.data.method, 'GET');
  });

  it('should ignore json parse when response empty', async () => {
    const response = await urllib.request(`${_url}mock-bytes?size=0`, {
      dataType: 'json',
    });
    assert.equal(response.status, 200);
    assert.equal(response.data, null);
  });

  it('should keep exists accept headers when dataType = json', async () => {
    const response = await urllib.request(_url, {
      dataType: 'json',
      headers: {
        accept: 'foo/json',
      },
    });
    assert.equal(response.status, 200);
    assert.equal(response.headers['content-type'], 'application/json');
    // console.log(response.data);
    assert.equal(response.data.headers.accept, 'foo/json');
  });

  it('should throw with dataType = json when response json format invaild', async () => {
    await assert.rejects(async () => {
      await urllib.request(`${_url}wrongjson`, {
        dataType: 'json',
      });
    }, (err: any) => {
      // console.error(err);
      assert.equal(err.name, 'JSONResponseFormatError');
      if (err.message.startsWith('Expected')) {
        if (nodeMajorVersion() >= 21) {
          assert.equal(err.message, 'Expected \',\' or \'}\' after property value in JSON at position 9 (line 1 column 10) (data json format: "{\\"foo\\":\\"\\"")');
        } else {
          // new message on Node.js >= 19
          assert.equal(err.message, 'Expected \',\' or \'}\' after property value in JSON at position 9 (data json format: "{\\"foo\\":\\"\\"")');
        }

      } else {
        assert.equal(err.message, 'Unexpected end of JSON input (data json format: "{\\"foo\\":\\"\\"")');
      }
      assert.equal(err.res.status, 200);
      assert.equal(err.res.headers['content-type'], 'application/json');
      assert.equal(err.res.size, 9);
      return true;
    });
  });

  it('should work with dataType = text when response json format invaild', async () => {
    const response = await urllib.request(`${_url}wrongjson`, {
      dataType: 'text',
    });
    assert.equal(response.status, 200);
    assert.equal(response.headers['content-type'], 'application/json');
    assert.equal(response.data, '{"foo":""');
  });

  it('should handle GET /wrongjson-gbk with dataType=json and data size > 1024', async () => {
    await assert.rejects(async () => {
      await urllib.request(`${_url}wrongjson-gbk`, {
        dataType: 'json',
      });
    }, (err: any) => {
      // console.error(err);
      assert.equal(err.name, 'JSONResponseFormatError');
      assert.match(err.message, /" \.\.\.skip\.\.\. "/);
      assert.equal(err.res.status, 200);
      assert.equal(err.res.headers['content-type'], 'application/json');
      return true;
    });
  });

  it('should work with dataType = stream', async () => {
    const response = await urllib.request(_url, {
      dataType: 'stream',
    });
    assert.equal(response.status, 200);
    assert.equal(response.headers['content-type'], 'application/json');
    assert(response.res);
    const bytes = await readableToBytes(response.res);
    const jsonString = bytes.toString();
    assert.equal(JSON.parse(jsonString).method, 'GET');
  });

  it('should work with streaming = true, alias to data = stream', async () => {
    const response = await urllib.request(_url, {
      streaming: true,
    });
    assert.equal(response.status, 200);
    assert.equal(response.headers['content-type'], 'application/json');
    assert(response.res);
    assert(response.res);
    const bytes = await readableToBytes(response.res);
    const jsonString = bytes.toString();
    assert.equal(JSON.parse(jsonString).method, 'GET');
  });
});