Command pattern for undo in LLD - Architecture Diagram

System Overview - Command pattern for undo

The system implements the Command design pattern to support undo functionality. It allows users to execute commands that change the system state and then undo those changes step-by-step.

Key requirements include tracking executed commands, reversing their effects, and maintaining a history stack for undo operations.

Architecture Diagram

User
  |
  v
Invoker (Command Manager)
  |
  v
+-----------------+      +----------------+
| ConcreteCommand  | ---> | Receiver       |
| (Execute/Undo)   |      | (Performs work)|
+-----------------+      +----------------+
  |
  v
Command History Stack

Components

User

actor

Initiates commands to change system state

Invoker (Command Manager)

service

Receives commands from user, executes them, and manages undo stack

ConcreteCommand

command

Encapsulates a request with execute and undo methods

Receiver

service

Performs the actual work requested by commands

Command History Stack

storage

Stores executed commands to enable undo operations

Request Flow - 8 Hops

User → Invoker (Command Manager)

Invoker (Command Manager) → ConcreteCommand

ConcreteCommand → Receiver

Invoker (Command Manager) → Command History Stack

User → Invoker (Command Manager)

Invoker (Command Manager) → Command History Stack

Invoker (Command Manager) → ConcreteCommand

ConcreteCommand → Receiver

Failure Scenario

Component Fails:Command History Stack

Impact:Undo operations fail because command history is lost or corrupted

Mitigation:Implement persistent storage or backup for command history; notify user of undo unavailability

Architecture Quiz - 3 Questions

Which component is responsible for executing and undoing commands?

A ConcreteCommand

B Receiver

C Invoker (Command Manager)

D Command History Stack

Design Principle

This architecture cleanly separates command invocation, execution, and undo logic. The Command pattern encapsulates requests as objects, enabling flexible undo by storing commands in a history stack. This design promotes loose coupling and easy extension.

Practice

1. What is the main purpose of the Command pattern in the context of undo functionality?

easy

A. To replace all conditional statements with loops

B. To directly modify the user interface without storing history

C. To store data in a database for permanent record

D. To encapsulate actions as objects with execute and undo methods

Solution

1. Step 1: Understand the role of Command pattern

   The Command pattern wraps actions as objects, allowing them to be executed and undone independently.

2. Step 2: Relate to undo functionality

   This wrapping enables storing commands in a history stack, so undo can call the undo method on the last command.

3. Final Answer:

   To encapsulate actions as objects with execute and undo methods -> Option D

4. Quick Check:

   Command pattern = encapsulate actions for undo [OK]

Hint: Command pattern wraps actions for undo/redo [OK]

Common Mistakes:

• Thinking Command pattern modifies UI directly
• Confusing Command pattern with data storage
• Assuming it replaces loops or conditionals

2. Which method signature correctly belongs to a Command interface supporting undo?

easy

A. void save(); void load();

B. void execute(); void undo();

C. void start(); void finish();

D. void run(); void stop();

Solution

1. Step 1: Identify standard Command interface methods

   The Command pattern typically defines an execute() method to perform the action and an undo() method to reverse it.

2. Step 2: Match method signatures

   Only void execute(); void undo(); has execute() and undo(), matching the Command pattern for undo.

3. Final Answer:

   void execute(); void undo(); -> Option B

4. Quick Check:

   Command methods = execute and undo [OK]

Hint: Look for execute() and undo() methods [OK]

Common Mistakes:

• Choosing unrelated method names like run/stop
• Confusing start/finish with undo functionality
• Assuming save/load are Command methods

3. Given the following code snippet, what will be the output after calling undo() on the last command?

class AddCommand:
    def __init__(self, value, receiver):
        self.value = value
        self.receiver = receiver
    def execute(self):
        self.receiver.total += self.value
    def undo(self):
        self.receiver.total -= self.value

class Receiver:
    def __init__(self):
        self.total = 0

receiver = Receiver()
cmd1 = AddCommand(5, receiver)
cmd2 = AddCommand(3, receiver)
cmd1.execute()
cmd2.execute()
cmd2.undo()
print(receiver.total)

medium

A. 5

B. 8

C. 3

D. 0

Solution

1. Step 1: Trace command executions

   Initially, receiver.total = 0. After cmd1.execute(), total = 0 + 5 = 5. After cmd2.execute(), total = 5 + 3 = 8.

2. Step 2: Apply undo on cmd2

   cmd2.undo() subtracts 3, so total = 8 - 3 = 5.

3. Final Answer:

   5 -> Option A

4. Quick Check:

   Execute adds, undo subtracts = 5 [OK]

Hint: Undo reverses last execute effect on total [OK]

Common Mistakes:

• Forgetting to subtract on undo
• Assuming undo resets total to zero
• Mixing order of execute and undo

4. Identify the bug in this undo implementation of a Command pattern:

class MultiplyCommand:
    def __init__(self, value, receiver):
        self.value = value
        self.receiver = receiver
        self.prev = None
    def execute(self):
        self.prev = self.receiver.total
        self.receiver.total *= self.value
    def undo(self):
        self.receiver.total /= self.value

receiver = type('Receiver', (), {'total': 10})()
cmd = MultiplyCommand(2, receiver)
cmd.execute()
cmd.undo()
print(receiver.total)

medium

A. Execute should add instead of multiply

B. Undo method is missing

C. Undo should restore previous value, not divide

D. Receiver class is not defined

Solution

1. Step 1: Analyze execute and undo methods

   Execute saves previous total and multiplies current total by value. Undo divides total by value.

2. Step 2: Identify problem with undo

   Undo divides by value, but if value is zero or changed, this may not restore original total exactly. It should restore saved previous total instead.

3. Final Answer:

   Undo should restore previous value, not divide -> Option C

4. Quick Check:

   Undo must restore saved state, not recalculate [OK]

Hint: Undo must restore saved state, not recalculate [OK]

Common Mistakes:

• Assuming division always reverses multiplication
• Not saving previous state before execute
• Ignoring edge cases like zero multiplication

5. You are designing a text editor with undo using the Command pattern. Which approach best supports multiple undo and redo operations efficiently?

hard

A. Use two stacks: one for undo commands, one for redo commands

B. Store all commands in a single list without pointers

C. Only keep the last command for undo, discard others

D. Save full document snapshots after each command

Solution

1. Step 1: Understand undo/redo requirements

   Undo reverses last command, redo reapplies commands undone. Efficient support requires tracking both undo and redo history.

2. Step 2: Evaluate data structures

   Two stacks allow pushing commands on execute, popping for undo, and pushing undone commands to redo stack. This supports multiple undo/redo efficiently.

3. Final Answer:

   Use two stacks: one for undo commands, one for redo commands -> Option A

4. Quick Check:

   Two stacks = efficient undo/redo [OK]

Hint: Two stacks handle undo and redo efficiently [OK]

Common Mistakes:

• Using single list without tracking position
• Keeping only last command loses history
• Saving full snapshots wastes memory