Add New Service Designer APIs #528

TharmiganK · 2024-12-19T04:41:06Z

Purpose

$Subject

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email [email protected] to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to [email protected] and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

Unit tests

Code coverage information
Integration tests

Details about the test cases and coverage

Security checks

Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no
Ran FindSecurityBugs plugin and verified report? yes/no
Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes/no

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

...sion/src/main/java/io/ballerina/servicemodelgenerator/extension/OpenApiServiceGenerator.java

...src/main/java/io/ballerina/servicemodelgenerator/extension/ServiceModelGeneratorService.java

nipunayf · 2025-01-12T15:46:39Z

...-ls-extension/src/main/java/io/ballerina/servicemodelgenerator/extension/model/MetaData.java


-public record MetaData(String label, String description, String groupName, int groupNo) {
+public record MetaData(String label, String description) {


Suggested change

public record MetaData(String label, String description) {

public record Metadata(String label, String description) {

nipunayf · 2025-01-12T15:51:30Z

...rc/main/java/io/ballerina/servicemodelgenerator/extension/response/CommonSourceResponse.java

+public record CommonSourceResponse(Map<String, List<TextEdit>> textEdits, String errorMsg, String stacktrace) {
+
+    public CommonSourceResponse() {
+        this(Map.of(), null, null);


Similar to the AbstractFlowModelResponse, can we isolate the error handling logic in the super class?

nipunayf · 2025-01-12T16:08:06Z

...sion/src/main/java/io/ballerina/servicemodelgenerator/extension/OpenApiServiceGenerator.java

+            StringBuilder sb = new StringBuilder();
+            for (String errorMessage : errorMessages) {
+                sb.append(DiagnosticSeverity.ERROR).append(": ").append(errorMessage).append(System.lineSeparator());
+            }
+            throw new BallerinaOpenApiException(sb.toString());


Suggested change

StringBuilder sb = new StringBuilder();

for (String errorMessage : errorMessages) {

sb.append(DiagnosticSeverity.ERROR).append(": ").append(errorMessage).append(System.lineSeparator());

}

throw new BallerinaOpenApiException(sb.toString());

String errorMessage = String.join(System.lineSeparator(), errorMessages);

throw new BallerinaOpenApiException(DiagnosticSeverity.ERROR + ": " + errorMessage);

nipunayf · 2025-01-12T18:05:17Z

...sion/src/main/java/io/ballerina/servicemodelgenerator/extension/OpenApiServiceGenerator.java

+    private String getDefaultRecordValue(RecordTypeSymbol recordTypeSymbol) {
+        StringBuilder sb = new StringBuilder();
+        sb.append(OPEN_BRACE);
+        Map<String, RecordFieldSymbol> fieldDescriptors = recordTypeSymbol.fieldDescriptors();
+        for (Map.Entry<String, RecordFieldSymbol> fieldDescriptor : fieldDescriptors.entrySet()) {
+            String key = fieldDescriptor.getKey();
+            if (key.contains("status") || key.contains("mediaType") || key.contains("headers")) {
+                continue;
+            }
+            sb.append(key).append(COLON).append(SPACE)
+                    .append(getDefaultValue(fieldDescriptor.getValue().typeDescriptor())).append(COMMA)
+                    .append(SPACE);
+        }
+        sb.append(DEFAULT_HTTP_RESPONSE_VALUE).append(CLOSE_BRACE);
+        return sb.toString();
+    }


Why do we need this method instead of directly calling RecordUtil.getFillAllRecordFieldInsertText

nipunayf · 2025-01-12T18:13:06Z

...src/main/java/io/ballerina/servicemodelgenerator/extension/ServiceModelGeneratorService.java

+                Package currentPackage = project.currentPackage();
+                Module module = currentPackage.module(ModuleName.from(currentPackage.packageName()));
+                ModuleId moduleId = module.moduleId();
+                SemanticModel semanticModel = currentPackage.getCompilation().getSemanticModel(moduleId);


We can get the semantic model directly from the workspace manager using this.workspacemanager.semanticModel()

nipunayf · 2025-01-12T18:33:52Z

...src/main/java/io/ballerina/servicemodelgenerator/extension/ServiceModelGeneratorService.java

+                    String importText = String.format("%simport %s/%s;%s", System.lineSeparator(),
+                            listener.getOrgName(), listener.getModuleName(), System.lineSeparator());


Suggested change

String importText = String.format("%simport %s/%s;%s", System.lineSeparator(),

listener.getOrgName(), listener.getModuleName(), System.lineSeparator());

String importText = String.format("%nimport %s/%s;%n", listener.getOrgName(), listener.getModuleName());

nipunayf · 2025-01-12T18:51:40Z

...tor-ls-extension/src/main/java/io/ballerina/servicemodelgenerator/extension/model/Value.java

+
+    public void addValue(String value) {
+        if (Objects.isNull(this.values)) {
+            this.values = List.of(value);


The list is immutable, and and you cannot call addValue afterwards.

nipunayf · 2025-01-12T18:54:23Z

...src/main/java/io/ballerina/servicemodelgenerator/extension/ServiceModelGeneratorService.java

+                TextEdit serviceEdit = new TextEdit(Utils.toRange(lineRange.endLine()),
+                        System.lineSeparator() + serviceDeclaration);
+                if (!importExists(node, service.getOrgName(), service.getModuleName())) {
+                    String importText = String.format("%simport %s/%s;%s", System.lineSeparator(), service.getOrgName(),


Can we move this to a util method since there is another usage?

nipunayf · 2025-01-12T19:03:05Z

...src/main/java/io/ballerina/servicemodelgenerator/extension/ServiceModelGeneratorService.java

+                if (document.isEmpty()) {
+                    return new CommonSourceResponse();
+                }


When the API attempts to add a resource to the service but finds a missing document, this indicates a program error. The error should be sent to the front end for debugging, and an exception should be thrown.

nipunayf · 2025-01-12T19:15:24Z

...src/main/java/io/ballerina/servicemodelgenerator/extension/ServiceModelGeneratorService.java

+                    return new CommonSourceResponse();
+                }
+                NonTerminalNode parentService = functionDefinitionNode.parent();
+                if (!(parentService.kind().equals(SyntaxKind.SERVICE_DECLARATION))) {


Suggested change

if (!(parentService.kind().equals(SyntaxKind.SERVICE_DECLARATION))) {

if (parentService.kind() != SyntaxKind.SERVICE_DECLARATION) {

KavinduZoysa · 2025-01-16T05:14:22Z

@TharmiganK, Let's fix the comments in a separate PR.

TharmiganK added 11 commits December 13, 2024 13:45

Add initial files

c2f5a42

Merge remote-tracking branch 'origin/main' into service-model

4ee7329

Fix check style issues

1c44b2f

Merge remote-tracking branch 'origin/main' into service-model

37b5f8e

Add edit APIs

eaf5173

Update APIs

672c132

Merge remote-tracking branch 'origin/main' into service-model

85575b8

Add OpenAPI gen support

72a55b6

Update edit APIs

dc91568

Add support for mapping HTTP responses

a0c7ae5

Fix getting type name

8eb097c

TharmiganK requested a review from KavinduZoysa as a code owner December 19, 2024 04:41

TharmiganK added 3 commits December 19, 2024 10:15

Remove old tests

1a4f197

Update listener models

b23831b

Disable failing test cases

b71fbf4

TharmiganK force-pushed the service-model branch from fe1439c to b71fbf4 Compare December 19, 2024 05:18

TharmiganK added 7 commits December 19, 2024 12:15

Refactor update APIs

827f2fa

Fix base path issue

6f9103a

Add file and ftp models

39df8a1

Fix issues with the edit APIs

9dcb1d4

Add add-new property to the listener

3796f03

Fix missing listener code-data

b6bee14

Add default value support

4c085bb

KavinduZoysa reviewed Jan 9, 2025

View reviewed changes

...sion/src/main/java/io/ballerina/servicemodelgenerator/extension/OpenApiServiceGenerator.java Outdated Show resolved Hide resolved

KavinduZoysa reviewed Jan 9, 2025

View reviewed changes

...src/main/java/io/ballerina/servicemodelgenerator/extension/ServiceModelGeneratorService.java Outdated Show resolved Hide resolved

KavinduZoysa reviewed Jan 9, 2025

View reviewed changes

...src/main/java/io/ballerina/servicemodelgenerator/extension/ServiceModelGeneratorService.java Outdated Show resolved Hide resolved

KavinduZoysa reviewed Jan 9, 2025

View reviewed changes

...src/main/java/io/ballerina/servicemodelgenerator/extension/ServiceModelGeneratorService.java Outdated Show resolved Hide resolved

TharmiganK added 3 commits January 9, 2025 14:58

Add status code response creation support

03c1491

Merge remote-tracking branch 'origin/main' into service-model

5a9a265

Add response type support

4322cc6

TharmiganK added 4 commits January 10, 2025 18:28

Fix check style issue

b339ca8

Address review suggestions

1f42fea

Remove unused test file

a9c101f

Disable test case

5045273

axewilledge approved these changes Jan 10, 2025

View reviewed changes

nipunayf reviewed Jan 12, 2025

View reviewed changes

KavinduZoysa merged commit 23e74ee into main Jan 16, 2025
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add New Service Designer APIs #528

Add New Service Designer APIs #528

TharmiganK commented Dec 19, 2024

nipunayf Jan 12, 2025

nipunayf Jan 12, 2025

nipunayf Jan 12, 2025

nipunayf Jan 12, 2025

nipunayf Jan 12, 2025

nipunayf Jan 12, 2025

nipunayf Jan 12, 2025

nipunayf Jan 12, 2025

nipunayf Jan 12, 2025 •

edited

Loading

nipunayf Jan 12, 2025

KavinduZoysa commented Jan 16, 2025


		public record MetaData(String label, String description, String groupName, int groupNo) {
		public record MetaData(String label, String description) {

		String importText = String.format("%simport %s/%s;%s", System.lineSeparator(),
		listener.getOrgName(), listener.getModuleName(), System.lineSeparator());

	String importText = String.format("%simport %s/%s;%s", System.lineSeparator(),
	listener.getOrgName(), listener.getModuleName(), System.lineSeparator());
	String importText = String.format("%nimport %s/%s;%n", listener.getOrgName(), listener.getModuleName());

	if (!(parentService.kind().equals(SyntaxKind.SERVICE_DECLARATION))) {
	if (parentService.kind() != SyntaxKind.SERVICE_DECLARATION) {

Add New Service Designer APIs #528

Add New Service Designer APIs #528

Conversation

TharmiganK commented Dec 19, 2024

Purpose

Goals

Approach

User stories

Release note

Documentation

Training

Certification

Marketing

Automation tests

Security checks

Samples

Related PRs

Migrations (if applicable)

Test environment

Learning

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nipunayf Jan 12, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KavinduZoysa commented Jan 16, 2025

nipunayf Jan 12, 2025 •

edited

Loading