Skip to content

feat: add deploy_health handler with DB, Redis caching, and tests #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
malik203 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add deploy_health handler with DB, Redis caching, and tests #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 62 additions & 4 deletions backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,10 +251,68 @@ Extensions enabled: `uuid-ossp`, `pgcrypto`, `citext`

## API Endpoints

| Method | Path | Description |
|--------|------------------|--------------------------------|
| `GET` | `/health` | Health check (DB + Redis) |
| `GET` | `/api/v1/status` | API status and version info |
| Method | Path | Description |
|----------|---------------------------------------------------|--------------------------------------|
| `GET` | `/health` | Health check (DB + Redis) |
| `GET` | `/api/v1/status` | API status and version info |
| `POST` | `/api/v1/deployments` | Register a new deployment |
| `GET` | `/api/v1/deployments/:id` | Get a deployment by UUID |
| `GET` | `/api/v1/deployments/contract/:contract_id` | List deployments for a contract |
| `PATCH` | `/api/v1/deployments/:id/status` | Update deployment health status |

### Deploy Health

The deploy-health API tracks the lifecycle and health of contract deployments.

#### Register a deployment

```http
POST /api/v1/deployments
Content-Type: application/json

{
"contract_id": "CAABC123...",
"version": "1.2.0",
"metadata": { "network": "testnet" }
}
```

Response `201 Created`:

```json
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"contract_id": "CAABC123...",
"version": "1.2.0",
"status": "pending",
"deployed_at": "2026-05-27T22:00:00Z",
"last_checked_at": null,
"error_message": null,
"metadata": { "network": "testnet" },
"created_at": "2026-05-27T22:00:00Z",
"updated_at": "2026-05-27T22:00:00Z"
}
```

#### Update deployment status

```http
PATCH /api/v1/deployments/:id/status
Content-Type: application/json

{
"status": "healthy"
}
```

Valid status values: `pending` | `healthy` | `degraded` | `failed`.

Pass `"error_message"` alongside `"status": "failed"` or `"status": "degraded"` to record a reason.

#### Caching

Single-deployment and contract-list responses are cached in Redis for 30 seconds.
A `PATCH` to update status invalidates the per-deployment cache entry immediately.

## Production Deployment

Expand Down
17 changes: 17 additions & 0 deletions backend/migrations/20260527000000_deployments.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
-- Deployments table for tracking contract deployment health
CREATE TABLE IF NOT EXISTS deployments (
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
contract_id VARCHAR(255) NOT NULL,
version VARCHAR(100) NOT NULL,
status VARCHAR(50) NOT NULL CHECK (status IN ('pending', 'healthy', 'degraded', 'failed')),
deployed_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
last_checked_at TIMESTAMPTZ,
error_message TEXT,
metadata JSONB,
created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
);

CREATE INDEX IF NOT EXISTS idx_deployments_contract_id ON deployments(contract_id);
CREATE INDEX IF NOT EXISTS idx_deployments_status ON deployments(status);
CREATE INDEX IF NOT EXISTS idx_deployments_deployed_at ON deployments(deployed_at);
Loading