Implement mechanism to avoid secondary rate limit on PR creation

README.md

@@ -187,6 +187,7 @@ Push each repository's local branch to the remote. If a branch already exists on
 </table>
 
 ### Pull Requests
+If you are planning to raise PRs, please add your github personal access token to the githubAccessToken object in `~/.config/nori-workspace/config.json`. Authenticating increases the [secondary rate limit](https://docs.github.com/en/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits) of GitHub API, which increases your chance to raise multiple PRs without being blocked by the limit.
 
 ##### `nori prs --templates.title --templates.body`
 

src/commands/prs.js

@@ -5,6 +5,8 @@ const styles = require('../lib/styles')
 const getConfig = require('../lib/config')
 const promiseAllErrors = require('../lib/promise-all-errors')
 
+const PR_CREATION_TIMEOUT_MS = 2000
+
 exports.command = 'prs'
 exports.desc = 'create Github pull requests for pushed branches'
 
@@ -45,47 +47,46 @@ exports.handler = async ({ templates: { title, body } }, state) => {
 
 	const octokit = getOctokit(githubAccessToken)
 
-	await promiseAllErrors(
-		state.repos.map(async repo => {
-			if (repo.remoteBranch) {
-				const [existingPr] = await octokit.paginate(
-					octokit.pulls.list.endpoint.merge({
-						owner: repo.owner,
-						repo: repo.name,
-						head: `${repo.owner}:${repo.remoteBranch}`,
-					}),
-				)
+	for (const repo of state.repos) {
+		if (repo.remoteBranch) {
+			const [existingPr] = await octokit.paginate(
+				octokit.pulls.list.endpoint.merge({
+					owner: repo.owner,
+					repo: repo.name,
+					head: `${repo.owner}:${repo.remoteBranch}`,
+				}),
+			)
 
-				if (existingPr) {
-					logger.log(`${repo.owner}/${repo.name} PR`, {
-						status: 'info',
-						message: `using existing PR ${styles.url(
-							existingPr.html_url,
-						)} for ${styles.branch(repo.remoteBranch)} on ${styles.repo(
-							`${repo.owner}/${repo.name}`,
-						)}`,
-					})
-				}
-				repo.pr =
-					existingPr ||
-					(await logger
-						.logPromise(
-							octokit.pulls.create({
-								owner: repo.owner,
-								repo: repo.name,
-								head: repo.remoteBranch,
-								base: repo.centralBranch,
-								title: titleTemplate(repo),
-								body: bodyTemplate(repo),
-							}),
-							`creating PR for ${styles.branch(
-								repo.remoteBranch,
-							)} on ${styles.repo(`${repo.owner}/${repo.name}`)}`,
-						)
-						.then(response => response.data))
+			if (existingPr) {
+				logger.log(`${repo.owner}/${repo.name} PR`, {
+					status: 'info',
+					message: `using existing PR ${styles.url(
+						existingPr.html_url,
+					)} for ${styles.branch(repo.remoteBranch)} on ${styles.repo(
+						`${repo.owner}/${repo.name}`,
+					)}`,
+				})
 			}
-		}),
-	)
+			repo.pr =
+				existingPr ||
+				(await logger
+					.logPromise(
+						octokit.pulls.create({
+							owner: repo.owner,
+							repo: repo.name,
+							head: repo.remoteBranch,
+							base: repo.centralBranch,
+							title: titleTemplate(repo),
+							body: bodyTemplate(repo),
+						}),
+						`creating PR for ${styles.branch(
+							repo.remoteBranch,
+						)} on ${styles.repo(`${repo.owner}/${repo.name}`)}`,
+					)
+					.then(response => response.data))
+			await new Promise(r => setTimeout(r, PR_CREATION_TIMEOUT_MS))
+		}
+	}
 }
 
 exports.undo = async (_, state) => {

src/lib/octokit.js

@@ -2,22 +2,37 @@ const { Octokit } = require('@octokit/rest')
 const { throttling } = require('@octokit/plugin-throttling')
 const { retry } = require('@octokit/plugin-retry')
 const OctokitInstance = Octokit.plugin(throttling, retry)
+const logger = require('../lib/logger')
+
+const RETRY_LIMIT = 5
 
 let client
 
+const retryWrapper = (retryAfter, options, message) => {
+	if (options.request.retryCount === RETRY_LIMIT) {
+		return
+	}
+	logger.log(`${message}, retrying after ${retryAfter}s`, {
+		status: 'pending',
+		message: `${message}, retrying after ${retryAfter}s`,
+	})
+	return true
+}
+
 module.exports = token => {
 	if (!client) {
 		client = new OctokitInstance({
 			previews: ['inertia-preview'],
-			auth: `token ${token}`,
+			auth: token,
 			throttle: {
-				onRateLimit: (retryAfter, options) => {
-					// Only retry once.
-					if (options.request.retryCount === 0) {
-						return true
-					}
-				},
-				onAbuseLimit: () => {},
+				onRateLimit: (retryAfter, options) =>
+					retryWrapper(retryAfter, options, 'Hit GitHub API rate limit'),
+				onAbuseLimit: (retryAfter, options) =>
+					retryWrapper(
+						retryAfter,
+						options,
+						'Hit secondary GitHub API rate limit',
+					),
 			},
 		})
 	}