ghstack 0.16.0__tar.gz → 0.17.0__tar.gz

{ghstack-0.16.0 → ghstack-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ghstack
-Version: 0.16.0
+Version: 0.17.0
 Summary: Stack diff support for GitHub
 Author: Edward Z. Yang
 Author-email: Edward Z. Yang <ezyang@mit.edu>

{ghstack-0.16.0 → ghstack-0.17.0}/pyproject.toml

@@ -16,7 +16,7 @@ dependencies = [
     "flake8<8.0.0,>=7.0.0",
 ]
 name = "ghstack"
-version = "0.16.0"
+version = "0.17.0"
 description = "Stack diff support for GitHub"
 readme = "README.md"
 classifiers = [

{ghstack-0.16.0 → ghstack-0.17.0}/src/ghstack/cli.py

@@ -61,6 +61,8 @@ def cli_context(
             oauth_token=config.github_oauth,
             proxy=config.proxy,
             github_url=config.github_url,
+            max_retries=config.max_retries,
+            initial_backoff_seconds=config.initial_backoff_seconds,
         )
         yield shell, config, github
 

{ghstack-0.16.0 → ghstack-0.17.0}/src/ghstack/config.py

@@ -111,6 +111,11 @@ Config = NamedTuple(
         ("reviewer", Optional[str]),
         # Default labels to add to new pull requests (comma-separated labels)
         ("label", Optional[str]),
+        # Retry/backoff tuning
+        ("max_retries", int),
+        # The initial backoff time to use, in seconds.  We will double this
+        # time for each retry.
+        ("initial_backoff_seconds", int),
         # Command to generate a per-PR update description from diff contents
         ("automsg", Optional[str]),
     ],
@@ -334,6 +339,16 @@ def read_config(
     else:
         automsg = None
 
+    if config.has_option("ghstack", "max_retries"):
+        max_retries = config.getint("ghstack", "max_retries")
+    else:
+        max_retries = 5
+
+    if config.has_option("ghstack", "initial_backoff_seconds"):
+        initial_backoff_seconds = config.getint("ghstack", "initial_backoff_seconds")
+    else:
+        initial_backoff_seconds = 60
+
     if write_back:
         with open(config_path, "w") as f:
             config.write(f)
@@ -351,6 +366,8 @@ def read_config(
         remote_name=remote_name,
         reviewer=reviewer,
         label=label,
+        max_retries=max_retries,
+        initial_backoff_seconds=initial_backoff_seconds,
         automsg=automsg,
     )
     logging.debug(f"conf = {conf}")

{ghstack-0.16.0 → ghstack-0.17.0}/src/ghstack/github_real.py

@@ -13,9 +13,6 @@ import aiohttp
 
 import ghstack.github
 
-MAX_RETRIES = 5
-INITIAL_BACKOFF_SECONDS = 60
-
 
 class RealGitHubEndpoint(ghstack.github.GitHubEndpoint):
     """
@@ -61,6 +58,9 @@ class RealGitHubEndpoint(ghstack.github.GitHubEndpoint):
     cert: Optional[Union[str, Tuple[str, str]]]
     _session: Optional[aiohttp.ClientSession]
 
+    max_retries: int
+    initial_backoff_seconds: int
+
     def __init__(
         self,
         oauth_token: Optional[str],
@@ -68,12 +68,16 @@ class RealGitHubEndpoint(ghstack.github.GitHubEndpoint):
         proxy: Optional[str] = None,
         verify: Optional[Union[str, bool]] = None,
         cert: Optional[Union[str, Tuple[str, str]]] = None,
+        max_retries: int = 5,
+        initial_backoff_seconds: int = 60,
     ):
         self.oauth_token = oauth_token
         self.proxy = proxy
         self.github_url = github_url
         self.verify = verify
         self.cert = cert
+        self.max_retries = max_retries
+        self.initial_backoff_seconds = initial_backoff_seconds
         self._rest_request_ids = itertools.count(1)
         self._session = None
 
@@ -212,11 +216,11 @@ class RealGitHubEndpoint(ghstack.github.GitHubEndpoint):
         if aiohttp_ssl is not None:
             request_kwargs["ssl"] = aiohttp_ssl
 
-        backoff_seconds = INITIAL_BACKOFF_SECONDS
+        backoff_seconds = self.initial_backoff_seconds
         request_id = next(self._rest_request_ids)
         log_prefix = f"rest[{request_id}]"
         session = self._get_session()
-        for attempt in range(0, MAX_RETRIES):
+        for attempt in range(0, self.max_retries):
             logging.debug("# %s %s %s", log_prefix, method, url)
             logging.debug(
                 "%s request body:\n%s", log_prefix, json.dumps(kwargs, indent=1)
@@ -224,12 +228,11 @@ class RealGitHubEndpoint(ghstack.github.GitHubEndpoint):
 
             async with getattr(session, method)(url, **request_kwargs) as resp:
                 logging.debug("%s response status: %s", log_prefix, resp.status)
+                resp_text = await resp.text()
                 try:
-                    r = await resp.json()
-                except (aiohttp.ContentTypeError, ValueError):
-                    logging.debug(
-                        "%s response body:\n%s", log_prefix, await resp.text()
-                    )
+                    r = json.loads(resp_text)
+                except ValueError:
+                    logging.debug("%s response body:\n%s", log_prefix, resp_text)
                     raise
                 else:
                     pretty_json = json.dumps(r, indent=1)
@@ -240,32 +243,32 @@ class RealGitHubEndpoint(ghstack.github.GitHubEndpoint):
                 if resp.status in (403, 429):
                     remaining_count = resp.headers.get("x-ratelimit-remaining")
                     reset_time = resp.headers.get("x-ratelimit-reset")
+                    more_attempts = attempt < self.max_retries - 1
 
                     if remaining_count == "0" and reset_time:
-                        sleep_time = int(reset_time) - int(time.time())
-                        logging.warning(
-                            f"Rate limit exceeded. Sleeping until reset in {sleep_time} seconds."
-                        )
-                        await asyncio.sleep(sleep_time)
-                        continue
+                        sleep_time = max(0, int(reset_time) - int(time.time()))
+                        if more_attempts:
+                            logging.warning(
+                                f"Rate limit exceeded. Sleeping until reset in {sleep_time} seconds."
+                            )
+                            await asyncio.sleep(sleep_time)
+                            continue
                     # GitHub doesn't document the content of these messages, but this
                     # seems to be an accurate way to find secondary rate limits.  Any
                     # other reason for 403 or 429 will fall through to the error below.
-                    elif b"rate limit" in resp.content.lower():
+                    elif "rate limit" in resp_text.lower():
                         retry_after_seconds = resp.headers.get("retry-after")
                         if retry_after_seconds:
                             sleep_time = int(retry_after_seconds)
-                            logging.warning(
-                                f"Secondary rate limit hit. Sleeping for {sleep_time} seconds."
-                            )
                         else:
                             sleep_time = backoff_seconds
+                            backoff_seconds *= 2
+                        if more_attempts:
                             logging.warning(
-                                f"Secondary rate limit hit. Sleeping for {sleep_time} seconds (exponential backoff)."
+                                f"Secondary rate limit hit. Sleeping for {sleep_time} seconds."
                             )
-                            backoff_seconds *= 2
-                        await asyncio.sleep(sleep_time)
-                        continue
+                            await asyncio.sleep(max(0, sleep_time))
+                            continue
 
                 if resp.status == 404:
                     raise ghstack.github.NotFoundError(

{ghstack-0.16.0 → ghstack-0.17.0}/src/ghstack/github_utils.py

@@ -32,7 +32,10 @@ async def get_github_repo_name_with_owner(
     # where commits will actually be pushed to
     remote_url = await sh.agit("remote", "get-url", "--push", remote_name)
     while True:
-        match = r"^git@{github_url}:/?([^/]+)/(.+?)(?:\.git)?$".format(
+        # The SSH user can be "git" (e.g. git@github.com:owner/repo.git) or an
+        # arbitrary identity such as the org-scoped deploy user GitHub now hands
+        # out (e.g. org-21003710@github.com:owner/repo.git), so match any user.
+        match = r"^[^@]+@{github_url}:/?([^/]+)/(.+?)(?:\.git)?$".format(
             github_url=github_url
         )
         m = re.match(match, remote_url)
@@ -175,7 +178,9 @@ GitHubPullRequestParams = TypedDict(
 def _normalize_remote_url(remote_url: str) -> str:
     """Convert SSH remote URL to HTTPS format, strip .git suffix."""
     # git@github.com:owner/repo.git -> https://github.com/owner/repo
-    m = re.match(r"^git@([^:]+):/?(.+?)(?:\.git)?$", remote_url)
+    # The SSH user may be "git" or an org-scoped identity such as
+    # org-21003710@github.com:owner/repo.git, so match any user.
+    m = re.match(r"^[^@]+@([^:]+):/?(.+?)(?:\.git)?$", remote_url)
     if m:
         return f"https://{m.group(1)}/{m.group(2)}"
     return re.sub(r"\.git$", "", remote_url)