Skip to main content

Backend Service

wspace-workspace-svc is the Workspaces backend subgraph on the Burdenoff platform. It runs as a managed container service in the India region and is federated into the workspace public gateway (wspace-public-gateway) and workspace internal gateway (wspace-int-gateway).

What it does​

  • Workspaces — workspace lifecycle, settings, and configuration
  • Projects — project creation, organization, archiving, and unarchiving
  • Invitations — member invitations with role assignment
  • Resource Management — workspace-scoped resource allocation and cleanup
  • Activity — workspace and project activity tracking
  • Dashboard — workspace dashboard data aggregation

Repo structure​

wspace-workspace-svc/
├── src/
│   ├── modules/         # Feature modules
│   │   ├── workspace/   # Workspace management
│   │   ├── project/     # Project management
│   │   ├── invitation/  # Invitation flows
│   │   └── activity/    # Activity tracking
│   ├── config/        # Configuration
│   ├── generated/     # Generated types
│   └── index.ts       # Entry point
├── prisma/            # Prisma schema and migrations
├── docker-compose.yml # State service orchestration
└── package.json       # Scripts and dependencies

Environment selection​

The service reads its gateway and database endpoints from environment variables. In production it uses:

ServiceProd endpoint
Workspace public gatewayhttps://graphqlworkspaces.burdenoff.com/workspaces/graphql
Workspace internal gatewayhttps://graphqlworkspaces.burdenoff.com/workspaces/graphql
Global public gatewayhttps://graphql.burdenoff.com/global/graphql

Local development uses localhost ports (see below).

Quick start (local development)​

# Install dependencies
bun install

# Start state services (PostgreSQL + Valkey)
cd ../shared-workspaces-state
docker compose up -d

# Generate Prisma client and GraphQL types
cd ../wspace-workspace-svc
bun run gendb
bun run codegen

# Apply migrations
bun run migrate:deploy

# Start development server
bun run dev

Commands​

Development​

bun run dev              # Start development server with watch mode
bun run dev:docker       # Start with docker environment
bun run start            # Start production server

Database​

bun run migrate          # Create new migration
bun run migrate:deploy   # Apply migrations
bun run reset            # Reset database (force)
bun run db:push          # Push schema changes
bun run gendb            # Generate Prisma client

Code generation​

bun run codegen          # Generate GraphQL types

Quality checks​

bun run lint             # Lint code
bun run lint:fix         # Lint and fix issues
bun run format           # Format code
bun run format:check     # Check code formatting
bun run type:check       # TypeScript type checking
bun run test             # Run tests
bun run test:watch       # Run tests in watch mode
bun run test:coverage    # Run tests with coverage
bun run knip             # Check for unused dependencies

Build & deploy​

bun run build            # Build for production
bun run sanity           # Run all quality checks (format, lint, type, build, test, knip)

GraphQL Hive​

bun run hive:schema      # Generate Hive schema
bun run hive:check       # Check schema compatibility
bun run hive:dev         # Publish to development
bun run hive:publish     # Publish to development
bun run hive:publish:staging     # Publish to staging
bun run hive:publish:production  # Publish to production
bun run hive:clean       # Clean Hive artifacts

Technology stack​

  • Runtime: Bun 1.3.14+
  • Language: TypeScript 5.9+
  • Framework: Elysiajs + GraphQL Yoga
  • GraphQL: Apollo Federation v2, GraphQL Hive Cloud
  • Database: PostgreSQL 18+ + Prisma 7.x with AGE graph extension
  • Cache / Events: managed Redis-compatible cache (TLS) via @burdenoff/be-sdk
  • SDK: @burdenoff/be-sdk

Environment variables​

Key variables (see .env.example and .env.local.example for the full list):

  • DATABASE_URL — PostgreSQL connection string (TLS required)
  • REDIS_URL — Redis-compatible cache connection string (TLS)
  • WSPACE_INT_GATEWAY_URL — Internal gateway URL
  • GLOBAL_PUBLIC_GATEWAY_URL — Cross-layer gateway URL
  • SERVICE_LAYER — Service layer (wspace)

Architecture​

Module structure​

Each module contains:

  • schema/ — GraphQL schema definitions
  • resolvers/ — GraphQL resolvers
  • services/ — Business logic
  • __tests__/ — Unit tests

Layer configuration​

This service is part of the wspace (workspace) layer and uses:

  • Internal Gateway: wspace-int-gateway for same-layer calls
  • Cross-Layer Gateway: global-public-gateway for cross-layer calls

Context field​

All Prisma models include a context JSON field for multi-dimensional data isolation:

interface EntityContext {
  workspace_id: string;      // REQUIRED
  project_id?: string;       // Optional
  actor_id?: string;         // Optional
  organization_id?: string;  // Optional
}
  • Service: github.com/algoshred/wspace-workspace-svc
  • State: ~/products/wspace/shared/shared-workspaces-state
  • E2E Tests: ~/products/workspaces/workspaces-doctor

Development workflow​

  1. Start state services: cd ../shared-workspaces-state && docker compose up -d
  2. Generate types: bun run codegen && bun run gendb
  3. Apply migrations: bun run migrate:deploy
  4. Start dev server: bun run dev
  5. Run tests: bun run test
  6. Before commit: bun run sanity

Source​

  • Repository: github.com/algoshred/wspace-workspace-svc
  • Deployed continuously from main via GitHub Actions (alpha, then production)

Next steps​