ITSASU-3206: Create delete all session backend route

app/controllers/SessionDataController.scala

@@ -67,4 +67,10 @@ class SessionDataController @Inject()(authService: AuthService,
       ).map(_ => Ok)
     }
   }
+
+  def deleteAllSessionData(): Action[AnyContent] = Action.async { implicit request =>
+    authService.authorised() {
+      sessionDataService.deleteAllSessionData.map(_ => Ok)
+    }
+  }
 }

app/repositories/SessionDataRepository.scala

@@ -101,14 +101,22 @@ class SessionDataRepository @Inject()(config: SessionDataRepositoryConfig)(impli
     findAndUpdate(selector, update)
   }
 
-
   private def findAndUpdate(selector: JsObject, update: JsObject, fetchNewObject: Boolean = false, upsert: Boolean = false) = {
     collection
       .findOneAndUpdate(selector, update, findOneAndUpdateOptions(upsert))
       .toFuture()
       .map(asOption)
   }
 
+  def deleteDataBySessionId(sessionId: String): Future[Option[JsValue]] = {
+    val selector: JsObject = Json.obj("session-id" -> sessionId)
+    findAndDelete(selector)
+  }
+  private def findAndDelete(selector: JsObject): Future[Option[JsValue]] = {
+    collection.findOneAndDelete(selector)
+      .toFutureOption()
+  }
+
   def insert(document: JsObject): Future[InsertOneResult] = {
     collection
       .insertOne(document)

app/services/SessionDataService.scala

@@ -48,6 +48,10 @@ class SessionDataService @Inject()(sessionDataRepository: SessionDataRepository,
       dataId = dataId
     )
 
+  def deleteAllSessionData(implicit hc: HeaderCarrier): Future[Option[JsValue]] =
+    sessionDataRepository.deleteDataBySessionId(sessionId = sessionIdFromHC)
+
+
   private[services] def sessionIdFromHC(implicit hc: HeaderCarrier): String = {
     hc.sessionId.fold(
       throw new InternalServerException("[SessionDataService][sessionIdFromHC] - No session id in header carrier")

conf/subscription.routes

@@ -18,6 +18,7 @@ GET         /session-data/all                        controllers.SessionDataCont
 GET         /session-data/id/:id                     controllers.SessionDataController.retrieveSessionData(id: String)
 POST        /session-data/id/:id                     controllers.SessionDataController.insertSessionData(id: String)
 DELETE      /session-data/id/:id                     controllers.SessionDataController.deleteSessionData(id: String)
+DELETE      /session-data/id                         controllers.SessionDataController.deleteAllSessionData
 
 POST        /mis/sign-up/:nino/:taxYear                 controllers.#Controller.#(nino: String, taxYear: String)
 

it/test/controllers/SessionDataControllerISpec.scala

@@ -177,4 +177,14 @@ class SessionDataControllerISpec extends ComponentSpecBase with FeatureSwitching
       }
     }
   }
+
+  s"DELETE ${controllers.routes.SessionDataController.deleteAllSessionData.url}" should {
+    "return OK and remove the entire document related to the user in mongo" when {
+      "the sessionId exists in mongo for the user" in {
+        AuthStub.stubAuthSuccess()
+        await(repository.insert(testDocumentAll))
+        IncomeTaxSubscription.deleteAllSessionData should have(httpStatus(OK))
+      }
+    }
+  }
 }

it/test/helpers/ComponentSpecBase.scala

@@ -159,6 +159,9 @@ trait ComponentSpecBase extends AnyWordSpecLike
     def deleteSessionData(id:String): WSResponse =
       authorisedClient(s"/session-data/id/$id").delete().futureValue
 
+    def deleteAllSessionData(): WSResponse =
+      authorisedClient(s"/session-data/id").delete().futureValue
+
     def insertSessionData(id:String, body: JsObject): WSResponse =
       authorisedClient(s"/session-data/id/$id", "Content-Type" -> "application/json").post(body.toString()).futureValue
 

it/test/repositories/SessionDataRepositorySpec.scala

@@ -18,6 +18,7 @@ package repositories
 
 import helpers.IntegrationTestConstants.testArn
 import org.scalatest.concurrent.ScalaFutures.convertScalaFuture
+import org.scalatest.matchers.must.Matchers.convertToAnyMustWrapper
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpecLike
 import org.scalatest.{BeforeAndAfterEach, OptionValues}
@@ -154,6 +155,26 @@ class SessionDataRepositorySpec extends AnyWordSpecLike with Matchers with Optio
       }
     }
 
+    "deleteDataBySessionId" when {
+      "the document was found" should {
+        "delete the entire document" in new Setup(testDocument()) {
+          testSessionDataRepository.deleteDataBySessionId(testSessionId).futureValue.map(_ \ "session-id").flatMap(_.asOpt[String]) shouldBe Some(testSessionId)
+
+          val optionalData: Option[JsValue] = testSessionDataRepository.getSessionData(testSessionId).futureValue
+          optionalData shouldBe None
+        }
+      }
+
+      "the document is not found" should {
+        "return no document" in new Setup(testDocument("testSessionIdTwo")) {
+          testSessionDataRepository.deleteDataBySessionId(testSessionId).futureValue shouldBe None
+
+          val optionalData: Option[JsValue] = testSessionDataRepository.getSessionData("testSessionIdTwo").futureValue
+          optionalData.isDefined shouldBe true
+        }
+      }
+    }
+
     "the document is not found" should {
       "return no document" in new Setup(testDocument()) {
         testSessionDataRepository.deleteDataWithSession(testSessionId + "-2", "testDataIdOne").futureValue shouldBe None

test/services/SessionDataServiceSpec.scala

@@ -110,4 +110,19 @@ class SessionDataServiceSpec extends CommonSpec with MockitoSugar with FeatureSw
     }
   }
 
+  "deleteAllSessionData" should {
+    "delete session using sessionId" in new Setup {
+
+      when(mockSessionDataRepository.deleteDataBySessionId(ArgumentMatchers.eq(testSessionId)))
+        .thenReturn(Future.successful(Some(testJson)))
+
+      await(service.deleteAllSessionData(headerCarrier)) shouldBe Some(testJson)
+    }
+    "throw an internal server exception when no session id exists" in new Setup {
+      intercept[InternalServerException](
+        await(service.deleteAllSessionData(headerCarrierWithOutSessionId))
+      ).message shouldBe errorMessage
+    }
+  }
+
 }