Return 410 Gone response to inactive senders in pipeline (#18748)

* Return 410 Gone response to inactive senders in pipeline

* Moved sender checking to the processRequest function

* Added allowed senders to the list

* Added more test senders to the comment

* Added check the sender.customerStatus inactive

* Added Unit Test

* Made message short and simple

* Update the message

Author: oslynn

prime-router/src/main/kotlin/azure/HttpUtilities.kt

@@ -210,6 +210,19 @@ class HttpUtilities {
             return httpResponse(request, msg, status)
         }
 
+        /**
+         * convenience method that combines logging, and generation of an HtttpResponse
+         * the requested resourece is permanently unavailable and will not be available again in the future.
+         */
+        fun gone(
+            request: HttpRequestMessage<String?>,
+            msg: String,
+            status: HttpStatus = HttpStatus.GONE,
+        ): HttpResponseMessage {
+            logger.error(msg)
+            return httpResponse(request, msg, status)
+        }
+
         /**
          * Do a variety of checks on payload size.
          * Returns a Pair (http error code, human readable error message)

prime-router/src/main/kotlin/azure/ReportFunction.kt

@@ -533,6 +533,18 @@ class ReportFunction(
         request: HttpRequestMessage<String?>,
         sender: Sender,
     ): HttpResponseMessage {
+        // Allow only CVS.default sender to pass through and deactivate all other senders.
+        // We also allow sender organizations of igore and test to pass since they are using for smoketest for RS.
+        if (!listOf("test", "ignore", "waters").contains(sender.organizationName) &&
+            sender.customerStatus == CustomerStatus.INACTIVE
+        ) {
+            return HttpUtilities.gone(
+                request,
+                "ReportStream sunsetted on December 31, 2025. For more detail, please refer to " +
+                        "https://reportstream.cdc.gov."
+            )
+        }
+
         // determine if we should be following the sync or async workflow
         val isAsync = processingType(request, sender) == ProcessingType.async
         // allow duplicates 'override' param

prime-router/src/test/kotlin/azure/ReportFunctionTests.kt

@@ -252,7 +252,7 @@ class ReportFunctionTests {
     }
 
     /** Do all the setup required to be able to run any process request tests**/
-    private fun setupForProcessRequestTests(actionHistory: ActionHistory):
+    private fun setupForProcessRequestTests(actionHistory: ActionHistory, senderOrg: String = "test"):
         Triple<ReportFunction, MockHttpRequestMessage, Sender> {
         val metadata = UnitTestUtils.simpleMetadata
         val settings = FileSettings().loadOrganizations(oneOrganization)
@@ -261,7 +261,7 @@ class ReportFunctionTests {
         val reportFunc = spyk(ReportFunction(engine, actionHistory))
         val sender = CovidSender(
             "Test Sender",
-            "test",
+            senderOrg,
             MimeFormat.CSV,
             schemaName =
             "one",
@@ -855,6 +855,21 @@ class ReportFunctionTests {
         verify(exactly = 0) { actionHistory.trackLogs(any<ActionLog>()) }
     }
 
+    @Test
+    fun `test processRequest should return HttpStatus GONE`() {
+        // setup steps
+        val actionHistory = spyk(ActionHistory(TaskAction.receive))
+        var (reportFunc, req, sender) = setupForProcessRequestTests(actionHistory, "senderInactive")
+        req.queryParameters["option"] = "ValidatePayload"
+
+        // Call the processRequest
+        var resp = reportFunc.processRequest(req, sender)
+
+        // Report Validated and no warnings returned
+        assert(resp.status.equals(HttpStatus.GONE))
+        verify(exactly = 0) { actionHistory.trackLogs(any<ActionLog>()) }
+    }
+
     @Test
     fun `test throws an error for an invalid payloadname`() {
         // 2052 character
@@ -1450,7 +1465,7 @@ class ReportFunctionTests {
 
         val sender = UniversalPipelineSender(
             name = "Test Sender",
-            organizationName = "org",
+            organizationName = "test",
             format = MimeFormat.HL7,
             hl7AcknowledgementEnabled = true,
             topic = Topic.FULL_ELR,