Multiple runtime environment support for Integration projects

[SanojPunchihewa]

Problem

Currently, Integration Studio contains only one version of MI as an embedded server.

Solution

Improve Integration Studio to dynamically add new MI runtime

Task breakdown

• [x] Add option to define runtime version for projects in the 'New Integration Project' Wizard - https://github.com/wso2/micro-integrator/issues/3141
• [ ] Add a new page to Export Project Artifacts and Run wizard
• [ ] Importing a new runtime

Affected Component

IntegrationStudio

Version

No response

Implementation

No response

Related Issues

No response

Suggested Labels

No response

[SanojPunchihewa]

[Progress Update] 28/03/2023

• Had the initial discussion with IsuruU and RosenS to understand the feature requirements.
• Go through eclipse documentations about Generic server
• Go through the existing IntegrationStudio codebase to understand the current implementation of the customized Generic server

[SanojPunchihewa]

[Progress Update] 29/03/2023

• Did research on adding a server programmatically. We need to use the eclipse IServer and ServerCore base classes and do the necessary customization on top of that.
• The current Add new Server option of the Studio use the above classes with the eclipse inbuilt UI. For this feature we may need to use a new customized UI as well.
• Currently the Export project artifacts and run option initialize only a single MI server instance(the latest version) and use that we when select this option.
• Need to check the feasibility of improving this wizard to have multiple runtime servers

[SanojPunchihewa]

[Progress Update]

• Added a dynamic server(hardcoded) using IServer and ServerCore and was able to deploy and run Capps
• Started working on a POC

[SanojPunchihewa]

[Progress Update]

• Improved the "New Project" wizard to define the runtime version
• Added a new page to the "Export Project Artifacts and Run" wizard
• Currently, the above page shows the runtime version of the project.
• Need to improve the new wizard to validate the existing runtimes, give option to add a new runtime etc

[SanojPunchihewa]

[Progress Update]

• Initial POC is completed which will add a new hardcoded server according to the runtime version
• Need to design the downloading and updating runtime functionality

[SanojPunchihewa]

[Progress Update]

• Due to the current limitations downloading a new runtime from Studio is not straightforward. Currently having discussions on this.

[SanojPunchihewa]

[Progress Update]

• Instead of the download option, an import option will be added to import a MI runtime as the embedded server
• Meeting notes can be found at https://docs.google.com/document/d/1wdMU7mDIxbth1eup18dgP4fhc3-LLQVizjohiCabj-Y/edit?usp=sharing

[SanojPunchihewa]

[Progress Update]

The proposed design for this feature is as follows,

1. Add a new option to the New Integration Project Wizard (Already implemented)

Add a Checkbox and a Textbox to define the required runtime server version. By default the version of the MI runtime shipped with the Studio will be set as the project’s runtime version.

When the wizard is completed, the runtime version will be added as a maven property to the parent POM file.

2. Add new page to Export Project Artifacts and Run wizard

This new Runtime page will validate the project’s runtime version with the default embedded runtime and give the user the option to choose a runtime. The Import Server button will open the Embedded runtime wizard

4. Importing a new runtime

The following Embedded runtime wizard can be used to change the default runtime and import a new one. This wizard can be accessed through the menu bar and Export Project Artifacts wizard.

The Import New Server button will open the following dialog in which the user needs to define the server name and use one of the options: Directory or Zip to point to the MI server which needs to be added as an embedded runtime.

[SanojPunchihewa]

[Design Update]

Participants: Asanka, Rukshan, Isuru, and Sanoj

Notes:

• Allowing the user to define the server name when importing an embedded runtime may lead to unforeseen issues, Therefore decided the generate the server name using the product name, version, and the update level without any user interactions.
• In the Run wizard, if the user selects a different runtime, update the project's runtime version accordingly.