Skip to content

Add Event-Driven Architecture BRD (Ask 3 proposal) - #1029

Open
NannerySlalom wants to merge 6 commits into
dotnet:mainfrom
tdurkota:feature/event-driven-architecture-propsoal
Open

NannerySlalom wants to merge 6 commits into
dotnet:mainfrom
tdurkota:feature/event-driven-architecture-propsoal

Conversation

@NannerySlalom

Copy link
Copy Markdown

w00t sauce

Copilot AI lite review requested due to automatic review settings September 14, 2026 19:22
@dotnet-policy-service

Copy link
Copy Markdown

@NannerySlalom please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@dotnet-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@dotnet-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Unresolved issues affect event contracts, tenancy, inventory semantics, delivery reliability, and acceptance criteria.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Adds a BRD proposing a phased event-driven architecture rollout for the eShop.

Changes:

  • Defines infrastructure, event contracts, subscriptions, and persistence epics.
  • Adds roadmap, success criteria, staffing, and risk mitigations.
File summaries
File Description
EVENT_DRIVEN_ARCHITECTURE_BRD.md Documents the proposed event-driven architecture and delivery plan.
Review details

Suppressed comments (5)

EVENT_DRIVEN_ARCHITECTURE_BRD.md:107

  • The stated persistence/replay criteria are insufficient for subscriber recovery. The existing IntegrationEventLogService is a publisher-side outbox tied to the originating transaction, while RabbitMQEventBus has no per-subscriber delivery state and acknowledges the message even when a handler throws. An event log alone therefore cannot replay a failed subscriber or support onboarding. Specify durable retention, subscriber delivery/attempt state, DLQ/retry/ack semantics, and a replay operation.
**Acceptance Criteria:**
- Generic event handler pattern available to all services
- Webhooks.API enhanced to subscribe to and forward events to external partners
- Event payload transformation/mapping examples

EVENT_DRIVEN_ARCHITECTURE_BRD.md:172

  • Production event emission is scheduled in Phases 1–2, but the outbox/replay capability relied on by the risk mitigation is not operational until Phase 3. The current code already has direct publishers such as PaymentProcessor, and the RabbitMQ consumer acknowledges failed handlers, so broker or consumer failures before Phase 3 can permanently lose events. Make durability/retry a prerequisite for the first production events, or explicitly defer the reliability claim until Phase 3.

---

EVENT_DRIVEN_ARCHITECTURE_BRD.md:58

  • The without blocking order service requirement is not met by the current path: TransactionBehavior awaits PublishEventsThroughEventBusAsync after committing, and that method awaits the RabbitMQ publish/retry path inline. An outbox entry alone is not non-blocking until a background dispatcher exists; make that dispatcher part of Epic 3, or narrow the criterion to subscriber handling and add an outage-latency test.
- Example events from Order, Catalog, Basket, and Payment domains

EVENT_DRIVEN_ARCHITECTURE_BRD.md:184

  • The reliability target is not actionable or supported by the current delivery semantics. The RabbitMQ consumer acknowledges messages even when handler processing throws (src/EventBusRabbitMQ/RabbitMQEventBus.cs:159-180), while the outbox marks publish failures as PublishedFailed; an outbox/replay claim alone does not guarantee subscriber delivery. Define the SLO scope and at-least-once/exactly-once semantics, and require failed deliveries to remain recoverable through requeue or a DLQ.
**Phase 2 (Weeks 5–7): Catalog, Payment, Fulfillment Events**

EVENT_DRIVEN_ARCHITECTURE_BRD.md:195

  • outbox pattern ensures no event loss overstates the mitigation. An outbox protects the producer transaction-to-message handoff, but broker replication, consumer retry/DLX, and replay are still needed; the current consumer acknowledges messages after handler exceptions rather than dead-lettering them. Separate producer durability from broker/subscriber recovery in this risk mitigation.
- Success metric: New developers can emit an event end-to-end
  • Files reviewed: 1/1 changed files
  • Comments generated: 7
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +37 to +41
- Event contract library established (shared types across services)
- Versioning strategy defined (backward compatibility rules)
- Documentation template for event payloads (schema registry or OpenAPI extension)
- Example events from Order, Catalog, Basket, and Payment domains
- Contract testing framework in place
Comment on lines +71 to +75
- PaymentProcessed, PaymentFailed events from Payment Processor
- InventoryReserved, InventoryReleased events from Catalog/Basket
- Fulfillment status events from OrderProcessor
- All events follow established contract patterns (Epic 2)
- End-to-end integration tests
- Generic event handler pattern available to all services
- Webhooks.API enhanced to subscribe to and forward events to external partners
- Event payload transformation/mapping examples
- Retry and idempotency logic documented

**Phase 1 (Weeks 3–4): Order Event Emission**
- Epic 3: OrderCreated, OrderStatusChanged events flowing
- Success metric: External systems (webhooks) receive order events in real-time
Comment on lines +20 to +24
- Message broker (RabbitMQ, Azure Service Bus, or equivalent) provisioned and running
- Event bus abstraction layer added to `eShop.ServiceDefaults`
- Publisher/subscriber patterns documented and tested
- Local dev environment supports event broker (Docker Compose or Aspire integration)
- Monitoring and dead-letter queue strategy in place
Comment on lines +54 to +58
- OrderCreated, OrderStatusChanged, OrderFailed, OrderShipped events published
- Events include order ID, customer ID, affected items, timestamps
- Existing Order API behavior unchanged; events fire alongside current logic
- Integration tests verify event publication
- Events flow to downstream subscribers without blocking order service
Comment on lines +183 to +184
1. **Real-time capability:** Downstream systems receive events within <500ms of domain event occurrence
2. **Reliability:** 99.9% event delivery guarantee (with replay/outbox guarantees)
Provide .env.example with required test credentials and optional custom base URL configuration. Default test users are alice/bob with password Pass123$. Supports PLAYWRIGHT_BASE_URL override for testing against non-default deployments.
- Add PLAYWRIGHT_BASE_URL environment variable support for running tests against custom deployments
- Auto-enable ignoreHTTPSErrors when using HTTPS URLs (self-signed certificates)
- Skip AppHost startup when custom base URL is provided (assumes server already running)
- Maintain default localhost:5045 behavior when no custom URL specified
- Remove commented-out browser configurations for clarity
- Fixes issue where tests could only run against localhost:5045
- Replace actual passwords with placeholders (your_test_username, your_test_password)
- Add clear documentation on where to find default test credentials
- Reference UsersSeed.cs for Identity.API seed configuration
- Update README with comprehensive E2E test setup instructions
- Document how to run tests with custom base URL for remote deployments
- Best practice: Never commit actual credentials to version control, even for tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants