feat(typescript): compile-time error when missing secret option (#461)

Author: jablko

src/index.ts

@@ -46,12 +46,12 @@ class Webhooks<TTransformed = unknown> {
     next?: (err?: any) => void
   ) => void | Promise<void>;
 
-  constructor(options: Options<TTransformed>) {
+  constructor(options: Options<TTransformed> & { secret: string }) {
     if (!options || !options.secret) {
       throw new Error("[@octokit/webhooks] options.secret required");
     }
 
-    const state: State = {
+    const state: State & { secret: string } = {
       eventHandler: createEventHandler(options),
       path: options.path || "/",
       secret: options.secret,
@@ -88,7 +88,9 @@ class Webhooks<TTransformed = unknown> {
 }
 
 /** @deprecated `createWebhooksApi()` is deprecated and will be removed in a future release of `@octokit/webhooks`, please use the `Webhooks` class instead */
-const createWebhooksApi = <TTransformed>(options: Options<TTransformed>) => {
+const createWebhooksApi = <TTransformed>(
+  options: Options<TTransformed> & { secret: string }
+) => {
   const log = createLogger(options.log);
   log.warn(
     "[@octokit/webhooks] `createWebhooksApi()` is deprecated and will be removed in a future release of `@octokit/webhooks`, please use the `Webhooks` class instead"

src/middleware-legacy/index.ts

@@ -4,12 +4,12 @@ import { createEventHandler } from "../event-handler/index";
 import { middleware } from "./middleware";
 import { Options, State } from "../types";
 
-export function createMiddleware(options: Options) {
+export function createMiddleware(options: Options & { secret: string }) {
   if (!options || !options.secret) {
     throw new Error("[@octokit/webhooks] options.secret required");
   }
 
-  const state: State = {
+  const state: State & { secret: string } = {
     eventHandler: createEventHandler(options),
     path: options.path || "/",
     secret: options.secret,

src/middleware-legacy/middleware.ts

@@ -7,7 +7,7 @@ import { IncomingMessage, ServerResponse } from "http";
 import { State, WebhookEventHandlerError } from "../types";
 
 export function middleware(
-  state: State,
+  state: State & { secret: string },
   request: IncomingMessage,
   response: ServerResponse,
   next?: Function

src/middleware-legacy/verify-and-receive.ts

@@ -2,15 +2,11 @@ import { EmitterWebhookEvent, State } from "../types";
 import { verify } from "../verify/index";
 
 export function verifyAndReceive(
-  state: State,
+  state: State & { secret: string },
   event: EmitterWebhookEvent & { signature: string }
 ): any {
   // verify will validate that the secret is not undefined
-  const matchesSignature = verify(
-    state.secret!,
-    event.payload,
-    event.signature
-  );
+  const matchesSignature = verify(state.secret, event.payload, event.signature);
 
   if (!matchesSignature) {
     const error = new Error(

test/unit/middleware-constructor-test.ts

@@ -1,5 +1,6 @@
 import { createMiddleware as Middleware } from "../../src/middleware-legacy";
 
 test("options: none", () => {
+  // @ts-expect-error
   expect(() => Middleware({})).toThrow();
 });

test/unit/middleware-test.ts

@@ -20,6 +20,7 @@ test("next() callback", () => {
 
   middleware(
     {
+      secret: "mysecret",
       hooks: {},
       log: console,
     },
@@ -45,7 +46,7 @@ describe("when does a timeout on retrieving the payload", () => {
     mockVerifyAndReceive.mockResolvedValueOnce(undefined);
 
     const promiseMiddleware = middleware(
-      { hooks: {}, path: "/foo", log: console },
+      { secret: "mysecret", hooks: {}, path: "/foo", log: console },
       ({
         method: "POST",
         url: "/foo",
@@ -78,7 +79,7 @@ describe("when does a timeout on retrieving the payload", () => {
     mockVerifyAndReceive.mockRejectedValueOnce(new Error("random error"));
 
     const promiseMiddleware = middleware(
-      { hooks: {}, path: "/foo", log: console },
+      { secret: "mysecret", hooks: {}, path: "/foo", log: console },
       ({
         method: "POST",
         url: "/foo",