Merge pull request #37 from chartgerink/fix/36

Add rate limit checking

Author: mpadge

NEWS.md

@@ -1,4 +1,15 @@
 # Development
+<<<<<<< fix/36 -- Incoming Change
+
+## Minor changes
+
+- Add a rate limit checker for the GitHub API calls. Will warn if rate limit is exceeded.
+
+---
+
+# v 0.1.1
+=======
+>>>>>>> main -- Current Change
 
 ## Minor changes
 

R/github.R

@@ -293,6 +293,8 @@ get_gh_issue_people <- function (org, repo,
             repo = repo,
             end_cursor = end_cursor
         )
+
+        check_rate_limit()
         dat <- gh::gh_gql (q)
 
         has_next_page <- dat$data$repository$issues$pageInfo$hasNextPage
@@ -443,6 +445,7 @@ get_gh_issue_titles <- function (org, repo) {
             repo = repo,
             end_cursor = end_cursor
         )
+        check_rate_limit()
         dat <- gh::gh_gql (q)
 
         has_next_page <- dat$data$repository$issues$pageInfo$hasNextPage
@@ -534,3 +537,23 @@ get_gh_contrib_issue <- function (org, repo) {
 
     unlist (pings)
 }
+
+#' Check the GitHub rate limit and warn if exceeded.
+#'
+#' @noRd
+check_rate_limit <- function () {
+    gh_state <- gh::gh_rate_limit()
+    limit_warn <- 0.1
+    warn_txt <- NULL
+    if (gh_state$remaining / gh_state$limit < limit_warn) {
+        warn_txt <- "You have used > 90% of your GitHub calls..."
+    } else if (gh_state$remaining == 0) {
+        warn_txt <- "The GitHub rate limit has been reached..."
+    }
+    if (!is.null (warn_txt)) {
+        cli::cli_alert_warning (sprintf(
+                "%s It resets in ~%s minutes.",
+                warn_txt,
+                ceiling(difftime(gh_state$reset, Sys.time(), units = "mins"))))
+    }
+}

tests/testthat/getcontribs/api.github.com/graphql-8cf72c-POST.json

@@ -4,7 +4,7 @@
             "issues": {
                 "pageInfo": {
                     "hasNextPage": false,
-                    "endCursor": "Y3Vyc29yOnYyOpHObs1_rQ=="
+                    "endCursor": "Y3Vyc29yOnYyOpK5MjAyMy0wOC0yMVQxMToyMDozMiswMjowMM5uzX-t"
                 },
                 "edges": [
                     {

tests/testthat/getcontribs/api.github.com/rate_limit-38c41e.json

@@ -0,0 +1,76 @@
+{
+    "resources": {
+        "core": {
+            "limit": 5000,
+            "used": 22,
+            "remaining": 4978,
+            "reset": 1710753401
+        },
+        "search": {
+            "limit": 30,
+            "used": 0,
+            "remaining": 30,
+            "reset": 1710752737
+        },
+        "graphql": {
+            "limit": 5000,
+            "used": 9,
+            "remaining": 4991,
+            "reset": 1710754258
+        },
+        "integration_manifest": {
+            "limit": 5000,
+            "used": 0,
+            "remaining": 5000,
+            "reset": 1710756277
+        },
+        "source_import": {
+            "limit": 100,
+            "used": 0,
+            "remaining": 100,
+            "reset": 1710752737
+        },
+        "code_scanning_upload": {
+            "limit": 1000,
+            "used": 0,
+            "remaining": 1000,
+            "reset": 1710756277
+        },
+        "actions_runner_registration": {
+            "limit": 10000,
+            "used": 0,
+            "remaining": 10000,
+            "reset": 1710756277
+        },
+        "scim": {
+            "limit": 15000,
+            "used": 0,
+            "remaining": 15000,
+            "reset": 1710756277
+        },
+        "dependency_snapshots": {
+            "limit": 100,
+            "used": 0,
+            "remaining": 100,
+            "reset": 1710752737
+        },
+        "audit_log": {
+            "limit": 1750,
+            "used": 0,
+            "remaining": 1750,
+            "reset": 1710756277
+        },
+        "code_search": {
+            "limit": 10,
+            "used": 0,
+            "remaining": 10,
+            "reset": 1710752737
+        }
+    },
+    "rate": {
+        "limit": 5000,
+        "used": 22,
+        "remaining": 4978,
+        "reset": 1710753401
+    }
+}

tests/testthat/getcontribs/api/contributors-b0fb04.json

@@ -18,7 +18,7 @@
         "received_events_url": "https://api.github.com/users/mpadge/received_events",
         "type": "User",
         "site_admin": false,
-        "contributions": 213
+        "contributions": 214
     },
     {
         "login": "daniellemccool",
@@ -40,5 +40,26 @@
         "type": "User",
         "site_admin": false,
         "contributions": 1
+    },
+    {
+        "login": "olivroy",
+        "id": 52606734,
+        "node_id": "MDQ6VXNlcjUyNjA2NzM0",
+        "avatar_url": "https://avatars.githubusercontent.com/u/52606734?v=4",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/olivroy",
+        "html_url": "https://github.com/olivroy",
+        "followers_url": "https://api.github.com/users/olivroy/followers",
+        "following_url": "https://api.github.com/users/olivroy/following{/other_user}",
+        "gists_url": "https://api.github.com/users/olivroy/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/olivroy/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/olivroy/subscriptions",
+        "organizations_url": "https://api.github.com/users/olivroy/orgs",
+        "repos_url": "https://api.github.com/users/olivroy/repos",
+        "events_url": "https://api.github.com/users/olivroy/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/olivroy/received_events",
+        "type": "User",
+        "site_admin": false,
+        "contributions": 1
     }
 ]