page:recipes:rest api:nestjs:worker state

Host Rest API with NestJS: Worker Execution and Job State

Summary

Deploy a rest API built with NestJS as a public web service plus a dedicated worker process on Ample. ample plan --write discovers both services and their shared database and writes ample.toml; ample up reconciles the topology: a managed PostgreSQL 16 database, a public web microVM and a private worker microVM (kind worker, no public URL), both reading DATABASE_URL. Verified on NestJS: a separately deployed worker service (kind worker, no public URL) sharing a declared managed PostgreSQL database with the web service, consuming a jobs table with row locks and marking jobs done once (worker=done attempts=1). Not separately tested: your job payloads, retry policy and scheduling; treat the rest API-specific behavior as your application code.

Representative Queries

Resource Requirements

Infrastructure Requirements

Framework

NestJS

Workload

REST API

Release Status

published

Support Status

verified

Execution Status

ready

Prerequisites

  1. A repository with the web app and the worker as separate service directories (the fixture uses apps/web and apps/worker), each building and starting with the documented commands (npm install, nest build (TypeScript) then node dist/main.js on the node-22 template; the worker starts with node worker (its own package.json start script) and binds no port).
  2. Both services read DATABASE_URL at runtime and share one jobs table; the worker claims rows with SELECT ... FOR UPDATE SKIP LOCKED and marks them done once.
  3. An Ample account token with servers:write and databases:write (ample up creates the database).

Workflow Steps

  1. Plan the topology: Run the planner once. It discovers the web and worker services, infers kind = "worker" for the process without a port, declares the database each service needs, and writes ample.toml. Command: ample plan --write .
  2. Share one database: Keep a single [databases.main] with engine = "postgres", drop any per-service database the planner added, and set DATABASE_URL = { database = "main" } under both [services.web.env] and [services.worker.env]. Command: ample plan --offline .
  3. Apply: Reconcile the whole manifest in dependency order: the database first, then both services. It is idempotent and never destructive. Command: ample up .
  4. Verify: Fetch the web service URL and its worker status route (/p/worker-queue/status in the example). Command: ample logs --kind runtime

Tested Configuration

Examples

Success Checks

Limitations

Cost Estimate

Formats