feat: wire constraint generation on form save and validate on subscription

JedrzejJanasiak · JedrzejJanasiak · commit 1ab6a9fd990a · 2026-03-24T12:44:59.000+01:00
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/AbstractResourceTest.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/AbstractResourceTest.java
@@ -18,6 +18,7 @@
 import static org.mockito.Mockito.reset;
 
 import io.gravitee.apim.core.subscription.use_case.CreateSubscriptionUseCase;
+import io.gravitee.apim.core.subscription_form.domain_service.SubscriptionFormSchemaGenerator;
 import io.gravitee.rest.api.portal.rest.JerseySpringTest;
 import io.gravitee.rest.api.portal.rest.mapper.AnalyticsMapper;
 import io.gravitee.rest.api.portal.rest.mapper.ApiMapper;
@@ -319,6 +320,9 @@ public abstract class AbstractResourceTest extends JerseySpringTest {
     @Autowired
     protected EndpointConnectorPluginService endpointConnectorPluginService;
 
+    @Autowired
+    protected SubscriptionFormSchemaGenerator subscriptionFormSchemaGenerator;
+
     public AbstractResourceTest() {
         super(
             new AuthenticationProviderManager() {
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
@@ -35,6 +35,7 @@
 
 import io.gravitee.apim.core.subscription.model.SubscriptionEntity;
 import io.gravitee.apim.core.subscription.use_case.CreateSubscriptionUseCase;
+import io.gravitee.apim.core.subscription_form.exception.SubscriptionFormValidationException;
 import io.gravitee.common.data.domain.Page;
 import io.gravitee.common.http.HttpStatusCode;
 import io.gravitee.rest.api.model.ApiKeyEntity;
@@ -58,6 +59,7 @@
 import jakarta.ws.rs.client.Entity;
 import jakarta.ws.rs.core.Response;
 import java.util.Collections;
+import java.util.List;
 import java.util.Map;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
@@ -235,6 +237,19 @@ void shouldReturnBadRequestWhenMetadataKeyIsInvalid() {
         verify(createSubscriptionUseCase, times(1)).execute(any());
     }
 
+    @Test
+    void shouldReturnBadRequestWhenSubscriptionFormMetadataIsInvalid() {
+        doThrow(new SubscriptionFormValidationException(List.of("Field 'email' is required")))
+            .when(createSubscriptionUseCase)
+            .execute(any());
+
+        SubscriptionInput subscriptionInput = new SubscriptionInput().application(APPLICATION).plan(PLAN).metadata(Map.of());
+
+        final Response response = target().request().post(Entity.json(subscriptionInput));
+        Assertions.assertEquals(HttpStatusCode.BAD_REQUEST_400, response.getStatus());
+        verify(createSubscriptionUseCase, times(1)).execute(any());
+    }
+
     @Test
     public void shouldHaveBadRequestWhileCreatingSubscription() {
         final Response response = target().request().post(Entity.json(null));
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/spring/ResourceContextConfiguration.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/spring/ResourceContextConfiguration.java
@@ -144,6 +144,7 @@
 import io.gravitee.apim.core.subscription.use_case.GetSubscriptionsUseCase;
 import io.gravitee.apim.core.subscription.use_case.ImportSubscriptionSpecUseCase;
 import io.gravitee.apim.core.subscription.use_case.UpdateSubscriptionUseCase;
+import io.gravitee.apim.core.subscription_form.domain_service.SubscriptionFormSchemaGenerator;
 import io.gravitee.apim.core.user.domain_service.UserContextLoader;
 import io.gravitee.apim.infra.adapter.SubscriptionAdapter;
 import io.gravitee.apim.infra.adapter.SubscriptionAdapterImpl;
@@ -1221,4 +1222,9 @@ public JsonSchemaChecker jsonSchemaChecker() {
     public ClusterConfigurationSchemaService clusterConfigurationSchemaService() {
         return mock(ClusterConfigurationSchemaService.class);
     }
+
+    @Bean
+    SubscriptionFormSchemaGenerator subscriptionFormSchemaGenerator() {
+        return mock(SubscriptionFormSchemaGenerator.class);
+    }
 }
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/subscription_form/model/SubscriptionForm.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/subscription_form/model/SubscriptionForm.java
@@ -45,19 +45,17 @@ public class SubscriptionForm {
     private boolean enabled;
     /**
      * Validation rules per field key, derived from GMD and persisted as JSON at the repository boundary.
-     * {@code null} when nothing is stored for this form (including when there are no rules to persist).
+     * On {@link #update}, this is always set to the constraints computed from the new GMD (possibly empty).
      */
     private SubscriptionFormFieldConstraints validationConstraints;
 
     /**
-     * Updates this form (mutates in place). When {@code constraints} is {@code null},
-     * existing validation constraints are left unchanged — use case can defer populating this until the resource layer.
+     * Updates this form (mutates in place). Always replaces validation constraints with the given value
+     * (typically {@link io.gravitee.apim.core.subscription_form.domain_service.SubscriptionFormConstraintsFactory#fromSchema}).
      */
     public void update(GraviteeMarkdown gmdContent, SubscriptionFormFieldConstraints constraints) {
         this.gmdContent = gmdContent;
-        if (constraints != null) {
-            this.validationConstraints = constraints;
-        }
+        this.validationConstraints = constraints;
     }
 
     /**
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/subscription_form/use_case/UpdateSubscriptionFormUseCase.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/subscription_form/use_case/UpdateSubscriptionFormUseCase.java
@@ -19,6 +19,8 @@
 import io.gravitee.apim.core.gravitee_markdown.GraviteeMarkdown;
 import io.gravitee.apim.core.gravitee_markdown.GraviteeMarkdownValidator;
 import io.gravitee.apim.core.subscription_form.crud_service.SubscriptionFormCrudService;
+import io.gravitee.apim.core.subscription_form.domain_service.SubscriptionFormConstraintsFactory;
+import io.gravitee.apim.core.subscription_form.domain_service.SubscriptionFormSchemaGenerator;
 import io.gravitee.apim.core.subscription_form.exception.SubscriptionFormNotFoundException;
 import io.gravitee.apim.core.subscription_form.model.SubscriptionForm;
 import io.gravitee.apim.core.subscription_form.model.SubscriptionFormId;
@@ -41,6 +43,7 @@ public class UpdateSubscriptionFormUseCase {
     private final SubscriptionFormCrudService subscriptionFormCrudService;
     private final SubscriptionFormQueryService subscriptionFormQueryService;
     private final GraviteeMarkdownValidator graviteeMarkdownValidator;
+    private final SubscriptionFormSchemaGenerator schemaGenerator;
 
     public Output execute(Input input) {
         graviteeMarkdownValidator.validateNotEmpty(GraviteeMarkdown.of(input.gmdContent()));
@@ -54,7 +57,10 @@ public Output execute(Input input) {
                 )
             );
 
-        existingForm.update(GraviteeMarkdown.of(input.gmdContent()), null);
+        var gmd = GraviteeMarkdown.of(input.gmdContent());
+        var schema = schemaGenerator.generate(gmd);
+        var constraints = SubscriptionFormConstraintsFactory.fromSchema(schema);
+        existingForm.update(gmd, constraints);
         var savedForm = subscriptionFormCrudService.update(existingForm);
 
         log.info("Updated subscription form [{}] for environment [{}]", input.subscriptionFormId(), input.environmentId());
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/v4/impl/validation/SubscriptionValidationServiceImpl.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/v4/impl/validation/SubscriptionValidationServiceImpl.java
@@ -18,6 +18,9 @@
 import io.gravitee.apim.core.application_certificate.crud_service.ClientCertificateCrudService;
 import io.gravitee.apim.core.application_certificate.model.ClientCertificate;
 import io.gravitee.apim.core.application_certificate.model.ClientCertificateStatus;
+import io.gravitee.apim.core.subscription_form.domain_service.SubscriptionFormSubmissionValidator;
+import io.gravitee.apim.core.subscription_form.model.SubscriptionForm;
+import io.gravitee.apim.core.subscription_form.query_service.SubscriptionFormQueryService;
 import io.gravitee.definition.model.v4.plan.PlanMode;
 import io.gravitee.rest.api.model.NewSubscriptionEntity;
 import io.gravitee.rest.api.model.PlanSecurityType;
@@ -32,6 +35,7 @@
 import io.gravitee.rest.api.service.v4.validation.SubscriptionMetadataSanitizer;
 import io.gravitee.rest.api.service.v4.validation.SubscriptionValidationService;
 import java.util.List;
+import java.util.Map;
 import java.util.Objects;
 import lombok.CustomLog;
 import lombok.RequiredArgsConstructor;
@@ -48,6 +52,7 @@ public class SubscriptionValidationServiceImpl extends TransactionalService impl
 
     private final EntrypointConnectorPluginService entrypointService;
     private final SubscriptionMetadataSanitizer subscriptionMetadataSanitizer;
+    private final SubscriptionFormQueryService subscriptionFormQueryService;
 
     private final ClientCertificateCrudService clientCertificateCrudService;
 
@@ -57,6 +62,22 @@ public void validateAndSanitize(final GenericPlanEntity genericPlanEntity, final
         if (subscription.getMetadata() != null) {
             subscription.setMetadata(subscriptionMetadataSanitizer.sanitizeAndValidate(subscription.getMetadata()));
         }
+        validateSubscriptionFormMetadataIfApplicable(genericPlanEntity, subscription);
+    }
+
+    private void validateSubscriptionFormMetadataIfApplicable(
+        final GenericPlanEntity genericPlanEntity,
+        final NewSubscriptionEntity subscription
+    ) {
+        subscriptionFormQueryService
+            .findDefaultForEnvironmentId(genericPlanEntity.getEnvironmentId())
+            .filter(SubscriptionForm::isEnabled)
+            .map(SubscriptionForm::getValidationConstraints)
+            .filter(c -> c != null && !c.isEmpty())
+            .ifPresent(constraints -> {
+                var submitted = subscription.getMetadata() != null ? subscription.getMetadata() : Map.<String, String>of();
+                new SubscriptionFormSubmissionValidator(constraints).validate(submitted);
+            });
     }
 
     @Override
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/test/java/io/gravitee/apim/core/subscription_form/use_case/UpdateSubscriptionFormUseCaseTest.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/test/java/io/gravitee/apim/core/subscription_form/use_case/UpdateSubscriptionFormUseCaseTest.java
@@ -17,32 +17,44 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.when;
 
 import fixtures.core.model.SubscriptionFormFixtures;
 import inmemory.SubscriptionFormCrudServiceInMemory;
 import inmemory.SubscriptionFormQueryServiceInMemory;
 import io.gravitee.apim.core.gravitee_markdown.GraviteeMarkdown;
 import io.gravitee.apim.core.gravitee_markdown.GraviteeMarkdownValidator;
 import io.gravitee.apim.core.gravitee_markdown.exception.GraviteeMarkdownContentEmptyException;
+import io.gravitee.apim.core.subscription_form.domain_service.SubscriptionFormSchemaGenerator;
 import io.gravitee.apim.core.subscription_form.exception.SubscriptionFormNotFoundException;
 import io.gravitee.apim.core.subscription_form.model.SubscriptionForm;
 import io.gravitee.apim.core.subscription_form.model.SubscriptionFormId;
+import io.gravitee.apim.core.subscription_form.model.SubscriptionFormSchema;
 import java.util.List;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
 
+@ExtendWith(MockitoExtension.class)
 class UpdateSubscriptionFormUseCaseTest {
 
     private final SubscriptionFormCrudServiceInMemory crudService = new SubscriptionFormCrudServiceInMemory();
     private final SubscriptionFormQueryServiceInMemory queryService = new SubscriptionFormQueryServiceInMemory();
     private final GraviteeMarkdownValidator gmdValidator = new GraviteeMarkdownValidator();
+
+    @Mock
+    private SubscriptionFormSchemaGenerator schemaGenerator;
+
     private UpdateSubscriptionFormUseCase useCase;
 
     @BeforeEach
     void setUp() {
         crudService.reset();
         queryService.reset();
-        useCase = new UpdateSubscriptionFormUseCase(crudService, queryService, gmdValidator);
+        useCase = new UpdateSubscriptionFormUseCase(crudService, queryService, gmdValidator, schemaGenerator);
     }
 
     @Test
@@ -52,6 +64,10 @@ void should_update_existing_form() {
         crudService.initWith(List.of(existingForm));
         queryService.initWith(List.of(existingForm));
 
+        when(schemaGenerator.generate(any(GraviteeMarkdown.class))).thenReturn(
+            new SubscriptionFormSchema(List.of(new SubscriptionFormSchema.InputField("updated", false, null, null, null, null)))
+        );
+
         // When
         var result = useCase.execute(
             new UpdateSubscriptionFormUseCase.Input(
@@ -66,7 +82,24 @@ void should_update_existing_form() {
             GraviteeMarkdown.of("<gmd-input name=\"updated\" fieldKey=\"updated\"/>")
         );
         assertThat(result.subscriptionForm().getId()).isEqualTo(existingForm.getId());
-        assertThat(result.subscriptionForm().getValidationConstraints()).isNull();
+        assertThat(result.subscriptionForm().getValidationConstraints()).isNotNull();
+        assertThat(result.subscriptionForm().getValidationConstraints().byFieldKey()).containsKey("updated");
+    }
+
+    @Test
+    void should_persist_empty_constraints_when_gmd_has_no_form_fields() {
+        SubscriptionForm existingForm = SubscriptionFormFixtures.aSubscriptionForm();
+        crudService.initWith(List.of(existingForm));
+        queryService.initWith(List.of(existingForm));
+
+        when(schemaGenerator.generate(any(GraviteeMarkdown.class))).thenReturn(new SubscriptionFormSchema(List.of()));
+
+        var result = useCase.execute(
+            new UpdateSubscriptionFormUseCase.Input(existingForm.getEnvironmentId(), existingForm.getId(), "<p>Only static content</p>")
+        );
+
+        assertThat(result.subscriptionForm().getValidationConstraints()).isNotNull();
+        assertThat(result.subscriptionForm().getValidationConstraints().isEmpty()).isTrue();
     }
 
     @Test
diff --git a/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/test/java/io/gravitee/rest/api/service/v4/impl/validation/SubscriptionValidationServiceImplTest.java b/gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/test/java/io/gravitee/rest/api/service/v4/impl/validation/SubscriptionValidationServiceImplTest.java
