feat: update @octokit/webhooks to v9

src/context.ts

@@ -1,7 +1,6 @@
 import path from "path";
 
 import { EmitterWebhookEvent as WebhookEvent } from "@octokit/webhooks";
-import { Repository } from "@octokit/webhooks-types";
 import merge from "deepmerge";
 
 import type { Logger } from "pino";
@@ -13,32 +12,6 @@ import { EmitterWebhookEventName as WebhookEvents } from "@octokit/webhooks/dist
 
 export type MergeOptions = merge.Options;
 
-export interface WebhookPayloadWithRepository {
-  [key: string]: any;
-  repository?: Repository;
-  issue?: {
-    [key: string]: any;
-    number: number;
-    html_url?: string;
-    body?: string;
-  };
-  pull_request?: {
-    [key: string]: any;
-    number: number;
-    html_url?: string;
-    body?: string;
-  };
-  sender?: {
-    [key: string]: any;
-    type: string;
-  };
-  action?: string;
-  installation?: {
-    id: number;
-    [key: string]: any;
-  };
-}
-
 /**
  * The context of the event that was triggered, including the payload and
  * helpers for extracting information can be passed to GitHub API calls.
@@ -56,10 +29,9 @@ export interface WebhookPayloadWithRepository {
  * @property {log} log - A pino instance
  */
 export class Context<E extends WebhookEvents = WebhookEvents> {
-  /*implements WebhookEvent<E>*/
   public name: WebhookEvents;
   public id: string;
-  public payload: WebhookPayloadWithRepository;
+  public payload: WebhookEvent<E>["payload"];
 
   public octokit: InstanceType<typeof ProbotOctokit>;
   public log: DeprecatedLogger;
@@ -90,6 +62,7 @@ export class Context<E extends WebhookEvents = WebhookEvents> {
    *
    */
   public repo<T>(object?: T) {
+    // @ts-ignore `repository` is not always present in this.payload
     const repo = this.payload.repository;
 
     if (!repo) {
@@ -100,7 +73,7 @@ export class Context<E extends WebhookEvents = WebhookEvents> {
 
     return Object.assign(
       {
-        owner: repo.owner.login || repo.owner.name!,
+        owner: repo.owner.login || repo.owner.name,
         repo: repo.name,
       },
       object
@@ -120,10 +93,12 @@ export class Context<E extends WebhookEvents = WebhookEvents> {
    * @param object - Params to be merged with the issue params.
    */
   public issue<T>(object?: T) {
-    const payload = this.payload;
     return Object.assign(
       {
-        issue_number: (payload.issue || payload.pull_request || payload).number,
+        issue_number:
+          // @ts-ignore - this.payload may not have `issue` or `pull_request` keys
+          (this.payload.issue || this.payload.pull_request || this.payload)
+            .number,
       },
       this.repo(object)
     );
@@ -145,6 +120,7 @@ export class Context<E extends WebhookEvents = WebhookEvents> {
     const payload = this.payload;
     return Object.assign(
       {
+        // @ts-ignore - this.payload may not have `issue` or `pull_request` keys
         pull_number: (payload.issue || payload.pull_request || payload).number,
       },
       this.repo(object)
@@ -156,7 +132,9 @@ export class Context<E extends WebhookEvents = WebhookEvents> {
    * @type {boolean}
    */
   get isBot() {
-    return this.payload.sender!.type === "Bot";
+    // @ts-expect-error - `sender` key is currently not present in all events
+    // see https://github.com/octokit/webhooks/issues/510
+    return this.payload.sender.type === "Bot";
   }
 
   /**

src/index.ts

@@ -1,6 +1,6 @@
 import { Logger } from "pino";
 
-import { Context, WebhookPayloadWithRepository } from "./context";
+import { Context } from "./context";
 import { Options, ApplicationFunctionOptions } from "./types";
 import { Probot } from "./probot";
 import { Server } from "./server/server";
@@ -21,4 +21,4 @@ export {
 };
 
 /** NOTE: exported types might change at any point in time */
-export { Options, WebhookPayloadWithRepository, ApplicationFunctionOptions };
+export { Options, ApplicationFunctionOptions };

src/octokit/get-webhooks.ts

@@ -4,10 +4,10 @@ import { State } from "../types";
 import { getErrorHandler } from "../helpers/get-error-handler";
 import { webhookTransform } from "./octokit-webhooks-transform";
 
-import { Context } from "../context";
+// import { Context } from "../context";
 
 export function getWebhooks(state: State) {
-  const webhooks = new Webhooks<Context>({
+  const webhooks = new Webhooks({
     secret: state.webhooks.secret!,
     transform: webhookTransform.bind(null, state),
   });

test/context.test.ts

@@ -9,15 +9,21 @@ import { Context } from "../src";
 import { ProbotOctokit } from "../src/octokit/probot-octokit";
 import { PushEvent } from "@octokit/webhooks-types";
 
-const pushEventPayload = (WebhookExamples.filter(
-  (event) => event.name === "push"
-)[0] as WebhookDefinition<"push">).examples[0];
-const issuesEventPayload = (WebhookExamples.filter(
-  (event) => event.name === "issues"
-)[0] as WebhookDefinition<"issues">).examples[0];
-const pullRequestEventPayload = (WebhookExamples.filter(
-  (event) => event.name === "pull_request"
-)[0] as WebhookDefinition<"pull_request">).examples[0];
+const pushEventPayload = (
+  WebhookExamples.filter(
+    (event) => event.name === "push"
+  )[0] as WebhookDefinition<"push">
+).examples[0];
+const issuesEventPayload = (
+  WebhookExamples.filter(
+    (event) => event.name === "issues"
+  )[0] as WebhookDefinition<"issues">
+).examples[0];
+const pullRequestEventPayload = (
+  WebhookExamples.filter(
+    (event) => event.name === "pull_request"
+  )[0] as WebhookDefinition<"pull_request">
+).examples[0];
 
 describe("Context", () => {
   let event: WebhookEvent<"push"> = {
@@ -191,6 +197,7 @@ describe("Context", () => {
         retry: { enabled: false },
         throttle: { enabled: false },
       });
+      // @ts-ignore - Expression produces a union type that is too complex to represent
       context = new Context(event, octokit, {} as any);
     });