← Recipes

阅读中文版本

Fix GraphQL N+1 with DataLoader

Batch per-request data loads with DataLoader so a list of 50 items fetches their authors in one query not 50.

~25 minapigraphqldataloader

Task

Implement const userLoader = new DataLoader(ids => db.users.findMany({ where: { id: { in: ids } } })); so the service degrades gracefully under failure instead of cascading timeouts to callers.

When to use this

A downstream service slows down and without const userLoader = new DataLoader(ids => db.users.findMany({ where: { id: { in: ids } } })); the upstream exhausts its thread pool in 12 seconds.

Prerequisites

  • A service with inter-service calls or external dependencies
  • A retry or circuit breaker library available

Steps

1. Configure const userLoader = new DataLoader(ids => db.users.findMany({ where: { id: { in: ids } } })); in the project configuration file with the recommended defaults.

const userLoader = new DataLoader(ids => db.users.findMany({ where: { id: { in: ids } } }));

Expected output: The configuration is accepted and const userLoader = new DataLoader(ids => db.users.findMany({ where: { id: { in: ids } } })); runs without errors on the first invocation.

2. Run the check locally to verify const userLoader = new DataLoader(ids => db.users.findMany({ where: { id: { in: ids } } })); produces the expected result before pushing.

pnpm test

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so const userLoader = new DataLoader(ids => db.users.findMany({ where: { id: { in: ids } } })); blocks merge on failure.

- name: Run add graphql n+1 dataloader
  run: pnpm test

Expected output: Pull requests with failing const userLoader = new DataLoader(ids => db.users.findMany({ where: { id: { in: ids } } })); are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

  • The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
  • Configuration drift is possible if someone edits settings outside version control.

Isolate failure

Start by measuring the problem. Batch per-request data loads with DataLoader so a list of 50 items fetches their authors in one query not 50. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run const userLoader = new DataLoader(ids => db.users.findMany({ where: { id: { in: ids } } })); against the current codebase and inspect the output before wiring it into CI.

const userLoader = new DataLoader(ids => db.users.findMany({ where: { id: { in: ids } } }));

Verify graceful degradation

Once the gate is in place, make failures actionable. A failing const userLoader = new DataLoader(ids => db.users.findMany({ where: { id: { in: ids } } })); should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.