feat: Ensuring UI5 2.x compliance for cards-editor-middleware Plugin

[UBSusmitha]

#2681

[changeset-bot]

🦋 Changeset detected

Latest commit: 3c9b09a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@sap-ux/cards-editor-middleware	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[cla-assistant]

All committers have signed the CLA.

[heimwege]

Did you test this with UI5 2 ? I'm quite confident that this line in your editor.html will not work in UI5 2

<script src="../test-resources/sap/ushell/bootstrap/sandbox.js" id="sap-ushell-bootstrap"></script>

because in UI5 2 it must be

<script src="../resources/sap/ushell/bootstrap/sandbox2.js" id="sap-ushell-bootstrap"></script>

In preview-middleware our first approach was trying to solve this dynamically in the respective flp html template but that seems to create a race condition. So I completely refactored this to loading the UI5 version upfront and using a UI5 version dependent template (see #2598).

Also using ../ hard coded is kind of dangerous as the basePath (here ../) is kind of dynamic (e.g. in case you want to support cds-plugin-ui5)

[UBSusmitha]

@heimwege > Thanks for pointing, I have seen the same in another commit as well.
After linking cards-editor-middleware to sap.ap.cards in local I was not seeing any issue, I will check with you to see if there is anything I am missing while testing.

[heimwege]

@heimwege > Thanks for pointing, I have seen the same in another commit as well. After linking cards-editor-middleware to sap.ap.cards in local I was not seeing any issue, I will check with you to see if there is anything I am missing while testing.

Using the UI5 2 sources from sap.ap.cards does only verify that the code within you sandbox will work. The issue I described is that the sandbox bootstrap as such will change in UI5 2. So even if your code would run in UI5 2, the sandbox the middleware is currently using will not. You will get a blank browser window and the console will show an http 404 error message telling you that /test-resources/sap/ushell/bootstrap/sandbox.js was not found (because it's located at /resources/sap/ushell/bootstrap/sandbox2.js in UI5 2)

[heimwege]

see Comments

[heimwege]

see additional comments

[UBSusmitha]

Testing steps:

Go to open-ux-tools -> packages -> cards-editor-middleware
pnpm build
To change node version npm i -g [email protected]
npm link

Go to any app in your project:

npm link @sap-ux/cards-editor-middleware
start the app <use the command in your package.json>          #To start the app

To check if app is updated with changes in this PR:
Right click when the app is launched after opening generator preview >> View Page Source >> Check for the below line:

<script src="[./Init.js](http://localhost:8081/test/Init.js)"></script>

Within <your app>/node_modules/@sap-ux/cards-editor-middleware/templates

If you are able to see both flpSandbox.html & Init.js, then cards-editor-middleware package is linked correctly and node_modules is up to date with the changes in this PR.

After running command for starting the app, you should be able to launch the app and see manifest.json & i18n.properties files getting saved correctly after closing the dialog.

[heimwege]

• changeset ok
• sonar issue with duplications should be ignored because of the upcoming integration of this middleware into preview middleware
• test coverage is good
• did NOT test locally

[sonarqubecloud]

Quality Gate failed

Failed conditions
25.0% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

[tobiasqueck]

Quality Gate failed

Failed conditions 25.0% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

As this is a temporary solution and we are already planning how to merge it into the preview-middleware, we are ok with the quality-gate-failure

[tobiasqueck]

• changeset ok
• code is duplicated but as mentioned in a comment earlier, agreed and accepted as temporary solution