Added deprecation to authInfo

http4s · Oct 30, 2019 · 96758df · 96758df
1 parent 3fd0129
commit 96758df
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 6 deletions.
diff --git a/core/src/main/scala/org/http4s/ContextRequest.scala b/core/src/main/scala/org/http4s/ContextRequest.scala
@@ -6,8 +6,9 @@ import cats.data.Kleisli
 
 final case class ContextRequest[F[_], A](context: A, req: Request[F]) {
   def mapK[G[_]](fk: F ~> G): ContextRequest[G, A] =
-    ContextRequest(authInfo, req.mapK(fk))
+    ContextRequest(context, req.mapK(fk))
 
+  @deprecated("Use context instead", "0.21.0")
   def authInfo: A = context
 
 }

diff --git a/docs/src/main/tut/auth.md b/docs/src/main/tut/auth.md
@@ -131,7 +131,7 @@ error handling, we recommend an error [ADT] instead of a `String`.
 ```tut:silent
 val authUser: Kleisli[IO, Request[IO], Either[String,User]] = Kleisli(_ => IO(???))
 
-val onFailure: AuthedRoutes[String, IO] = Kleisli(req => OptionT.liftF(Forbidden(req.authInfo)))
+val onFailure: AuthedRoutes[String, IO] = Kleisli(req => OptionT.liftF(Forbidden(req.context)))
 val middleware = AuthMiddleware(authUser, onFailure)
 
 val service: HttpRoutes[IO] = middleware(authedRoutes)

diff --git a/dsl/src/main/scala/org/http4s/dsl/impl/Auth.scala b/dsl/src/main/scala/org/http4s/dsl/impl/Auth.scala
@@ -5,6 +5,6 @@ import org.http4s.{AuthedRequest, Request}
 trait Auth {
   object as {
     def unapply[F[_], A](ar: AuthedRequest[F, A]): Option[(Request[F], A)] =
-      Some(ar.req -> ar.authInfo)
+      Some(ar.req -> ar.context)
   }
 }
diff --git a/server/src/test/scala/org/http4s/server/middleware/authentication/AuthMiddlewareSpec.scala b/server/src/test/scala/org/http4s/server/middleware/authentication/AuthMiddlewareSpec.scala
@@ -18,7 +18,7 @@ class AuthMiddlewareSpec extends Http4sSpec {
         Kleisli.pure(Left("Unauthorized"))
 
       val onAuthFailure: AuthedRoutes[String, IO] =
-        Kleisli(req => OptionT.liftF(Forbidden(req.authInfo)))
+        Kleisli(req => OptionT.liftF(Forbidden(req.context)))
 
       val authedRoutes: AuthedRoutes[User, IO] =
         AuthedRoutes.of {
@@ -41,7 +41,7 @@ class AuthMiddlewareSpec extends Http4sSpec {
         Kleisli.pure(Right(userId))
 
       val onAuthFailure: AuthedRoutes[String, IO] =
-        Kleisli(req => OptionT.liftF(Forbidden(req.authInfo)))
+        Kleisli(req => OptionT.liftF(Forbidden(req.context)))
 
       val authedRoutes: AuthedRoutes[User, IO] =
         AuthedRoutes.of {
@@ -63,7 +63,7 @@ class AuthMiddlewareSpec extends Http4sSpec {
         Kleisli.pure(Right(userId))
 
       val onAuthFailure: AuthedRoutes[String, IO] =
-        Kleisli(req => OptionT.liftF(Forbidden(req.authInfo)))
+        Kleisli(req => OptionT.liftF(Forbidden(req.context)))
 
       val authedRoutes: AuthedRoutes[User, IO] =
         AuthedRoutes.of {