Phase 26 · Lesson 07

TanStack Query Integration

≈ 2 min core reading · 206 source/companion words
Learning contract

What you should be able to do after this

  • Explain TanStack Query Integration without relying on framework buzzwords.
  • Connect the lesson to the phase outcome: Add realtime synchronization without creating a second source of truth or leaking unauthorized events.
  • Reproduce the relevant behavior and verify it with evidence.
  • Diagnose at least one representative failure instead of guessing.
Figure 26.7 — TaskFlow boundary map
database/event source
Supabase Realtime channel
authorized/scoped subscription
event handler
query cache reconcile
UI
This lesson belongs to Phase 26. Keep the full request/data path visible even when today's code changes only one box.
Instructor workflow: predict first → implement the smallest slice → run it → inspect evidence → break one assumption → diagnose → explain it back. Do not copy the whole code block before understanding the first failing boundary.

TanStack Query Integration: Invalidate First, Patch Selectively Volume 07 - Advanced Application Architecture

Default strategy Realtime event + TanStack Query

Broadcast event Handler invalidateQueries API INSERT/UPDATE/DELETE small + idempotent taskKeys.all refetch

Why invalidate first? The backend already owns authorization, filters, pagination and derived state.

Patch the cache directly only when the event contract is stable and the update is easy to prove correct.

Why invalidate is the safe default • NestJS already owns authorization and business rules.

• Phase 15 already owns search, filters, sorting, pagination and metadata.

• Phase 25 already owns optimistic local UX for the current user.

• A Realtime event can simply mark cached Task data stale and let the API rebuild the correct view.

Targeted invalidation options // Simple and safe: queryClient.invalidateQueries({ queryKey: taskKeys.all, })

// Narrower when the event contract gives a reliable Task id: queryClient.invalidateQueries({ queryKey: taskKeys.detail(taskId), }) queryClient.invalidateQueries({ queryKey: taskKeys.lists(), })

When direct cache patching is justified Patch with setQueryData only when the event schema is stable, the update is easy to prove correct, and you are not rebuilding authorization/filter/pagination logic in the browser. Otherwise invalidate.

Burst events A later optimization may debounce/coalesce invalidations for high-frequency streams. Start correct first, then measure network churn before adding complexity.

Executable lesson studio · query

Now turn the explanation into engineering skill.

TanStack Query is a server-state synchronization system, not merely a fetch helper. Cache identity, freshness, invalidation, and mutation semantics are the core model.

By the end, you should be able to

  • Explain TanStack Query Integration in terms of concrete inputs, ownership, outputs, and evidence.
  • Implement or reproduce the smallest TaskFlow slice that demonstrates this query concept.
  • Diagnose one representative query failure using observable evidence instead of trial-and-error.
Figure 26.7B — Mental model
component
query key
cache state
fetch/mutation
reconciliation
Read left-to-right while implementing. When debugging, walk right-to-left until the first observed fact differs from your prediction.
Code-along sequence

One coherent change at a time

  1. 01

    Restate the goal of “TanStack Query Integration” as one observable behavior. Write the success signal before touching code.

  2. 02

    Trace the boundary map: component → query key → cache state → fetch/mutation → reconciliation. Mark the one boundary this lesson changes.

  3. 03

    Inspect the current repository state and record the exact files, route, table, or runtime involved. Avoid creating an abstraction before you can name the existing owner.

  4. 04

    Implement the smallest vertical slice. Add one coherent change, run the narrowest verification command, and read the output before continuing.

  5. 05

    Connect the slice to TaskFlow’s phase artifact: Realtime task updates that merge into TanStack Query state with scoped subscriptions and reconnect behavior.. Verify behavior from the outside as a user or API client would.

  6. 06

    Create one controlled failure that is safe to reproduce. Predict the symptom first, capture evidence, locate the earliest broken boundary, then fix only that cause.

  7. 07

    Close the reference and rebuild or explain the core change from memory. Record what you would monitor or test before trusting the same change in production.

tsCache identity should mirror resource identity
export const taskKeys = {
  all: ["tasks"] as const,
  list: (filters: TaskFilters) => ["tasks", "list", filters] as const,
  detail: (id: string) => ["tasks", "detail", id] as const,
};

Do not copy this as a finished answer. Predict what each boundary does, type the smallest useful slice, run it, then compare the result with your prediction.

Verification

Prove the happy path

  1. Run the narrowest relevant command or request and require a clean exit/status.
  2. Inspect the boundary-specific evidence: terminal output, Network panel, database row/query plan, test report, container health, or deployment logs.
  3. Repeat the behavior once after the change so a one-off cached or stale result cannot masquerade as success.
Break it on purpose

Build debugging memory

  1. Events for other tenants visible to a client
  2. Change one assumption in the query example—identity, input, configuration, ordering, connectivity, or state—and predict the exact symptom before running it.
SymptomInvestigation path
Expected result does not appear

Return to the nearest observable boundary: input, network, process log, database, or rendered UI. Compare actual evidence with the predicted path.

A shortcut appears to fix it

Change one variable at a time and reproduce the original failure after the fix; otherwise you have correlation, not diagnosis.

Closed-reference challenge

Can you transfer the idea?

Without copying the final source, create a second small scenario that applies “TanStack Query Integration” to a different TaskFlow resource or input. Write the acceptance criteria first, implement it, and provide the evidence that each criterion is satisfied.

Explain-back

Answer these without reopening the solution

  1. What problem does TanStack Query Integration solve in TaskFlow, and what would be observably wrong without it?
  2. Which part of the query boundary owns the decision, and which neighboring layer must not own it?
  3. What evidence proves the happy path instead of merely suggesting it worked?
  4. Name one realistic failure or abuse case and the first place you would inspect.
  5. If requirements doubled tomorrow, which part of this design should stay stable and which part is allowed to change?
Lesson studio

Turn the reading into skill

01

Do it

Choose the exact collaborative event that benefits from realtime rather than subscribing to everything.

Use the smallest change that demonstrates this lesson. Stop after it works and capture evidence.
02

Break it safely

Events for other tenants visible to a client

Predict the symptom before causing the failure. Then locate the earliest boundary where reality diverges from expectation.
03

Explain it back

Why does this responsibility live here, what input does it trust, what output proves success, and what would go wrong if another layer owned it?

If your explanation is vague, repeat the boundary trace before moving on.
Exit ticket

Before marking complete

Close the reference. Reproduce the core idea from memory or explain the exact request/data flow aloud. Then check your diff or notes for accidental shortcuts that bypass validation, authorization, error handling, or verification earned in earlier phases.