Tool to compare two SAPUI5 versions to check for deprecated objects?

[BrendanFarthing]

Hi,

Does anyone know of an automated tool for comparing two different SAPUI5 versions, specifically to look for what has been deprecated between those two versions? I don't want to do this manually by comparing documentation as it would be too time consuming.

For example, we would like to upgrade the SAPUI5 version we use from 1.84.27 to the latest 1.96.xx version and want to know what has been deprecated between those two versions so we can look for those APIs, Controls etc in all of our apps and adjust the code. We'd like to do that rather than just having user's test and hope they find all issues. Users would also test, but they may miss things, hence wanting to do this also in a more controlled way.

Note that i also played around with the UI5 Support Assistant but it doesn't seen useful enough for this task.

Thanks,

Brendan

[boghyon · Accepted solution]

There are mainly three ways to learn about deprecated APIs between different versions:

• UI5 linter: A static code analysis tool for UI5 - GitHub (Introducing UI5 linter - SAP Community)
• Deprecated and Deleted APIs - SAPUI5 What's New Viewer
• Index of Deprecated APIs - Demo Kit - SAPUI5 SDK

Please note that the last #api/deprecated page lists only the APIs that are entirely deprecated with the JSDoc tag `@deprecated` in the source code. There are other APIs which are only partially deprecated while the API itself is not. So far, I'm aware of

• sap/ui/core/theming/Parameters.get: non-object `vName` deprecated since 1.92 and 1.94
• sap/ui/model/json/JSONModel#loadData: `bAsync` and `bCache` deprecated since 1.107
• sap/ui/model/odata/v4/ODataModel constructor: `synchronizationMode` deprecated since 1.110
• sap/ui/model/odata/v2/ODataModel#createEntry: passing an array to `mProperties.properties` since 1.120
• sap/ui/core/Core#loadLibrary: no parameter deprecated so far but make sure to either enable the `async` flag or pass `true` as the 2nd argument in order to fetch the library asynchronously (no sync XHR). The Core#loadLibrary API is deprecated since 1.119 in favor of sap.ui.core.Lib.load.
• sap/chart/Chart#setIsAnalytical deprecated only as per the description but missing `@deprecated` in the source code.
• sap/m/FeedInput's `iconDensityAware` and `ariaLabelForPicture`, and sap.m.FeedListItem's `iconDensityAware` were all deprecated but missing `@deprecated`. Fixed with commit 8710e5d.

Also, there are APIs that are not even partially deprecated yet, but still provide an `async` parameter (mostly `false` by default) and therefore might become partially deprecated in the future to further restrict the number of sync XHRs:

• sap/ui/model/resource/ResourceModel constructor
• sap/base/i18n/ResourceBundle.create
• sap/base/util/Properties.create
• sap/ui/core/ComponentContainer constructor (assuming a falsy `manifest`)
• sap/ui/core/ExtensionPoint.load
• sap/ui/core/Manifest.load
• Constructor of sap/*/routing/Targets and sap/m/routing/Router. Make sure to add `interfaces: ["sap.ui.core.IAsyncContentCreation"]` to your `metadata` in Component.js to create the root view and the router targets asynchronously.
• sap.ui.loader.config or missing `data-sap-ui-async="true"`
• sap/ui/model/odata/v2/ODataModel#refreshSecurityToken
• sap/ui/model/odata/ODataMetadata constructor (default: true)
• sap/ui/core/Component#createComponent (default: true)

Make sure to pass `true` to `async` whenever possible.

Additionally, take a look at the relevant warning and error logs in the browser console reported by the latest UI5 1.x version. You might have to increase the log level to see the logs. If the reported issue is caused by the framework code itself, create an issue in https://github.com/SAP/openui5/issues (OpenUI5 code) or a customer case (SAPUI5 code).

For new SAPUI5 application projects, it is recommended to develop with TypeScript which can help identifying deprecated APIs immediately during the development time.

[BrendanFarthing · Accepted solution]

Thanks Boghyon, that's pretty much what I need. I didn't realise that functionality was there.