QUnit 3.0 Roadmap

[Krinkle]

In our usual way, QUnit 3.0 will be a trivial release that adds no features, but only removes deprecated functionality and/or changes default settings.

Users should be able to update to the latest QUnit 2.x release and get all the same new capabilities. Anything that passes on the latest QUnit 2.x without warnings must pass on QUnit 3.0. Anything we want to change in QUnit 3.0 should be deprecated or issue warnings on QUnit 2.0 so that users can gradually address these warnings, and then perform an super simple, uneventful, upgrade to QUnit 3.0.

Before QUnit 3 development starts

• Complete 2.x release milestone (especially deprecations), at https://github.com/qunitjs/qunit/milestone/11

QUnit 3 development

Notable changes:

• Remove QUnit.load (deprecated in Deprecate QUnit.load #1084).
• Remove QUnit.onError (deprecated in Core: New error event for bailing on uncaught errors #1638).
• Remove support for PhantomJS in HTML Reporter (ref HTML Reporter: deprecate PhantomJS #1505).
• Remove support for Bower distribution (ref No longer publish new releases for Bower and Git submodules #1677).
• Remove support for AMD export. Can we drop builtin AMD support? #1729
• Remove support for Node 10-16, require Node 18+. Drop support for node < 18? #1727
• Remove support for IE9-IE10. Drop support for IE9-IE10 #1725
• Reject async functions in QUnit.module (ref Detect and warn when async function is passed to module() #1600).
• Change module hooks to inherit before from parent modules, same as beforeEach today (ref Share 'before' hook test environment with child module #1328).
• Enable test timeouts by default (ref Set a default timeout in QUnit 3.0 #1483).
• Fix unsemantic element in HTML Reporter (ref appendTestResults() creates DOM that is invalid HTML if serialised  #1301).

Other work:

• Complete 3.0 release milestone, at https://github.com/qunitjs/qunit/milestone/12
• Write "QUnit 3.0 Upgrade Guide" page on qunitjs.com.

Other ideas

• Release: Discontinue qunit/ subdirectory in favour of dist/ (ref Phase out dist/ folder in favour of qunit/ #1133). We ended up doing the reverse instead, thus not a breaking change, and already done during 2.x.
• Core: Separate module options (ref Separate module options from test environment #923).
• Assert: Support differentiating -0 and +0 (ref Support differentiating -0 and +0 (sameValue assertion) #1010).
• Assert: Step counter (ref Counter for expected assertions when using step(..) / verifySteps(..) is surprising (and undocumented!) #1226).
• Reject duplicate module names in QUnit.module (deprecated in Merge modules with same name (or treat as error) #1162).

[Krinkle]

I've added:

• Core: Remove QUnit.onError (deprecated in Core: New error event for bailing on uncaught errors #1638).
• Write "QUnit 3.0 Upgrade Guide" page on qunitjs.com.

[Krinkle]

Another thing, the HTML UI is currently unable to report global failures from before the first test in the UI because the qunit-tests element is created from QUnit.begin() which naturally fires just after the tests have been loaded, not before.

I'd like to address this by having the UI initialise right away instead of waiting for QUnit.begin(). Given how tight some wrappers and integrations are, though, I propose we do this in QUnit 3.0 rather than now.

[Krinkle]

I propose the following for QUnit 3 as well:

• Remove support for Node.js 10, require Node.js 12+.

[NullVoxPopuli]

may as well add removing node14 by now, too.

but anywho, reason why I came here is --- ESM.

Currently, the qunit package is not valid, and rollup will error if it tries processing imports of qunit.
Is this something that we need to wait for QUnit 3 to fix? or can we fix in v2?

[Krinkle]

@NullVoxPopuli That sounds like something we can fix in a minor release.

If I understand correctly, you're looking to import qunit and embed within a larger bundle? I've not tried to do that myself, but in terms of loading it over ESM, that seems to work in both browsers and Node.js. E.g. in browsers await import("https://code.jquery.com/qunit/qunit-2.19.4.js"); results in QUnit being defined, and in Node.js, import('qunit'); returns the QUnit API.

Could you file a bug report with details on where it currently fails?

[NullVoxPopuli]

sounds good: #1724

can we change the whole package to use modern JS? I see IIFE, and non-class usage when it looks like it really wants to be using classes.
I'm willing to make PRs, add tests, etc.

and for v3, can we extract non-browser utils to like a @qunit/cli or something?

[lifeart]

It will be really handy to have builtin retry as in playwright-test - https://playwright.dev/docs/test-retries
Related issue: #1572
Related qunit addon: https://github.com/mrloop/QUnit-retry