[issue 486] Add logging for incoming webhook events fixes #486 (#487)

Co-authored-by: Siba sankar Nayak <sibasankarnayak@Sibas-Air.lan>
Co-authored-by: siba <siba@ip-172-31-33-5.ap-south-1.compute.internal>

plugin.json

@@ -111,6 +111,13 @@
                         "value": "disable"
                     }
                 ]
+            },
+            {
+                "key": "EnableWebhookEventLogging",
+                "display_name": "Enable Webhook Event Logging:",
+                "type": "bool",
+                "help_text": "Allow the plugin to log the webhook event. The log level needs to be set to DEBUG.",
+                "default": false
             }
         ],
         "footer": "* To report an issue, make a suggestion or a contribution, [check the repository](https://github.com/mattermost/mattermost-plugin-github)."

server/plugin/configuration.go

@@ -30,6 +30,7 @@ type Configuration struct {
 	EnterpriseBaseURL           string
 	EnterpriseUploadURL         string
 	EnableCodePreview           string
+	EnableWebhookEventLogging   bool
 	UsePreregisteredApplication bool
 }
 

server/plugin/manifest.go

@@ -148,6 +148,14 @@ const manifestStr = `
             "value": "disable"
           }
         ]
+      },
+      {
+        "key": "EnableWebhookEventLogging",
+        "display_name": "Enable Webhook Event Logging:",
+        "type": "bool",
+        "help_text": "Allow the plugin to log the webhook event. The log level needs to be set to DEBUG.",
+        "placeholder": "",
+        "default": false
       }
     ]
   }

server/plugin/webhook.go

@@ -5,6 +5,7 @@ import (
 	"crypto/hmac"
 	"crypto/sha1" //nolint:gosec // GitHub webhooks are signed using sha1 https://developer.github.com/webhooks/.
 	"encoding/hex"
+	"encoding/json"
 	"io/ioutil"
 	"net/http"
 	"strings"
@@ -61,13 +62,28 @@ func (p *Plugin) handleWebhook(w http.ResponseWriter, r *http.Request) {
 	config := p.getConfiguration()
 
 	signature := r.Header.Get("X-Hub-Signature")
-
 	body, err := ioutil.ReadAll(r.Body)
 	if err != nil {
 		http.Error(w, "Bad request body", http.StatusBadRequest)
 		return
 	}
 
+	event, err := github.ParseWebHook(github.WebHookType(r), body)
+	if err != nil {
+		p.API.LogDebug("GitHub webhook content type should be set to \"application/json\"", "error", err.Error)
+		http.Error(w, "wrong mime-type. should be \"application/json\"", http.StatusBadRequest)
+		return
+	}
+
+	if config.EnableWebhookEventLogging {
+		bodyByte, appErr := json.Marshal(event)
+		if appErr != nil {
+			p.API.LogWarn("Error while Marshal Webhook Request", "err", appErr.Error())
+			http.Error(w, "Error while Marshal Webhook Request", http.StatusBadRequest)
+			return
+		}
+		p.API.LogDebug("Webhook Event Log", "event", string(bodyByte))
+	}
 	valid, err := verifyWebhookSignature([]byte(config.WebhookSecret), signature, body)
 	if err != nil {
 		p.API.LogWarn("Failed to verify webhook signature", "error", err.Error())
@@ -80,13 +96,6 @@ func (p *Plugin) handleWebhook(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	event, err := github.ParseWebHook(github.WebHookType(r), body)
-	if err != nil {
-		p.API.LogDebug("GitHub webhook content type should be set to \"application/json\"", "error", err.Error)
-		http.Error(w, "wrong mime-type. should be \"application/json\"", http.StatusBadRequest)
-		return
-	}
-
 	var repo *github.Repository
 	var handler func()
 

webapp/src/manifest.ts

@@ -137,6 +137,14 @@ const manifest = JSON.parse(`
                         "value": "disable"
                     }
                 ]
+            },
+            {
+                "key": "EnableWebhookEventLogging",
+                "display_name": "Enable Webhook Event Logging:",
+                "type": "bool",
+                "help_text": "Allow the plugin to log the webhook event. The log level needs to be set to DEBUG.",
+                "placeholder": "",
+                "default": false
             }
         ]
     }