p4pa-workflow-worker

This application belong to the batch tier of the Piattaforma Unitaria product.

See PU Microservice Architecture for more details.

See p4pa-doc for further documentation.

🧱 Role

• To execute workflow activities through Temporal.io;
  • See Temporal.io Confluence page for details on its usage;
  • See Workflow Confluence page for implemented Workflows;
  • It will register the activities implemented on p4pa-payhub-activities to Temporal.io task queue:
    • See spring.temporal.workers.* properties on application.yml.

🔎 Monitoring

See available actuator endpoints through the following path:

• /actuator

📌 Relevant endpoints

• Health (provide an accessToken to see details): /actuator/health
  • Liveness: /actuator/health/liveness
  • Readiness: /actuator/health/readiness
• Metrics: /actuator/metrics
  • Prometheus: /actuator/prometheus

Further endpoints are exposed through the JMX console.

✏️ Logging

See log configured pattern.

🔗 Dependencies

🗄️ Resources

• Temporal.io
• See Resources declared on p4pa-payhub-activities

🔧 Configuration

• See application.yml for each configurable property;
• See pa4pa-payhub-activities application.yml for additional configurable properties.

📌 Relevant configurations

See also relevant configurations documented on pa4pa-payhub-activities.

🌐 Application Server

ENV	DESCRIPTION	DEFAULT
SERVER_PORT	Application server listening port	8080

✏️ Logging

ENV	DESCRIPTION	DEFAULT
LOG_LEVEL_ROOT	Base level	INFO
LOG_LEVEL_PAGOPA	Base level of custom classes	INFO
LOG_LEVEL_SPRING	Level applied to Spring framework	INFO
LOG_LEVEL_SPRING_BOOT_AVAILABILITY	To print availability events	DEBUG
LOGGING_LEVEL_API_REQUEST_EXCEPTION	Level applied to APIs exception	INFO
LOG_LEVEL_PERFORMANCE_LOG	Level applied to PerformanceLog	INFO
LOG_LEVEL_PERFORMANCE_LOG_API_REQUEST	Level applied to API Performance Log	INFO
LOG_LEVEL_PERFORMANCE_LOG_REST_INVOKE	Level applied to REST invoke Performance Log	INFO

🔁 Integrations

🕒 Temporal.io

ENV	DESCRIPTION	DEFAULT
TEMPORAL_SERVER_HOST	Temporal hostname	localhost
TEMPORAL_SERVER_PORT	Temporal port	7233
TEMPORAL_SERVER_ENABLE_HTTPS	To use HTTPS when invoking Temporal	false
TEMPORAL_SERVER_NAMESPACE	Temporal namespace	pu
TEMPORAL_TIMEOUT_SYSTEM_INFO_SECONDS	Timeout set to wait for SystemInfo invokes (seconds)	5
TEMPORAL_TIMEOUT_RPC_LONG_POLL_SECONDS	Timeout set to wait for long poll RPCs (seconds)	70
TEMPORAL_TIMEOUT_RPC_QUERY_SECONDS	Timeout set to wait for query RPCs (seconds)	10
TEMPORAL_TIMEOUT_RPC_GENERIC_SECONDS	Timeout set to wait for other RPCs (seconds)	10

📥 TaskQueue poller sizes

See the following properties for poller sizes:

• spring.temporal.workers[*].capacity.activity-task-pollers-configuration.poller-behavior-autoscaling

🔑 keys

ENV	DESCRIPTION	DEFAULT
JWT_TOKEN_PUBLIC_KEY	p4pa-auth JWT public key

🛠️ Getting Started

📝 Prerequisites

Ensure the following tools are installed on your machine:

1. Java 21+
2. Gradle (or use the Gradle wrapper included in the repository)
3. Docker (to build and run on an isolated environment, optional)
4. GITHUB_TOKEN environment variable

🔐 Write Locks

./gradlew dependencies --write-locks

⚙️ Build

./gradlew clean build

🧪 Test

📌 JUnit

./gradlew test

🚀 Run local

./gradlew bootRun

🐳 Build & run through Docker

docker build -t <APP_NAME> .
docker run --env-file <ENV_FILE> <APP_NAME>

⚖️ Generate dependencies licenses

./gradlew generateLicenseReport