Propagate isHttpGetRequest via GraphQLRequest param instead

ghostdogpr · Jul 9, 2024 · 66584cf · 66584cf
1 parent df9145c
commit 66584cf
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 45 deletions.
diff --git a/adapters/quick/src/main/scala/caliban/QuickRequestHandler.scala b/adapters/quick/src/main/scala/caliban/QuickRequestHandler.scala
@@ -169,7 +169,7 @@ final private class QuickRequestHandler[R](
   private def executeRequest(method: Method, req: GraphQLRequest)(implicit
     trace: Trace
   ): ZIO[R, Response, GraphQLResponse[Any]] =
-    interpreter.executeRequest(HttpRequestMethod.updateRequest(method == Method.GET)(req))
+    interpreter.executeRequest(if (method == Method.GET) req.asHttpGetRequest else req)
 
   private def responseHeaders(headers: Headers, cacheDirective: Option[String]): Headers =
     cacheDirective match {
@@ -202,7 +202,7 @@ final private class QuickRequestHandler[R](
             encodeSingleResponse(resp, keepDataOnErrors = !isBadRequest, hasCacheDirective = cacheDirective.isDefined)
         )
       case resp                                                 =>
-        val isBadRequest = resp.errors.contains(HttpRequestMethod.MutationOverGetError)
+        val isBadRequest = resp.errors.contains(HttpUtils.MutationOverGetError)
         Response(
           status = if (isBadRequest) Status.BadRequest else Status.Ok,
           headers = responseHeaders(ContentTypeJson, cacheDirective),

diff --git a/build.sbt b/build.sbt
@@ -742,7 +742,10 @@ lazy val enableMimaSettingsJVM =
   Def.settings(
     mimaFailOnProblem      := enforceMimaCompatibility,
     mimaPreviousArtifacts  := previousStableVersion.value.map(organization.value %% moduleName.value % _).toSet,
-    mimaBinaryIssueFilters := Seq()
+    mimaBinaryIssueFilters := Seq(
+      ProblemFilters.exclude[DirectMissingMethodProblem]("caliban.GraphQLRequest.*"),
+      ProblemFilters.exclude[Problem]("caliban.HttpRequestMethod*")
+    )
   )
 
 lazy val enableMimaSettingsJS =

diff --git a/core/src/main/scala/caliban/GraphQL.scala b/core/src/main/scala/caliban/GraphQL.scala
@@ -189,8 +189,8 @@ trait GraphQL[-R] { self =>
           if (
             req.operationType == OperationType.Mutation &&
             !cfg.allowMutationsOverGetRequests &&
-            HttpRequestMethod.isGetRequest(gqlReq)
-          ) Exit.fail(HttpRequestMethod.MutationOverGetError)
+            gqlReq.isHttpGetRequest
+          ) Exit.fail(HttpUtils.MutationOverGetError)
           else Exit.succeed(req)
       }
     }

diff --git a/core/src/main/scala/caliban/GraphQLRequest.scala b/core/src/main/scala/caliban/GraphQLRequest.scala
@@ -15,7 +15,8 @@ case class GraphQLRequest(
   query: Option[String] = None,
   operationName: Option[String] = None,
   variables: Option[Map[String, InputValue]] = None,
-  extensions: Option[Map[String, InputValue]] = None
+  extensions: Option[Map[String, InputValue]] = None,
+  isHttpGetRequest: Boolean = false
 ) { self =>
 
   def withExtension(key: String, value: InputValue): GraphQLRequest =
@@ -24,9 +25,11 @@ case class GraphQLRequest(
   def withFederatedTracing: GraphQLRequest =
     withExtension(`apollo-federation-include-trace`, StringValue(ftv1))
 
+  private[caliban] def asHttpGetRequest: GraphQLRequest =
+    new GraphQLRequest(query, operationName, variables, extensions, isHttpGetRequest = true)
+
   private[caliban] def isEmpty: Boolean =
     operationName.isEmpty && query.isEmpty && extensions.isEmpty
-
 }
 
 object GraphQLRequest {

diff --git a/core/src/main/scala/caliban/HttpRequestMethod.scala b/core/src/main/scala/caliban/HttpRequestMethod.scala
diff --git a/core/src/main/scala/caliban/HttpUtils.scala b/core/src/main/scala/caliban/HttpUtils.scala
@@ -1,5 +1,6 @@
 package caliban
 
+import caliban.CalibanError.ValidationError
 import caliban.ResponseValue.{ ObjectValue, StreamValue }
 import caliban.Value.NullValue
 import caliban.wrappers.Caching
@@ -8,6 +9,9 @@ import zio.{ Cause, Chunk, Trace }
 
 private[caliban] object HttpUtils {
 
+  val MutationOverGetError: ValidationError =
+    ValidationError("Mutations are not allowed for GET requests", "")
+
   object DeferMultipart {
     private val Newline        = "\r\n"
     private val ContentType    = "Content-Type: application/json; charset=utf-8"

diff --git a/interop/tapir/src/main/scala/caliban/interop/tapir/HttpInterpreter.scala b/interop/tapir/src/main/scala/caliban/interop/tapir/HttpInterpreter.scala
@@ -77,7 +77,7 @@ object HttpInterpreter {
       graphQLRequest: GraphQLRequest,
       serverRequest: ServerRequest
     )(implicit streamConstructor: StreamConstructor[BS]): ZIO[R, TapirResponse, CalibanResponse[BS]] = {
-      val req = HttpRequestMethod.updateRequest(serverRequest.method == Method.GET)(graphQLRequest)
+      val req = if (serverRequest.method == Method.GET) graphQLRequest.asHttpGetRequest else graphQLRequest
       interpreter.executeRequest(req).map(buildHttpResponse[E, BS](serverRequest))
     }
   }

diff --git a/interop/tapir/src/main/scala/caliban/interop/tapir/TapirAdapter.scala b/interop/tapir/src/main/scala/caliban/interop/tapir/TapirAdapter.scala
@@ -140,7 +140,7 @@ object TapirAdapter {
           encodeTextEventStreamResponse(resp)
         )
       case resp                                                 =>
-        val isBadRequest = response.errors.contains(HttpRequestMethod.MutationOverGetError: Any)
+        val isBadRequest = response.errors.contains(HttpUtils.MutationOverGetError: Any)
         (
           MediaType.ApplicationJson,
           if (isBadRequest) StatusCode.BadRequest else StatusCode.Ok,