feat(middleware): PR fixes

Author: tg44

README.md

@@ -370,7 +370,7 @@ Returns a promise. Runs all handlers set with [`webhooks.on()`](#webhookson) in
 
 The `.receive()` method belongs to the `event-handler` module which can be used [standalone](src/event-handler/).
 
-The `originalRequest` is an optional parameter, if it is set, it will be available in the `on` functions. 
+The `originalRequest` is an optional parameter, if it is set, it will be available in the `on` functions.
 
 ### webhooks.on()
 
@@ -581,44 +581,32 @@ createServer(middleware).listen(3000);
       <td>
         <code>path</code>
         <em>
-          string
+          string | RegEx
         </em>
       </td>
       <td>
         Custom path to match requests against. Defaults to <code>/api/github/webhooks</code>.
-      </td>
-    </tr>
-    <tr>
-      <td>
-        <code>pathRegex</code>
-        <em>
-          RegEx
-        </em>
-      </td>
-      <td>
 
-Custom path matcher. If set, overrides the <code>path</code> option.
-Can be used as;
+Can be used as a regular expression;
 
 ```js
-const middleware = createNodeMiddleware(
-  webhooks, 
-  { pathRegex: /^\/api\/github\/webhooks/ }
-);
+const middleware = createNodeMiddleware(webhooks, {
+  path: /^\/api\/github\/webhooks/,
+});
 ```
 
 Test the regex before usage, the `g` and `y` flags [makes it stateful](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/test)!
 
 </td>
-    </tr>
-    <tr>
-      <td>
-        <code>log</code>
-        <em>
-          object
-        </em>
-      </td>
-      <td>
+</tr>
+<tr>
+<td>
+<code>log</code>
+<em>
+object
+</em>
+</td>
+<td>
 
 Used for internal logging. Defaults to [`console`](https://developer.mozilla.org/en-US/docs/Web/API/console) with `debug` and `info` doing nothing.
 

src/middleware/node/index.ts

@@ -8,14 +8,12 @@ export function createNodeMiddleware(
   webhooks: Webhooks,
   {
     path = "/api/github/webhooks",
-    pathRegex = undefined,
     onUnhandledRequest = onUnhandledRequestDefault,
     log = createLogger(),
   }: MiddlewareOptions = {}
 ) {
   return middleware.bind(null, webhooks, {
     path,
-    pathRegex,
     onUnhandledRequest,
     log,
   } as Required<MiddlewareOptions>);

src/middleware/node/middleware.ts

@@ -44,9 +44,10 @@ export async function middleware(
     );
     return;
   }
-  const pathMatch = options.pathRegex
-    ? options.pathRegex.test(pathname)
-    : pathname === options.path;
+  const pathMatch =
+    options.path instanceof RegExp
+      ? options.path.test(pathname)
+      : pathname === options.path;
   const isUnknownRoute = request.method !== "POST" || !pathMatch;
   const isExpressMiddleware = typeof next === "function";
   if (isUnknownRoute) {
@@ -87,6 +88,11 @@ export async function middleware(
     response.end("still processing\n");
   }, 9000);
 
+  /* istanbul ignore else */
+  if (typeof timeout.unref === "function") {
+    timeout.unref();
+  }
+
   try {
     const payload = await getPayload(request);
 

src/middleware/node/types.ts

@@ -6,8 +6,7 @@ import { Logger } from "../../createLogger";
 import { IncomingMessage, ServerResponse } from "./middleware";
 
 export type MiddlewareOptions = {
-  path?: string;
-  pathRegex?: RegExp;
+  path?: string | RegExp;
   log?: Logger;
   onUnhandledRequest?: (
     request: IncomingMessage,

test/integration/node-middleware.test.ts

@@ -62,7 +62,7 @@ describe("createNodeMiddleware(webhooks)", () => {
     server.close();
   });
 
-  test("pathRegex match", async () => {
+  test("path match with regex", async () => {
     expect.assertions(7);
 
     const webhooks = new Webhooks({
@@ -71,7 +71,7 @@ describe("createNodeMiddleware(webhooks)", () => {
 
     const server = createServer(
       createNodeMiddleware(webhooks, {
-        pathRegex: /^\/api\/github\/webhooks/,
+        path: /^\/api\/github\/webhooks/,
       })
     ).listen();
 
@@ -129,7 +129,7 @@ describe("createNodeMiddleware(webhooks)", () => {
     server.close();
   });
 
-  test("original request passed by as intented", async () => {
+  test("original request passed by as intended", async () => {
     expect.assertions(6);
 
     const webhooks = new Webhooks({
@@ -138,7 +138,7 @@ describe("createNodeMiddleware(webhooks)", () => {
 
     const server = createServer(
       createNodeMiddleware(webhooks, {
-        pathRegex: /^\/api\/github\/webhooks/,
+        path: /^\/api\/github\/webhooks/,
       })
     ).listen();