Add changes to modify external gateway API invocation URL in portal tryout

msm1992 · msm1992 · commit 5a739553e50f · 2025-02-07T08:34:33.000+05:30
diff --git a/components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIConsumerImpl.java b/components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/APIConsumerImpl.java
@@ -88,6 +88,8 @@
 import org.wso2.carbon.apimgt.api.model.policy.PolicyConstants;
 import org.wso2.carbon.apimgt.api.model.webhooks.Subscription;
 import org.wso2.carbon.apimgt.api.model.webhooks.Topic;
+import org.wso2.carbon.apimgt.impl.deployer.ExternalGatewayDeployer;
+import org.wso2.carbon.apimgt.impl.deployer.exceptions.DeployerException;
 import org.wso2.carbon.apimgt.impl.dto.ai.ApiChatConfigurationDTO;
 import org.wso2.carbon.apimgt.impl.caching.CacheProvider;
 import org.wso2.carbon.apimgt.impl.dao.ApiMgtDAO;
@@ -3435,8 +3437,17 @@ private String getOpenAPIDefinitionForDeployment(API api, String environmentName
         apiTenantDomain = MultitenantUtils.getTenantDomain(
                 APIUtil.replaceEmailDomainBack(api.getId().getProviderName()));
         hostsWithSchemes = getHostWithSchemeMappingForEnvironment(api, apiTenantDomain, environmentName);
-        api.setContext(getBasePath(apiTenantDomain, api.getContext()));
-        updatedDefinition = oasParser.getOASDefinitionForStore(api, definition, hostsWithSchemes, kmId);
+
+        Environment environment = APIUtil.getEnvironments().get(environmentName);
+        Map<String, ExternalGatewayDeployer> externalGatewayDeployers = ServiceReferenceHolder.getInstance().getExternalGatewayDeployers();
+        ExternalGatewayDeployer gatewayDeployer = externalGatewayDeployers.get(environment.getProvider());
+        if (gatewayDeployer != null) {
+            api.setContext("");
+            updatedDefinition = oasParser.getOASDefinitionForStore(api, definition, hostsWithSchemes, kmId);
+        } else {
+            api.setContext(getBasePath(apiTenantDomain, api.getContext()));
+            updatedDefinition = oasParser.getOASDefinitionForStore(api, definition, hostsWithSchemes, kmId);
+        }
         return updatedDefinition;
     }
 
@@ -3607,13 +3618,25 @@ private Map<String, String> getHostWithSchemeMappingForEnvironment(API api, Stri
             }
 
             VHost vhost = VHostUtils.getVhostFromEnvironment(environment, host);
-            if (StringUtils.containsIgnoreCase(api.getTransports(), APIConstants.HTTP_PROTOCOL)
-                    && vhost.getHttpPort() != -1) {
-                hostsWithSchemes.put(APIConstants.HTTP_PROTOCOL, vhost.getHttpUrl());
-            }
-            if (StringUtils.containsIgnoreCase(api.getTransports(), APIConstants.HTTPS_PROTOCOL)
-                    && vhost.getHttpsPort() != -1) {
-                hostsWithSchemes.put(APIConstants.HTTPS_PROTOCOL, vhost.getHttpsUrl());
+            Map<String, ExternalGatewayDeployer> externalGatewayDeployers = ServiceReferenceHolder.getInstance().getExternalGatewayDeployers();
+            ExternalGatewayDeployer gatewayDeployer = externalGatewayDeployers.get(environment.getProvider());
+            try {
+                if (StringUtils.containsIgnoreCase(api.getTransports(), APIConstants.HTTP_PROTOCOL)
+                        && vhost.getHttpPort() != -1) {
+                    String httpUrl = gatewayDeployer != null ?
+                            gatewayDeployer.getResolvedAPIInvocationUrl(api.getUuid(), vhost.getHttpUrl(), environment) :
+                            vhost.getHttpUrl();
+                    hostsWithSchemes.put(APIConstants.HTTP_PROTOCOL, httpUrl);
+                }
+                if (StringUtils.containsIgnoreCase(api.getTransports(), APIConstants.HTTPS_PROTOCOL)
+                        && vhost.getHttpsPort() != -1) {
+                    String httpsUrl = gatewayDeployer != null ?
+                            gatewayDeployer.getResolvedAPIInvocationUrl(api.getUuid(), vhost.getHttpsUrl(), environment) :
+                            vhost.getHttpsUrl();
+                    hostsWithSchemes.put(APIConstants.HTTPS_PROTOCOL, httpsUrl);
+                }
+            } catch (DeployerException e) {
+                throw new APIManagementException(e.getMessage());
             }
         }
         return hostsWithSchemes;
diff --git a/components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/dao/ApiMgtDAO.java b/components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/dao/ApiMgtDAO.java
@@ -15225,8 +15225,8 @@ private void addGatewayVhosts(Connection connection, int id, List<VHost> vhosts)
                 prepStmt.setInt(1, id);
                 prepStmt.setString(2, vhost.getHost());
                 prepStmt.setString(3, vhost.getHttpContext());
-                prepStmt.setString(4, vhost.getHttpPort().toString());
-                prepStmt.setString(5, vhost.getHttpsPort().toString());
+                prepStmt.setString(4, (vhost.getHttpPort() != null) ? vhost.getHttpPort().toString() : "N/A");
+                prepStmt.setString(5, (vhost.getHttpsPort() != null) ? vhost.getHttpsPort().toString() : "N/A");
                 prepStmt.setString(6, (vhost.getWsPort() != null) ? vhost.getWsPort().toString() : "N/A");
                 prepStmt.setString(7, (vhost.getWssPort() != null) ? vhost.getWssPort().toString() : "N/A");
                 prepStmt.addBatch();
@@ -15271,8 +15271,24 @@ private List<VHost> getVhostGatewayEnvironments(Connection connection, Integer e
                 while (rs.next()) {
                     String host = rs.getString("HOST");
                     String httpContext = rs.getString("HTTP_CONTEXT");
-                    Integer httpPort = rs.getInt("HTTP_PORT");
-                    Integer httpsPort = rs.getInt("HTTPS_PORT");
+                    Integer httpPort;
+                    String httpPortValue = rs.getString("HTTP_PORT");
+                    if ("N/A".equals(httpPortValue)) {
+                        // Handle the "N/A" case
+                        httpPort = null;
+                    } else {
+                        // Parse the integer value
+                        httpPort = Integer.parseInt(httpPortValue);
+                    }
+                    Integer httpsPort;
+                    String httpsPortValue = rs.getString("HTTPS_PORT");
+                    if ("N/A".equals(httpsPortValue)) {
+                        // Handle the "N/A" case
+                        httpsPort = null;
+                    } else {
+                        // Parse the integer value
+                        httpsPort = Integer.parseInt(httpsPortValue);
+                    }
                     Integer wsPort;
                     String wsPortValue = rs.getString("WS_PORT");
                     if ("N/A".equals(wsPortValue)) {
diff --git a/components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/deployer/ExternalGatewayDeployer.java b/components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/deployer/ExternalGatewayDeployer.java
@@ -88,4 +88,14 @@ public boolean undeploy(String apiID, String apiName, String apiVersion, String
      * @return List<String> validation result
      */
     public List<String> validateApi(API api) throws DeployerException;
+
+    /**
+     * This method returns the resolved API invocation URL by replacing all placeholders appropriately
+     *
+     * @return String resolved url
+     */
+    public default String getResolvedAPIInvocationUrl(String apiId, String url, Environment environment)
+            throws DeployerException {
+        return url;
+    }
 }
diff --git a/components/apimgt/org.wso2.carbon.apimgt.rest.api.admin.v1/src/gen/java/org/wso2/carbon/apimgt/rest/api/admin/v1/dto/VHostDTO.java b/components/apimgt/org.wso2.carbon.apimgt.rest.api.admin.v1/src/gen/java/org/wso2/carbon/apimgt/rest/api/admin/v1/dto/VHostDTO.java
@@ -40,7 +40,7 @@ public VHostDTO host(String host) {
   @ApiModelProperty(example = "mg.wso2.com", required = true, value = "")
   @JsonProperty("host")
   @NotNull
- @Pattern(regexp="^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$") @Size(min=1,max=255)  public String getHost() {
+ @Size(min=1,max=255)  public String getHost() {
     return host;
   }
   public void setHost(String host) {
diff --git a/components/apimgt/org.wso2.carbon.apimgt.rest.api.admin.v1/src/main/resources/admin-api.yaml b/components/apimgt/org.wso2.carbon.apimgt.rest.api.admin.v1/src/main/resources/admin-api.yaml
@@ -4832,7 +4832,7 @@ components:
           maxLength: 255
           minLength: 1
           # hostname regex as per RFC 1123 (http://tools.ietf.org/html/rfc1123) and appended *
-          pattern: '^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$'
+          #pattern: '^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$'
           type: string
           example: mg.wso2.com
         httpContext:
diff --git a/components/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/admin-api.yaml b/components/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/admin-api.yaml
@@ -4832,7 +4832,7 @@ components:
           maxLength: 255
           minLength: 1
           # hostname regex as per RFC 1123 (http://tools.ietf.org/html/rfc1123) and appended *
-          pattern: '^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$'
+          #pattern: '^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$'
           type: string
           example: mg.wso2.com
         httpContext:
diff --git a/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/java/org/wso2/carbon/apimgt/rest/api/store/v1/mappings/APIMappingUtil.java b/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/java/org/wso2/carbon/apimgt/rest/api/store/v1/mappings/APIMappingUtil.java
@@ -42,6 +42,9 @@
 import org.wso2.carbon.apimgt.api.model.VHost;
 import org.wso2.carbon.apimgt.impl.APIConstants;
 import org.wso2.carbon.apimgt.impl.APIType;
+import org.wso2.carbon.apimgt.impl.deployer.ExternalGatewayDeployer;
+import org.wso2.carbon.apimgt.impl.deployer.exceptions.DeployerException;
+import org.wso2.carbon.apimgt.impl.internal.ServiceReferenceHolder;
 import org.wso2.carbon.apimgt.impl.utils.APIUtil;
 import org.wso2.carbon.apimgt.impl.utils.VHostUtils;
 import org.wso2.carbon.apimgt.rest.api.common.RestApiCommonUtil;
@@ -567,11 +570,25 @@ private static APIEndpointURLsDTO fromAPIRevisionToEndpoints(APIDTO apidto, Envi
         boolean isGQLSubscription = StringUtils.equalsIgnoreCase(APIConstants.GRAPHQL_API, apidto.getType())
                 && isGraphQLSubscriptionsAvailable(apidto);
         if (!isWs) {
-            if (apidto.getTransport().contains(APIConstants.HTTP_PROTOCOL)) {
-                apiurLsDTO.setHttp(vHost.getHttpUrl() + context);
-            }
-            if (apidto.getTransport().contains(APIConstants.HTTPS_PROTOCOL)) {
-                apiurLsDTO.setHttps(vHost.getHttpsUrl() + context);
+            //prevent context appending in case the gateway is an external one
+            Map<String, ExternalGatewayDeployer> externalGatewayDeployers = ServiceReferenceHolder.getInstance().
+                    getExternalGatewayDeployers();
+            ExternalGatewayDeployer gatewayDeployer = externalGatewayDeployers.get(environment.getProvider());
+            context = gatewayDeployer != null ? "" : context;
+            try {
+                String httpUrl = gatewayDeployer != null ? gatewayDeployer.getResolvedAPIInvocationUrl(
+                        apidto.getId(), vHost.getHttpUrl(), environment) : vHost.getHttpUrl();
+                String httpsUrl = gatewayDeployer != null ? gatewayDeployer.getResolvedAPIInvocationUrl(
+                        apidto.getId(), vHost.getHttpsUrl(), environment) : vHost.getHttpsUrl();
+
+                if (apidto.getTransport().contains(APIConstants.HTTP_PROTOCOL)) {
+                    apiurLsDTO.setHttp(httpUrl + context);
+                }
+                if (apidto.getTransport().contains(APIConstants.HTTPS_PROTOCOL)) {
+                    apiurLsDTO.setHttps(httpsUrl + context);
+                }
+            } catch (DeployerException e) {
+                throw new APIManagementException(e.getMessage());
             }
         }
         if (isWs || isGQLSubscription) {

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public VHostDTO host(String host) {`
`40`	`40`	`@ApiModelProperty(example = "mg.wso2.com", required = true, value = "")`
`41`	`41`	`@JsonProperty("host")`
`42`	`42`	`@NotNull`
`43`		`- @Pattern(regexp="^(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\\-][a-zA-Z0-9])\\.)([A-Za-z0-9]\|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$") @Size(min=1,max=255) public String getHost() {`
	`43`	`+ @Size(min=1,max=255) public String getHost() {`
`44`	`44`	`return host;`
`45`	`45`	`}`
`46`	`46`	`public void setHost(String host) {`