deps: @octokit/rest ^21.0.0

.changeset/ninety-colts-sit.md

@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+deps: @octokit/rest ^21.0.0

package.json

@@ -72,7 +72,7 @@
     "@jest/types": "^29.0.0",
     "@octokit/graphql": "^8.0.0",
     "@octokit/graphql-schema": "^15.3.0",
-    "@octokit/rest": "^20.0.0",
+    "@octokit/rest": "^21.0.0",
     "@octokit/types": "^13.0.0",
     "@types/jest": "^29.0.0",
     "@types/node": ">=18.12",

src/api/github/checkRun.test.ts

@@ -1,16 +1,16 @@
-import { Octokit } from '@octokit/rest';
 import type { Endpoints } from '@octokit/types';
 import git, { type ReadCommitResult } from 'isomorphic-git';
 
 import type * as GitHub from '../github';
 
 import { createCheckRun } from './checkRun';
+import { createRestClient } from './octokit';
 
 type CreateCheckRunResponse =
   Endpoints['POST /repos/{owner}/{repo}/check-runs']['response'];
 
-jest.mock('@octokit/rest');
 jest.mock('isomorphic-git');
+jest.mock('./octokit');
 
 const mockClient = {
   checks: {
@@ -50,7 +50,7 @@ describe('createCheckRun', () => {
   const title = 'Build #23 failed';
 
   beforeEach(() => {
-    jest.mocked(Octokit).mockReturnValue(mockClient as unknown as Octokit);
+    jest.mocked(createRestClient).mockResolvedValue(mockClient as never);
     jest
       .mocked(git.listRemotes)
       .mockResolvedValue([
@@ -76,7 +76,7 @@ describe('createCheckRun', () => {
       title,
     });
 
-    expect(jest.mocked(Octokit)).toHaveBeenCalledWith({
+    expect(jest.mocked(createRestClient)).toHaveBeenCalledWith({
       auth: 'Hello from GITHUB_API_TOKEN',
     });
   });
@@ -93,7 +93,7 @@ describe('createCheckRun', () => {
       title,
     });
 
-    expect(jest.mocked(Octokit)).toHaveBeenCalledWith({
+    expect(jest.mocked(createRestClient)).toHaveBeenCalledWith({
       auth: 'Hello from GITHUB_TOKEN',
     });
   });

src/api/github/checkRun.ts

@@ -1,10 +1,10 @@
-import { Octokit } from '@octokit/rest';
 import type { Endpoints } from '@octokit/types';
 
 import { pluralise } from '../../utils/logging';
 import * as Git from '../git';
 
 import { apiTokenFromEnvironment } from './environment';
+import { createRestClient } from './octokit';
 
 type Output = NonNullable<
   Endpoints['PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}']['parameters']['output']
@@ -106,7 +106,7 @@ export const createCheckRun = async ({
     Git.getOwnerAndRepo({ dir }),
   ]);
 
-  const client = new Octokit({ auth: apiTokenFromEnvironment() });
+  const client = await createRestClient({ auth: apiTokenFromEnvironment() });
 
   await client.checks.create({
     conclusion,

src/api/github/issueComment.test.ts

@@ -1,10 +1,10 @@
-import { Octokit } from '@octokit/rest';
 import git from 'isomorphic-git';
 
 import { putIssueComment } from './issueComment';
+import { createRestClient } from './octokit';
 
-jest.mock('@octokit/rest');
 jest.mock('isomorphic-git');
+jest.mock('./octokit');
 
 const mockClient = {
   issues: {
@@ -27,7 +27,7 @@ beforeEach(() => {
       { remote: 'origin', url: '[email protected]:seek-oss/skuba.git' },
     ]);
 
-  jest.mocked(Octokit).mockReturnValue(mockClient as never);
+  jest.mocked(createRestClient).mockResolvedValue(mockClient as never);
 });
 
 afterEach(jest.resetAllMocks);
@@ -45,7 +45,7 @@ describe('putIssueComment', () => {
       }),
     ).resolves.toStrictEqual({ id: 789 });
 
-    expect(Octokit).toHaveBeenCalledTimes(1);
+    expect(createRestClient).toHaveBeenCalledTimes(1);
 
     expect(mockClient.issues.listComments).toHaveBeenCalledTimes(1);
     expect(mockClient.issues.listComments.mock.calls[0][0])
@@ -110,7 +110,7 @@ describe('putIssueComment', () => {
       }),
     ).resolves.toStrictEqual({ id: 789 });
 
-    expect(Octokit).toHaveBeenCalledTimes(1);
+    expect(createRestClient).toHaveBeenCalledTimes(1);
 
     expect(mockClient.users.getAuthenticated).toHaveBeenCalledTimes(1);
 
@@ -176,7 +176,7 @@ describe('putIssueComment', () => {
       }),
     ).resolves.toStrictEqual({ id: 789 });
 
-    expect(Octokit).toHaveBeenCalledTimes(1);
+    expect(createRestClient).toHaveBeenCalledTimes(1);
 
     expect(mockClient.users.getAuthenticated).toHaveBeenCalledTimes(1);
 
@@ -238,7 +238,7 @@ describe('putIssueComment', () => {
       }),
     ).resolves.toStrictEqual({ id: 789 });
 
-    expect(Octokit).toHaveBeenCalledTimes(1);
+    expect(createRestClient).toHaveBeenCalledTimes(1);
 
     expect(mockClient.users.getAuthenticated).toHaveBeenCalledTimes(1);
 
@@ -301,7 +301,7 @@ describe('putIssueComment', () => {
       }),
     ).resolves.toStrictEqual({ id: 789 });
 
-    expect(Octokit).toHaveBeenCalledTimes(1);
+    expect(createRestClient).toHaveBeenCalledTimes(1);
 
     expect(mockClient.users.getAuthenticated).toHaveBeenCalledTimes(1);
 
@@ -357,7 +357,7 @@ describe('putIssueComment', () => {
       }),
     ).resolves.toStrictEqual({ id: 789 });
 
-    expect(Octokit).toHaveBeenCalledTimes(1);
+    expect(createRestClient).toHaveBeenCalledTimes(1);
 
     // This should be skipped when `userId` is specified.
     expect(mockClient.users.getAuthenticated).not.toHaveBeenCalled();

src/api/github/issueComment.ts

@@ -1,8 +1,9 @@
-import { Octokit } from '@octokit/rest';
+import type { Octokit } from '@octokit/rest';
 
 import * as Git from '../git';
 
 import { apiTokenFromEnvironment } from './environment';
+import { createRestClient } from './octokit';
 import { getPullRequestNumber } from './pullRequest';
 
 const getUserId = async (client: Octokit): Promise<number> => {
@@ -83,7 +84,7 @@ export const putIssueComment = async (
 
   const { owner, repo } = await Git.getOwnerAndRepo({ dir });
 
-  const client = new Octokit({ auth: apiTokenFromEnvironment() });
+  const client = await createRestClient({ auth: apiTokenFromEnvironment() });
 
   const issueNumber =
     params.issueNumber ?? (await getPullRequestNumber({ client, env }));

src/api/github/octokit.ts

@@ -1,5 +1,10 @@
+import type { Octokit } from '@octokit/rest';
 import type { RequestParameters } from '@octokit/types';
 
+export const createRestClient = async (options: {
+  auth: unknown;
+}): Promise<Octokit> => new (await import('@octokit/rest')).Octokit(options);
+
 export const graphql = async <ResponseData>(
   query: string,
   parameters?: RequestParameters,

src/api/github/pullRequest.test.ts

@@ -1,18 +1,20 @@
-import { Octokit } from '@octokit/rest';
 import git from 'isomorphic-git';
 
+import { createRestClient } from './octokit';
 import { getPullRequestNumber } from './pullRequest';
 
-jest.mock('@octokit/rest');
 jest.mock('isomorphic-git');
+jest.mock('./octokit');
 
 const mockClient = {
   repos: {
     listPullRequestsAssociatedWithCommit: jest.fn(),
   },
 };
 
-beforeEach(() => jest.mocked(Octokit).mockReturnValue(mockClient as never));
+beforeEach(() =>
+  jest.mocked(createRestClient).mockResolvedValue(mockClient as never),
+);
 
 afterEach(jest.resetAllMocks);
 
@@ -22,15 +24,15 @@ describe('getPullRequestNumber', () => {
       getPullRequestNumber({ env: { BUILDKITE_PULL_REQUEST: '123' } }),
     ).resolves.toBe(123);
 
-    expect(Octokit).not.toHaveBeenCalled();
+    expect(createRestClient).not.toHaveBeenCalled();
   });
 
   it('prefers a GitHub Actions environment variable', async () => {
     await expect(
       getPullRequestNumber({ env: { GITHUB_REF: 'refs/pull/456/merge' } }),
     ).resolves.toBe(456);
 
-    expect(Octokit).not.toHaveBeenCalled();
+    expect(createRestClient).not.toHaveBeenCalled();
   });
 
   it('falls back to the most recently updated pull request from the GitHub API', async () => {
@@ -96,7 +98,7 @@ describe('getPullRequestNumber', () => {
       }
     `);
 
-    expect(Octokit).toHaveBeenCalledTimes(1);
+    expect(createRestClient).toHaveBeenCalledTimes(1);
   });
 
   it('throws on an empty response from the GitHub API', async () => {

src/api/github/pullRequest.ts

@@ -1,8 +1,9 @@
-import { Octokit } from '@octokit/rest';
+import type { Octokit } from '@octokit/rest';
 
 import * as Git from '../git';
 
 import { apiTokenFromEnvironment } from './environment';
+import { createRestClient } from './octokit';
 
 interface GetPullRequestParameters {
   /**
@@ -41,7 +42,8 @@ export const getPullRequestNumber = async (
   }
 
   const client =
-    params.client ?? new Octokit({ auth: apiTokenFromEnvironment() });
+    params.client ??
+    (await createRestClient({ auth: apiTokenFromEnvironment() }));
 
   const [commitId, { owner, repo }] = await Promise.all([
     Git.getHeadCommitId({ dir, env }),