Merge pull request #119 from outfoxx/feature/suspend-flow

Allow choosing `suspend` modifier for `Flow` service methods (disabled by default)
outfoxx · Dec 2, 2024 · 1ccc13d · 1ccc13d
2 parents e77665b + e2f6810
commit 1ccc13d
Show file tree

Hide file tree

Showing 26 changed files with 623 additions and 267 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,7 +20,7 @@ jobs:
     - uses: actions/setup-java@v4
       with:
         java-version: '21'
-        distribution: temurin
+        distribution: oracle
 
     - name: Setup Gradle
       uses: gradle/actions/setup-gradle@v4

diff --git a/cli/src/main/kotlin/io/outfoxx/sunday/generator/kotlin/KotlinJAXRSGenerateCommand.kt b/cli/src/main/kotlin/io/outfoxx/sunday/generator/kotlin/KotlinJAXRSGenerateCommand.kt
@@ -40,6 +40,11 @@ open class KotlinJAXRSGenerateCommand :
     help = "Generate suspendable service methods for coroutine support",
   ).flag()
 
+  val coroutineFlowMethods by option(
+    "-flow-coroutines",
+    help = "Generate suspendable flow service methods for coroutine support",
+  ).flag(default = false)
+
   val reactiveResponseType by option(
     "-reactive",
     help = "Generic result type for reactive service methods",
@@ -76,6 +81,7 @@ open class KotlinJAXRSGenerateCommand :
       shapeIndex,
       typeRegistry,
       KotlinJAXRSGenerator.Options(
+        coroutineFlowMethods,
         coroutineServiceMethods,
         reactiveResponseType,
         explicitSecurityParameters,

diff --git a/cli/src/test/kotlin/io/outfoxx/sunday/generator/KotlinJAXRSCLITest.kt b/cli/src/test/kotlin/io/outfoxx/sunday/generator/KotlinJAXRSCLITest.kt
@@ -64,6 +64,18 @@ class KotlinJAXRSCLITest {
     assertThat(commandWithFalse.coroutineServiceMethods, equalTo(false))
   }
 
+  @Test
+  fun `--flow-coroutines flag`() {
+
+    val commandWithTrue = KotlinJAXRSGenerateCommandTest()
+    assertDoesNotThrow { commandWithTrue.parse(arrayOf("-flow-coroutines", *requiredOptions)) }
+    assertThat(commandWithTrue.coroutineFlowMethods, equalTo(true))
+
+    val commandWithFalse = KotlinJAXRSGenerateCommandTest()
+    assertDoesNotThrow { commandWithFalse.parse(requiredOptions) }
+    assertThat(commandWithFalse.coroutineServiceMethods, equalTo(false))
+  }
+
   @Test
   fun `--reactive flag`() {
 

diff --git a/generator/src/main/kotlin/io/outfoxx/sunday/generator/kotlin/KotlinGenerator.kt b/generator/src/main/kotlin/io/outfoxx/sunday/generator/kotlin/KotlinGenerator.kt
@@ -352,6 +352,18 @@ abstract class KotlinGenerator(
             }
           }
         }
+        if (operation.successes.isEmpty()) {
+          processReturnType(
+            endPoint,
+            operation,
+            Response(),
+            null,
+            problemTypes,
+            typeBuilder,
+            functionBuilder,
+            UNIT,
+          )
+        }
 
         operation.failures.forEach { response ->
 

diff --git a/generator/src/main/kotlin/io/outfoxx/sunday/generator/kotlin/KotlinJAXRSGenerator.kt b/generator/src/main/kotlin/io/outfoxx/sunday/generator/kotlin/KotlinJAXRSGenerator.kt
@@ -90,6 +90,7 @@ class KotlinJAXRSGenerator(
 ) {
 
   class Options(
+    val coroutineFlowMethods: Boolean,
     val coroutineServiceMethods: Boolean,
     val reactiveResponseType: String?,
     val explicitSecurityParameters: Boolean,
@@ -227,13 +228,13 @@ class KotlinJAXRSGenerator(
 
     val mediaTypesForPayloads = response.payloads.mapNotNull { it.mediaType }
 
-    if (options.coroutineServiceMethods) {
-      functionBuilder.addModifiers(SUSPEND)
-    }
-
     val isSSE = operation.findBoolAnnotation(SSE, generationMode) == true
     val isFlow = operation.hasAnnotation(EventStream, generationMode) && options.coroutineServiceMethods
 
+    if ((isFlow && options.coroutineFlowMethods) || (!isFlow && options.coroutineServiceMethods)) {
+      functionBuilder.addModifiers(SUSPEND)
+    }
+
     val reactive = operation.findBoolAnnotation(Reactive, generationMode) ?: reactiveDefault
     if (reactive && reactiveResponseType != null && !isSSE && !isFlow) {
 

diff --git a/generator/src/main/kotlin/io/outfoxx/sunday/generator/swift/SwiftGenerator.kt b/generator/src/main/kotlin/io/outfoxx/sunday/generator/swift/SwiftGenerator.kt
@@ -312,6 +312,18 @@ abstract class SwiftGenerator(
             }
           }
         }
+        if (operation.successes.isEmpty()) {
+          processReturnType(
+            endPoint,
+            operation,
+            Response(),
+            null,
+            problemTypes,
+            typeBuilder,
+            functionBuilder,
+            VOID,
+          )
+        }
 
         operation.failures.forEach { response ->
 

diff --git a/generator/src/main/kotlin/io/outfoxx/sunday/generator/typescript/TypeScriptGenerator.kt b/generator/src/main/kotlin/io/outfoxx/sunday/generator/typescript/TypeScriptGenerator.kt
@@ -338,6 +338,18 @@ abstract class TypeScriptGenerator(
             }
           }
         }
+        if (operation.successes.isEmpty()) {
+          processReturnType(
+            endPoint,
+            operation,
+            Response(),
+            null,
+            problemTypes,
+            typeBuilder,
+            functionBuilder,
+            VOID,
+          )
+        }
 
         operation.failures.forEach { response ->
 

diff --git a/generator/src/test/kotlin/io/outfoxx/sunday/generator/kotlin/jaxrs/RequestBodyParamTest.kt b/generator/src/test/kotlin/io/outfoxx/sunday/generator/kotlin/jaxrs/RequestBodyParamTest.kt
@@ -343,7 +343,8 @@ class RequestBodyParamTest {
           shapeIndex,
           typeRegistry,
           KotlinJAXRSGenerator.Options(
-            false,
+            coroutineFlowMethods = false,
+            coroutineServiceMethods = false,
             null,
             false,
             null,
@@ -400,7 +401,8 @@ class RequestBodyParamTest {
           shapeIndex,
           typeRegistry,
           KotlinJAXRSGenerator.Options(
-            false,
+            coroutineFlowMethods = false,
+            coroutineServiceMethods = false,
             null,
             false,
             null,
@@ -466,7 +468,8 @@ class RequestBodyParamTest {
           shapeIndex,
           typeRegistry,
           KotlinJAXRSGenerator.Options(
-            false,
+            coroutineFlowMethods = false,
+            coroutineServiceMethods = false,
             null,
             false,
             null,
@@ -531,7 +534,8 @@ class RequestBodyParamTest {
           shapeIndex,
           typeRegistry,
           KotlinJAXRSGenerator.Options(
-            false,
+            coroutineFlowMethods = false,
+            coroutineServiceMethods = false,
             null,
             false,
             null,
@@ -589,7 +593,8 @@ class RequestBodyParamTest {
           shapeIndex,
           typeRegistry,
           KotlinJAXRSGenerator.Options(
-            false,
+            coroutineFlowMethods = false,
+            coroutineServiceMethods = false,
             null,
             false,
             null,
@@ -646,7 +651,8 @@ class RequestBodyParamTest {
           shapeIndex,
           typeRegistry,
           KotlinJAXRSGenerator.Options(
-            false,
+            coroutineFlowMethods = false,
+            coroutineServiceMethods = false,
             null,
             false,
             null,