sap.ui.qunit.utils.nextUIUpdate and waitForThemeApplied recommended as replacements, but not exposed

[LukasHeimann]

Prior to UI5 2.0, a couple of methods were deprecated. The jsdoc in OpenUI5, and thus TypeScript types as well as the UI5 linter expose the deprecation notices with hints to replace with alternatives from sap.ui.qunit.utils, i.e.

• openui5/src/sap.ui.core/src/sap/ui/core/Core.js

  Lines 2309 to 2310 in 4950f1d

  	* update mechanisms. Test code can use the test module <code>sap/ui/qunit/utils/nextUIUpdate</code>
  	* as a convenient way to wait for the next asynchronous rendering.

  Core.applyChanges() suggests nextUIUpdate

• openui5/src/sap.ui.core/src/sap/ui/qunit/QUnitUtils.js

  Line 122 in 4950f1d

  * they rather should use the waitForTheme option or module <code>waitForThemeApplied</code>.

  QUtils.delayTestStart() suggests waitForThemeApplied

Indeed, those two methods are really useful when writing tests for custom controls. However, these methods are not exposed properly. nextUIUpdate is marked as @public, but waitForThemeApplied is not. Both are not shown on https://ui5.sap.com, and don't appear in the generated types, presumably due to deliberate exclusion at

openui5/src/sap.ui.core/src/sap/ui/core/.library

Line 125 in 4950f1d

<exclude name="sap.ui.qunit." />

This discussion started at SAP/ui5-typescript#459, but I was redirected here as the types are generated correctly, but the issue is the JSDoc and library configuration. Also, it was noted there that (until now) the two functions were deliberately not released (yet).

• As a developer, I want to use the recommended replacements for deprecated public functionality in a compliant manner, and thus would like to have the recommended replacements publicly released and documented.
• As a developer of custom controls, I'd like to use simple promise-based methods to wait for the execution environment to be in the right state -- this especially includes waiting for UI rerendering and themes being applied.

Thus, please consider properly exposing the two methods to end users, both in JSDoc as well as in TypeScript and https://ui5.sap.com.

Thank you very much for your support!
Lukas

[flovogt]

Thanks a lot @LukasHeimann for reporting this issue. I have created an internal incident DINC0193814 and the respective team will update the status of the issue here in GitHub.