feat(upgrade): Use GitHub token if available when downloading patches (#10515)

Author: Tobbe

.changesets/10515.md

@@ -0,0 +1,8 @@
+- feat(upgrade): Use GitHub token if available when downloading patches (#10515) by @Tobbe
+
+If a GitHub token is available in the environment we use that when fetching the
+git tree from GitHub. That way we're less likely to be rate limited. For most
+users the token shouldn't be needed. The free allowance/usage of the GitHub API
+should be enough.
+
+We support `GH_TOKEN`, `GITHUB_TOKEN` and `REDWOOD_GITHUB_TOKEN` as the env var names

packages/cli/src/commands/upgrade.js

@@ -365,11 +365,24 @@ async function downloadYarnPatches(ctx, { dryRun, verbose }) {
     throw new Error('Failed to upgrade')
   }
 
+  const githubToken =
+    process.env.GH_TOKEN ||
+    process.env.GITHUB_TOKEN ||
+    process.env.REDWOOD_GITHUB_TOKEN
+
   const res = await fetch(
     'https://api.github.com/repos/redwoodjs/redwood/git/trees/main?recursive=1',
+    {
+      headers: {
+        Authorization: githubToken ? `Bearer ${githubToken}` : undefined,
+        ['X-GitHub-Api-Version']: '2022-11-28',
+        Accept: 'application/vnd.github+json',
+      },
+    },
   )
+
   const json = await res.json()
-  const patches = json.tree.filter((patchInfo) =>
+  const patches = json.tree?.filter((patchInfo) =>
     patchInfo.path.startsWith(
       'packages/create-redwood-app/templates/ts/.yarn/patches/',
     ),
@@ -386,7 +399,7 @@ async function downloadYarnPatches(ctx, { dryRun, verbose }) {
   }
 
   return new Listr(
-    patches.map((patch) => {
+    (patches || []).map((patch) => {
       return {
         title: `Downloading ${patch.path}`,
         task: async () => {