Merge pull request #53 from AndyHWChung/AIV-262-log-payload

AIV-262 - made logging userinfo response payload configurable

app/uk/gov/hmrc/openidconnect/userinfo/config/FeatureSwitch.scala

@@ -44,3 +44,9 @@ object UserInfoFeatureSwitches {
   def allSwitches: Seq[FeatureSwitch] = Seq(countryCode, addressLine5)
 
 }
+
+object LoggingSwitches {
+
+  lazy val logUserInfoResponsePayload: FeatureSwitch = FeatureSwitch.forName("log-userinfo-response-payload")
+
+}

app/uk/gov/hmrc/openidconnect/userinfo/controllers/UserInfoController.scala

@@ -32,9 +32,11 @@ package uk.gov.hmrc.openidconnect.userinfo.controllers
  * limitations under the License.
  */
 
+import play.api.Logger
 import play.api.libs.json.Json
 import uk.gov.hmrc.api.controllers.HeaderValidator
 import uk.gov.hmrc.http.{BadRequestException, Upstream4xxResponse, Upstream5xxResponse}
+import uk.gov.hmrc.openidconnect.userinfo.config.LoggingSwitches.logUserInfoResponsePayload
 import uk.gov.hmrc.openidconnect.userinfo.services.{LiveUserInfoService, SandboxUserInfoService, UserInfoService}
 import uk.gov.hmrc.play.microservice.controller.BaseController
 
@@ -43,9 +45,17 @@ import scala.concurrent.ExecutionContext.Implicits.global
 trait UserInfoController extends BaseController with HeaderValidator {
   val service: UserInfoService
 
+  val responseLogger = Logger("userinfo-response-payload-logger")
+
   final def userInfo() = validateAccept(acceptHeaderValidationRules).async { implicit request =>
     service.fetchUserInfo() map { userInfo =>
-      Ok(Json.toJson(userInfo))
+      val json = Json.toJson(userInfo)
+
+      if(logUserInfoResponsePayload.isEnabled){
+        responseLogger.debug(s"Returning userinfo payload: $json")
+      }
+
+      Ok(json)
     } recover {
       case Upstream4xxResponse(msg, 401, _, _) => Unauthorized(Json.toJson(ErrorUnauthorized()))
       case Upstream4xxResponse(msg4xx, _, _ , _) => BadGateway(Json.toJson(ErrorBadGateway(msg4xx)))

conf/logback.xml

@@ -49,6 +49,8 @@
 
     <logger name="application" level="DEBUG"/>
 
+    <logger name="userinfo-response-payload-logger" level="DEBUG"/>
+
     <logger name="connector" level="TRACE">
         <appender-ref ref="STDOUT"/>
     </logger>