Order tracking state machine in LLD - Architecture Diagram

System Overview - Order tracking state machine

This system manages the states of an order as it moves through different stages like placed, processed, shipped, delivered, or cancelled. It ensures that the order transitions follow valid paths and updates are consistent and reliable.

Architecture Diagram

User
  |
  v
Order Tracking Service
  |
  v
State Machine Engine
  |
  v
Order Database
  |
  v
Notification Service

Components

User

actor

Initiates order status requests and receives updates

Order Tracking Service

service

Receives user requests and interacts with the state machine

State Machine Engine

service

Manages order states and enforces valid state transitions

Order Database

database

Stores current order states and history

Notification Service

service

Sends updates to users about order state changes

Request Flow - 5 Hops

User → Order Tracking Service

Order Tracking Service → State Machine Engine

State Machine Engine → Order Database

State Machine Engine → Notification Service

Notification Service → User

Failure Scenario

Component Fails:Order Database

Impact:State changes cannot be saved or read, causing stale or lost order status information

Mitigation:Use database replication and fallback to read-only mode from replicas; queue state changes for retry

Architecture Quiz - 3 Questions

Which component ensures that order states change only through valid transitions?

A Order Database

B Order Tracking Service

C State Machine Engine

D Notification Service

Design Principle

This design uses a dedicated state machine service to enforce valid order state transitions, ensuring data consistency and clear separation of concerns. Notifications are decoupled to improve user experience without blocking state updates.

Practice

1. What is the main purpose of an Order Tracking State Machine in system design?

easy

A. To manage user authentication and sessions

B. To store customer payment information securely

C. To calculate the total price of an order

D. To represent the different stages an order goes through and control transitions

Solution

1. Step 1: Understand the role of state machines

   A state machine models states and transitions between them based on events.

2. Step 2: Apply to order tracking context

   In order tracking, it shows order stages like placed, shipped, delivered, and controls valid moves.

3. Final Answer:

   To represent the different stages an order goes through and control transitions -> Option D

4. Quick Check:

   State machine = stages and transitions [OK]

Hint: Think: states show progress steps, transitions move between them [OK]

Common Mistakes:

• Confusing state machine with data storage
• Mixing order calculation with state control
• Assuming it handles user login

2. Which of the following is the correct way to define a state transition in a state machine for order tracking?

easy

A. transition('delivered', 'placed', event='return_order')

B. transition('placed', 'shipped', event='ship_order')

C. transition('shipped', 'placed', event='cancel_order')

D. transition('cancelled', 'delivered', event='refund')

Solution

1. Step 1: Identify valid order flow transitions

   Orders move forward: placed -> shipped -> delivered; backward or invalid transitions are not typical.

2. Step 2: Check each option's direction and event

   transition('placed', 'shipped', event='ship_order') correctly moves from placed to shipped on ship_order event; others reverse or skip states incorrectly.

3. Final Answer:

   transition('placed', 'shipped', event='ship_order') -> Option B

4. Quick Check:

   Valid forward transition = transition('placed', 'shipped', event='ship_order') [OK]

Hint: Transitions should follow logical order flow forward [OK]

Common Mistakes:

• Defining backward transitions without valid reason
• Skipping intermediate states
• Using wrong event names

3. Given this simplified state machine code snippet:

state = 'placed'
event = 'ship_order'
if state == 'placed' and event == 'ship_order':
    state = 'shipped'
elif state == 'shipped' and event == 'deliver_order':
    state = 'delivered'
print(state)

What will be the output if event = 'deliver_order' when state = 'placed'?

medium

A. shipped

B. delivered

C. placed

D. error

Solution

1. Step 1: Check condition for event 'deliver_order' when state is 'placed'

   The first if checks for 'ship_order' event; it does not match 'deliver_order'. The elif checks for 'shipped' state, but current state is 'placed'.

2. Step 2: Determine state after conditions

   No condition matches, so state remains unchanged as 'placed'.

3. Final Answer:

   placed -> Option C

4. Quick Check:

   No matching transition keeps state same [OK]

Hint: If no condition matches, state stays unchanged [OK]

Common Mistakes:

• Assuming event triggers transition regardless of current state
• Confusing elif with else
• Expecting error without exception handling

4. Identify the bug in this order tracking state machine snippet:

state = 'shipped'
event = 'cancel_order'
if state == 'placed' and event == 'cancel_order':
    state = 'cancelled'
elif state == 'shipped' and event == 'cancel_order':
    print('Cannot cancel after shipping')
else:
    state = 'cancelled'
print(state)

medium

A. The else block cancels order even after shipping

B. Missing transition from 'placed' to 'shipped'

C. No print statement for cancellation confirmation

D. State variable is not updated correctly for 'placed' state

Solution

1. Step 1: Analyze conditions for state 'shipped' and event 'cancel_order'

   The if does not match. The elif matches, prints 'Cannot cancel after shipping' but leaves state unchanged. However, if event were different (e.g., 'deliver_order') with state='shipped', if and elif fail, else wrongly sets state='cancelled'.

2. Step 2: Identify why this is a bug

   The else acts as a catch-all, allowing cancellation of shipped orders for unhandled events, contradicting the intent to prevent cancellation after shipping.

3. Final Answer:

   The else block cancels order even after shipping -> Option A

4. Quick Check:

   Else wrongly cancels unhandled shipped cases [OK]

Hint: Else block can override specific conditions--check carefully [OK]

Common Mistakes:

• Ignoring else block effects
• Assuming print prevents state change
• Not testing all branches

5. You need to design an order tracking state machine that handles normal flow and exceptions like cancellation and returns. Which design approach best ensures scalability and clarity?

hard

A. Model states hierarchically with sub-states for exceptions and normal flow

B. Use a single flat state list with many transitions for all cases

C. Handle exceptions outside the state machine with separate logic

D. Use only two states: 'active' and 'closed' to simplify design

Solution

1. Step 1: Understand complexity of order states

   Orders have normal states (placed, shipped, delivered) and exceptions (cancelled, returned) which can be grouped logically.

2. Step 2: Evaluate design approaches for scalability and clarity

   Hierarchical states allow grouping related states, reducing complexity and improving maintainability compared to flat or oversimplified models.

3. Final Answer:

   Model states hierarchically with sub-states for exceptions and normal flow -> Option A

4. Quick Check:

   Hierarchical states = scalable and clear [OK]

Hint: Group related states hierarchically for clarity and scale [OK]

Common Mistakes:

• Using flat states causing many transitions
• Ignoring exceptions in state machine
• Oversimplifying states losing detail