feat: reply after 9s with 202 status

package.json

@@ -20,6 +20,7 @@
     "@pika/pack": "^0.5.0",
     "@pika/plugin-build-node": "^0.9.2",
     "@pika/plugin-build-types": "^0.9.2",
+    "@sinonjs/fake-timers": "^6.0.1",
     "@tsconfig/node10": "^1.0.3",
     "@types/debug": "^4.1.5",
     "@types/express": "^4.17.6",

src/middleware/middleware.ts

@@ -48,6 +48,15 @@ export function middleware(
 
   debugWebhooks(`${eventName} event received (id: ${id})`);
 
+  // GitHub will abort the request if it does not receive a response within 10s
+  // See https://github.com/octokit/webhooks.js/issues/185
+  let didTimeout = false;
+  const timeout = setTimeout(() => {
+    didTimeout = true;
+    response.statusCode = 202;
+    response.end("still processing\n");
+  }, 9000).unref();
+
   return getPayload(request)
     .then((payload: any) => {
       return verifyAndReceive(state, {
@@ -59,10 +68,18 @@ export function middleware(
     })
 
     .then(() => {
+      clearTimeout(timeout);
+
+      if (didTimeout) return;
+
       response.end("ok\n");
     })
 
     .catch((error: WebhookEventHandlerError) => {
+      clearTimeout(timeout);
+
+      if (didTimeout) return;
+
       const statusCode = Array.from(error)[0].status;
       response.statusCode = statusCode || 500;
       response.end(error.toString());

test/integration/server-test.js

@@ -1,4 +1,7 @@
 import http from "http";
+
+import FakeTimers from "@sinonjs/fake-timers";
+
 import axios from "axios";
 import getPort from "get-port";
 import { promisify } from "util";
@@ -249,3 +252,51 @@ test("POST / with hook error", (t) => {
 
     .catch(t.error);
 });
+
+test("POST / with timeout", async (t) => {
+  t.plan(1);
+
+  const clock = FakeTimers.install({
+    toFake: ["setTimeout"],
+  });
+
+  const api = new Webhooks({
+    secret: "mysecret",
+  });
+  const server = http.createServer(api.middleware);
+  const tenSecondsInMs = 10 * 1000;
+
+  api.on("push", async (event) => {
+    await new Promise((resolve) => setTimeout(resolve, tenSecondsInMs));
+  });
+
+  promisify(server.listen.bind(server))(this.port)
+
+    .then(() => {
+      return axios.post(`http://localhost:${this.port}`, pushEventPayload, {
+        headers: {
+          "X-GitHub-Delivery": "123e4567-e89b-12d3-a456-426655440000",
+          "X-GitHub-Event": "push",
+          "X-Hub-Signature": "sha1=f4d795e69b5d03c139cc6ea991ad3e5762d13e2f",
+        },
+      });
+    })
+
+    .catch(t.error)
+
+    .then((result) => {
+      t.is(result.status, 202);
+    })
+
+    .then(() => {
+      server.close();
+      clock.uninstall();
+    })
+
+    .catch(t.error);
+
+  await clock.nextAsync();
+  await clock.nextAsync();
+  await clock.nextAsync();
+  await clock.nextAsync();
+});