Retrieved Pensions Record Service

The Retrieved Pensions Record Service is an Azure Function app designed to manage pension records retrieved from external sources. Retrieved pensions are received by this service via a service bus queue. It makes the retrieved pensions available to other services via REST http endpoints. It provides a reliable interface for processing requests and managing the associated pension data.

Features

• Retrieved pension persistence: Processes retrieved pension records and links them to active sessions
• Retrieved Pension API: Handles requests for retrieved pension records associated with a given session.
• Error Handling: Implements robust error handling for various scenarios encountered during data retrieval.

Architecture

The service follows a modular architecture with clear separation of concerns. Key components include:

• Functions: Implement Azure Functions that handle incoming HTTP requests and orchestrate responses.
• Models: Define the data structures for requests and responses, including models for handling pension records.
• Repository: Encapsulates the logic for data access, managing interactions with the Cosmos DB.

Tech Stack

The Retrieved Pensions Record Service is built using the following technologies:

• .NET 8.0: The core framework for building the microservice, supporting modern C# features and performance improvements.
• Azure Functions v4: The framework used for implementing serverless functions.
• C#: The primary programming language used for service development.
• MhpdCommon: A shared library for models and utilities used across the MHPD ecosystem.
• Microsoft.Azure.Cosmos: For managing data in Azure Cosmos DB.
• Microsoft.Azure.Functions.Extensions: Provides extension methods for Azure Functions.
• Microsoft.Azure.Functions.Worker: For building Azure Functions using the Worker SDK.
• Microsoft.Azure.Functions.Worker.Extensions.Http: For handling HTTP triggers in Azure Functions.
• Microsoft.Azure.Functions.Worker.Extensions.ServiceBus: For handling Service Bus triggers in Azure Functions.
• Microsoft.ApplicationInsights.WorkerService: For monitoring and logging with Application Insights.
• Newtonsoft.Json.Schema: For JSON schema validation and manipulation.
• Microsoft.VisualStudio.Azure.Containers.Tools.Targets: For working with Docker containers in Azure Functions.

Installation

To set up the Retrieved Pensions Record Service locally, follow these steps:

1. Clone the Repository:

   git clone https://github.com/moneyadviceservice/mhpd-backend-retrieved-pensions-service.git
   cd app/RetrievedPensionsRecordFunction

2. Restore Dependencies:

   dotnet restore

3. Configure Application Settings: Update the local.settings.json file with your configuration settings. Here's an example structure based on the current requirements:

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "<your_azure_web_jobs_storage>",
    "FUNCTIONS_WORKER_RUNTIME": "dotnet-isolated",
    "APPLICATIONINSIGHTS_CONNECTION_STRING": "<app_insights_conn_string>",
    "CommonServiceBusConfiguration__InboundQueue": "outbound"
  },
  "CosmosBusinessConfiguration": {
    "DatabaseId": "mhpd-business-layer",
    "RetrievedPensionsContainer": "mhpdRetrievedPensionRecords"
  },
  "CommonServiceBusConfiguration": {
    "InboundQueue": "retrieved-pension-details"
  },
  "ConnectionStrings": {
    "CosmosDBConnectionString": "AccountEndpoint=<your_cosmosdb_account_endpoint>;AccountKey=<your_cosmosdb_account_key>;",
    "ServiceBusConnectionstring": "Endpoint=sb://<your_servicebus_namespace>.servicebus.windows.net/;SharedAccessKeyName=<your_shared_access_key_name>;SharedAccessKey=<your_shared_access_key>;"
  }
}

4. Build the Service:

   dotnet build

5. Run the Service:

   dotnet run

Testing

Unit tests are implemented to ensure the reliability of the service. To run the tests, navigate to the tests directory and execute:

cd tests
dotnet test

Contributing

Submit a pull request or open an issue for any enhancements or bug fixes.

📦 Release Notes

🔧 Release 0.3.0 — 2025-03-04

• Added CSRF support .

🔧 Release 0.5.0 — 2025-09-08

• Applied industry standard security response headers.
• Updated logging output consistency to improve traceability.