How codacy20/nodejs-ts-pdf-label-maker works
Project type and purpose
• Type: Standalone backend microservice (REST API)
• Purpose: Receive HTTP requests to generate shipping-label PDFs from HTML templates, expose health-check endpoints, and run inside Docker/Kubernetes.
File structure
• Top level:
– Dockerfile, docker-compose support → containerization
– README.md, postman-collection.json → documentation/testing
– assets/ → HTML templates, sample PDFs
– functions/ → the application code
• functions/src:
– config/ → InversifyJS DI container setup
– constants/ → symbols, types for DI
– health/ → HealthController (liveness/readiness)
– shipping-label/ → ShippingLabelController + ShippingLabelService
– pdf/ → IPdfGenerator and PuppeteerPdfGenerator
– utils/ → HtmlRenderer, Logger, RequestLogger
– index.ts → Express app entry point
• functions/tests: unit tests for service layer (ShippingLabelService)
README for additional insights
• Clean architecture: controller–service separation, DI for loose coupling
• Tech stack: Node.js 20+, TypeScript, Express (implied), Puppeteer, InversifyJS
• Features: REST API (/get-label, /health), multi-language support, Docker
Main components & their interactions
A. API Layer
• Express HTTP server (functions/src/index.ts)
• Middleware: RequestLogger, error handlers
• Controllers:
– ShippingLabelController: handles POST /get-label
– HealthController: handles GET /health, /liveness, /readiness
B. Service Layer
• ShippingLabelService: business logic (validate input, select template, orchestrate PDF gen)
• IPdfGenerator & PuppeteerPdfGenerator: render HTML and create PDF via Puppeteer
• HtmlRenderer: inject data into labelTemplate.html
C. Infrastructure & Utilities
• InversifyJS Container (config/inversify.config.ts): binds interfaces → implementations
• Logger: application-wide logging
D. Assets & External Dependencies
• assets/labelTemplate.html: HTML template
• Puppeteer (headless Chrome)
• Docker container runtime
Data Flow:
HTTP POST → Express → RequestLogger → ShippingLabelController
→ ShippingLabelService → HtmlRenderer (loads labelTemplate.html from assets)
→ PuppeteerPdfGenerator → headless Chrome → PDF Buffer
← ShippingLabelService → Controller → HTTP Response (PDF)
Health checks follow a similar, simpler path to HealthController.
Architectural patterns & design principles
• Controller–Service pattern: thin controllers, fat services
• Dependency Injection (InversifyJS): decouple modules, easy testing
• Clean Architecture: separate layers (API, business, infrastructure)
• Single Responsibility: each module has a clear, narrow purpose
Essential elements
• Notes on ports (e.g. 3000) and health-probe URLs