# Gogs Webhook Server

A modular Node.js server for receiving and processing Gogs webhooks. The server logs all incoming webhooks to the console, executes configured commands based on webhook events, and provides an extensible callback system for custom event handling.

## Features

- **Persistent Job Queue**: FIFO queue ensures sequential execution and crash recovery
- **Modular Architecture**: Clean separation of concerns (server, handler, queue, logger)
- **Command Execution**: Execute shell commands on webhook events with variable substitution
- **Environment Configuration**: Configure commands via .env file
- **Variable Substitution**: Access repo name, branch, pusher, issue details, and more in commands
- **Branch Filtering**: Execute commands only for specific branches
- **Extensible Callback System**: Register callbacks for specific events or all events
- **Console Logging**: Colored, formatted logging of all webhook events
- **Health Check Endpoint**: Built-in health monitoring
- **Graceful Shutdown**: Saves queue state and ensures proper cleanup on process termination
- **Zero Dependencies**: Pure Node.js implementation

## Requirements

- Node.js >= 18.0.0

## Installation

```bash
npm install
```

## Usage

### Quick Start

1. Copy the example environment file:
```bash
cp .env.example .env
```

2. Edit `.env` to configure commands for webhook events (see Configuration section below)

3. Start the server:
```bash
npm start
```

The server will start on port 3000 and execute configured commands when webhooks are received.

### Development Mode (Auto-reload)

```bash
npm run dev
```

### Configuration

The server is configured using a `.env` file. Copy `.env.example` to `.env` and edit it:

```bash
cp .env.example .env
```

#### Basic Server Configuration

```env
HOST=0.0.0.0
PORT=3000
WEBHOOK_PATH=/webhook
WEBHOOK_SECRET=your-secret-here
```

- `HOST` - The network interface to bind to (default: `0.0.0.0` for all interfaces, use `127.0.0.1` for localhost only)
- `PORT` - The port number to listen on (default: `3000`)
- `WEBHOOK_PATH` - The URL path for webhooks (default: `/webhook`)
- `WEBHOOK_SECRET` - Optional secret for webhook verification

#### Command Execution Configuration

Configure commands to execute when webhooks are received. Commands support variable substitution:

**Available Variables:**
- `{{repo}}` - Repository name (e.g., "my-repo")
- `{{full_repo}}` - Full repository name (e.g., "user/my-repo")
- `{{branch}}` - Branch name (e.g., "main", "feature/new-feature")
- `{{pusher}}` - Username of person who triggered the event
- `{{event}}` - Event type (e.g., "push", "pull_request")
- `{{commit}}` - Latest commit hash (short, for push events)
- `{{commit_msg}}` - Latest commit message (for push events)
- `{{pr_number}}` - Pull request number (for PR events)
- `{{pr_action}}` - Pull request action (opened, closed, etc.)
- `{{tag}}` - Tag name (for create/delete tag events)
- `{{issue_number}}` - Issue number (for issue events)
- `{{issue_title}}` - Issue title (for issue events)
- `{{issue_action}}` - Issue action (opened, closed, reopened, etc.)
- `{{issue_body}}` - Issue description/body (for issue events)
- `{{comment_body}}` - Comment text (for issue_comment events)

**Example .env configuration:**

```env
# Execute command on push events
WEBHOOK_PUSH_ENABLED=true
WEBHOOK_PUSH_COMMAND=echo "Push to {{branch}} by {{pusher}} in {{repo}}"

# Deploy only when pushing to main branch
WEBHOOK_PUSH_FILTER_BRANCH=main
WEBHOOK_PUSH_COMMAND=/path/to/deploy.sh {{branch}} {{repo}} {{pusher}}

# Execute command on pull request events
WEBHOOK_PULL_REQUEST_ENABLED=true
WEBHOOK_PULL_REQUEST_COMMAND=echo "PR #{{pr_number}} {{pr_action}} by {{pusher}}"

# Global command (runs for all events)
WEBHOOK_GLOBAL_ENABLED=true
WEBHOOK_GLOBAL_COMMAND=/path/to/notify.sh {{event}} {{repo}} {{pusher}}
```

**Supported Event Types:**
- `WEBHOOK_PUSH_*` - Push events
- `WEBHOOK_PULL_REQUEST_*` - Pull request events
- `WEBHOOK_CREATE_*` - Branch/tag creation
- `WEBHOOK_DELETE_*` - Branch/tag deletion
- `WEBHOOK_RELEASE_*` - Release events
- `WEBHOOK_ISSUES_*` - Issue events (opened, closed, reopened, etc.)
- `WEBHOOK_ISSUE_COMMENT_*` - Issue comment events
- `WEBHOOK_GLOBAL_*` - All events

**Command Settings:**
```env
COMMAND_TIMEOUT=300000          # Command timeout in ms (default: 5 minutes)
COMMAND_WORKING_DIR=/workspace  # Working directory for commands
```

### Endpoints

- `POST /webhook` - Webhook endpoint
- `GET /health` - Health check endpoint

## Job Queue System

The webhook server uses a persistent job queue to ensure reliable and sequential command execution:

### How It Works

1. **Webhook Received**: When a webhook arrives, it's immediately accepted and added to the queue
2. **Quick Response**: The server responds to Gogs instantly (no timeout issues)
3. **Sequential Processing**: Jobs are executed one at a time in FIFO (first-in-first-out) order
4. **Persistence**: Queue state is saved to `queue.json` after every change
5. **Crash Recovery**: If the server crashes or restarts, pending jobs are automatically resumed

### Benefits

- **No Lost Webhooks**: Even if the server crashes, queued jobs are preserved and executed after restart
- **No Concurrent Execution**: Prevents conflicts when multiple webhooks trigger deployment scripts
- **Handle Bursts**: Can accept many webhooks quickly while processing them sequentially
- **Reliable**: Long-running commands won't block new webhook deliveries

### Queue File

The queue state is stored in `queue.json` in the project root:

```json
{
  "queue": [
    {
      "id": 1,
      "eventType": "push",
      "status": "pending",
      "createdAt": "2025-10-28T12:00:00.000Z"
    }
  ],
  "jobIdCounter": 5,
  "lastSaved": "2025-10-28T12:05:00.000Z"
}
```

This file is automatically managed and should not be manually edited. It's excluded from git via `.gitignore`.

## Real-World Examples

### Example 1: Auto-deploy on push to main

**.env:**
```env
WEBHOOK_PUSH_ENABLED=true
WEBHOOK_PUSH_FILTER_BRANCH=main
WEBHOOK_PUSH_COMMAND=/home/deploy/deploy.sh {{repo}} {{branch}} {{commit}}
```

**deploy.sh:**
```bash
#!/bin/bash
REPO=$1
BRANCH=$2
COMMIT=$3

echo "Deploying $REPO from $BRANCH (commit: $COMMIT)"
cd /var/www/$REPO
git pull origin $BRANCH
npm install
npm run build
systemctl restart $REPO
```

### Example 2: Send notification on any webhook

**.env:**
```env
WEBHOOK_GLOBAL_ENABLED=true
WEBHOOK_GLOBAL_COMMAND=curl -X POST https://api.slack.com/webhook -d '{"text":"{{event}} in {{repo}} by {{pusher}}"}'
```

### Example 3: Run tests on pull request

**.env:**
```env
WEBHOOK_PULL_REQUEST_ENABLED=true
WEBHOOK_PULL_REQUEST_COMMAND=/home/scripts/run-tests.sh {{repo}} {{pr_number}} {{pusher}}
```

## Extending with Callbacks

The server is designed to be easily extended with custom callbacks. See `examples/with-callbacks.js` for a complete example.

### Register Event-Specific Callbacks

```javascript
import { WebhookServer } from './src/server.js';

const server = new WebhookServer({ port: 3000 });
const handler = server.getHandler();

// Handle push events
handler.on('push', async (payload, headers) => {
  console.log('Push to:', payload.repository.name);
  console.log('Commits:', payload.commits.length);
  // Your custom logic here
});

// Handle pull request events
handler.on('pull_request', async (payload, headers) => {
  console.log('PR:', payload.action);
  // Your custom logic here
});

server.start();
```

### Register Global Callbacks

```javascript
// Handle all events
handler.onAny(async (eventType, payload, headers) => {
  console.log('Received event:', eventType);
  // Send to analytics, external logging, etc.
});
```

### Run the Example

```bash
node examples/with-callbacks.js
```

## Gogs Webhook Configuration

1. Go to your Gogs repository settings
2. Navigate to Webhooks → Add Webhook → Gogs
3. Configure:
   - **Payload URL**: `http://your-server:3000/webhook`
   - **Content Type**: `application/json`
   - **Secret**: (optional) your webhook secret
   - **Events**: Select which events to receive
4. Click "Add Webhook"

### Supported Events

- `push` - Repository push
- `create` - Branch or tag creation
- `delete` - Branch or tag deletion
- `pull_request` - Pull request actions
- `issues` - Issue actions
- `issue_comment` - Issue comment actions
- `release` - Release actions

## Project Structure

```
.
├── src/
│   ├── index.js           # Main entry point
│   ├── server.js          # HTTP server implementation
│   ├── webhookHandler.js  # Webhook processing and callbacks
│   ├── jobQueue.js        # Persistent job queue with FIFO processing
│   ├── commandExecutor.js # Command execution with variable substitution
│   ├── config.js          # Configuration loader (.env parser)
│   └── logger.js          # Logging utility
├── examples/
│   └── with-callbacks.js  # Example with custom callbacks
├── .env.example           # Example configuration file
├── queue.json             # Queue state (auto-generated, gitignored)
├── package.json
└── README.md
```

## Architecture

### WebhookServer (`src/server.js`)
- Creates HTTP server
- Handles routing and request parsing
- Manages webhook verification
- Delegates webhook processing to handler

### WebhookHandler (`src/webhookHandler.js`)
- Manages callback registration
- Executes callbacks for events
- Supports event-specific and global callbacks
- Provides error handling for callbacks

### JobQueue (`src/jobQueue.js`)
- Manages persistent job queue with FIFO processing
- Ensures only one job executes at a time
- Persists queue state to `queue.json`
- Handles crash recovery and job resumption
- Provides queue statistics and status

### CommandExecutor (`src/commandExecutor.js`)
- Executes shell commands on webhook events
- Performs variable substitution
- Handles command timeouts and errors
- Extracts webhook payload data

### Logger (`src/logger.js`)
- Formats and colorizes console output
- Provides structured logging methods
- Handles timestamp formatting

### Config (`src/config.js`)
- Loads and parses .env file
- Provides configuration access methods
- Merges environment variables with file config

## Testing

You can test the webhook server using curl:

```bash
# Test health check
curl http://localhost:3000/health

# Test webhook with push event
curl -X POST http://localhost:3000/webhook \
  -H "Content-Type: application/json" \
  -H "X-Gogs-Event: push" \
  -H "X-Gogs-Delivery: 12345" \
  -d '{
    "ref": "refs/heads/main",
    "repository": {
      "name": "test-repo",
      "full_name": "user/test-repo"
    },
    "pusher": {
      "username": "testuser"
    },
    "commits": [
      {
        "id": "abc123",
        "message": "Test commit"
      }
    ]
  }'
```

## License

ISC