ProgramGuru

Gateway Aggregation Pattern

Gateway Aggregation: start from the problem

See the responsibilities

ClientRequests one dashboard
AggregatorCoordinates under a shared deadline
DependenciesReturn independent results
Combined responseReports required and optional outcomes
Client: Requests one dashboard → Aggregator: Coordinates under a shared deadline → Dependencies: Return independent results → Combined response: Reports required and optional outcomes

A dashboard needs account and order summaries. If the client coordinates many service calls, it must manage multiple addresses and partial failures. An aggregation endpoint can return a defined combined response.

This is a service boundaries pattern lesson. Follow the responsibilities, inspect the small JavaScript example and compare the design choices. The example is local teaching code; its boundary is explained before you apply the idea to a real service.

What you’ll learn

  • Explain the problem Gateway Aggregation addresses and the roles involved.
  • Follow the example and distinguish this pattern from nearby alternatives.
  • Choose when the benefit justifies the extra responsibilities and testing.

How the responsibilities work

Gateway Aggregation coordinates several downstream reads behind one client-facing operation. The response contract decides what is required, optional, stale or unavailable. Calls can run concurrently where the dependencies and budget allow it.

The local example combines two already available objects. It has no network or point-in-time snapshot guarantee. A real aggregator must name deadlines and partial results rather than implying every service answered atomically.

Follow a small example

Read the JavaScript from top to bottom and compare the expected output. The values are chosen to make this pattern’s responsibility visible. This example runs in one local execution context; it does not create remote services, durable storage or production access controls.

JavaScript · local teaching example

const account = {name: 'Mira'};
const orders = {pending: 2};
function dashboard() { return {account, orders}; }
console.log(JSON.stringify(dashboard()));

Expected output

{"account":{"name":"Mira"},"orders":{"pending":2}}

Choose a design and inspect the consequence

Compare the design choices

Four downstream reads share a one-second endpoint target.
Each dashboard triggers hundreds of tiny calls.

Compare the visible consequences. With JavaScript enabled, choose an option in each scenario to assemble your decision record.

This is an exploratory design exercise. It does not run infrastructure, measure capacity or replace the lesson’s quiz.

Use the consequences to explain your decision, including the simpler alternative.

Apply the pattern to two situations. Select one option in each situation to build a decision record. Every option and its consequence stays visible, and you can change your choices.

When it helps—and what it costs

Use it when combining several requests improves a client interaction and a suitable server boundary can own the latency and failure contract.

The aggregator can become a bottleneck and a failure amplifier. Avoid unbounded fan-out, N+1 calls and independent full-duration timeouts. Combined reads are not automatically a transactionally consistent snapshot.

Distinguish the neighbouring patterns

BFF chooses a client-specific interface. Aggregation combines sources. CQRS can precompute a query view to reduce runtime fan-out, but adds its own update and freshness work.

Follow client-experience boundaries, precomputed query models, the total response budget to compare the specific responsibility before combining patterns.

For further reading, use Microsoft’s Gateway Aggregation guidance. Compare it with this original example and the guarantee required by your application.

Check your pattern reasoning

If an optional recommendation call times out, what should decide the response?
Choose one answer. You can try again.

Answer and explanation

The documented partial-result contract.

The product decides whether that part can be missing.

Check your pattern reasoning

Do combined service reads imply a single database snapshot?
Choose one answer. You can try again.

Answer and explanation

No; consistency must be supplied by an explicit mechanism.

One response envelope does not create a transaction.

Name the responsibility before choosing the pattern

For Gateway Aggregation, describe the problem, the participating roles and the observable contract. Use the example as a starting point and test the boundaries identified in the trade-offs. A pattern name alone does not establish correctness or performance.

Return to the design-pattern guide to compare families, or apply the idea alongside the total response budget.

Reaching the recap and completing the quizzes are separate milestones.

    Next lesson: Anti-Corruption Layer Pattern →