Skip to content

Latest commit

 

History

History
79 lines (47 loc) · 2.89 KB

DEVELOPMENT.md

File metadata and controls

79 lines (47 loc) · 2.89 KB
Raw

MQTTjs Development

This document aims to help you get started with developing MQTT.js.

Release Process

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:

npm test

This will run both browser and node tests.

Running specific tests

For example, you can run node -r esbuild-register --test test/keepaliveManager.ts

Browser

Browser tests use wtr as the test runner. To build browser bundle using esbuild and run browser tests, you can use the following command:

npm run test:browser

The configuration file is web-test-runner.config.msj. It starts a local broker using 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:

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 file and run npm run build.

Node

For NodeJS tests we use the NodeJS Test Runner. To run the tests, you can use the following command:

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)

When developing/debugging tests it's useful to run the tests for a single file/test, for example:

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:

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.

Lint

You can run and automatically fix linting issues with

npm run lint-fix