feat: use octokit-auth-probot (#1392)

probot · Oct 28, 2020 · 8ba3a8e · 8ba3a8e
1 parent 506a5ed
commit 8ba3a8e
Show file tree

Hide file tree

Showing 7 changed files with 888 additions and 818 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -36,8 +36,6 @@
   "author": "Brandon Keepers",
   "license": "ISC",
   "dependencies": {
-    "@octokit/auth-app": "^2.4.14",
-    "@octokit/auth-unauthenticated": "^1.0.0",
     "@octokit/core": "^3.1.0",
     "@octokit/graphql": "^4.2.0",
     "@octokit/plugin-enterprise-compatibility": "^1.2.1",
@@ -69,6 +67,7 @@
     "js-yaml": "^3.13.1",
     "jsonwebtoken": "^8.1.0",
     "lru-cache": "^6.0.0",
+    "octokit-auth-probot": "^1.2.0",
     "octokit-pagination-methods": "1.1.0",
     "pino": "^6.5.0",
     "pino-http": "^5.2.0",

diff --git a/src/octokit/get-authenticated-octokit-for-event.ts b/src/octokit/get-authenticated-octokit-for-event.ts
diff --git a/src/octokit/get-authenticated-octokit.ts b/src/octokit/get-authenticated-octokit.ts
@@ -1,32 +1,53 @@
 import { State } from "../types";
+import { ProbotOctokit } from "./probot-octokit";
+
+type FactoryOptions = {
+  octokit: InstanceType<typeof ProbotOctokit>;
+  octokitOptions: ConstructorParameters<typeof ProbotOctokit> & {
+    throttle?: Record<string, unknown>;
+    auth?: Record<string, unknown>;
+  };
+  [key: string]: unknown;
+};
 
 export async function getAuthenticatedOctokit(
   state: State,
   installationId?: number
 ) {
-  const { githubToken, log, Octokit, octokit } = state;
+  const { log, octokit } = state;
 
   if (!installationId) return octokit;
 
-  const constructorAuthOptions = githubToken
-    ? {}
-    : { auth: { installationId: installationId } };
+  return octokit.auth({
+    type: "installation",
+    installationId,
+    factory: ({ octokit, octokitOptions, ...otherOptions }: FactoryOptions) => {
+      const pinoLog = log.child({ name: "github" });
 
-  const pinoLog = log.child({ name: "github" });
-  const options = {
-    log: {
-      fatal: pinoLog.fatal.bind(pinoLog),
-      error: pinoLog.error.bind(pinoLog),
-      warn: pinoLog.warn.bind(pinoLog),
-      info: pinoLog.info.bind(pinoLog),
-      debug: pinoLog.debug.bind(pinoLog),
-      trace: pinoLog.trace.bind(pinoLog),
-    },
-    throttle: {
-      id: installationId,
-    },
-    ...constructorAuthOptions,
-  };
+      const options = {
+        ...octokitOptions,
+        log: {
+          fatal: pinoLog.fatal.bind(pinoLog),
+          error: pinoLog.error.bind(pinoLog),
+          warn: pinoLog.warn.bind(pinoLog),
+          info: pinoLog.info.bind(pinoLog),
+          debug: pinoLog.debug.bind(pinoLog),
+          trace: pinoLog.trace.bind(pinoLog),
+        },
+        throttle: {
+          ...octokitOptions.throttle,
+          id: installationId,
+        },
+        auth: {
+          ...octokitOptions.auth,
+          otherOptions,
+          installationId,
+        },
+      };
+
+      const Octokit = octokit.constructor as typeof ProbotOctokit;
 
-  return new Octokit(options);
+      return new Octokit(options);
+    },
+  }) as Promise<InstanceType<typeof ProbotOctokit>>;
 }
diff --git a/src/octokit/get-probot-octokit-with-defaults.ts b/src/octokit/get-probot-octokit-with-defaults.ts
@@ -1,4 +1,3 @@
-import { createAppAuth } from "@octokit/auth-app";
 import LRUCache from "lru-cache";
 import { ProbotOctokit } from "./probot-octokit";
 import Redis from "ioredis";
@@ -30,14 +29,13 @@ type Options = {
  */
 export function getProbotOctokitWithDefaults(options: Options) {
   const authOptions = options.githubToken
-    ? { auth: options.githubToken }
+    ? {
+        token: options.githubToken,
+      }
     : {
-        auth: {
-          cache: options.cache,
-          id: options.appId,
-          privateKey: options.privateKey,
-        },
-        authStrategy: createAppAuth,
+        cache: options.cache,
+        appId: options.appId,
+        privateKey: options.privateKey,
       };
 
   const octokitThrottleOptions = getOctokitThrottleOptions({
@@ -49,7 +47,7 @@ export function getProbotOctokitWithDefaults(options: Options) {
     baseUrl:
       process.env.GHE_HOST &&
       `${process.env.GHE_PROTOCOL || "https"}://${process.env.GHE_HOST}/api/v3`,
-    ...authOptions,
+    auth: authOptions,
   };
 
   if (options.throttleOptions || octokitThrottleOptions) {

diff --git a/src/octokit/octokit-webhooks-transform.ts b/src/octokit/octokit-webhooks-transform.ts
@@ -1,6 +1,5 @@
 import { WebhookEvent } from "@octokit/webhooks";
 
-import { getAuthenticatedOctokitForEvent } from "./get-authenticated-octokit-for-event";
 import { Context } from "../context";
 import { State } from "../types";
 
@@ -11,6 +10,9 @@ import { State } from "../types";
  */
 export async function webhookTransform(state: State, event: WebhookEvent) {
   const log = state.log.child({ name: "event", id: event.id });
-  const github = await getAuthenticatedOctokitForEvent(state, event);
+  const github = (await state.octokit.auth({
+    type: "event-octokit",
+    event,
+  })) as typeof state.octokit;
   return new Context(event, github, log);
 }
diff --git a/src/octokit/probot-octokit.ts b/src/octokit/probot-octokit.ts
@@ -1,17 +1,18 @@
 import { Octokit } from "@octokit/core";
 import { enterpriseCompatibility } from "@octokit/plugin-enterprise-compatibility";
 import { RequestOptions } from "@octokit/types";
-
 import { paginateRest } from "@octokit/plugin-paginate-rest";
 import { restEndpointMethods } from "@octokit/plugin-rest-endpoint-methods";
 import { retry } from "@octokit/plugin-retry";
 import { throttling } from "@octokit/plugin-throttling";
 import { config } from "@probot/octokit-plugin-config";
+import { createProbotAuth } from "octokit-auth-probot";
 
 import { probotRequestLogging } from "./octokit-plugin-probot-request-logging";
 import { VERSION } from "../version";
 
 const defaultOptions = {
+  authStrategy: createProbotAuth,
   throttle: {
     onAbuseLimit: (
       retryAfter: number,