feat: allow users to get subscriptions with their consumer configuration

Okhelifi · Okhelifi · commit b5b3597e8f7a · 2025-03-11T09:18:52.000+01:00
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/main/java/io/gravitee/rest/api/portal/rest/mapper/ConfigurationSerializationMapper.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/main/java/io/gravitee/rest/api/portal/rest/mapper/ConfigurationSerializationMapper.java
@@ -0,0 +1,59 @@
+/*
+ * Copyright © 2015 The Gravitee team (http://gravitee.io)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.gravitee.rest.api.portal.rest.mapper;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.gravitee.definition.jackson.datatype.GraviteeMapper;
+import io.gravitee.rest.api.service.exceptions.TechnicalManagementException;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import org.mapstruct.Mapper;
+import org.mapstruct.Named;
+import org.mapstruct.factory.Mappers;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Mapper
+public interface ConfigurationSerializationMapper {
+    ConfigurationSerializationMapper INSTANCE = Mappers.getMapper(ConfigurationSerializationMapper.class);
+    Logger logger = LoggerFactory.getLogger(ConfigurationSerializationMapper.class);
+
+    @Named("deserializeConfiguration")
+    default Object deserializeConfiguration(String configuration) {
+        if (Objects.isNull(configuration)) {
+            return null;
+        }
+
+        ObjectMapper mapper = new GraviteeMapper();
+        try {
+            return mapper.readValue(configuration, LinkedHashMap.class);
+        } catch (JsonProcessingException jse) {
+            logger.debug("Cannot parse configuration as LinkedHashMap: " + configuration);
+        }
+
+        try {
+            return mapper.readValue(configuration, List.class);
+        } catch (JsonProcessingException jse) {
+            logger.debug("Cannot parse configuration as List: " + configuration);
+        }
+
+        return configuration;
+    }
+}
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/main/java/io/gravitee/rest/api/portal/rest/mapper/SubscriptionMapper.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/main/java/io/gravitee/rest/api/portal/rest/mapper/SubscriptionMapper.java
@@ -15,9 +15,11 @@
  */
 package io.gravitee.rest.api.portal.rest.mapper;
 
+import io.gravitee.rest.api.model.SubscriptionConfigurationEntity;
 import io.gravitee.rest.api.model.SubscriptionEntity;
 import io.gravitee.rest.api.model.SubscriptionStatus;
 import io.gravitee.rest.api.portal.rest.model.Subscription;
+import io.gravitee.rest.api.portal.rest.model.SubscriptionConsumerConfiguration;
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
 import org.mapstruct.factory.Mappers;
@@ -28,7 +30,7 @@
  * @author Florent CHAMFROY (florent.chamfroy at graviteesource.com)
  * @author GraviteeSource Team
  */
-@Mapper(uses = { DateMapper.class })
+@Mapper(uses = { ConfigurationSerializationMapper.class, DateMapper.class })
 public interface SubscriptionMapper {
     Logger log = LoggerFactory.getLogger(SubscriptionMapper.class);
     SubscriptionMapper INSTANCE = Mappers.getMapper(SubscriptionMapper.class);
@@ -38,6 +40,9 @@ public interface SubscriptionMapper {
     @Mapping(target = "startAt", source = "startingAt")
     Subscription map(SubscriptionEntity subscriptionEntity);
 
+    @Mapping(target = "entrypointConfiguration", qualifiedByName = "deserializeConfiguration")
+    SubscriptionConsumerConfiguration map(SubscriptionConfigurationEntity subscriptionConfigurationEntity);
+
     default Subscription.StatusEnum map(SubscriptionStatus status) {
         return Subscription.StatusEnum.fromValue(status.name());
     }
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/main/java/io/gravitee/rest/api/portal/rest/resource/SubscriptionResource.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/main/java/io/gravitee/rest/api/portal/rest/resource/SubscriptionResource.java
@@ -84,6 +84,7 @@ public class SubscriptionResource extends AbstractResource {
     private GraviteeMapper graviteeMapper;
 
     private static final String INCLUDE_KEYS = "keys";
+    private static final String INCLUDE_CONSUMER_CONFIGURATION = "consumerConfiguration";
 
     @GET
     @Produces(MediaType.APPLICATION_JSON)
@@ -93,6 +94,7 @@ public Response getSubscriptionBySubscriptionId(
     ) {
         SubscriptionEntity subscriptionEntity = subscriptionService.findById(subscriptionId);
         final ExecutionContext executionContext = GraviteeContext.getExecutionContext();
+
         if (
             hasPermission(executionContext, RolePermission.API_SUBSCRIPTION, subscriptionEntity.getApi(), RolePermissionAction.READ) ||
             hasPermission(executionContext, APPLICATION_SUBSCRIPTION, subscriptionEntity.getApplication(), RolePermissionAction.READ)
@@ -107,6 +109,11 @@ public Response getSubscriptionBySubscriptionId(
                     .collect(Collectors.toList());
                 subscription.setKeys(keys);
             }
+
+            if (include.contains(INCLUDE_CONSUMER_CONFIGURATION)) {
+                subscription.setConsumerConfiguration(SubscriptionMapper.INSTANCE.map(subscriptionEntity.getConfiguration()));
+            }
+
             return Response.ok(subscription).build();
         }
         throw new ForbiddenAccessException();
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/main/resources/portal-openapi.yaml b/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/main/resources/portal-openapi.yaml
@@ -3489,6 +3489,7 @@ components:
                     type: string
                     enum:
                         - keys
+                        - consumerConfiguration
         subscriptionConsumerStatusParam:
             name: status
             in: query
@@ -4601,6 +4602,9 @@ components:
                     type: array
                     items:
                         $ref: "#/components/schemas/Key"
+                consumerConfiguration:
+                    $ref: "#/components/schemas/SubscriptionConsumerConfiguration"
+
         Ticket:
             properties:
                 id:
@@ -5934,6 +5938,38 @@ components:
                     type: array
                     items:
                         type: string
+
+        SubscriptionConsumerConfiguration:
+          type: object
+          description: Consumer configuration associated to the subscription in case it is attached to a push plan.
+          properties:
+            entrypointId:
+              type: string
+              description: The id of the targeted entrypoint
+              example: webhook
+            channel:
+              type: string
+              description: The channel to consume
+              example: /channel1
+            entrypointConfiguration:
+              type: object
+              description: The configuration to use at subscription time to push to the target service.
+              example: |
+                {
+                    "callbackUrl": "https://webhook.site/aaaaaaaa-ffff-ffff-ffff-aaaaaaaa",
+                    "headers": [
+                        {
+                            "name": "demoHeader",
+                            "value": "my-value"
+                        },
+                        {
+                            "name": "anotherHeader",
+                            "value": "my-value2"
+                        }
+                    ]
+                }
+          required: [ entrypointId ]
+
     responses:
         InternalServerError:
             description: Internal Server Error
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/test/java/io/gravitee/rest/api/portal/rest/mapper/SubscriptionMapperTest.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/test/java/io/gravitee/rest/api/portal/rest/mapper/SubscriptionMapperTest.java
@@ -15,16 +15,22 @@
  */
 package io.gravitee.rest.api.portal.rest.mapper;
 
+import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
 
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.gravitee.rest.api.model.SubscriptionConfigurationEntity;
 import io.gravitee.rest.api.model.SubscriptionEntity;
 import io.gravitee.rest.api.model.SubscriptionStatus;
 import io.gravitee.rest.api.portal.rest.model.Subscription;
 import io.gravitee.rest.api.portal.rest.model.Subscription.StatusEnum;
+import io.gravitee.rest.api.portal.rest.model.SubscriptionConsumerConfiguration;
 import java.time.Instant;
 import java.util.Date;
+import lombok.SneakyThrows;
 import org.junit.Test;
 import org.mapstruct.factory.Mappers;
 
@@ -47,6 +53,7 @@ public class SubscriptionMapperTest {
     private SubscriptionEntity subscriptionEntity;
 
     private final SubscriptionMapper subscriptionMapper = Mappers.getMapper(SubscriptionMapper.class);
+    private final ObjectMapper objectMapper = new ObjectMapper();
 
     @Test
     public void testConvert() {
@@ -129,4 +136,31 @@ public void should_handle_origin_not_in_enum() {
         assertEquals(SUBSCRIPTION_API, subscription.getApi());
         assertNull(subscription.getOrigin());
     }
+
+    @Test
+    @SneakyThrows
+    public void should_handle_entrypoint_configuration() {
+        var entrypointId = "entrypointId";
+        var configuration =
+            "{\"auth\":{\"type\":\"none\"},\"callbackUrl\":\"https://webhook.example/1234\",\"ssl\":{\"keyStore\":{\"type\":\"\"},\"hostnameVerifier\":false,\"trustStore\":{\"type\":\"\"},\"trustAll\":true},\"retry\":{\"retryOption\":\"No Retry\"}}";
+        var channel = "channel";
+
+        SubscriptionConfigurationEntity subscriptionConfigurationEntity = new SubscriptionConfigurationEntity();
+        subscriptionConfigurationEntity.setEntrypointId(entrypointId);
+        subscriptionConfigurationEntity.setChannel(channel);
+        subscriptionConfigurationEntity.setEntrypointConfiguration(configuration);
+
+        SubscriptionConsumerConfiguration result = subscriptionMapper.map(subscriptionConfigurationEntity);
+
+        assertThat(entrypointId).isEqualTo(result.getEntrypointId());
+        assertThat(channel).isEqualTo(result.getChannel());
+        assertThat(result).isNotNull();
+        assertThat(result.getEntrypointConfiguration()).isNotNull();
+
+        JsonNode actualConfig = objectMapper.valueToTree(result.getEntrypointConfiguration());
+        assertThat(actualConfig.get("auth").get("type").asText()).isEqualTo("none");
+        assertThat(actualConfig.get("callbackUrl").asText()).isEqualTo("https://webhook.example/1234");
+        assertThat(actualConfig.get("ssl").get("trustAll").asBoolean()).isTrue();
+        assertThat(actualConfig.get("retry").get("retryOption").asText()).isEqualTo("No Retry");
+    }
 }
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/test/java/io/gravitee/rest/api/portal/rest/resource/SubscriptionResourceTest.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/test/java/io/gravitee/rest/api/portal/rest/resource/SubscriptionResourceTest.java
@@ -40,7 +40,6 @@
 import org.junit.Before;
 import org.junit.Test;
 import org.mockito.ArgumentCaptor;
-import org.mockito.Mockito;
 
 /**
  * @author Florent CHAMFROY (florent.chamfroy at graviteesource.com)
@@ -197,6 +196,41 @@ public void shouldGetSubscriptionWithKeys() {
         assertFalse(subscription.getKeys().isEmpty());
     }
 
+    @Test
+    public void shouldGetSubscriptionWithConsumerStatus() {
+        doReturn(true)
+            .when(permissionService)
+            .hasPermission(
+                eq(GraviteeContext.getExecutionContext()),
+                eq(RolePermission.API_SUBSCRIPTION),
+                eq(API),
+                eq(RolePermissionAction.READ)
+            );
+        doReturn(true)
+            .when(permissionService)
+            .hasPermission(
+                eq(GraviteeContext.getExecutionContext()),
+                eq(RolePermission.APPLICATION_SUBSCRIPTION),
+                eq(APPLICATION),
+                eq(RolePermissionAction.READ)
+            );
+
+        SubscriptionConfigurationEntity subscriptionConfigurationEntity = new SubscriptionConfigurationEntity();
+        subscriptionConfigurationEntity.setEntrypointId("entrypointId");
+        subscriptionConfigurationEntity.setChannel("channel");
+        subscriptionConfigurationEntity.setEntrypointConfiguration(
+            "{\"auth\":{\"type\":\"none\"},\"callbackUrl\":\"https://webhook.example/1234\",\"ssl\":{\"keyStore\":{\"type\":\"\"},\"hostnameVerifier\":false,\"trustStore\":{\"type\":\"\"},\"trustAll\":true},\"retry\":{\"retryOption\":\"No Retry\"}}"
+        );
+        subscriptionEntity.setConfiguration(subscriptionConfigurationEntity);
+
+        final Response response = target(SUBSCRIPTION).queryParam("include", "consumerConfiguration").request().get();
+        assertEquals(HttpStatusCode.OK_200, response.getStatus());
+
+        Subscription subscription = response.readEntity(Subscription.class);
+        assertNotNull(subscription);
+        assertNotNull(subscription.getConsumerConfiguration());
+    }
+
     @Test
     public void shouldNotGetSubscription() {
         final Response response = target(UNKNOWN_SUBSCRIPTION).request().get();
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/test/java/io/gravitee/rest/api/portal/rest/resource/SubscriptionsResourceTest.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/test/java/io/gravitee/rest/api/portal/rest/resource/SubscriptionsResourceTest.java
@@ -19,10 +19,14 @@
 import static io.gravitee.common.http.HttpStatusCode.OK_200;
 import static java.util.Arrays.asList;
 import static java.util.Collections.emptyList;
-import static org.junit.Assert.*;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
-import static org.mockito.Mockito.*;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.reset;
+import static org.mockito.Mockito.when;
 import static org.mockito.internal.util.collections.Sets.newSet;
 
 import io.gravitee.common.data.domain.Page;
@@ -32,11 +36,11 @@
 import io.gravitee.rest.api.model.NewSubscriptionEntity;
 import io.gravitee.rest.api.model.PlanEntity;
 import io.gravitee.rest.api.model.SubscriptionEntity;
+import io.gravitee.rest.api.model.SubscriptionStatus;
 import io.gravitee.rest.api.model.application.ApplicationListItem;
 import io.gravitee.rest.api.model.pagedresult.Metadata;
 import io.gravitee.rest.api.model.permissions.RolePermission;
 import io.gravitee.rest.api.model.permissions.RolePermissionAction;
-import io.gravitee.rest.api.portal.rest.mapper.SubscriptionMapper;
 import io.gravitee.rest.api.portal.rest.model.ApiKeyModeEnum;
 import io.gravitee.rest.api.portal.rest.model.Key;
 import io.gravitee.rest.api.portal.rest.model.Links;
@@ -79,17 +83,17 @@ public void init() {
 
         SubscriptionEntity subscriptionEntity1 = new SubscriptionEntity();
         subscriptionEntity1.setId(SUBSCRIPTION);
+        subscriptionEntity1.setStatus(SubscriptionStatus.ACCEPTED);
         SubscriptionEntity subscriptionEntity2 = new SubscriptionEntity();
         subscriptionEntity2.setId(ANOTHER_SUBSCRIPTION);
+        subscriptionEntity2.setStatus(SubscriptionStatus.ACCEPTED);
         final Page<SubscriptionEntity> subscriptionPage = new Page<>(asList(subscriptionEntity1, subscriptionEntity2), 0, 1, 2);
         doReturn(subscriptionPage.getContent()).when(subscriptionService).search(eq(GraviteeContext.getExecutionContext()), any());
         doReturn(subscriptionPage).when(subscriptionService).search(any(), any(), any());
 
-        doReturn(new Subscription().id(SUBSCRIPTION)).when(SubscriptionMapper.INSTANCE).map(subscriptionEntity1);
-        doReturn(new Subscription().id(ANOTHER_SUBSCRIPTION)).when(SubscriptionMapper.INSTANCE).map(subscriptionEntity2);
-
         SubscriptionEntity createdSubscription = new SubscriptionEntity();
         createdSubscription.setId(SUBSCRIPTION);
+        createdSubscription.setStatus(SubscriptionStatus.ACCEPTED);
         doReturn(createdSubscription).when(subscriptionService).create(eq(GraviteeContext.getExecutionContext()), any());
 
         SubscriptionEntity subscriptionEntity = new SubscriptionEntity();
