collect domain event from aggregate roots when command handler is executed

Author: pgorecki

poetry.lock

@@ -28,11 +28,11 @@ click = "8.0.4"
 httpx = "^0.23.1"
 requests = "^2.28.1"
 bcrypt = "^4.0.1"
+mypy = "^1.4.1"
 
 [tool.poetry.dev-dependencies]
 poethepoet = "^0.10.0"
 pytest-cov = "^2.12.1"
-mypy = "^0.910"
 vulture = "^2.7"
 
 [build-system]

pyproject.toml

@@ -21,9 +21,7 @@ def place_bid(
     command: PlaceBidCommand, listing_repository: ListingRepository
 ) -> CommandResult:
     bidder = Bidder(id=command.bidder_id)
-    bid = Bid(bidder=bidder, max_price=Money(command.amount))
+    bid = Bid(bidder=bidder, max_price=Money(amount=command.amount))
 
     listing = listing_repository.get_by_id(command.listing_id)
     listing.place_bid(bid)
-
-    return CommandResult.success()

src/modules/bidding/application/command/place_bid.py

@@ -19,6 +19,4 @@ def retract_bid(
     bidder = Bidder(id=command.bidder_id)
 
     listing: Listing = listing_repository.get_by_id(id=command.listing_id)
-    event = listing.retract_bid_of(bidder)
-
-    return CommandResult.success(event=event)
+    listing.retract_bid_of(bidder)

src/modules/bidding/application/command/retract_bid.py

@@ -0,0 +1,4 @@
+from .notify_outbid_winner import notify_outbid_winner
+from .when_listing_is_published_start_auction import (
+    when_listing_is_published_start_auction,
+)

src/modules/bidding/application/event/__init__.py

@@ -0,0 +1,8 @@
+from modules.bidding.application import bidding_module
+from modules.bidding.domain.events import BidWasPlaced
+from seedwork.infrastructure.logging import logger
+
+
+@bidding_module.domain_event_handler
+def notify_outbid_winner(event: BidWasPlaced):
+    logger.info(f"Message from a handler: Listing {event.listing_id} was published")

src/modules/bidding/application/event/notify_outbid_winner.py

@@ -20,4 +20,3 @@ def when_listing_is_published_start_auction(
         ends_at=datetime.now() + timedelta(days=7),
     )
     listing_repository.add(listing)
-    return EventResult.success()

src/modules/bidding/application/event.py renamed to src/modules/bidding/application/event/when_listing_is_published_start_auction.py

@@ -2,10 +2,16 @@
 from datetime import datetime, timedelta
 from typing import Optional
 
+from modules.bidding.domain.events import (
+    BidWasPlaced,
+    BidWasRetracted,
+    HighestBidderWasOutbid,
+    ListingWasCancelled,
+)
 from modules.bidding.domain.rules import (
     BidCanBeRetracted,
     ListingCanBeCancelled,
-    PlacedBidMustBeGreaterOrEqualThanNextMinimumBid,
+    PriceOfPlacedBidMustBeGreaterOrEqualThanNextMinimumPrice,
 )
 from modules.bidding.domain.value_objects import Bid, Bidder, Seller
 from seedwork.domain.entities import AggregateRoot
@@ -26,18 +32,6 @@ class ListingCannotBeCancelled(DomainException):
     ...
 
 
-class BidPlacedEvent(DomainEvent):
-    ...
-
-
-class BidRetractedEvent(DomainEvent):
-    ...
-
-
-class ListingCancelledEvent(DomainEvent):
-    ...
-
-
 @dataclass(kw_only=True)
 class Listing(AggregateRoot[GenericUUID]):
     seller: Seller
@@ -61,34 +55,57 @@ def next_minimum_price(self) -> Money:
         return self.current_price + Money(amount=1, currency=self.ask_price.currency)
 
     # public commands
-    def place_bid(self, bid: Bid) -> DomainEvent:
+    def place_bid(self, bid: Bid):
         """Public method"""
         self.check_rule(
-            PlacedBidMustBeGreaterOrEqualThanNextMinimumBid(
+            PriceOfPlacedBidMustBeGreaterOrEqualThanNextMinimumPrice(
                 current_price=bid.max_price, next_minimum_price=self.next_minimum_price
             )
         )
 
+        previous_winner_id = self.highest_bid.bidder.id if self.highest_bid else None
+        current_winner_id = bid.bidder.id
+
         if self.has_bid_placed_by(bidder=bid.bidder):
             self._update_bid(bid)
         else:
             self._add_bid(bid)
 
-        return BidPlacedEvent(
-            listing_id=self.id, bidder=bid.bidder, max_price=bid.max_price
+        self.register_event(
+            BidWasPlaced(
+                listing_id=self.id,
+                bidder_id=bid.bidder.id,
+            )
         )
 
-    def retract_bid_of(self, bidder: Bidder) -> DomainEvent:
+        # if there was previous winner...
+        if previous_winner_id is not None and previous_winner_id != current_winner_id:
+            self.register_event(
+                HighestBidderWasOutbid(
+                    listing_id=self.id,
+                    outbid_bidder_id=previous_winner_id,
+                )
+            )
+
+    def retract_bid_of(self, bidder: Bidder):
         """Public method"""
         bid = self.get_bid_of(bidder)
         self.check_rule(
             BidCanBeRetracted(listing_ends_at=self.ends_at, bid_placed_at=bid.placed_at)
         )
 
         self._remove_bid_of(bidder=bidder)
-        return BidRetractedEvent(listing_id=self.id, bidder_id=bidder.id)
+        self.register_event(
+            BidWasRetracted(
+                listing_id=self.id,
+                retracting_bidder_id=bidder.id,
+                winning_bidder_id=self.highest_bid.bidder.id
+                if self.highest_bid
+                else None,
+            )
+        )
 
-    def cancel(self) -> DomainEvent:
+    def cancel(self):
         """
         Seller can cancel a listing (end a listing early). Listing must be eligible to cancelled,
         depending on time left and if bids have been placed.
@@ -100,14 +117,13 @@ def cancel(self) -> DomainEvent:
             )
         )
         self.ends_at = datetime.utcnow()
-        return ListingCancelledEvent(listing_id=self.id)
+        self.register_event(ListingWasCancelled(listing_id=self.id))
 
     def end(self) -> DomainEvent:
         """
         Ends listing.
         """
         raise NotImplementedError()
-        return []
 
     # public queries
     def get_bid_of(self, bidder: Bidder) -> Bid:
@@ -126,7 +142,7 @@ def has_bid_placed_by(self, bidder: Bidder) -> bool:
         return True
 
     @property
-    def winning_bid(self) -> Optional[Bid]:
+    def highest_bid(self) -> Optional[Bid]:
         try:
             highest_bid = max(self.bids, key=lambda bid: bid.max_price)
         except ValueError:

src/modules/bidding/domain/entities.py

@@ -1,2 +1,20 @@
-class PlacedBidIsGreaterThanCurrentWinningBid:
+from seedwork.domain.events import DomainEvent
+from seedwork.domain.value_objects import GenericUUID
+
+
+class BidWasPlaced(DomainEvent):
+    listing_id: GenericUUID
+    bidder_id: GenericUUID
+
+
+class HighestBidderWasOutbid(DomainEvent):
+    listing_id: GenericUUID
+    outbid_bidder_id: GenericUUID
+
+
+class BidWasRetracted(DomainEvent):
+    ...
+
+
+class ListingWasCancelled(DomainEvent):
     ...

src/modules/bidding/domain/events.py

@@ -6,7 +6,7 @@
 from seedwork.domain.value_objects import Money
 
 
-class PlacedBidMustBeGreaterOrEqualThanNextMinimumBid(BusinessRule):
+class PriceOfPlacedBidMustBeGreaterOrEqualThanNextMinimumPrice(BusinessRule):
     __message = "Placed bid must be greater or equal than {next_minimum_price}"
 
     current_price: Money

src/modules/bidding/domain/rules.py

@@ -18,7 +18,7 @@ def test_listing_initial_price():
         starts_at=datetime.utcnow(),
         ends_at=datetime.utcnow(),
     )
-    assert listing.winning_bid is None
+    assert listing.highest_bid is None
 
 
 @pytest.mark.unit
@@ -35,7 +35,7 @@ def test_place_one_bid():
         ends_at=datetime.utcnow(),
     )
     listing.place_bid(bid)
-    assert listing.winning_bid == Bid(Money(20), bidder=bidder, placed_at=now)
+    assert listing.highest_bid == Bid(Money(20), bidder=bidder, placed_at=now)
     assert listing.current_price == Money(10)
 
 
@@ -64,7 +64,7 @@ def test_place_two_bids_second_buyer_outbids():
     listing.place_bid(Bid(bidder=bidder2, max_price=Money(30), placed_at=now))
     assert listing.current_price == Money(15)
     assert listing.next_minimum_price == Money(16)
-    assert listing.winning_bid == Bid(Money(30), bidder=bidder2, placed_at=now)
+    assert listing.highest_bid == Bid(Money(30), bidder=bidder2, placed_at=now)
 
 
 @pytest.mark.unit
@@ -90,7 +90,7 @@ def test_place_two_bids_second_buyer_fails_to_outbid():
     listing.place_bid(Bid(bidder=bidder2, max_price=Money(20), placed_at=now))
 
     # ...but he fails. bidder1 is still a winner, but current price changes
-    assert listing.winning_bid == Bid(Money(30), bidder=bidder1, placed_at=now)
+    assert listing.highest_bid == Bid(Money(30), bidder=bidder1, placed_at=now)
     assert listing.current_price == Money(20)
 
 
@@ -109,7 +109,7 @@ def test_place_two_bids_second_buyer_fails_to_outbid_with_same_amount():
     )
     listing.place_bid(Bid(bidder=bidder1, max_price=Money(30), placed_at=now))
     listing.place_bid(Bid(bidder=bidder2, max_price=Money(30), placed_at=now))
-    assert listing.winning_bid == Bid(Money(30), bidder=bidder1, placed_at=now)
+    assert listing.highest_bid == Bid(Money(30), bidder=bidder1, placed_at=now)
     assert listing.current_price == Money(30)
 
 
@@ -129,7 +129,7 @@ def test_place_two_bids_by_same_bidder():
     listing.place_bid(Bid(max_price=Money(30), bidder=bidder, placed_at=now))
 
     assert len(listing.bids) == 1
-    assert listing.winning_bid == Bid(max_price=Money(30), bidder=bidder, placed_at=now)
+    assert listing.highest_bid == Bid(max_price=Money(30), bidder=bidder, placed_at=now)
     assert listing.current_price == Money(10)
 
 
@@ -151,7 +151,7 @@ def test_cannot_place_bid_if_listing_ended():
     )
     with pytest.raises(
         BusinessRuleValidationException,
-        match="PlacedBidMustBeGreaterOrEqualThanNextMinimumBid",
+        match="PriceOfPlacedBidMustBeGreaterOrEqualThanNextMinimumPrice",
     ):
         listing.place_bid(bid)
 

src/modules/bidding/tests/domain/test_bidding.py

@@ -32,6 +32,4 @@ def create_listing_draft(
         seller_id=command.seller_id,
     )
     repository.add(listing)
-    return CommandResult.success(
-        entity_id=listing.id, events=[ListingDraftCreatedEvent(listing_id=listing.id)]
-    )
+    return CommandResult.success(event=ListingDraftCreatedEvent(listing_id=listing.id))

src/modules/catalog/application/command/create_listing_draft.py

@@ -34,6 +34,4 @@ def delete_listing_draft(
     )
     check_rule(PublishedListingMustNotBeDeleted(status=listing.status))
     repository.remove(listing)
-    return CommandResult.success(
-        entity_id=listing.id, events=[ListingDraftDeletedEvent(listing_id=listing.id)]
-    )
+    return CommandResult.success(event=ListingDraftDeletedEvent(listing_id=listing.id))

src/modules/catalog/application/command/delete_listing_draft.py

@@ -5,7 +5,6 @@
 from modules.catalog.domain.repositories import ListingRepository
 from modules.catalog.domain.rules import OnlyListingOwnerCanPublishListing
 from modules.catalog.domain.value_objects import ListingId, SellerId
-from seedwork.application.command_handlers import CommandResult
 from seedwork.application.commands import Command
 from seedwork.domain.mixins import check_rule
 
@@ -30,9 +29,4 @@ def publish_listing_draft(
             listing_seller_id=listing.seller_id, current_seller_id=command.seller_id
         )
     )
-
-    events = listing.publish()
-
-    listing_repository.persist_all()
-
-    return CommandResult.success(entity_id=listing.id, events=events)
+    listing.publish()