Skip to content

AN-796 Fix Swagger UI 500 errors #7822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

AN-796 Fix Swagger UI 500 errors #7822

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
660e41a
Fix Swagger UI index.html 304 Not Modified response causing 500 error…
djken2009 Nov 8, 2025
4adb5b2
Merge branch 'develop' into fix-swagger-304-response-issue-7763
LizBaldo Dec 4, 2025
4e08e7e
Merge branch 'develop' into fix-swagger-304-response-issue-7763
LizBaldo Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions engine/src/main/scala/cromwell/webservice/SwaggerUiHttpService.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package cromwell.webservice

import akka.http.scaladsl.model.{HttpResponse, StatusCodes}
import akka.http.scaladsl.model.{HttpEntity, HttpResponse, StatusCodes}
import akka.http.scaladsl.server
import akka.http.scaladsl.server.Directives._
import akka.http.scaladsl.server.Route
Expand All @@ -23,14 +23,23 @@ trait SwaggerUiHttpService {
| operationsSorter: "alpha"
""".stripMargin

mapResponseEntity { entityFromJar =>
entityFromJar.transformDataBytes(Flow.fromFunction[ByteString, ByteString] { original: ByteString =>
ByteString(
original.utf8String
.replace("""url: "https://petstore.swagger.io/v2/swagger.json"""", "url: 'cromwell.yaml'")
.replace("""layout: "StandaloneLayout"""", s"""layout: "StandaloneLayout", $swaggerOptions""")
)
})
// Fix Issue #7763: Must intercept 304 BEFORE mapResponseEntity tries to transform it
mapResponse { response =>
if (response.status == StatusCodes.NotModified) {
// For 304, return immediately with empty entity, don't try to transform
response.withEntity(HttpEntity.Empty)
} else {
// For 200, transform the entity content
response.mapEntity { entityFromJar =>
entityFromJar.transformDataBytes(Flow.fromFunction[ByteString, ByteString] { original: ByteString =>
ByteString(
original.utf8String
.replace("""url: "https://petstore.swagger.io/v2/swagger.json"""", "url: 'cromwell.yaml'")
.replace("""layout: "StandaloneLayout"""", s"""layout: "StandaloneLayout", $swaggerOptions""")
)
})
}
}
} {
getFromResource(s"$resourceDirectory/index.html")
}
Expand Down