[rust-axum] fix: support range response status codes (4XX, 5XX)

bin/configs/manual/rust-axum-range-responses.yaml

@@ -0,0 +1,12 @@
+generatorName: rust-axum
+outputDir: samples/server/petstore/rust-axum/output/rust-axum-range-responses
+inputSpec: modules/openapi-generator/src/test/resources/3_0/rust-axum/rust-axum-range-responses.yaml
+templateDir: modules/openapi-generator/src/main/resources/rust-axum
+generateAliasAsModel: true
+additionalProperties:
+  hideGenerationTimestamp: "true"
+  packageName: rust-axum-range-responses-test
+  homePageUrl: https://github.com/openapitools/openapi-generator
+globalProperties:
+  skipFormModel: false
+enablePostProcessFile: true

modules/openapi-generator/src/main/resources/rust-axum/response.mustache

@@ -15,6 +15,43 @@ pub enum {{{operationId}}}Response {
     {{#vendorExtensions}}
     {{{x-response-id}}}
     {{/vendorExtensions}}
+    {{#range}}
+    {
+        status: u16,
+      {{#dataType}}
+        {{#vendorExtensions}}
+          {{#x-produces-sse}}
+        body: models::SSE,
+          {{/x-produces-sse}}
+          {{#x-produces-plain-text}}
+        body: String,
+          {{/x-produces-plain-text}}
+          {{#x-produces-bytes}}
+        body: ByteArray,
+          {{/x-produces-bytes}}
+          {{^x-produces-sse}}
+          {{^x-produces-plain-text}}
+          {{^x-produces-bytes}}
+        body: {{{dataType}}},
+          {{/x-produces-bytes}}
+          {{/x-produces-plain-text}}
+          {{/x-produces-sse}}
+        {{/vendorExtensions}}
+      {{/dataType}}
+      {{#headers}}
+        {{{name}}}:
+        {{^required}}
+        Option<
+        {{/required}}
+        {{{dataType}}}
+        {{^required}}
+        >
+        {{/required}}
+        ,
+      {{/headers}}
+    }
+    {{/range}}
+    {{^range}}
     {{^dataType}}
       {{#hasHeaders}}
     {
@@ -90,6 +127,7 @@ pub enum {{{operationId}}}Response {
     }
       {{/-last}}
     {{/headers}}
+    {{/range}}
     {{^-last}}
     ,
     {{/-last}}

modules/openapi-generator/src/main/resources/rust-axum/server-operation.mustache

@@ -288,6 +288,18 @@ where
                                             Ok(rsp) => match rsp {
 {{#responses}}
                                                 apis::{{classFilename}}::{{{operationId}}}Response::{{#vendorExtensions}}{{x-response-id}}{{/vendorExtensions}}
+{{#range}}
+                                                    {
+                                                        status,
+{{#dataType}}
+                                                        body,
+{{/dataType}}
+{{#headers}}
+                                                        {{{name}}},
+{{/headers}}
+                                                    }
+{{/range}}
+{{^range}}
 {{#dataType}}
 {{^headers}}
                                                     ({{#isDefault}}status, {{/isDefault}}body)
@@ -325,6 +337,7 @@ where
 {{/-last}}
 {{/headers}}
 {{/dataType}}
+{{/range}}
                                                 => {
 {{#vendorExtensions}}
 {{#x-produces-sse}}
@@ -337,7 +350,15 @@ where
                 })?;
 {{/isDefault}}
                 let (mut parts, body) = axum::response::Sse::new(body).into_response().into_parts();
+{{#range}}
+                parts.status = StatusCode::from_u16(status).map_err(|e| {
+                    error!(error = ?e);
+                    StatusCode::INTERNAL_SERVER_ERROR
+                })?;
+{{/range}}
+{{^range}}
                 parts.status = {{#isDefault}}status{{/isDefault}}{{^isDefault}}{{{code}}}.try_into().unwrap_or_default(){{/isDefault}};
+{{/range}}
 
                 {{#headers}}
                 {{^required}}if let Some({{{name}}}) = {{{name}}}{{/required}} {
@@ -380,7 +401,11 @@ where
                     }
                 {{/headers}}
 {{#range}}
-                                                  response.status::<u16>(body.code.parse().unwrap());  // {{{code}}}
+                                                  let status = StatusCode::from_u16(status).map_err(|e| {
+                                                    error!(error = ?e);
+                                                    StatusCode::INTERNAL_SERVER_ERROR
+                                                  })?;
+                                                  let mut response = response.status(status);
 {{/range}}
 {{^range}}
 {{#isDefault}}

modules/openapi-generator/src/test/java/org/openapitools/codegen/rust/RustAxumServerCodegenTest.java

@@ -271,4 +271,37 @@ public void testRecursiveModelFieldsAreNotBoxedByDefault() throws IOException {
         TestUtils.assertFileContains(modelsPath, "pub manager: Nullable<models::Employee>,");
         TestUtils.assertFileNotContains(modelsPath, "Box<models::");
     }
+
+    @Test
+    public void testRangeResponseCodes() throws IOException {
+        Path target = Files.createTempDirectory("test");
+        final CodegenConfigurator configurator = new CodegenConfigurator()
+                .setGeneratorName("rust-axum")
+                .setInputSpec("src/test/resources/3_0/rust-axum/rust-axum-range-responses.yaml")
+                .setSkipOverwrite(false)
+                .setOutputDir(target.toAbsolutePath().toString().replace("\\", "/"));
+        List<File> files = new DefaultGenerator().opts(configurator.toClientOptInput()).generate();
+        files.forEach(File::deleteOnExit);
+
+        // Range responses carry the concrete status code chosen by the implementation
+        Path apiPath = Path.of(target.toString(), "/src/apis/default.rs");
+        TestUtils.assertFileExists(apiPath);
+        TestUtils.assertFileContains(apiPath, "Status200_ThePet (models::Pet)");
+        TestUtils.assertFileContains(apiPath, "Status4XX_ClientError { status: u16, body: models::Error, }");
+        TestUtils.assertFileContains(apiPath, "Status5XX_ServerError { status: u16, retry_after: Option<");
+        TestUtils.assertFileContains(apiPath, "Status4XX_ClientError { status: u16, }");
+        TestUtils.assertFileContains(apiPath, "Status5XX_ServerError { status: u16, body: models::Error, x_request_id:");
+
+        Path serverPath = Path.of(target.toString(), "/src/server/mod.rs");
+        TestUtils.assertFileExists(serverPath);
+        TestUtils.assertFileContains(serverPath, "GetPetResponse::Status4XX_ClientError { status, body, } =>");
+        TestUtils.assertFileContains(serverPath, "DeletePetResponse::Status5XX_ServerError { status, body, x_request_id, } =>");
+        TestUtils.assertFileContains(serverPath, "let mut response = response.status(status);");
+        // An out-of-range status is rejected before it reaches the response builder
+        TestUtils.assertFileContains(serverPath, "let status = StatusCode::from_u16(status).map_err(");
+        TestUtils.assertFileContains(serverPath, "GetPetEventsResponse::Status2XX_PetEvents { status, body, x_stream_id, } =>");
+        TestUtils.assertFileContains(serverPath, "parts.status = StatusCode::from_u16(status).map_err(");
+        TestUtils.assertFileNotContains(serverPath, "parts.status = status.try_into()");
+        TestUtils.assertFileNotContains(serverPath, "body.code.parse()");
+    }
 }

modules/openapi-generator/src/test/resources/3_0/rust-axum/rust-axum-range-responses.yaml

@@ -0,0 +1,99 @@
+openapi: 3.0.3
+info:
+  title: Rust Axum Range Response Codes Test
+  version: 1.0.0
+paths:
+  /pets/{petId}:
+    get:
+      operationId: getPet
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          schema:
+            type: integer
+            format: int64
+      responses:
+        "200":
+          description: The pet
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pet"
+        "4XX":
+          description: Client error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        "5XX":
+          description: Server error
+          headers:
+            Retry-After:
+              schema:
+                type: integer
+                format: int32
+    delete:
+      operationId: deletePet
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          schema:
+            type: integer
+            format: int64
+      responses:
+        "204":
+          description: Deleted
+        "4XX":
+          description: Client error
+        "5XX":
+          description: Server error
+          headers:
+            X-Request-Id:
+              required: true
+              schema:
+                type: string
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /pets/events:
+    get:
+      operationId: getPetEvents
+      responses:
+        "2XX":
+          description: Pet events
+          headers:
+            X-Stream-Id:
+              schema:
+                type: string
+          content:
+            text/event-stream:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: string
+        "5XX":
+          description: Server error
+components:
+  schemas:
+    Pet:
+      type: object
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+    Error:
+      type: object
+      required:
+        - message
+      properties:
+        message:
+          type: string

samples/server/petstore/rust-axum/output/rust-axum-range-responses/.gitignore

@@ -0,0 +1,2 @@
+target
+Cargo.lock

samples/server/petstore/rust-axum/output/rust-axum-range-responses/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

samples/server/petstore/rust-axum/output/rust-axum-range-responses/.openapi-generator/FILES

@@ -0,0 +1,10 @@
+.gitignore
+Cargo.toml
+README.md
+src/apis/default.rs
+src/apis/mod.rs
+src/header.rs
+src/lib.rs
+src/models.rs
+src/server/mod.rs
+src/types.rs

samples/server/petstore/rust-axum/output/rust-axum-range-responses/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.27.0-SNAPSHOT

samples/server/petstore/rust-axum/output/rust-axum-range-responses/Cargo.toml

@@ -0,0 +1,66 @@
+[package]
+name = "rust-axum-range-responses-test"
+version = "1.0.0"
+authors = ["OpenAPI Generator team and contributors"]
+description = "No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)"
+edition = "2024"
+homepage = "https://github.com/openapitools/openapi-generator"
+
+[features]
+default = ["server"]
+server = [
+    "ammonia",
+    "async-trait",
+    "axum",
+    "axum-extra",
+    "bytes",
+    "futures-util",
+    "headers",
+    "http",
+    "serde_html_form",
+    "tokio",
+    "tracing",
+]
+conversion = [
+    "frunk",
+    "frunk_derives",
+    "frunk_core",
+    "frunk-enum-core",
+    "frunk-enum-derive",
+]
+
+[dependencies]
+ammonia = { version = "4", optional = true }
+async-trait = { version = "0.1", optional = true }
+axum = { version = "0.8", features = ["multipart"], optional = true }
+axum-extra = { version = "0.12", features = [
+  "cookie",
+  "query",
+  "typed-header",
+], optional = true }
+base64 = "0.22"
+bytes = { version = "1", optional = true }
+chrono = { version = "0.4", features = ["serde"] }
+frunk = { version = "0.4", optional = true }
+frunk-enum-core = { version = "0.3", optional = true }
+frunk-enum-derive = { version = "0.3", optional = true }
+frunk_core = { version = "0.4", optional = true }
+frunk_derives = { version = "0.4", optional = true }
+futures-util = { version = "0.3", optional = true }
+headers = { version = "0.4", optional = true }
+http = { version = "1", optional = true }
+lazy_static = "1"
+regex = "1"
+serde = { version = "1", features = ["derive"] }
+serde_html_form = { version = "0.2", optional = true }
+serde_json = { version = "1", features = ["raw_value"] }
+tokio = { version = "1", default-features = false, features = [
+    "signal",
+    "rt-multi-thread",
+], optional = true }
+tracing = { version = "0.1", features = ["attributes"], optional = true }
+uuid = { version = "1", features = ["serde"] }
+validator = { version = "0.20", features = ["derive"] }
+
+[dev-dependencies]
+tracing-subscriber = "0.3"