Fix various rate limiting issues #1424

hipstersmoothie · 2020-07-30T18:24:33Z

What Changed

previously we would just error out on the abuse limit, now we will retry

Why

#1422 (I'm not sure this PR solves for #1422)

📦 Published PR as canary version: under canary scope @auto-canary@9.49.3-canary.1424.17806.0

✨ Test out this PR locally via:

npm install @auto-canary/bot-list@9.49.3-canary.1424.17806.0
npm install @auto-canary/auto@9.49.3-canary.1424.17806.0
npm install @auto-canary/core@9.49.3-canary.1424.17806.0
npm install @auto-canary/all-contributors@9.49.3-canary.1424.17806.0
npm install @auto-canary/brew@9.49.3-canary.1424.17806.0
npm install @auto-canary/chrome@9.49.3-canary.1424.17806.0
npm install @auto-canary/cocoapods@9.49.3-canary.1424.17806.0
npm install @auto-canary/conventional-commits@9.49.3-canary.1424.17806.0
npm install @auto-canary/crates@9.49.3-canary.1424.17806.0
npm install @auto-canary/exec@9.49.3-canary.1424.17806.0
npm install @auto-canary/first-time-contributor@9.49.3-canary.1424.17806.0
npm install @auto-canary/gem@9.49.3-canary.1424.17806.0
npm install @auto-canary/gh-pages@9.49.3-canary.1424.17806.0
npm install @auto-canary/git-tag@9.49.3-canary.1424.17806.0
npm install @auto-canary/gradle@9.49.3-canary.1424.17806.0
npm install @auto-canary/jira@9.49.3-canary.1424.17806.0
npm install @auto-canary/maven@9.49.3-canary.1424.17806.0
npm install @auto-canary/npm@9.49.3-canary.1424.17806.0
npm install @auto-canary/omit-commits@9.49.3-canary.1424.17806.0
npm install @auto-canary/omit-release-notes@9.49.3-canary.1424.17806.0
npm install @auto-canary/released@9.49.3-canary.1424.17806.0
npm install @auto-canary/s3@9.49.3-canary.1424.17806.0
npm install @auto-canary/slack@9.49.3-canary.1424.17806.0
npm install @auto-canary/twitter@9.49.3-canary.1424.17806.0
npm install @auto-canary/upload-assets@9.49.3-canary.1424.17806.0
# or 
yarn add @auto-canary/bot-list@9.49.3-canary.1424.17806.0
yarn add @auto-canary/auto@9.49.3-canary.1424.17806.0
yarn add @auto-canary/core@9.49.3-canary.1424.17806.0
yarn add @auto-canary/all-contributors@9.49.3-canary.1424.17806.0
yarn add @auto-canary/brew@9.49.3-canary.1424.17806.0
yarn add @auto-canary/chrome@9.49.3-canary.1424.17806.0
yarn add @auto-canary/cocoapods@9.49.3-canary.1424.17806.0
yarn add @auto-canary/conventional-commits@9.49.3-canary.1424.17806.0
yarn add @auto-canary/crates@9.49.3-canary.1424.17806.0
yarn add @auto-canary/exec@9.49.3-canary.1424.17806.0
yarn add @auto-canary/first-time-contributor@9.49.3-canary.1424.17806.0
yarn add @auto-canary/gem@9.49.3-canary.1424.17806.0
yarn add @auto-canary/gh-pages@9.49.3-canary.1424.17806.0
yarn add @auto-canary/git-tag@9.49.3-canary.1424.17806.0
yarn add @auto-canary/gradle@9.49.3-canary.1424.17806.0
yarn add @auto-canary/jira@9.49.3-canary.1424.17806.0
yarn add @auto-canary/maven@9.49.3-canary.1424.17806.0
yarn add @auto-canary/npm@9.49.3-canary.1424.17806.0
yarn add @auto-canary/omit-commits@9.49.3-canary.1424.17806.0
yarn add @auto-canary/omit-release-notes@9.49.3-canary.1424.17806.0
yarn add @auto-canary/released@9.49.3-canary.1424.17806.0
yarn add @auto-canary/s3@9.49.3-canary.1424.17806.0
yarn add @auto-canary/slack@9.49.3-canary.1424.17806.0
yarn add @auto-canary/twitter@9.49.3-canary.1424.17806.0
yarn add @auto-canary/upload-assets@9.49.3-canary.1424.17806.0

codecov · 2020-07-30T18:35:07Z

Codecov Report

Merging #1424 into master will decrease coverage by 0.03%.
The diff coverage is 68.42%.

@@            Coverage Diff             @@
##           master    #1424      +/-   ##
==========================================
- Coverage   81.15%   81.12%   -0.04%     
==========================================
  Files          58       58              
  Lines        4261     4248      -13     
  Branches      936      935       -1     
==========================================
- Hits         3458     3446      -12     
  Misses        563      563              
+ Partials      240      239       -1

Impacted Files	Coverage Δ
packages/core/src/release.ts	`94.30% <ø> (-0.03%)`	⬇️
plugins/released/src/index.ts	`87.95% <50.00%> (ø)`
packages/core/src/git.ts	`88.79% <57.14%> (-0.26%)`	⬇️
plugins/first-time-contributor/src/index.ts	`86.66% <75.00%> (+2.05%)`	⬆️
packages/core/src/auto.ts	`77.50% <100.00%> (-0.12%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 89481d6...d6e7be2. Read the comment docs.

better time remaining messaging

…e last tag. getting all commits can trigger rate limits and canaries should be lightweight

hipstersmoothie · 2020-07-31T17:41:19Z

packages/core/src/auto.ts

-      latestTag = await this.git.getFirstCommit();
-    }
-
-    const commitsInRelease = await this.release.getCommits(latestTag);


Removed this because getting all the commits in a canary release with no recent release can lead to hitting the rate limits. With canaries this is especially easy to hit because they are made so often.

hipstersmoothie · 2020-07-31T17:41:39Z

packages/core/src/git.ts

          );
+          return true;


Will now actually retry after abuse limit is hit

hipstersmoothie · 2020-07-31T17:42:27Z

packages/core/src/git.ts

@@ -488,6 +491,7 @@ export default class Git {
  }

  /** Search to GitHub project's issue and pull requests */
+  @memoize()


In a single run if the search query is the same it should be safe to memoize. The search endpoints have super low rate limits so this should help a bit.

hipstersmoothie · 2020-07-31T17:42:52Z

packages/core/src/git.ts

@@ -505,10 +509,11 @@ export default class Git {
  }

  /** Run a graphql query on the GitHub project */
+  @memoize()


Same thing goes for graphql queries. Easy to memoize.

hipstersmoothie · 2020-07-31T17:43:24Z

packages/core/src/git.ts

  async graphql<T>(query: string) {
    this.logger.verbose.info("Querying Github using GraphQL:\n", query);

-    const data = await graphql<T>(query, {
+    const data = await this.github.graphql<T>(query, {


Switching to octokit's graphql function will make sure that it is rate/abuse limited properly

hipstersmoothie · 2020-07-31T17:44:28Z

packages/core/src/release.ts

@@ -283,6 +283,7 @@ export default class Release {
   * @param from - Tag or SHA to start at
   * @param to - Tag or SHA to end at (defaults to HEAD)
   */
+  @memoize()


I was iffy on adding memoization here. But since auto will never care about generated commits I think it's safe to memoize this function. This should also help with some log reduction

…works

hipstersmoothie · 2020-07-31T20:45:25Z

plugins/first-time-contributor/src/index.ts

-                  return author;
+            // prettier-ignore
+            // eslint-disable-next-line no-await-in-loop
+            const prs = await auto.git?.graphql<Record<string, any>>(`


Call graphql API serially so we can use the memoized the graphql call

hipstersmoothie · 2020-07-31T21:01:57Z

packages/core/src/release.ts

@@ -611,12 +612,9 @@ export default class Release {
          hash: commit.hash,
        });
      } else if (commit.authorEmail) {
-        const author = await this.git.getUserByEmail(commit.authorEmail);


getUserByEmail used search which is easily rate-limited, just omitting instead. It's 50/50 that the user has their email public anyway

hipstersmoothie · 2020-07-31T21:02:24Z

plugins/first-time-contributor/src/index.ts

@@ -14,9 +14,6 @@ export default class FirstTimeContributorPlugin implements IPlugin {

  /** Tap into auto plugin points. */
  apply(auto: Auto) {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const cache: Record<string, Record<string, any>> = {};


Rely on git client memoization instead of custom cache

adierkens · 2020-07-31T21:21:13Z

🚀 PR was released in v9.49.3 🚀

retry after abuse limit

80b3922

hipstersmoothie added the patch Increment the patch version when merged label Jul 30, 2020

hipstersmoothie added 2 commits July 30, 2020 12:35

memoize searchRepo

84109da

pretty print time left on rate limit

0ef0b9a

better time remaining messaging

hipstersmoothie force-pushed the abuse branch from 26c426b to 51b2261 Compare July 31, 2020 16:59

hipstersmoothie added 5 commits July 31, 2020 10:28

use graphql api on octokit instance

3d64d66

mock octokit in cli tests

b4831c0

return only commits in the canary release instead of all commits sinc…

66f7e2a

…e last tag. getting all commits can trigger rate limits and canaries should be lightweight

remove author email match, easily hits rate limit

5d9bb97

memoize getCommits

2a0f270

hipstersmoothie force-pushed the abuse branch from f936268 to 2a0f270 Compare July 31, 2020 17:39

hipstersmoothie commented Jul 31, 2020

View reviewed changes

packages/core/src/git.ts

);

return true;

Copy link

Collaborator Author

hipstersmoothie Jul 31, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will now actually retry after abuse limit is hit

hipstersmoothie commented Jul 31, 2020

View reviewed changes

hipstersmoothie mentioned this pull request Jul 31, 2020

Hitting GH rate-limit when generating changelog over very large amount of commits #1422

Closed

hipstersmoothie added 2 commits July 31, 2020 11:20

call getPullRequest 1 less time

baab296

search for past contributions serially so that memoized graphql call …

d6e7be2

…works

hipstersmoothie changed the title ~~retry after abuse limit~~ Fix various rate limiting issues Jul 31, 2020

hipstersmoothie commented Jul 31, 2020

View reviewed changes

hipstersmoothie merged commit 8bf2f44 into master Jul 31, 2020

hipstersmoothie deleted the abuse branch July 31, 2020 21:03

adierkens added the released This issue/pull request has been released. label Jul 31, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix various rate limiting issues #1424

Fix various rate limiting issues #1424

hipstersmoothie commented Jul 30, 2020 •

edited

codecov bot commented Jul 30, 2020 •

edited

hipstersmoothie Jul 31, 2020

hipstersmoothie Jul 31, 2020

hipstersmoothie Jul 31, 2020

hipstersmoothie Jul 31, 2020

hipstersmoothie Jul 31, 2020

hipstersmoothie Jul 31, 2020

hipstersmoothie Jul 31, 2020

hipstersmoothie Jul 31, 2020

hipstersmoothie Jul 31, 2020

adierkens commented Jul 31, 2020

Fix various rate limiting issues #1424

Fix various rate limiting issues #1424

Conversation

hipstersmoothie commented Jul 30, 2020 • edited

What Changed

Why

codecov bot commented Jul 30, 2020 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adierkens commented Jul 31, 2020

hipstersmoothie commented Jul 30, 2020 •

edited

codecov bot commented Jul 30, 2020 •

edited