pagopa-ecommerce-local

All you need to start the whole pagopa eCommerce platform locally for development purposes and integration tests:

for more details you can read eCommerce pagoPA Design Review

Configure

In the .env file there are a configurations related to conainers that can be customized, in particular the container ports and the services git branch to run a given version of microservices.

name	description
MONGO_PORT	The port the mongodb listens to.
MONGO_EXPRESS_PORT	The port the mongo-express listens to.
REDIS_PORT	The port the redis listens to.
REDIS_INSIGHT_PORT	The port the redis-insight listens to.
REDIS_PORT	The port the redis listens to.
NODO_MOCK_PORT	The port the nodo-mock listens to.
NODO_MOCK_COMMIT_SHA	The branch or commit SHA you want to build from. Used when the code is fetched from remote repo.
ECOMMERCE_TRANSACTIONS_PORT	The port the pagopa-ecommerce-transactions-service listens to.
ECOMMERCE_TRANSACTIONS_COMMIT_SHA	The branch or commit SHA of pagopa-ecommerce-transactions-service you want to build from. Used when the code is fetched from remote repo.
ECOMMERCE_PAYMENT_METHODS_PORT	The port the pagopa-ecommerce-payment-methods-service listens to.
ECOMMERCE_PAYMENT_METHODS_COMMIT_SHA	The branch or commit SHA of pagopa-ecommerce-payment-methods-service you want to build from. Used when the code is fetched from remote repo.
NOTIFICATIONS_SERVICE_PORT	The port the pagopa-notifications-service listens to.
NOTIFICATIONS_SERVICE_COMMIT_SHA	The branch or commit SHA of pagopa-notifications-service you want to build from. Used when the code is fetched from remote repo.
ECOMMERCE_PAYMENT_REQUESTS_COMMIT_SHA	The branch or commit SHA of pagopa-ecommerce-payment-requests-service you want to build from. Used when the code is fetched from remote repo.
ECOMMERCE_PAYMENT_REQUESTS_PORT	The port the pagopa-ecommerce-payment-requests-service listens to.
ECOMMERCE_HELPDESK_COMMANDS_PORT	The port the pagopa-ecommerce-helpdesk-commands-service listens to.
ECOMMERCE_HELPDESK_COMMANDS_COMMIT_SHA	The branch or commit SHA of pagopa-ecommerce-helpdesk-commands-service you want to build from. Used when the code is fetched from remote repo.
ECOMMERCE_CDC_PORT	The port the pagopa-ecommerce-cdc-service listens to.
ECOMMERCE_CDC_COMMIT_SHA	The branch or commit SHA of pagopa-ecommerce-cdc-service you want to build from. Used when the code is fetched from remote repo.
PGS_PORT	The port the pagopa-pgs-mock
NPG_PORT	The port the pagopa-npg-mock
WALLET_PORT	The port the pagopa-wallet-mock

In addiction, the parameters of the individual microservices can also be customized by editing the env file contained in the folder of the specific service.

Run eCommerce pagoPA

docker-compose up

If you use the default configurations, we will have the following services exposed:

service	url
nodo-mock	http://localhost:3002/webservices/pof/PagamentiTelematiciPspNodoservice
pagopa-ecommerce-transactions-service	http://localhost:8080/transactions
pagopa-ecommerce-payment-methods-service	http://localhost:8083/payment-methods
pagopa-ecommerce-payment-requests-service	http://localhost:8088/payment-requests and http://localhost:8088/carts
pagopa-ecommerce-helpdesk-commands-service	http://localhost:8087/commands

You can check data persisted to either Mongo or Redis with their respective web interfaces (Mongo express/Redis Insight). To do so, go to:

service	url
Redis Insight	http://localhost:8001
Mongo Express	http://localhost:8081

If you want to connect to MongoDB using an external client than mongo express (such as Mongo Compass etc) you will have to add an entry in hosts file

127.0.0.1 pagopa-ecommerce-mongo

to map the pagopa-ecommerce-mongo hostname with localhost. This is required since mongo is started as a replicas with that hostname

When changing configuration parameters, remember to rebuild containers with

docker-compose build SERVICE_NAME [--no-cache]

Create azurite queues

There is the azurite-init container that automatically creates all queue and, once done, terminate it's execution.

To recreate the queues simply run again the above container.

If env files have been changed run again azurite-init to make the container again to start new queues automatic creation processing

Service Integration Notes

Helpdesk Commands Service

The pagopa-ecommerce-helpdesk-commands-service provides manual operations support for the ecommerce platform:

• Refund Operations: Manual transaction refunds across payment gateways
• Notification Management: Email notification resending capabilities
• Integration Testing: Includes polling-based tests that verify transaction state transitions

eCommerce CDC Service

The pagopa-ecommerce-cdc-service provides real-time Change Data Capture functionality for the ecommerce platform:

• Transaction Event Processing: Monitors MongoDB change streams for transaction lifecycle events
• Real-time Updates: Processes transaction state changes in near real-time
• Event Streaming: Captures and processes events such as transaction creation, authorization, and completion
• Integration Testing: Provides comprehensive event processing capabilities for testing transaction flows

Troubleshooting

To fix:

#0 135.0 [output clipped, log limit 1MiB reached]

run docker compose with:

DOCKER_BUILDKIT=1DOCKER