Shopify / Shopify/ci-queue

Sensible Defaults for Python Redis Client

Offen
#71 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Ruby
Sterne
240
Forks
36
Ø Merge
28 Min.
Gemergte PRs (30 T.)
3

Beschreibung

By default no timeouts are set for the Redis client. It's poorly documented, but as far as I can tell, the Redis client will wait hang infinitely by default. This is not a sensible default for ci-queue clients, forcing every client to specify this value. socket_connect_timeout defaults to whatever is specified for socket_timeout, but since that is handled deep down in the Redis client and certainly not documented by ci-queue a responsible client might not rely on that.

I suggest explicitly setting sensible defaults for these two values to reduce the burden on clients.

https://github.com/Shopify/ci-queue/blob/3b7ac596016b8c569ea49a6ff80696443b2569ce/python/ciqueue/_pytest/test_queue.py#L59-L81

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit python/ciqueue/_pytest/test_queue.py etwa in den Zeilen 59-81 und untersuche die Einrichtung des Redis-Clients, um festzustellen, wo socket_timeout und socket_connect_timeout konfiguriert werden. Ermittle und dokumentiere explizite Standardwerte für beide Werte und füge dann Tests für den Queue-Client hinzu oder aktualisiere sie, um zu überprüfen, dass Clients standardmäßig nicht unbestimmte Zeit warten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python, redis
Bereich
backend, distributed-systems
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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