chore: [PAGOPA-3449] Add Helpdesk API Legacy Redirect (#3554)

* [PAGOPA-3449] added generator helpdesk api to technical support product

* [PAGOPA-3449] fix api and  policy definition and added integration tests sub key

* [PAGOPA-3449] fix

* chore: rollback

* feat(pdf-helpdesk): Add redirect policy

* fix(pdf-helpdesk): Update hostname and add comments

* chore: Update OpenAPI version

* wip(receipts): Remove API and Product for receipts-service-api

* chore(receipts): Receipts API removal

- Remove policy and API migrated to the microservice infra
- Add useful script and file for resource import and state removal

* chore: UAT apply

- Remove alert from UAT
- Add resource for apply

* chore(receipts): Add apim_receipts_product module

* chore(receipts): Clean migration tools

* chore(receipts): Fix hostname and remove recover-failed APIs

* chore(receipts): Remove cart API from helpdesk openapi

---------

Co-authored-by: Angelo Caporaso <56113767+cap-ang@users.noreply.github.com>

Author: gioelemella

src/domains/receipts-app/00_alert.tf

@@ -1,7 +1,7 @@
 
 locals {
 
-  fn_name_for_alerts_exceptions = var.env_short == "d" ? [] : [
+  fn_name_for_alerts_exceptions = var.env_short != "p" ? [] : [
     {
       name : "BizEventToReceiptProcessor"
     }
@@ -58,7 +58,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-sending-receipt
 # BizEventToReceiptProcessor execution logs that a Receipt instance has been set to NOT_QUEUE_SENT
 # https://github.com/pagopa/pagopa-receipt-pdf-datastore/blob/1a0b36f9693c17ceeffe5d35bf7ace7371a72a13/src/main/java/it/gov/pagopa/receipt/pdf/datastore/service/BizEventToReceiptService.java#L58C17-L58C28
 resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-datastore-not-sent-to-queue-alert" {
-  count               = var.env_short != "d" ? 1 : 0
+  count               = var.env_short == "p" ? 1 : 0
   resource_group_name = "dashboards"
   name                = "pagopa-${var.env_short}-receiptsdatastore-not-sent-to-queue-alert"
   location            = var.location
@@ -92,7 +92,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-datastore-not-s
 # BizEventToReceiptProcessor receive a biz event related to a cart (totalNotice > 1)
 # https://github.com/pagopa/pagopa-receipt-pdf-datastore/blob/1a0b36f9693c17ceeffe5d35bf7ace7371a72a13/src/main/java/it/gov/pagopa/receipt/pdf/datastore/BizEventToReceipt.java#L160
 resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-cart-event-discarded-alert" {
-  count               = var.env_short != "d" ? 1 : 0
+  count               = var.env_short == "p" ? 1 : 0
   resource_group_name = "dashboards"
   name                = "pagopa-${var.env_short}-receipt-cart-event-discarded-alert"
   location            = var.location
@@ -130,7 +130,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-cart-event-disc
 # ManageReceiptPoisonQueueProcessor execution logs that a new entry has been set in error
 # https://github.com/pagopa/pagopa-receipt-pdf-generator/blob/6b6c600db4b13ad7cd4b64596ba29fd0f6c38e70/src/main/java/it/gov/pagopa/receipt/pdf/generator/ManageReceiptPoisonQueue.java#L105
 resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-in-error-alert" {
-  count               = var.env_short != "d" ? 1 : 0
+  count               = var.env_short == "p" ? 1 : 0
   resource_group_name = "dashboards"
   name                = "pagopa-${var.env_short}-receipt-in-error-alert"
   location            = var.location
@@ -164,7 +164,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-in-error-alert"
 # GenerateReceiptProcess execution logs that the receipt pdf cant be generated because there are missing property in biz-event
 # https://github.com/pagopa/pagopa-receipt-pdf-generator/blob/653edca00eee4fc3ecf65b60c91c9b20395e7df2/src/main/java/it/gov/pagopa/receipt/pdf/generator/service/impl/GenerateReceiptPdfServiceImpl.java#L165
 resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-missing-bizevent-property-alert" {
-  count               = var.env_short != "d" ? 1 : 0
+  count               = var.env_short == "p" ? 1 : 0
   resource_group_name = "dashboards"
   name                = "pagopa-${var.env_short}-missing-bizevent-property-alert"
   location            = var.location
@@ -198,7 +198,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-missing-bizeven
 # GenerateReceiptProcess execution logs that the pdf engine responded with KO
 # https://github.com/pagopa/pagopa-receipt-pdf-generator/blob/653edca00eee4fc3ecf65b60c91c9b20395e7df2/src/main/java/it/gov/pagopa/receipt/pdf/generator/service/impl/GenerateReceiptPdfServiceImpl.java#L165
 resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-pdf-engine-response-ko" {
-  count               = var.env_short != "d" ? 1 : 0
+  count               = var.env_short == "p" ? 1 : 0
   resource_group_name = "dashboards"
   name                = "pagopa-${var.env_short}-pdf-engine-response-ko"
   location            = var.location
@@ -232,7 +232,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-pdf-engine-resp
 # GenerateReceiptProcess execution logs that cannot save the PDF Receipt in blob storage
 # https://github.com/pagopa/pagopa-receipt-pdf-generator/blob/653edca00eee4fc3ecf65b60c91c9b20395e7df2/src/main/java/it/gov/pagopa/receipt/pdf/generator/service/impl/GenerateReceiptPdfServiceImpl.java#L165
 resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-pdf-save-to-blob-error" {
-  count               = var.env_short != "d" ? 1 : 0
+  count               = var.env_short == "p" ? 1 : 0
   resource_group_name = "dashboards"
   name                = "pagopa-${var.env_short}-pdf-save-to-blob-error"
   location            = var.location
@@ -266,7 +266,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-pdf-save-to-blo
 # PDVTokenizerServiceImpl execution logs that an error has been encountered on the PDV Tokenizer service
 # https://github.com/pagopa/pagopa-receipt-pdf-datatstore/blob/main/src/main/java/it/gov/pagopa/receipt/pdf/datastore/service/impl/PDVTokenizerServiceImpl.java#L80
 resource "azurerm_monitor_scheduled_query_rules_alert" "receipt-tokenizer-error-on-datastore-alert" {
-  count               = var.env_short != "d" ? 1 : 0
+  count               = var.env_short == "p" ? 1 : 0
   resource_group_name = "dashboards"
   name                = "pagopa-${var.env_short}-tokenizer-error-on-datastore"
   location            = var.location
@@ -305,7 +305,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "receipt-tokenizer-error-
 # NotifierRetry execution logs that a new entry has been set in error
 # https://github.com/pagopa/pagopa-receipt-pdf-notifier/blob/26067525b154796962168e661ee932d4e628f1be/src/main/java/it/gov/pagopa/receipt/pdf/notifier/NotifierRetry.java#L52
 resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-to-notify-in-retry-alert" {
-  count               = var.env_short != "d" ? 1 : 0
+  count               = var.env_short == "p" ? 1 : 0
   resource_group_name = "dashboards"
   name                = "pagopa-${var.env_short}-notify-in-error-retry"
   location            = var.location
@@ -340,7 +340,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "receipts-to-notify-in-re
 # ReceiptToIoService execution logs that a receipt could not be notified (due to maximum retries, or failing to send to message queue)
 # https://github.com/pagopa/pagopa-receipt-pdf-notifier/blob/26067525b154796962168e661ee932d4e628f1be/src/main/java/it/gov/pagopa/receipt/pdf/notifier/service/impl/ReceiptToIOServiceImpl.java#L333
 resource "azurerm_monitor_scheduled_query_rules_alert" "receipt-unable-to-notify-alert" {
-  count               = var.env_short != "d" ? 1 : 0
+  count               = var.env_short == "p" ? 1 : 0
   resource_group_name = "dashboards"
   name                = "pagopa-${var.env_short}-unable-to-send-notify"
   location            = var.location
@@ -374,7 +374,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "receipt-unable-to-notify
 # PDVTokenizerServiceImpl execution logs that an error using the PDV Tokenizer error has been encountered
 # https://github.com/pagopa/pagopa-receipt-pdf-notifier/blob/26067525b154796962168e661ee932d4e628f1be/src/main/java/it/gov/pagopa/receipt/pdf/notifier/service/impl/PDVTokenizerServiceImpl.java#L89
 resource "azurerm_monitor_scheduled_query_rules_alert" "receipt-tokenizer-error-on-notify-alert" {
-  count               = var.env_short != "d" ? 1 : 0
+  count               = var.env_short == "p" ? 1 : 0
   resource_group_name = "dashboards"
   name                = "pagopa-${var.env_short}-tokenizer-error-on-notify"
   location            = var.location
@@ -413,7 +413,7 @@ resource "azurerm_monitor_scheduled_query_rules_alert" "receipt-tokenizer-error-
 # AttachmentService execution logs that an error has been encountered on the PDV Tokenizer service
 # https://github.com/pagopa/pagopa-receipt-pdf-service/blob/main/src/main/java/it/gov/pagopa/receipt/pdf/service/service/impl/AttachmentServiceImpl.java#L96
 resource "azurerm_monitor_scheduled_query_rules_alert" "receipt-tokenizer-error-on-service-alert" {
-  count               = var.env_short != "d" ? 1 : 0
+  count               = var.env_short == "p" ? 1 : 0
   resource_group_name = "dashboards"
   name                = "pagopa-${var.env_short}-tokenizer-error-on-service"
   location            = var.location

src/domains/receipts-app/04_apim_receipts.tf

@@ -17,21 +17,13 @@ module "apim_receipts_product" {
   approval_required     = true
   subscriptions_limit   = 1000
 
-  policy_xml = file("./api_product/receipt-service/_base_policy.xml")
+  policy_xml = file("./api_product/_base_policy.xml")
 }
 
-#################
+########################
 ##    API Biz Events  ##
-#################
+########################
 locals {
-  apim_receipts_service_api = {
-    display_name          = "Receipts Service PDF"
-    description           = "API to handle receipts"
-    path                  = "receipts/service"
-    subscription_required = true
-    service_url           = null
-  }
-
   apim_receipts_helpdesk_api = {
     display_name          = "Receipts Helpdesk PDF"
     description           = "API to handle receipts helpdesk"
@@ -41,43 +33,6 @@ locals {
   }
 }
 
-resource "azurerm_api_management_api_version_set" "api_receipts_api" {
-
-  name                = format("%s-receipts-service-api", var.env_short)
-  resource_group_name = local.pagopa_apim_rg
-  api_management_name = local.pagopa_apim_name
-  display_name        = local.apim_receipts_service_api.display_name
-  versioning_scheme   = "Segment"
-}
-
-
-module "apim_api_receipts_api_v1" {
-  source = "./.terraform/modules/__v3__/api_management_api"
-
-  name                  = format("%s-receipts-service-api", local.project)
-  api_management_name   = local.pagopa_apim_name
-  resource_group_name   = local.pagopa_apim_rg
-  product_ids           = [module.apim_receipts_product.product_id]
-  subscription_required = local.apim_receipts_service_api.subscription_required
-  version_set_id        = azurerm_api_management_api_version_set.api_receipts_api.id
-  api_version           = "v1"
-
-  description  = local.apim_receipts_service_api.description
-  display_name = local.apim_receipts_service_api.display_name
-  path         = local.apim_receipts_service_api.path
-  protocols    = ["https"]
-  service_url  = local.apim_receipts_service_api.service_url
-
-  content_format = "openapi"
-  content_value = templatefile("./api/receipt-service/v1/_openapi.json.tpl", {
-    host = local.apim_hostname
-  })
-
-  xml_content = templatefile("./api/receipt-service/v1/_base_policy.xml", {
-    hostname = local.receipts_hostname
-  })
-}
-
 resource "azurerm_api_management_api_version_set" "api_receipts_helpdesk_api" {
 
   name                = format("%s-receipts-helpdesk-service-api", var.env_short)
@@ -87,14 +42,16 @@ resource "azurerm_api_management_api_version_set" "api_receipts_helpdesk_api" {
   versioning_scheme   = "Segment"
 }
 
-
+/*
+ @Deprecated
+ */
 module "apim_api_receipts_helpdesk_api_v1" {
   source = "./.terraform/modules/__v3__/api_management_api"
 
   name                  = format("%s-receipts-helpdesk-api", local.project)
   api_management_name   = local.pagopa_apim_name
   resource_group_name   = local.pagopa_apim_rg
-  product_ids           = [module.apim_receipts_product.product_id, "technical_support_api"]
+  product_ids           = ["technical_support_api"]
   subscription_required = local.apim_receipts_helpdesk_api.subscription_required
   version_set_id        = azurerm_api_management_api_version_set.api_receipts_helpdesk_api.id
   api_version           = "v1"
@@ -111,6 +68,6 @@ module "apim_api_receipts_helpdesk_api_v1" {
   })
 
   xml_content = templatefile("./api/receipt-helpdesk/v1/_base_policy.xml", {
-    hostname = local.receipts_hostname
+    hostname = "https://${local.receipts_hostname}"
   })
-}
+}

src/domains/receipts-app/README.md

@@ -17,7 +17,6 @@
 | Name | Source | Version |
 |------|--------|---------|
 | <a name="module___v3__"></a> [\_\_v3\_\_](#module\_\_\_v3\_\_) | git::https://github.com/pagopa/terraform-azurerm-v3 | d0a0b3a81963169bdc974f79eba31e41e918e63d |
-| <a name="module_apim_api_receipts_api_v1"></a> [apim\_api\_receipts\_api\_v1](#module\_apim\_api\_receipts\_api\_v1) | ./.terraform/modules/__v3__/api_management_api | n/a |
 | <a name="module_apim_api_receipts_helpdesk_api_v1"></a> [apim\_api\_receipts\_helpdesk\_api\_v1](#module\_apim\_api\_receipts\_helpdesk\_api\_v1) | ./.terraform/modules/__v3__/api_management_api | n/a |
 | <a name="module_apim_receipts_product"></a> [apim\_receipts\_product](#module\_apim\_receipts\_product) | ./.terraform/modules/__v3__/api_management_product | n/a |
 | <a name="module_cert_mounter"></a> [cert\_mounter](#module\_cert\_mounter) | ./.terraform/modules/__v3__/cert_mounter | n/a |
@@ -31,7 +30,6 @@
 
 | Name | Type |
 |------|------|
-| [azurerm_api_management_api_version_set.api_receipts_api](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/api_management_api_version_set) | resource |
 | [azurerm_api_management_api_version_set.api_receipts_helpdesk_api](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/api_management_api_version_set) | resource |
 | [azurerm_key_vault_secret.aks_apiserver_url](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_secret) | resource |
 | [azurerm_key_vault_secret.azure_devops_sa_cacrt](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault_secret) | resource |

src/domains/receipts-app/api/receipt-helpdesk/v1/_base_policy.xml

@@ -1,15 +1,43 @@
 <policies>
     <inbound>
         <base />
-        <set-backend-service base-url="https://${hostname}/pagopa-receipt-pdf-helpdesk" />
+        <set-variable name="backendBaseUrl"
+                      value="${hostname}"/>
+        <!--
+            Redirect Logic
+            - healthCheck and GET Receipts and Cart operations -> pdf-service
+            - Recover operations -> pdf-datastore
+            - RegenerateReceiptPdf -> pdf-generator
+         -->
+        <choose>
+            <when condition="@(context.Operation.Id == "RegenerateReceiptPdf")">
+                <set-variable name="servicePath" value="pagopa-receipt-pdf-generator-helpdesk"/>
+            </when>
+            <when condition="@(new [] {
+                    "healthCheck", "GetReceipt", "GetReceiptByOrganizationFiscalCodeAndIUV",
+                    "GetReceiptMessage", "GetReceiptPdf", "GetReceiptError", "GetCart"
+                    }.Contains(context.Operation.Id))">
+                <set-variable name="servicePath" value="pagopa-receipt-pdf-service-helpdesk"/>
+            </when>
+            <when condition="@(new [] {
+                    "ReceiptToReviewed", "RecoverFailedReceipt", "RecoverFailedReceiptMassive",
+                    "RecoverNotNotifiedReceipt", "RecoverNotNotifiedReceiptMassive"
+                    }.Contains(context.Operation.Id))">
+                <set-variable name="servicePath" value="pagopa-receipt-pdf-datastore-helpdesk"/>
+            </when>
+            <otherwise>
+                <set-variable name="servicePath" value="pagopa-receipt-pdf-helpdesk"/>
+            </otherwise>
+        </choose>
+        <set-backend-service base-url="@((string)context.Variables["backendBaseUrl"] + "/"+ (string)context.Variables["servicePath"])"/>
     </inbound>
     <outbound>
-        <base />
+    <base />
     </outbound>
     <backend>
-        <base />
+    <base />
     </backend>
     <on-error>
-        <base />
+    <base />
     </on-error>
-</policies>
+</policies>