feat: validate operation params (#31)

anssari1 · web-flow · commit f81b2efa29fb · 2024-11-26T15:05:22.000+03:00
diff --git a/.github/workflows/generate-and-publish-sdk-sources.yaml b/.github/workflows/generate-and-publish-sdk-sources.yaml
@@ -12,7 +12,7 @@ on:
 
 jobs:
   generate-and-publish-sources:
-    uses: ExpediaGroup/expediagroup-java-sdk/.github/workflows/selfserve-full-workflow.yaml@v20241013
+    uses: ExpediaGroup/expediagroup-java-sdk/.github/workflows/selfserve-full-workflow.yaml@v20241125
     secrets: inherit
     with:
       name: xap
diff --git a/customizations/generator/openapi/src/main/kotlin/com/expediagroup/sdk/generators/openapi/OpenApiSdkGenerator.kt b/customizations/generator/openapi/src/main/kotlin/com/expediagroup/sdk/generators/openapi/OpenApiSdkGenerator.kt
@@ -40,9 +40,6 @@ class OpenApiSdkGenerator {
             "README.md",
             "ApiException.kt",
             "LinkableOperation.kt",
-            "PropertyConstraintViolation.kt",
-            "PropertyConstraintsValidator.kt",
-            "PropertyConstraintViolationException.kt",
             "ApiAbstractions.kt"
         )
 
@@ -147,27 +144,6 @@ class OpenApiSdkGenerator {
                                     "ApiException.kt"
                                 )
                             )
-                            add(
-                                SupportingFile(
-                                    "validation/propertyConstraintViolationException.mustache",
-                                    "$packagePath/models/exception/",
-                                    "PropertyConstraintViolationException.kt"
-                                )
-                            )
-                            add(
-                                SupportingFile(
-                                    "validation/propertyConstraintViolation.mustache",
-                                    "$packagePath/models/exception/",
-                                    "PropertyConstraintViolation.kt"
-                                )
-                            )
-                            add(
-                                SupportingFile(
-                                    "validation/propertyConstraintsValidator.mustache",
-                                    "$packagePath/validation/",
-                                    "PropertyConstraintsValidator.kt"
-                                )
-                            )
 
                             add(
                                 TemplateDefinition(
diff --git a/customizations/generator/openapi/src/main/resources/post-processor/assets/templates/get-lodging-listings-operation-params/rooms.kt b/customizations/generator/openapi/src/main/resources/post-processor/assets/templates/get-lodging-listings-operation-params/rooms.kt
@@ -1,5 +1,11 @@
 fun rooms(rooms: List<Room>) =
     apply {
+        if (rooms.size > 8) {
+            throw PropertyConstraintViolationException(
+                constraintViolations = listOf("rooms: size must be between 0 and 8")
+            )
+        }
+
         rooms.elementAtOrNull(0)?.let {
             this.room1Adults = it.adults
             this.room1ChildAges = it.childAges?.map { item -> item.toString() }
diff --git a/customizations/generator/openapi/src/main/resources/post-processor/assets/templates/get-lodging-quotes-operation-params/rooms.kt b/customizations/generator/openapi/src/main/resources/post-processor/assets/templates/get-lodging-quotes-operation-params/rooms.kt
@@ -1,5 +1,11 @@
 fun rooms(rooms: List<Room>) =
     apply {
+        if (rooms.size > 8) {
+            throw PropertyConstraintViolationException(
+                constraintViolations = listOf("rooms: size must be between 0 and 8")
+            )
+        }
+
         rooms.elementAtOrNull(0)?.let {
             this.room1Adults = it.adults
             this.room1ChildAges = it.childAges?.map { item -> item.toString() }
diff --git a/customizations/generator/openapi/src/main/resources/templates/expediagroup-sdk/client.mustache b/customizations/generator/openapi/src/main/resources/templates/expediagroup-sdk/client.mustache
@@ -52,7 +52,6 @@ class {{clientClassname}}Client private constructor(clientConfiguration: XapClie
             }
 
             appendHeaders(extraHeaders)
-            validateConstraints(operation.requestBody)
             contentType(ContentType.Application.Json)
             setBody(operation.requestBody)
         }
diff --git a/customizations/generator/openapi/src/main/resources/templates/expediagroup-sdk/operation_params.mustache b/customizations/generator/openapi/src/main/resources/templates/expediagroup-sdk/operation_params.mustache
@@ -3,13 +3,25 @@
         {{#hasNonBodyParams}}
             package com.expediagroup.sdk.{{namespace}}.operations
 
+            import com.expediagroup.sdk.core.model.exception.client.PropertyConstraintViolationException
             import com.expediagroup.sdk.core.model.OperationParams
+
             import {{packageName}}.infrastructure.*
             import com.fasterxml.jackson.annotation.JsonProperty
             import com.fasterxml.jackson.databind.annotation.JsonDeserialize
             import io.ktor.http.Headers
             import io.ktor.http.Parameters
 
+            import javax.validation.constraints.Max
+            import javax.validation.constraints.Min
+            import javax.validation.constraints.NotNull
+            import javax.validation.constraints.Pattern
+            import javax.validation.constraints.Size
+            import javax.validation.Valid
+            import javax.validation.Validation
+
+            import org.hibernate.validator.messageinterpolation.ParameterMessageInterpolator
+
             /**
             {{#nonBodyParams}}
                 {{#params}}
@@ -21,6 +33,7 @@
             data class {{classname}}Params(
                 {{#nonBodyParams}}
                     {{#params}}
+                        {{>models/constraints}}
                         {{>modelMutable}} {{>client/apiParam}}{{^-last}}, {{/-last}}
                     {{/params}}
                 {{/nonBodyParams}}
@@ -67,32 +80,36 @@
                     {{/nonBodyParams}}
 
                     fun build(): {{classname}}Params {
-                        {{#hasRequiredParams}}
-                            validateNullity()
-                        {{/hasRequiredParams}}
-
-                        return {{classname}}Params(
+                        val params =  {{classname}}Params(
                             {{#nonBodyParams}}
                                 {{#params}}
                                     {{{paramName}}} = {{{paramName}}}{{#required}}!!{{/required}}{{^-last}},{{/-last}}
                                 {{/params}}
                             {{/nonBodyParams}}
                         )
+
+                        validate(params)
+
+                        return params
                     }
 
-                    {{#hasRequiredParams}}
-                        private fun validateNullity() {
-                            {{#nonBodyParams}}
-                                {{#params}}
-                                    {{#required}}
-                                        if ({{{paramName}}} == null) {
-                                            throw NullPointerException("Required parameter {{{paramName}}} is missing")
-                                        }
-                                    {{/required}}
-                                {{/params}}
-                            {{/nonBodyParams}}
+                    private fun validate(params: {{classname}}Params) {
+                        val validator =
+                            Validation
+                                .byDefaultProvider()
+                                .configure()
+                                .messageInterpolator(ParameterMessageInterpolator())
+                                .buildValidatorFactory()
+                                .validator
+
+                        val violations = validator.validate(params)
+
+                        if (violations.isNotEmpty()) {
+                            throw PropertyConstraintViolationException(
+                                constraintViolations = violations.map { "${it.propertyPath}: ${it.message}" }
+                            )
                         }
-                    {{/hasRequiredParams}}
+                    }
                 }
 
                 fun toBuilder() = Builder(
diff --git a/examples/src/main/java/com/expediagroup/sdk/xap/examples/scenarios/lodging/AvailabilityCalendarsQuickStartScenario.java b/examples/src/main/java/com/expediagroup/sdk/xap/examples/scenarios/lodging/AvailabilityCalendarsQuickStartScenario.java
@@ -20,10 +20,10 @@
 import com.expediagroup.sdk.xap.models.AvailabilityCalendarResponse;
 import com.expediagroup.sdk.xap.operations.GetLodgingAvailabilityCalendarsOperation;
 import com.expediagroup.sdk.xap.operations.GetLodgingAvailabilityCalendarsOperationParams;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import java.util.Arrays;
 import java.util.HashSet;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * This example demonstrates how to use Availability Calendar api with simple search.

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,6 @@ class {{clientClassname}}Client private constructor(clientConfiguration: XapClie`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`appendHeaders(extraHeaders)`
`55`		`- validateConstraints(operation.requestBody)`
`56`	`55`	`contentType(ContentType.Application.Json)`
`57`	`56`	`setBody(operation.requestBody)`
`58`	`57`	`}`