diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 683228f91..e9cc8b839 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -8,3 +8,59 @@ In order to create a new release you have two options: 1. Locally run `npm run release` and follow the interactive CLI 2. Manually trigger the GitHub Action `release` workflow specifyin the type of release you want to create + +## Tests + +To run the tests, you can use the following command: + +```sh +npm test +``` + +This will run both `browser` and `node` tests. + +### Browser + +Browser tests use [`wtr`](https://modern-web.dev/docs/test-runner/overview/) as the test runner. To build browser bundle using [esbuild](https://esbuild.github.io/) and run browser tests, you can use the following command: + +```sh +npm run test:browser +``` + +The configuration file is [web-test-runner.config.msj](./web-test-runner.config.mjs). It starts a local broker using [aedes-cli](https://github.com/moscajs/aedes-cli) with `ws` and `wss` support and then runs the tests in 3 different browsers: `chrome`, `firefox` and `safari`. + +The tests are located in the `test/browser` directory and there are also tests for service workers in the `test/browser/worker.js` directory. + +When developing/debugging tests it's useful to run the tests in a single browser, for example: + +```sh +npx wtr --manual --open +``` + +This will open the browser on `localhost:8001` and lets you choose the test to run by clicking on the link with the test name. By opening the DevTools you will be able to see the tests output and put debugger in both worker and main tests files. + +Be aware that tests will use the bundled version of the library, so you need to run `npm run build` before running the tests. If you need to debug issues in the code it could be useful to enable source maps when building, in order to do this just set `sourcemap: true` in [esbuild.js](./esbuild.js) file and run `npm run build`. + +### Node + +For NodeJS tests we use the NodeJS [Test Runner](https://nodejs.org/api/test.html). To run the tests, you can use the following command: + +```sh +npm run test:node +``` + +The tests are located in the `test` directory. The entrypoint of tests is `runTests.ts` file. It is used to filter the tests to run, set concurrency and create a nice looking tests summary (see reason [here](https://github.com/nodejs/help/issues/3902#issuecomment-1726033310)) + +When developing/debugging tests it's useful to run the tests for a single file/test, for example: + +```sh +node -r esbuild-register --test --inspect test/client.ts +``` + +If you want to run tests using a filter, you can use the `--test-name-pattern` flag: + +```sh +node -r esbuild-register --test --test-name-pattern="should resend in-flight QoS" --inspect test/client.ts +``` + +You can also run tests in watch mode using the `--watch` flag.