Update service design meta info by samithkavishke · Pull Request #422 · ballerina-platform/ballerina-language-server

samithkavishke · 2025-10-24T09:15:34Z

Purpose

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 documentation@wso2.com 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 certification@wso2.com 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.

samithkavishke · 2025-10-27T06:28:58Z

@RadCod3 Can you review this

Copilot

Pull Request Overview

This PR implements a new read-only metadata system for service design, enabling services to display configuration information extracted from various sources (annotations, listener parameters, service descriptions).

Adds database schema and JSON configuration for read-only metadata definitions
Implements an extractor architecture for retrieving metadata from different sources
Integrates metadata extraction into service builders and updates test fixtures
Updates HTTP version references in test files from 2.14.6 to 2.14.7

Reviewed Changes

Copilot reviewed 37 out of 38 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
service_artifacts.json	Defines read-only metadata configuration for multiple service types
service-index.sql	Creates database table for storing metadata definitions
ServiceIndexGenerator.java	Adds metadata insertion logic during index generation
DatabaseManager.java	Implements database insertion method for metadata
ReadOnlyMetaData.java	Defines record structure for metadata items
ServiceDatabaseManager.java	Implements query method for retrieving metadata
*Extractor.java files	Implements extraction strategy pattern for different metadata sources
AbstractServiceBuilder.java	Integrates metadata extraction into service building
Various test JSON files	Updates expected test outputs with metadata and version changes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-27T06:31:10Z

...e-model-index-generator/src/main/java/io/ballerina/indexgenerator/ServiceIndexGenerator.java

 import java.io.IOException;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;


The import java.nio.file.Files is unused and should be removed to keep the imports clean.

Suggested change

import java.nio.file.Files;

Copilot · 2025-10-27T06:31:11Z

...e-model-index-generator/src/main/java/io/ballerina/indexgenerator/ServiceIndexGenerator.java

 import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.Paths;


The import java.nio.file.Paths is unused and should be removed to keep the imports clean.

Suggested change

import java.nio.file.Paths;

Copilot · 2025-10-27T06:31:11Z

...ain/java/io/ballerina/servicemodelgenerator/extension/builder/service/AsbServiceBuilder.java

+        Map<String, List<String>> result = new HashMap<>();
+
+        // Handle ASB-specific nested parameter extraction
+        if (("queueName".equals(metadataItem.metadataKey())|| "topicName".equals(metadataItem.metadataKey()))) {


Missing space after || operator. Should be || for consistency with standard Java formatting conventions.

Suggested change

if (("queueName".equals(metadataItem.metadataKey())|| "topicName".equals(metadataItem.metadataKey()))) {

if (("queueName".equals(metadataItem.metadataKey()) || "topicName".equals(metadataItem.metadataKey()))) {

Copilot · 2025-10-27T06:31:11Z

...nsion/src/main/java/io/ballerina/servicemodelgenerator/extension/util/ServiceModelUtils.java

 import io.ballerina.servicemodelgenerator.extension.model.Value;

 import java.util.ArrayList;
+import java.util.HashMap;


[nitpick] The import statement for HashMap should be placed after the existing import for ArrayList to maintain alphabetical ordering of imports.

Copilot · 2025-10-27T06:31:11Z

...erator-commons/src/main/java/io/ballerina/modelgenerator/commons/ServiceDatabaseManager.java

+                        rs.getString("kind")
+                ));
+            }
+            conn.close();


The connection is already being closed by the try-with-resources statement. This explicit conn.close() call is redundant and should be removed.

RadCod3 · 2025-10-27T09:17:32Z

LGTM

model-generator-commons/src/main/java/io/ballerina/modelgenerator/commons/ReadOnlyMetaData.java

LakshanWeerasinghe · 2025-10-27T10:40:50Z

...ava/io/ballerina/servicemodelgenerator/extension/builder/service/AbstractServiceBuilder.java

        builder.append(String.join(TWO_NEW_LINES, functions)).append(NEW_LINE).append(CLOSE_BRACE);
    }

+    public static void extractServicePathInfo(ServiceDeclarationNode serviceNode, Service serviceModel) {


You can use the method in the this util.

LakshanWeerasinghe · 2025-10-27T10:42:07Z

...ain/java/io/ballerina/servicemodelgenerator/extension/builder/service/AsbServiceBuilder.java

+        return List.of();
+    }
+
+}


Suggested change

}

}

pasindufernando1

Shall we update the @SInCE 1.0.0 to @1.3.0 in newly created files? Also its better to add the empty line at EOF in these files

pasindufernando1 · 2025-10-27T10:27:33Z

model-generator-commons/src/main/java/io/ballerina/modelgenerator/commons/ReadOnlyMetaData.java

+ * @param displayName The display name for the metadata field
+ * @param kind The kind/category of the metadata field (e.g., ANNOTATION, SERVICE_DESCRIPTION, LISTENER_PARAM)
+ *
+ * @since 1.0.0


Suggested change

* @since 1.0.0

* @since 1.3.0

...ava/io/ballerina/servicemodelgenerator/extension/builder/service/AbstractServiceBuilder.java

pasindufernando1 · 2025-10-27T10:40:09Z

...rc/main/java/io/ballerina/servicemodelgenerator/extension/extractor/AnnotationExtractor.java

+ * Extractor for ANNOTATION kind readOnly metadata.
+ * Extracts parameter values from service annotations.
+ *
+ * @since 1.0.0


Suggested change

* @since 1.0.0

* @since 1.3.0

...rc/main/java/io/ballerina/servicemodelgenerator/extension/extractor/AnnotationExtractor.java

pasindufernando1 · 2025-10-27T10:40:43Z

...on/src/main/java/io/ballerina/servicemodelgenerator/extension/extractor/CustomExtractor.java

+ * Interface for concrete service builders to implement custom readOnly metadata extraction.
+ * This allows each service builder to define its own extraction logic for CUSTOM kind metadata.
+ *
+ * @since 1.0.0


Suggested change

* @since 1.0.0

* @since 1.3.0

pasindufernando1 · 2025-10-27T10:40:53Z

...on/src/main/java/io/ballerina/servicemodelgenerator/extension/extractor/CustomExtractor.java

+    default boolean canExtractCustom(ReadOnlyMetaData metadataItem, ModelFromSourceContext context) {
+        return "CUSTOM".equals(metadataItem.kind());
+    }
+}


Suggested change

}

}

...n/java/io/ballerina/servicemodelgenerator/extension/extractor/ReadOnlyMetadataExtractor.java

...ain/java/io/ballerina/servicemodelgenerator/extension/extractor/ReadOnlyMetadataManager.java

samithkavishke added 14 commits October 24, 2025 14:29

Add readonly params

07bd65d

Add listener support

40942f7

Correct the rabbitmq meta info

547c566

Add service class meta info

93cfd2f

Extract listener parameters

50f3c90

Add metainfo to the http,graphql builder

e538c49

Add metainfo to the http,graphql builder

fe863e4

Add multiple listners support

cd8bd3f

Remove redundant comments

2c57f64

Add array logic to listner extractor

37ab8ae

Add asb custom extractor

6218529

Remove redundant logics

5b6c994

Remove rabbitmq fallback logic

31cd7c4

Add ftp meta info

ac4378b

samithkavishke force-pushed the metadata branch from 791d708 to 1eb564a Compare October 27, 2025 04:57

samithkavishke marked this pull request as ready for review October 27, 2025 04:57

samithkavishke requested a review from KavinduZoysa as a code owner October 27, 2025 04:57

Correct test cases

4438eab

samithkavishke force-pushed the metadata branch from 1eb564a to 4438eab Compare October 27, 2025 04:58

RadCod3 mentioned this pull request Oct 27, 2025

Add sample value generation context for Databinding and fix redirect wso2/vscode-extensions#742

Merged

Correct the icons

54a8518

samithkavishke changed the base branch from main to 1.3.x October 27, 2025 06:18

NipunaRanasinghe requested a review from ayeshLK October 27, 2025 06:28

NipunaRanasinghe requested a review from Copilot October 27, 2025 06:30

Copilot AI reviewed Oct 27, 2025

View reviewed changes

samithkavishke added 2 commits October 27, 2025 13:13

Merge 1.3.x

ca4d59b

Resolve check style issues

ab4cd49

LakshanWeerasinghe reviewed Oct 27, 2025

View reviewed changes

model-generator-commons/src/main/java/io/ballerina/modelgenerator/commons/ReadOnlyMetaData.java Outdated Show resolved Hide resolved

LakshanWeerasinghe reviewed Oct 27, 2025

View reviewed changes

pasindufernando1 reviewed Oct 27, 2025

View reviewed changes

LakshanWeerasinghe reviewed Oct 27, 2025

View reviewed changes

...ain/java/io/ballerina/servicemodelgenerator/extension/extractor/ReadOnlyMetadataManager.java Outdated Show resolved Hide resolved

samithkavishke added 4 commits October 27, 2025 19:18

Resolve check style issues

9c8854c

Resolve comments

c285cbb

Change the metadata name

be22409

Remove test updating logic

74e179f

NipunaRanasinghe approved these changes Oct 27, 2025

View reviewed changes

NipunaRanasinghe merged commit b4152dc into ballerina-platform:1.3.x Oct 27, 2025
3 checks passed

nipunayf mentioned this pull request Oct 29, 2025

[Release Checklist] WSO2 Integrator: BI - v1.4.0 wso2/product-ballerina-integrator#1640

Closed

	if (("queueName".equals(metadataItem.metadataKey())\|\| "topicName".equals(metadataItem.metadataKey()))) {
	if (("queueName".equals(metadataItem.metadataKey()) \|\| "topicName".equals(metadataItem.metadataKey()))) {

Comments

Conversation

samithkavishke commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Goals

Approach

User stories

Release note

Documentation

Training

Certification

Marketing

Automation tests

Security checks

Samples

Related PRs

Migrations (if applicable)

Test environment

Learning

Uh oh!

samithkavishke commented Oct 27, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

RadCod3 commented Oct 27, 2025

Uh oh!

Uh oh!

LakshanWeerasinghe Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

LakshanWeerasinghe Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

pasindufernando1 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pasindufernando1 Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pasindufernando1 Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pasindufernando1 Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pasindufernando1 Oct 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

samithkavishke commented Oct 24, 2025 •

edited

Loading

pasindufernando1 left a comment •

edited

Loading

pasindufernando1 Oct 27, 2025 •

edited

Loading

pasindufernando1 Oct 27, 2025 •

edited

Loading

pasindufernando1 Oct 27, 2025 •

edited

Loading