Merge pull request #453 from chathuranga-jayanath-99/handle-adding-new-properties

Handle adding new properties to the POM

Author: chathuranga-jayanath-99

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/SynapseLanguageService.java

@@ -77,6 +77,7 @@
 import org.eclipse.lemminx.customservice.synapse.parser.OverviewPageDetailsResponse;
 import org.eclipse.lemminx.customservice.synapse.parser.UpdateConfigRequest;
 import org.eclipse.lemminx.customservice.synapse.parser.UpdateDependencyRequest;
+import org.eclipse.lemminx.customservice.synapse.parser.UpdatePropertyRequest;
 import org.eclipse.lemminx.customservice.synapse.parser.UpdateResponse;
 import org.eclipse.lemminx.customservice.synapse.parser.config.ConfigParser;
 import org.eclipse.lemminx.customservice.synapse.parser.config.ConfigurableEntry;
@@ -642,6 +643,12 @@ public CompletableFuture<SignatureHelp> signatureHelp(ExpressionParam params) {
         return CompletableFuture.supplyAsync(() -> ExpressionSignatureProvider.getFunctionSignatures(params));
     }
 
+    @Override
+    public CompletableFuture<UpdateResponse> updateProperty(UpdatePropertyRequest request) {
+        UpdateResponse response = PomParser.updateProperty(projectUri, request);
+        return CompletableFuture.supplyAsync(() -> response);
+    }
+
     @Override
     public CompletableFuture<UpdateResponse> updateDependency(UpdateDependencyRequest request) {
         UpdateResponse response = PomParser.updateDependency(projectUri, request);

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/ISynapseLanguageService.java

@@ -63,6 +63,7 @@
 import org.eclipse.lemminx.customservice.synapse.parser.OverviewPageDetailsResponse;
 import org.eclipse.lemminx.customservice.synapse.parser.UpdateConfigRequest;
 import org.eclipse.lemminx.customservice.synapse.parser.UpdateDependencyRequest;
+import org.eclipse.lemminx.customservice.synapse.parser.UpdatePropertyRequest;
 import org.eclipse.lemminx.customservice.synapse.parser.UpdateResponse;
 import org.eclipse.lemminx.customservice.synapse.parser.config.ConfigurableEntry;
 import org.eclipse.lemminx.customservice.synapse.resourceFinder.ResourceUsagesRequest;
@@ -229,6 +230,9 @@ public interface ISynapseLanguageService {
     @JsonRequest
     CompletableFuture<OverviewPageDetailsResponse> getOverviewPageDetails();
 
+    @JsonRequest
+    CompletableFuture<UpdateResponse> updateProperty(UpdatePropertyRequest request);
+
     @JsonRequest
     CompletableFuture<UpdateResponse> updateDependency(UpdateDependencyRequest request);
 

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/synapse/parser/BuildDetails.java

@@ -16,13 +16,24 @@
 public class BuildDetails {
 
     private AdvanceDetails advanceDetails;
+    private Node enableFatCar;
     private DockerDetails dockerDetails;
 
     BuildDetails() {
         advanceDetails = new AdvanceDetails();
         dockerDetails = new DockerDetails();
     }
 
+    public Node getEnableFatCar() {
+
+        return enableFatCar;
+    }
+
+    public void setEnableFatCar(Node enableFatCar) {
+
+        this.enableFatCar = enableFatCar;
+    }
+
     public AdvanceDetails getAdvanceDetails() {
         return this.advanceDetails;
     }

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/synapse/parser/Constants.java

@@ -63,6 +63,7 @@ private Constants() { }
     public static final String ZIP = "zip";
     public static final String CAR = "car";
     public static final String DOCKER_FILE_BASE_IMAGE = "dockerfile.base.image";
+    public static final String FAT_CAR_ENABLE = "fat.car.enable";
     public static final String CIPHER_TOOL_ENABLE = "ciphertool.enable";
     public static final String KEY_STORE_ALIAS = "keystore.alias";
     public static final String KEY_STORE_PASSWORD = "keystore.password";

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/synapse/parser/PropertyDetails.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2025, WSO2 LLC. (http://www.wso2.com).
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     WSO2 LLC - support for WSO2 Micro Integrator Configuration
+ */
+
+package org.eclipse.lemminx.customservice.synapse.parser;
+
+import org.eclipse.lsp4j.Range;
+
+public class PropertyDetails {
+
+    private String name;
+    private String value;
+    private Range range;
+
+    public String getName() {
+
+        return name;
+    }
+
+    public void setName(String name) {
+
+        this.name = name;
+    }
+
+    public String getValue() {
+
+        return value;
+    }
+
+    public void setValue(String value) {
+
+        this.value = value;
+    }
+
+    public Range getRange() {
+
+        return range;
+    }
+
+    public void setRange(Range range) {
+
+        this.range = range;
+    }
+}

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/synapse/parser/UpdatePropertyRequest.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2025, WSO2 LLC. (http://www.wso2.com).
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     WSO2 LLC - support for WSO2 Micro Integrator Configuration
+ */
+
+package org.eclipse.lemminx.customservice.synapse.parser;
+
+import java.util.List;
+
+public class UpdatePropertyRequest {
+
+    public List<PropertyDetails> properties;
+}

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/synapse/parser/pom/PluginHandler.java

@@ -262,6 +262,8 @@ private void processProperties(String qName, String value, int valueStartLine, i
                 pomDetailsResponse.getBuildDetails().getDockerDetails().
                         setKeyStoreAlias(new Node(value, Either.forLeft(range)));
                 break;
+            case Constants.FAT_CAR_ENABLE: pomDetailsResponse.getBuildDetails().setEnableFatCar(
+                        new Node(value, Either.forLeft(range)));
             case Constants.CIPHER_TOOL_ENABLE:
                 pomDetailsResponse.getBuildDetails().getDockerDetails().setCipherToolEnable(
                         new Node(value, Either.forLeft(range)));

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/customservice/synapse/parser/pom/PomParser.java

@@ -19,7 +19,9 @@
 import org.eclipse.lemminx.customservice.synapse.parser.DeployPluginDetails;
 import org.eclipse.lemminx.customservice.synapse.parser.DependencyDetails;
 import org.eclipse.lemminx.customservice.synapse.parser.OverviewPageDetailsResponse;
+import org.eclipse.lemminx.customservice.synapse.parser.PropertyDetails;
 import org.eclipse.lemminx.customservice.synapse.parser.UpdateDependencyRequest;
+import org.eclipse.lemminx.customservice.synapse.parser.UpdatePropertyRequest;
 import org.eclipse.lemminx.customservice.synapse.parser.UpdateResponse;
 import org.eclipse.lemminx.customservice.synapse.utils.Constant;
 import org.eclipse.lsp4j.Position;
@@ -37,6 +39,7 @@
 import javax.xml.parsers.SAXParser;
 import javax.xml.parsers.SAXParserFactory;
 import javax.xml.stream.Location;
+import javax.xml.stream.XMLInputFactory;
 import javax.xml.stream.XMLStreamConstants;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
@@ -52,6 +55,8 @@
 import java.io.StringReader;
 import java.io.StringWriter;
 import java.nio.file.Files;
+import java.util.ArrayDeque;
+import java.util.Deque;
 import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -63,12 +68,52 @@ public class PomParser {
     private static DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
     private static TransformerFactory transformerFactory = TransformerFactory.newInstance();
     private static boolean hasDependencies = false;
+    private static boolean hasProperties = false;
 
     public static void getPomDetails(String projectUri, OverviewPageDetailsResponse detailsResponse) {
         pomDetailsResponse = detailsResponse;
         extractPomContent(projectUri);
     }
 
+    public static UpdateResponse updateProperty(String projectUri, UpdatePropertyRequest request) {
+        try {
+            DocumentBuilder builder = factory.newDocumentBuilder();
+            Document document = builder.newDocument();
+            UpdateResponse updateResponse = new UpdateResponse();
+            StringBuilder elementInString = new StringBuilder();
+            List<String> pomContent = readPom(projectUri);
+            assert pomContent != null;
+            Element propertiesElement = null;
+            Range initialRange = getPropertiesRange(pomContent);
+            if (!hasProperties) {
+                propertiesElement = document.createElement(Constants.PROPERTIES);
+            }
+            for (PropertyDetails property : request.properties) {
+                if (property.getRange() != null) {
+                    updateResponse.add(new TextEdit(property.getRange(),
+                            elementToString(createPropertyElement(document, property))));
+                } else {
+                    if (propertiesElement != null) {
+                        propertiesElement.appendChild(createPropertyElement(document, property));
+                    } else {
+                        elementInString.append(elementToString(createPropertyElement(document, property)));
+                    }
+                }
+            }
+            String value =
+                    (propertiesElement != null) ? elementToString(propertiesElement) : elementInString.toString();
+            if (StringUtils.isEmpty(value)) {
+                return null;
+            }
+            // Add the new content inside the <properties> section
+            updateResponse.add(new TextEdit(new Range(initialRange.getStart(), initialRange.getStart()), value));
+            return updateResponse;
+        } catch (ParserConfigurationException e) {
+            LOGGER.log(Level.SEVERE, "Error parsing the POM file : " + e.getMessage());
+            return null;
+        }
+    }
+
     public static UpdateResponse updateDependency(String projectUri, UpdateDependencyRequest request) {
         try {
             DocumentBuilder builder = factory.newDocumentBuilder();
@@ -300,6 +345,68 @@ private static List<String> readPom(String projectUri) {
         }
     }
 
+    private static Range getPropertiesRange(List<String> pomContent) {
+        if (pomContent == null || pomContent.isEmpty()) {
+            return null;
+        }
+        XMLStreamReader reader = null;
+        try {
+            reader = getXMLReader(pomContent);
+            Deque<String> elementStack = new ArrayDeque<>();
+            int startLine = -1, startChar = -1;
+            int endLine = -1, endChar = -1;
+
+            while (reader.hasNext()) {
+                int event = reader.next();
+
+                if (event == XMLStreamConstants.START_ELEMENT) {
+                    String localName = reader.getLocalName();
+                    elementStack.push(localName);
+
+                    if (Constants.PROPERTIES.equals(localName) && elementStack.size() == 2 &&
+                            Constant.PROJECT.equals(elementStack.peekLast())) {
+                        hasProperties = true;
+                        startLine = reader.getLocation().getLineNumber();
+                        startChar = reader.getLocation().getColumnNumber() + localName.length() + 2; // After <properties>
+                    }
+                }
+
+                if (event == XMLStreamConstants.END_ELEMENT) {
+                    String localName = reader.getLocalName();
+
+                    if (Constants.PROPERTIES.equals(localName) && startLine != -1 && elementStack.size() == 2 &&
+                            Constant.PROJECT.equals(elementStack.peekLast())) {
+                        endLine = reader.getLocation().getLineNumber();
+                        endChar = reader.getLocation().getColumnNumber(); // At </properties>
+                        break;
+                    }
+
+                    elementStack.pop();
+                }
+            }
+
+            if (startLine == -1 || endLine == -1 || startChar == -1 || endChar == -1) {
+                return null;
+            }
+
+            Position start = new Position(startLine, startChar);
+            Position end = new Position(endLine, endChar);
+            return new Range(start, end);
+
+        } catch (Exception e) {
+            LOGGER.log(Level.SEVERE, "Error reading the POM file: " + e.getMessage());
+            return null;
+        } finally {
+            if (reader != null) {
+                try {
+                    reader.close();
+                } catch (XMLStreamException e) {
+                    LOGGER.log(Level.WARNING, "Error closing XMLStreamReader: " + e.getMessage());
+                }
+            }
+        }
+    }
+
     private static Position getDependenciesStartPosition(List<String> pomContent) {
         try {
             XMLStreamReader reader = getXMLReader(pomContent);
@@ -345,6 +452,12 @@ private static Position getDependenciesStartPosition(List<String> pomContent) {
         }
     }
 
+    private static Element createPropertyElement(Document document, PropertyDetails propertyDetails) {
+        Element property = document.createElement(propertyDetails.getName());
+        property.setTextContent(propertyDetails.getValue());
+        return property;
+    }
+
     private static Element createDependencyElement(Document document, DependencyDetails dependencyDetails) {
         Element dependency = document.createElement(Constants.DEPENDENCY);
         Element groupId = document.createElement(Constants.GROUP_ID);