Skip to content

README.md

Latest commit

 

History

History
119 lines (79 loc) · 2.98 KB

README.md

File metadata and controls

119 lines (79 loc) · 2.98 KB
Raw

Order Processing Client Sample

Standalone client sample demonstrating how to interact with the unified order processing contract

This sample demonstrates that a single client can interact with any worker implementation of the unified contract.

Overview

This client package demonstrates that:

  • Both order-processing-worker and order-processing-worker-nestjs workers implement the same unified contract
  • A single client works with any worker implementation
  • From the client's perspective, all workers are identical
  • Workers handle errors internally using the Result/Future pattern with ActivityError

Running the Sample

Prerequisites

  1. Start Temporal server:
temporal server start-dev
  1. Build the workspace from the repository root:
cd ../..
pnpm install && pnpm build

Running with Any Worker

  1. Start a worker (choose one):

Option A: Standard Worker

cd ../order-processing-worker
pnpm dev

Option B: NestJS Worker

cd ../order-processing-worker-nestjs
pnpm dev
  1. Run the client:
cd ../order-processing-client
pnpm dev

Testing

The client includes integration tests that verify:

  • Workflow execution through the contract
  • Proper input validation via contract schema
  • Correct output types matching contract schema
  • Workflow history and metadata access

Run tests:

pnpm test

What to Notice

  • Same Contract: The client uses orderProcessingContract from @temporal-contract/sample-order-processing-contract
  • Same Task Queue: All workers listen on the same task queue: "order-processing"
  • Worker Agnostic: The client doesn't know or care which worker implementation is running
  • Type Safety: All inputs and outputs are validated against the contract schemas

Key Concepts

Unified Contract

The unified contract (orderProcessingContract) defines:

  • Global activities: log, sendNotification
  • Workflow: processOrder
    • Activities: processPayment, reserveInventory, releaseInventory, createShipment, refundPayment

Worker Implementations

Both workers implement the exact same contract but with different frameworks:

  1. Standard Worker (samples/order-processing-worker)

    • Uses @temporal-contract/worker
    • Activities use Result/Future pattern with ActivityError
    • Clean Architecture with dependency injection
    • Standalone TypeScript application

  2. NestJS Worker (samples/order-processing-worker-nestjs)

    • Uses @temporal-contract/worker-nestjs
    • Activities use Result/Future pattern with ActivityError
    • NestJS dependency injection and decorators
    • Better for NestJS-based applications

Client Perspective

From the client's perspective, there's no difference between the workers:

  • Same contract import
  • Same workflow names
  • Same activity signatures
  • Same result types

This demonstrates the power of contract-driven development - implementations can vary while maintaining compatibility.

License

MIT