Set a default timeout in QUnit 3.0

[Krinkle]

Tip

Migration guide has been published at: https://qunitjs.com/api/config/testTimeout/

Rationale

• Give better feedback by default in the common case of an async test failing or getting stuck. This applies to both the HTML Reporter and QUnit CLI on Node.js (Common case, because inevitably something somewhere might have relied on taking longer than the default timeout we'll come up with, e.g. minutes or hours).
• Avoid silent failure when using QUnit via require('qunit') without the QUnit CLI, ref Async tests can abruptly stop in standalone Node.js mode #1132. Right now, due to there not being a default timeout, there appears to be nothing preventing Node.js from silently existing the process after a stuck async test.

Research

• Jasmine: 5 seconds, ref /~https://github.com/jasmine/jasmine/blob/v3.6.0/lib/jasmine-core/jasmine.js#L196-L201.
• Mocha: 2 seconds, ref https://mochajs.org/#command-line-usage.
• Tape: No default, I think? ref /~https://github.com/substack/tape.
• Karma: 30 seconds (inactivity), ref https://karma-runner.github.io/5.2/config/configuration-file.html.
• Jest: 5 seconds, ref https://jestjs.io/docs/en/api.
• Intern: 30 seconds, ref https://theintern.io/docs.html#Intern/4/docs/docs%2Fconfiguration.md/properties.

Subtasks

• Determine the timeout we're going to use.
• Improve documentation of config.testTimeout to include an example of how to set this for integrations like karma-qunit, node-qunit-puppeteer and the QUnit CLI since for many users this is likely the first time they are needing to set a configuration option rather than simply loading test files into a test runner.
• In QUnit 2.x, emit a warning for tests that have no timeout configurred but take longer than our preferred timeout.
• In QUnit 3.0, enable the timeout by default and remove the warning.

[rwjblue]

This seems good to me. I commonly see it set to 30 or 60 seconds, but a lower default seems fine also.

[Krinkle]

We'll need a way to warn users on the last 2.x release if their tests take longer and don't yet have a timeout configured, so that they can set a higher timeout ahead of the QUnit 3.0 release.

[Krinkle]

I've landed 448e976, which adds a deprecation warning after 3 seconds if no timeout is set.

This will be released in QUnit 2.21.

Details and guidance about the new timeout can be found at https://qunitjs.com/api/config/testTimeout/.