StackStorm/st2

Retry logic for 'st2client' and 'st2 pack'

Open

#3257 opened on Feb 27, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5,794 stars) (740 forks)batch import
enhancementgood first issue

Description

Improvement from the https://github.com/StackStorm/st2-packages/issues/429

Most of the networking-related logic needs retrying mechanism. This is a rule of dumb in any package manager/client since in reality failures occur pretty frequently.

StackStorm shouldn't be an exception in following more reliable strategy.

TODO

  1. Add retry, timeout, delay-on-retry logic to st2client httpclient
  2. st2 pack retry logic for git cloning and any networking-related requests.

Resources

Contributor guide

Tech stack
python
Domain
clibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Pythonrequests libraryHTTP basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the HTTP client in st2client/utils/httpclient.py and add retry logic using requests' HTTPAdapter with Retry. Also update pack management functions in contrib/packs/actions/pack mgmt/download.py and st2common/st2common/services/packs.py to apply retries for git cloning and networking. Use the resources provided: requests documentation and adapters. The goal is to implement exponential backoff with configurable retries and timeouts.