Repository: octokit/webhooks.js
Pull request #694 (2022-06-27 19:19:59)

ci: adds codeql-analysis.yml for codeql execution
This PR:

- enables codeql for this repo to meet the security and stability requirements of the octokit org.
- Removes the error and stack from being returned from the middleware
- Logs errors to stdout via logger



timrogers: It feels like it would be reasonable to change `response.end(String(error));`. There isn't really any need for that to expose quite so much information, although I don't consider it to be a big deal by any means.
nickfloyd: > It feels like it would be reasonable to change `response.end(String(error));`. There isn't really any need for that to expose quite so much information, although I don't consider it to be a big deal by any means.

I could definitely go to the logging to server log route.  I didn't want to assume I knew why that was there (Chesterton's fence and all 😉).  Perhaps, @gr2m, @wolfy1339, or @G-Rath would have more historical knowledge on why the error is being returned the way it is  - my assumption is that it eases debugging, but again, we should be able to post and get that from server logs.
wolfy1339: That has been there since the very beginnings of this project.

It would make sense to remove it and log it instead
nickfloyd: > It would make sense to remove it and log it instead

Solid.  I'll take care of it in this PR.  Thanks for the 👀!

Patch:
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
new file mode 100644
index 0000000..c170088
--- /dev/null
+++ b/.github/workflows/codeql-analysis.yml
@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '28 11 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'typescript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
diff --git a/src/middleware/node/middleware.ts b/src/middleware/node/middleware.ts
index 95a25cf..f0c818a 100644
--- a/src/middleware/node/middleware.ts
+++ b/src/middleware/node/middleware.ts
@@ -93,8 +93,18 @@ export async function middleware(
 
     if (didTimeout) return;
 
-    const statusCode = Array.from(error as WebhookEventHandlerError)[0].status;
-    response.statusCode = typeof statusCode !== "undefined" ? statusCode : 500;
-    response.end(String(error));
+    const err = Array.from(error as WebhookEventHandlerError)[0];
+    const errorMessage = err.message
+      ? `${err.name}: ${err.message}`
+      : "Error: An Unspecified error occurred";
+    response.statusCode = typeof err.status !== "undefined" ? err.status : 500;
+
+    options.log.error(error);
+
+    response.end(
+      JSON.stringify({
+        error: errorMessage,
+      })
+    );
   }
 }


Test patch:
diff --git a/test/integration/node-middleware.test.ts b/test/integration/node-middleware.test.ts
index 6af202c..d0d69f4 100644
--- a/test/integration/node-middleware.test.ts
+++ b/test/integration/node-middleware.test.ts
@@ -264,7 +264,42 @@ describe("createNodeMiddleware(webhooks)", () => {
       }
     );
 
-    await expect(response.text()).resolves.toMatch(/boom/);
+    await expect(response.text()).resolves.toMatch(/Error: boom/);
+    expect(response.status).toEqual(500);
+
+    server.close();
+  });
+
+  test("Handles empty errors", async () => {
+    const webhooks = new Webhooks({
+      secret: "mySecret",
+    });
+
+    webhooks.on("push", () => {
+      throw new Error();
+    });
+
+    const server = createServer(createNodeMiddleware(webhooks)).listen();
+
+    // @ts-expect-error complains about { port } although it's included in returned AddressInfo interface
+    const { port } = server.address();
+
+    const response = await fetch(
+      `http://localhost:${port}/api/github/webhooks`,
+      {
+        method: "POST",
+        headers: {
+          "X-GitHub-Delivery": "123e4567-e89b-12d3-a456-426655440000",
+          "X-GitHub-Event": "push",
+          "X-Hub-Signature-256": signatureSha256,
+        },
+        body: pushEventPayload,
+      }
+    );
+
+    await expect(response.text()).resolves.toMatch(
+      /Error: An Unspecified error occurred/
+    );
     expect(response.status).toEqual(500);
 
     server.close();