storage 9.0.0: retries never stop and run about 1 ms apart (maxRetries ignored, delays read as milliseconds)

Offen
#9,871 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
52/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
nodejs, typescript
Bereich
api

Rechercherichtung

Start in the StorageTransport makeRequest method, where the retryConfig object is built from maxRetries and retryOptions (src/storage-transport.ts, compiled to build/cjs/src/storage-transport.js). Check how the shouldRetry wrapper ignores the attempt count, and whether maxRetryDelay and totalTimeout are passed to gaxios in seconds when gaxios expects milliseconds. Run the reproduction script with a local server that returns 503. Done when the call rejects after about 4 requests and roughly 15 seconds, and no TimeoutNegativeWarning appears.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Package: @google-cloud/storage (handwritten/storage)

Environment

  • @google-cloud/storage 9.0.0 (gaxios 8.3.3, google-auth-library 11.3.4)
  • Node 26.5.1 (same under Bun 1.4)
  • 8.0.0 behaves as documented with the same script

Steps to reproduce

A local server that always answers 503, so no bucket or credentials are needed:

import http from "node:http";
import { Storage } from "@google-cloud/storage";
import { JWT } from "google-auth-library";

let hits = 0;
const server = http.createServer((req, res) => {
  hits++;
  res.writeHead(503, { "content-type": "application/json" });
  res.end('{"error":{"code":503,"message":"down"}}');
});
await new Promise((r) => server.listen(0, "127.0.0.1", r));

const authClient = new JWT({ email: "[email protected]", key: "fake" });
authClient.credentials = { access_token: "t", expiry_date: Date.now() + 3600e3 };
const storage = new Storage({ projectId: "p", authClient, apiEndpoint: `http://127.0.0.1:${server.address().port}` });

const t0 = Date.now();
const outcome = await Promise.race([
  storage.bucket("b").file("o").getMetadata().then(() => "resolved", (e) => `rejected code=${e.code}`),
  new Promise((r) => setTimeout(() => r("still pending"), 8000)),
]);
console.log({ outcome, ms: Date.now() - t0, requests: hits });
process.exit(0);

Actual (9.0.0)

TimeoutNegativeWarning: -2 is a negative number.
Timeout duration was set to 1.
{ outcome: 'still pending', ms: 8001, requests: 5039 }

The call never settles and sends about 600 requests per second. The same happens for a 429 on an idempotent upload (file.save(buffer, { resumable: false, preconditionOpts: { ifGenerationMatch: 0 } })), and a refused connection is still pending after 20 s.

Expected (8.0.0)

{ outcome: 'rejected code=503', ms: 15430, requests: 4 }

maxRetries (default 3) with exponential backoff, as retryOptions documents.

Cause

In StorageTransport.makeRequest (build/cjs/src/storage-transport.js):

retryConfig: {
    retry: maxRetries,
    noResponseRetries: maxRetries,
    maxRetryDelay: this.retryOptions.maxRetryDelay,
    retryDelayMultiplier: this.retryOptions.retryDelayMultiplier,
    totalTimeout: this.retryOptions.totalTimeout,
    shouldRetry: (err) => !isRetryDisabled && !!this.retryOptions.retryableErrorFn?.(err),
},
  1. No retry cap. In gaxios, retry and noResponseRetries are only enforced inside the default shouldRetryRequest. Passing a custom shouldRetry replaces that function (config.shouldRetry || shouldRetryRequest), and the custom one never looks at currentRetryAttempt, so retries continue for as long as the error is retryable.
  2. Seconds passed as milliseconds. maxRetryDelay (64) and totalTimeout (600) are documented in seconds, and resumable-upload.js multiplies them by 1000, but gaxios reads them as milliseconds. The backoff is therefore capped at 64 ms, and once 600 ms have passed totalTimeout - elapsed is negative, which is where the TimeoutNegativeWarning and the 1 ms delay come from.

Impact

During a 5xx or 429 incident, or a network failure, every idempotent call hangs until the caller's own deadline while sending hundreds of requests per second to the API, instead of failing after about 15 seconds.

Suggested fix

Enforce the attempt cap in the shouldRetry wrapper (for example err.config.retryConfig.currentRetryAttempt < maxRetries), and convert maxRetryDelay and totalTimeout to milliseconds when building the gaxios retryConfig.

Vorherrschende Sprache
TypeScript
Sterne
3.2k
Forks
732
Ø Merge
2 T. 11 Std.
Gemergte PRs (30 T.)
99

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus googleapis/google-cloud-node

Alle Issues in googleapis/google-cloud-node

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.