Merge pull request #64 from udx/worker-upgrade

Maintenance Update

Author: fqjony

.github/workflows/tests.yml

@@ -0,0 +1,21 @@
+---
+name: Tests
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Build and Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Build image and run tests
+        run: make test

Dockerfile

@@ -1,8 +1,8 @@
 # Use the latest udx-worker as the base image
-FROM usabilitydynamics/udx-worker:0.36.0
+FROM usabilitydynamics/udx-worker:0.37.0
 
 # Add metadata labels
-LABEL version="0.24.0"
+LABEL version="0.25.0"
 
 # Set build arguments for Node.js version and application port
 ARG NODE_VERSION=22.21.1
@@ -75,4 +75,4 @@ WORKDIR "${APP_HOME}"
 ENTRYPOINT ["/usr/local/worker/bin/entrypoint.sh"]
 
 # Use the default command from parent image
-CMD ["tail", "-f", "/dev/null"]
+CMD ["tail", "-f", "/dev/null"]

Makefile

@@ -6,7 +6,7 @@ include Makefile.help
 .DEFAULT_GOAL := help
 
 # Phony targets ensure Make doesn't get confused by filenames
-.PHONY: build run deploy run-it clean exec log test dev-pipeline run-all-tests wait-container-ready
+.PHONY: build run deploy run-it clean exec log test dev-pipeline run-all-tests run-test wait-container-ready
 
 # Docker Commands for Reusability
 DOCKER_RUN_BASE := docker run --rm --name $(CONTAINER_NAME) \
@@ -22,6 +22,12 @@ endif
 
 DOCKER_EXEC := docker exec -it $(CONTAINER_NAME)
 DOCKER_CLEAN := docker rm -f $(CONTAINER_NAME) || true
+TEST_VOLUMES := \
+	-v $(PWD)/src/tests:/usr/src/app/tests \
+	-v $(PWD)/src/examples/simple-server/index.js:/usr/src/app/index.js \
+	-v $(PWD)/src/examples/simple-server/.config/worker/services.yaml:/home/udx/.config/worker/services.yaml
+TEST_ENV := -e NODE_ENV=test
+TEST_RUN := docker run --rm $(TEST_VOLUMES) $(TEST_ENV) $(DOCKER_IMAGE)
 
 # Build the Docker image with multi-platform support
 build:
@@ -42,6 +48,11 @@ run: clean
 	@$(MAKE) wait-container-ready
 	@echo "Container started successfully."
 
+# Deploy Docker container (production mode)
+deploy: clean
+	@echo "Deploying Docker container (production mode)..."
+	@$(MAKE) run NODE_ENV=production
+
 # Run Docker container in interactive mode
 run-it:
 	$(MAKE) run INTERACTIVE=true CMD="/bin/bash"
@@ -77,23 +88,28 @@ wait-container-ready:
 	@echo "Container is ready."
 
 # Run all tests in the tests directory
-run-all-tests:
+run-all-tests: build
 	@echo "Running all tests in Docker container..."
-	@docker run --rm \
-		-v $(PWD)/src/tests:/usr/src/app/tests \
-		-v $(PWD)/src/examples/simple-server/index.js:/usr/src/app/index.js \
-		-v $(PWD)/src/examples/simple-server/.config/worker/services.yaml:/home/udx/.config/worker/services.yaml \
-		-e NODE_ENV=test \
-		$(DOCKER_IMAGE) \
+	@$(TEST_RUN) \
 		/bin/sh -c 'cd /usr/src/app/tests && for test_script in *.sh; do \
 			echo "Running $$test_script..."; \
 			sh ./$$test_script || { echo "Test $$test_script failed"; exit 1; }; \
 		done'
 
+# Run a specific test script
+run-test: build
+	@if [ -z "$(TEST_SCRIPT)" ]; then \
+		echo "TEST_SCRIPT is required (e.g., make run-test TEST_SCRIPT=10_validate_environment.sh)"; \
+		exit 1; \
+	fi
+	@echo "Running test $(TEST_SCRIPT) in Docker container..."
+	@$(TEST_RUN) \
+		/bin/sh -c 'cd /usr/src/app/tests && sh ./$(TEST_SCRIPT)'
+
 # Run validation tests (build and run-all-tests)
-test: build run-all-tests
+test: run-all-tests
 	@echo "Validation tests completed."
 
 # Development pipeline (build and test)
-dev-pipeline: build test
+dev-pipeline: test
 	@echo "Development pipeline completed successfully."

Makefile.help

@@ -9,9 +9,9 @@ help:
 	@echo "  clean               Stop and remove any existing container with the specified name"
 	@echo "  wait-container-ready Wait for the container to be ready by checking application readiness"
 	@echo "  run-test            Run a specific test script in the test environment (requires TEST_SCRIPT variable)"
-	@echo "  run-all-tests       Run all test scripts in the tests directory with a test environment"
-	@echo "  test                Run validation tests (build and run-all-tests)"
-	@echo "  dev-pipeline        Execute the full development pipeline (build and test)\n"
+	@echo "  run-all-tests       Build the image and run all test scripts"
+	@echo "  test                Run validation tests (same as run-all-tests)"
+	@echo "  dev-pipeline        Execute the validation pipeline\n"
 	@echo "Variables (with default values):\n"
 	@echo "  IMAGE_NAME           = $(IMAGE_NAME)         # Name of the Docker image"
 	@echo "  TAG                  = $(TAG)                # Tag for the Docker image"
@@ -27,5 +27,6 @@ help:
 	@echo "  BUILD_PLATFORMS      = $(BUILD_PLATFORMS)    # Platforms for multi-platform builds"
 	@echo "  NO_CACHE             = $(NO_CACHE)           # Disable cache when building Docker images"
 	@echo "  DETACHED             = $(DETACHED)           # Run containers in detached mode by default"
-	@echo "  CMD                  = $(CMD)                # Default command to run inside the container\n"
+	@echo "  CMD                  = $(CMD)                # Default command to run inside the container"
+	@echo "  TEST_SCRIPT          = $(TEST_SCRIPT)        # Test script to run with run-test\n"
 	@echo "To run a specific test with run-test, set the TEST_SCRIPT variable, e.g., 'make run-test TEST_SCRIPT=10_validate_environment.sh'"

Makefile.variables

@@ -24,3 +24,4 @@ NO_CACHE ?= false
 # Runtime Options
 DETACHED ?= true
 CMD ?= /bin/bash
+TEST_SCRIPT ?=

README.md

@@ -1,185 +1,85 @@
-# UDX Worker Node.js
+<img src="assets/logo.svg" alt="UDX Worker Node.js">
 
 [![Docker Pulls](https://img.shields.io/docker/pulls/usabilitydynamics/udx-worker-nodejs.svg)](https://hub.docker.com/r/usabilitydynamics/udx-worker-nodejs) [![License](https://img.shields.io/github/license/udx/worker-nodejs.svg)](LICENSE)
 
-**A versatile Docker image for running Node.js applications with built-in process management, providing a ready-to-use environment to deploy and manage your JavaScript projects.**
+**Node.js runtime image built on UDX Worker.**
 
-[Quick Start](#-quick-start) • [Development](#-development) • [Documentation](#-documentation) • [Contributing](#-contributing)
+[Quick Start](#quick-start) • [Usage](#usage) • [Development](#development) • [Resources](#resources)
 
-## 🚀 Overview
+## Overview
 
-UDX Worker Node.js is a specialized Docker image built on UDX Worker that provides:
+UDX Worker Node.js is a Docker image that provides a ready-to-use Node.js runtime with the same operational model as `udx/worker` (https://github.com/udx/worker).
 
-- 🔧 **Node.js Runtime**: Ready-to-use environment for JavaScript applications
-- 📦 **Process Management**: Built-in supervisor-based service management
-- 🛠️ **Service Configuration**: YAML-based service definition and control
-- 🔄 **Zero Downtime**: Seamless application updates and restarts
-- 🏗️ **Base Image**: Built on `udx-worker` for secure, efficient operations
+## Quick Start
 
-## 👨‍💻 Development
+Requirements: Docker and Node.js (for the CLI).
 
-### 📋 Prerequisites
-
-- `Docker` installed and running on your system
-- Node.js application code (optional)
-
-## 🚀 Quick Start
-
-### Example 1: Simple Service
-
-1. Create a service configuration in `.config/worker/services.yaml`:
-
-```yaml
-kind: workerService
-version: udx.io/worker-v1/service
-services:
-  - name: "node-app"
-    command: "node index.js"
-    autostart: true
-    autorestart: true
-    envs:
-      - "PORT=3000"
-```
-
-2. Pull and run the image:
+1. Install the deployment CLI ([@udx/worker-deployment](https://www.npmjs.com/package/@udx/worker-deployment)).
 
 ```bash
-docker pull usabilitydynamics/udx-worker-nodejs:latest
-docker run -d --name my-node-app -p 3000:3000 -v $(pwd)/.config:/home/udx/.config usabilitydynamics/udx-worker-nodejs:latest
-```
-
-### Example 2: Custom Application
-
-1. Create your service configuration in `.config/worker/services.yaml`:
-
-```yaml
-kind: workerService
-version: udx.io/worker-v1/service
-services:
-  - name: "api-server"
-    command: "node api/server.js"
-    autostart: true
-    autorestart: true
-    envs:
-      - "PORT=3000"
-      - "NODE_ENV=production"
-  - name: "worker-queue"
-    command: "node worker.js"
-    autostart: true
-    envs:
-      - "QUEUE_URL=redis://localhost:6379"
+npm install -g @udx/worker-deployment
 ```
 
-2. Create a `docker-compose.yml`:
-
-```yaml
-version: '3'
-services:
-  app:
-    image: usabilitydynamics/udx-worker-nodejs:latest
-    volumes:
-      - ./:/usr/src/app
-      - ./.config:/home/udx/.config
-    ports:
-      - "3000:3000"
-```
-
-### Development Setup
-
-1. Clone this repository:
+2. Generate a config and edit `deploy.yml` for your app.
 
-```
-git clone https://github.com/udx/udx-worker-nodejs.git
-cd udx-worker-nodejs
+```bash
+worker config
 ```
 
-2. Build the Docker image:
+3. Run the container.
 
+```bash
+worker run
 ```
-make build
-```
-
-3. Run Tests to verify functionality:
 
-```
-make run-all-tests
-```
+## Usage
 
-You can add additional tests in the `src/tests/` directory as needed.
+- Deploy configuration: https://github.com/udx/worker-deployment/blob/latest/docs/deploy-config.md
 
-## ⚙️ Configuration
+- Service configuration: https://github.com/udx/worker/blob/latest/docs/runtime/services.md
 
-You can configure build and runtime variables in `Makefile.variables`:
+- Runtime config and secrets: https://github.com/udx/worker/blob/latest/docs/runtime/config.md
 
-- Node.js version. _(Node.js 20.x LTS supported by default)_
-- Port mappings
-- Source paths
+### Examples
 
-Adjust these variables to suit your environment or specific deployment requirements.
+- `src/examples/simple-server` is included as a minimal sample.
 
-## 🛠️ Makefile Commands Helper
+## Development
 
-Use make to view all available commands:
+```bash
+git clone https://github.com/udx/worker-nodejs.git
+cd worker-nodejs
 
+make build
+make test
 ```
-make help
-```
-
-These commands offer options for building, running, and testing your application seamlessly.
-
-## 📚 Documentation
-
-### 🔧 Based on udx-worker
-
-Built on [`udx-worker`](https://github.com/udx/worker), this image benefits from secure, resource-efficient configurations and best practices, providing a reliable foundation for Node.js applications.
 
-### Core Concepts
+To run a single test:
 
-- **Process Management**: Uses supervisor-based worker process manager
-- **Service Configuration**: Defined through `services.yaml`
-- **Configuration**: Customizable through `Makefile.variables`
-
-### Additional Resources
-
-- Build variables can be configured in `Makefile.variables`
-- View available commands with `make help`
-- Test examples available in `src/tests/`
+```bash
+make run-test TEST_SCRIPT=10_validate_environment.sh
+```
 
-## 🛠️ Development
+Build defaults for contributors live in `Makefile.variables` (Node.js version, ports, build args).
 
-Contribute to the project:
+## Resources
 
-1. Fork the repository
-2. Create your feature branch
-3. Submit a pull request
+- Base image docs: https://github.com/udx/worker/tree/latest/docs
+- Deployment CLI: https://github.com/udx/worker-deployment/tree/latest/docs
+- Docker Hub: https://hub.docker.com/r/usabilitydynamics/udx-worker-nodejs
 
-## 🤝 Contributing
-We welcome contributions! Here's how you can help:
+## Contributing
 
 1. Fork the repository
 2. Create a feature branch
 3. Commit your changes
 4. Push to your branch
 5. Open a Pull Request
 
-Please ensure your PR:
-- Follows our coding standards
-- Includes appropriate tests
-- Updates relevant documentation
-
-## 🔗 Resources
-- [Docker Hub](https://hub.docker.com/r/usabilitydynamics/udx-worker-nodejs)
-- [UDX Worker Documentation](https://github.com/udx/worker)
-- [Product Page](https://udx.io/products/udx-worker-nodejs)
-
-## 🎯 Custom Development
-Need specific features or customizations?
-[Contact our team](https://udx.io/) for professional development services.
-
-## 📄 License
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+Please ensure your PR includes appropriate tests and documentation updates.
 
 ---
+
 <div align="center">
 Built by <a href="https://udx.io">UDX</a> © 2025
-</div>
+</div>