feat(NOC-1903): Unit testing and API testing with jest + supertest

[dynamite-bud]

Description

This PR introduces unit tests and API tests for this project.

Technologies used

I've used:

1. jest for unit tests
2. supertest for API testing

Test Structure

The tests live under the server/__tests__/*.

Unit tests

Unit tests are located under server/__tests__/unit/*. They currently test splitters.

1. intercom.tests.ts
2. json.tests.ts
3. markdown.tests.ts
4. pdf.tests.ts
5. unstructured.tests.ts

These tests test the splitters' functionality to split different types of documents supplied.

API tests

These tests are located under server/__tests__/api/*. They test different endpoints such as:

1./completions
2. /pricing/model
3. /pricing/model/cost
4. /state

Tests development

Important

Please update values in your .env file following .env/example file.

Unit tests

1. Create another file in server/__tests__/unit/
2. Run yarn run test:unit:watch, to watch development in realtime

API tests

1. Place one in server/__tests__/api/api.tests.ts
2. Run API tests using yarn run test:api

Note

All API tests are written in one file and there's no watch mode as supertests instantiate an express app and as a new server is spun so if you make multiple files, multiple apps are instantiated creating the error.

ERROR: Address already in use

Running tests

Unit tests

yarn run test:unit

API tests

yarn run test:api

[ciaranjmp]

Great work @dynamite-bud! I've made some minor changes and we're now ready to merge 💪

[ciaranjmp]

Note, all tests can now be run with yarn run test and you can use yarn run test:debug to get logs. You can also run make test to run the testing suite.

The required node version has also been bumped to v20 because node version 19.8.1 is not compatible with ts-jest.