Merge pull request #2 from badsyntax/feature/error-handling

Better error handling

Author: badsyntax

.dockerignore

@@ -1,6 +1,7 @@
 node_modules
 npm-debug.log
 build
+.env
 .vscode
 .git
 .gitignore

CONTRIBUTING.md

@@ -21,6 +21,6 @@ curl --header "Content-Type: application/json" \
 
 ```bash
 docker build -t ghcr.io/badsyntax/strapi-webhook-actions-proxy:latest .
-docker run --publish 5000:5000 ghcr.io/badsyntax/strapi-webhook-actions-proxy:latest
+docker run --publish 5000:5000 --env-file .env ghcr.io/badsyntax/strapi-webhook-actions-proxy:latest
 docker push ghcr.io/badsyntax/strapi-webhook-actions-proxy:latest
 ```

README.md

@@ -2,6 +2,12 @@
 
 A super simple & lightweight Node.js proxy to send `repository_dispatch` events to GitHub from a Strapi Webhook.
 
+Useful when you want to run a GitHub Actions workflow when changes are made in strapi.
+
+## Background
+
+You can't point strapi webhooks to the [repository dispatch event endpoint](https://docs.github.com/en/rest/reference/repos#create-a-repository-dispatch-event) as the webook request body is not compatible with the dispatches endpoint, thus a proxy is required.
+
 ## Usage
 
 Ensure your GitHub Actions workflow file handles the "repository_dispatch" event with your custom type:
@@ -16,7 +22,7 @@ on:
 Deploy the service to your server, for example:
 
 ```bash
-docker run --publish 5000:5000 ghcr.io/badsyntax/strapi-webhook-actions-proxy:latest
+docker run --publish 5000:5000 --env GITHUB_TOKEN=YOURTOKEN ghcr.io/badsyntax/strapi-webhook-actions-proxy:latest
 ```
 
 TODO: env

src/routes/api/index.ts

@@ -15,20 +15,31 @@ indexRoute.post(
     if (!repo) {
       return res.status(400).send('repo param missing');
     }
+
     try {
-      await fetch(`https://api.github.com/repos/${repo}/dispatches`, {
-        method: 'post',
-        headers: new Headers({
-          Accept: 'application/vnd.github.v3+json',
-          Authorization: `token ${process.env.GITHUB_TOKEN}`,
-          ContentType: 'application/json',
-        }),
-        body: JSON.stringify({ event_type: eventType }),
+      const response = await fetch(
+        `https://api.github.com/repos/${repo}/dispatches`,
+        {
+          method: 'post',
+          headers: new Headers({
+            Accept: 'application/vnd.github.v3+json',
+            Authorization: `token ${process.env.GITHUB_TOKEN}`,
+            ContentType: 'application/json',
+          }),
+          body: JSON.stringify({
+            event_type: eventType,
+            client_payload: req.body,
+          }),
+        }
+      ).then((response) => {
+        if (!response.ok) {
+          throw new Error(response.statusText);
+        }
       });
       res.status(200).send('Success');
     } catch (e) {
       const msg = 'Error calling actions endpoint';
-      console.error(msg, e.message);
+      console.error(`${msg}:`, e.message);
       res.status(500).send(msg);
     }
   }