← Recipes

阅读中文版本

Distribute a Timeout Budget Across Hops

Subtract each hop's elapsed time from the total budget so the last hop gets the remainder not a fresh full timeout.

~20 minapitimeoutbudget

Task

Implement const remaining = deadline - (Date.now() - start); call下游({ timeout: remaining }); 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 remaining = deadline - (Date.now() - start); call下游({ timeout: remaining }); 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 remaining = deadline - (Date.now() - start); call下游({ timeout: remaining }); in the project configuration file with the recommended defaults.

const remaining = deadline - (Date.now() - start); call下游({ timeout: remaining });

Expected output: The configuration is accepted and const remaining = deadline - (Date.now() - start); call下游({ timeout: remaining }); runs without errors on the first invocation.

2. Run the check locally to verify const remaining = deadline - (Date.now() - start); call下游({ timeout: remaining }); 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 remaining = deadline - (Date.now() - start); call下游({ timeout: remaining }); blocks merge on failure.

- name: Run add timeout budget per hop
  run: pnpm test

Expected output: Pull requests with failing const remaining = deadline - (Date.now() - start); call下游({ timeout: remaining }); 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. Subtract each hop’s elapsed time from the total budget so the last hop gets the remainder not a fresh full timeout. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run const remaining = deadline - (Date.now() - start); call下游({ timeout: remaining }); against the current codebase and inspect the output before wiring it into CI.

const remaining = deadline - (Date.now() - start); call下游({ timeout: remaining });

Verify graceful degradation

Once the gate is in place, make failures actionable. A failing const remaining = deadline - (Date.now() - start); call下游({ timeout: remaining }); 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.