Unit Tests Workflow (unit-tests.yml)

The Unit Tests Workflow provides comprehensive testing capabilities for all DashClicks services, supporting both Node.js and Deno-based applications. It features intelligent change detection to run tests only for modified services, extensive caching for performance, and detailed coverage reporting.

🧪 Overview

• File: .github/workflows/unit-tests.yml
• Purpose: Execute unit tests for Node.js and Deno services
• Triggers: Pull requests and manual dispatch
• Features: Smart change detection, parallel execution, coverage reporting
• Platforms: Ubuntu 22.04 with Node.js 18 and Deno 2.1.7

🔄 Trigger Events

on:
  workflow_dispatch: # Manual execution
  pull_request: # All pull requests to any branch
    branches:
      - '**'

🔍 Intelligent Change Detection

The workflow analyzes changed files to determine which test suites to run:

Service Categories

# Node.js services (11 services)
NODE_SERVICES="conversation-socket dashboard-gateway external functions
               general-socket internal misc notifications queue-manager
               router tests"

# Deno services (1 service)
DENO_SERVICES="ai-service"

Change Detection Logic

# Get changed files based on trigger type
if [ "${{ github.event_name }}" == "pull_request" ]; then
  git fetch origin ${{ github.base_ref }}
  CHANGED_FILES=$(git diff --name-only origin/${{ github.base_ref }}..HEAD)
else
  CHANGED_FILES=$(git diff --name-only HEAD^..HEAD)
fi

# Determine which test suites to run
NODE_SERVICES_CHANGED="false"
for service in $NODE_SERVICES; do
  if echo "$CHANGED_FILES" | grep -q "^$service/"; then
    NODE_SERVICES_CHANGED="true"
    break
  fi
done

DENO_SERVICES_CHANGED="false"
if echo "$CHANGED_FILES" | grep -q "^ai-service/"; then
  DENO_SERVICES_CHANGED="true"
fi

Test Execution Strategy

Scenario	Node.js Tests	Deno Tests	Result
No changes	Skip	Skip	All tests skipped
Only Node.js changes	Run	Skip	Node.js tests only
Only Deno changes	Skip	Run	Deno tests only
Both changed	Run	Run	Full test suite

🏗️ Node.js Test Setup

Environment Configuration

# Package management
uses: pnpm/action-setup@v2
with:
  version: 9.x

# Node.js setup
uses: actions/setup-node@v4
with:
  node-version: 18
  cache: 'pnpm'

MongoDB Test Database

# MongoDB Memory Server configuration
MONGOMS_VERSION: '6.0.9'
MONGOMS_DOWNLOAD_DIR: '/tmp/mongodb-binaries'
NODE_ENV: 'test'
MONGODB_DEBUG: '1'

Dependency Caching

# Comprehensive Node.js caching
path: |
  ~/.pnpm
  node_modules
  */*/node_modules
  tests/node_modules
  internal/node_modules
  external/node_modules
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json', '**/package.json') }}

Shared Files Distribution

# Copy shared models and utilities
pnpm run copySharedFiles

# Install all dependencies
pnpm install --no-frozen-lockfile

🧪 Node.js Test Execution

Test Command

pnpm test -- --coverage --testPathPattern="($NODE_PATTERN)"

Coverage Configuration

The workflow generates comprehensive coverage reports:

• Format: Jest coverage with multiple formats (JSON, LCOV, HTML)
• Thresholds: Configurable minimum coverage requirements
• Output: Coverage reports stored as artifacts

Test Pattern Filtering

Tests run only for changed services using pattern matching:

# Example: If internal/ and external/ changed
--testPathPattern="(internal|external)"

🦕 Deno Test Setup

Environment Configuration

# Deno setup
uses: denoland/setup-deno@v2
with:
  deno-version: 2.1.7

Test Execution

cd ai-service
NO_COLOR=true NODE_ENV=test deno test \
  --coverage=tests/coverage \
  --allow-net \
  --allow-env \
  --allow-read

Coverage Generation

# Generate coverage report
NO_COLOR=true NODE_ENV=test deno coverage tests/coverage

📊 Test Results & Reporting

Exit Code Handling

# Capture test results with proper exit codes
pnpm test 2>&1 | tee node-coverage-log.txt
TEST_EXIT_CODE=${PIPESTATUS[0]}
echo "exit_code=$TEST_EXIT_CODE" >> "$GITHUB_OUTPUT"

Error Capture

# Capture specific error messages for Deno
ERROR_MSG=$(grep -A 5 "error:" ../deno-coverage-log.txt || true)
if [ -n "$ERROR_MSG" ]; then
  echo "DENO_TEST_ERROR<<EOF" >> "$GITHUB_ENV"
  echo "$ERROR_MSG" >> "$GITHUB_ENV"
  echo "EOF" >> "$GITHUB_ENV"
fi

Failure Reporting

The workflow fails if any test suite fails:

# Check for test failures
FAIL=false

if [ "${{ steps.node-tests.outputs.exit_code }}" != "0" ]; then
  FAIL=true
  echo "❌ Node.js tests failed"
fi

if [ "${{ steps.deno-tests.outputs.exit_code }}" != "0" ]; then
  FAIL=true
  echo "❌ Deno tests failed"
fi

if [ "$FAIL" = true ]; then
  exit 1
fi

📦 Artifacts & Coverage

Upload Strategy

# Upload comprehensive test artifacts
- name: 📦 Upload test results
  uses: actions/upload-artifact@v4
  with:
    name: test-results
    path: |
      coverage/
      ai-service/coverage/
      test-results/
      node-coverage-log.txt
      deno-coverage-log.txt
    retention-days: 14

Coverage Analysis

The workflow extracts coverage information:

# Node.js coverage extraction
coverageSummaryMatch = /File.*?(\d+\.\d+)\s*%.*?Branch.*?(\d+\.\d+)\s*%/s.exec(fullNodeCoverage);

# Deno coverage extraction
coverageSummaryMatch = /(\d+\.\d+)%.*?coverage/s.exec(fullDenoCoverage);

💬 Pull Request Integration

Automated PR Comments

The workflow posts detailed test results to pull requests:

// Comment structure
const comment = `## 🧪 Unit Test Results

### ${statusEmoji} Status: ${statusMessage}

### 📊 Run Information
- **Run ID**: [${context.runId}](${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId})
- **Triggered by**: ${context.actor}

### 🔍 Changed Files
${changedFilesList}

### 📋 Test Execution Summary
${testSummary}

### 🟢 Node.js Test Results Summary
${nodeCoverage}

### 🦕 Deno Test Results Summary  
${denoCoverage}
`;

Comment Features

• Collapsible sections for detailed logs
• Coverage summaries with key metrics
• Error highlighting for failed tests
• File change tracking with limits for readability
• Direct links to workflow runs

🔧 Caching Configuration

Cache Types

Cache Type	Path	Key
Node modules	~/.pnpm	Package files hash
MongoDB binaries	/tmp/mongodb-binaries	MongoDB version
Chrome browser	System default	Runner OS

🛠️ Environment Variables

MongoDB Configuration

MONGOMS_VERSION: '6.0.9'
MONGOMS_DOWNLOAD_DIR: '/tmp/mongodb-binaries'
MONGODB_VERSION: '6.0.9'
MONGODB_TEST_URI: 'mongodb://localhost:27017/dashclicks_test'
MONGODB_DEBUG: '1'

Test Environment

NODE_ENV: 'test'
NO_COLOR: 'true'        # Disable color output for Deno
SKIP_TESTS: 'false'     # Control test execution
SKIP_NODE_TESTS: 'false'
SKIP_DENO_TESTS: 'false'

🔍 Debug Configuration

Logging Variables

MONGODB_DEBUG: '1'
NODE_ENV: 'test'
NO_COLOR: 'true'

📋 Test Configuration

Coverage Requirements

Minimum coverage thresholds enforced:

• Branch coverage: 40% minimum
• Function coverage: 50% minimum
• Line coverage: 50% minimum
• Statement coverage: 50% minimum

Environment Dependencies

• Node.js 18: Runtime for Node.js services
• Deno 2.1.7: Runtime for AI service
• pnpm 9.x: Package manager
• MongoDB 6.0.9: Test database via Memory Server
• Chrome browser: For Puppeteer-based tests

---

🔗 Related Workflows

• lint-check.yaml - Code quality validation before testing
• generate-coverage.yaml - Dedicated coverage reporting
• build.docker.yaml - Build images after successful tests