feat!: Change Hook.Config field from map to *HookConfig (#3073)

Fixes: #3072. BREAKING CHANGE: Changes `Hook.Config` from `map[string]interface{}` to `*HookConfig`.
google · Feb 17, 2024 · 7342217 · 7342217
1 parent 454c1dd
commit 7342217
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 29 deletions.
diff --git a/github/event_types_test.go b/github/event_types_test.go
@@ -7691,6 +7691,7 @@ func TestPingEvent_Marshal(t *testing.T) {
 
 	l := make(map[string]interface{})
 	l["key"] = "value"
+	hookConfig := new(HookConfig)
 
 	u := &PingEvent{
 		Zen:    String("z"),
@@ -7705,7 +7706,7 @@ func TestPingEvent_Marshal(t *testing.T) {
 			TestURL:      String("tu"),
 			PingURL:      String("pu"),
 			LastResponse: l,
-			Config:       l,
+			Config:       hookConfig,
 			Events:       []string{"a"},
 			Active:       Bool(true),
 		},
@@ -12165,6 +12166,9 @@ func TestMetaEvent_Marshal(t *testing.T) {
 
 	v := make(map[string]interface{})
 	v["a"] = "b"
+	hookConfig := &HookConfig{
+		ContentType: String("json"),
+	}
 
 	u := &MetaEvent{
 		Action: String("a"),
@@ -12179,7 +12183,7 @@ func TestMetaEvent_Marshal(t *testing.T) {
 			TestURL:      String("tu"),
 			PingURL:      String("pu"),
 			LastResponse: v,
-			Config:       v,
+			Config:       hookConfig,
 			Events:       []string{"a"},
 			Active:       Bool(true),
 		},
@@ -12201,7 +12205,7 @@ func TestMetaEvent_Marshal(t *testing.T) {
 				"a": "b"
 			},
 			"config": {
-				"a": "b"
+				"content_type": "json"
 			},
 			"events": [
 				"a"

diff --git a/github/github-accessors.go b/github/github-accessors.go
diff --git a/github/github-accessors_test.go b/github/github-accessors_test.go
diff --git a/github/github-stringify_test.go b/github/github-stringify_test.go
diff --git a/github/orgs_audit_log.go b/github/orgs_audit_log.go
@@ -20,16 +20,6 @@ type GetAuditLogOptions struct {
 	ListCursorOptions
 }
 
-// HookConfig describes metadata about a webhook configuration.
-type HookConfig struct {
-	ContentType *string `json:"content_type,omitempty"`
-	InsecureSSL *string `json:"insecure_ssl,omitempty"`
-	URL         *string `json:"url,omitempty"`
-
-	// Secret is returned obfuscated by GitHub, but it can be set for outgoing requests.
-	Secret *string `json:"secret,omitempty"`
-}
-
 // ActorLocation contains information about reported location for an actor.
 type ActorLocation struct {
 	CountryCode *string `json:"country_code,omitempty"`

diff --git a/github/repos_hooks.go b/github/repos_hooks.go
@@ -51,9 +51,9 @@ type Hook struct {
 
 	// Only the following fields are used when creating a hook.
 	// Config is required.
-	Config map[string]interface{} `json:"config,omitempty"`
-	Events []string               `json:"events,omitempty"`
-	Active *bool                  `json:"active,omitempty"`
+	Config *HookConfig `json:"config,omitempty"`
+	Events []string    `json:"events,omitempty"`
+	Active *bool       `json:"active,omitempty"`
 }
 
 func (h Hook) String() string {
@@ -67,10 +67,10 @@ func (h Hook) String() string {
 // information.
 type createHookRequest struct {
 	// Config is required.
-	Name   string                 `json:"name"`
-	Config map[string]interface{} `json:"config,omitempty"`
-	Events []string               `json:"events,omitempty"`
-	Active *bool                  `json:"active,omitempty"`
+	Name   string      `json:"name"`
+	Config *HookConfig `json:"config,omitempty"`
+	Events []string    `json:"events,omitempty"`
+	Active *bool       `json:"active,omitempty"`
 }
 
 // CreateHook creates a Hook for the specified repository.

diff --git a/github/repos_hooks_configuration.go b/github/repos_hooks_configuration.go
@@ -10,6 +10,21 @@ import (
 	"fmt"
 )
 
+// HookConfig describes metadata about a webhook configuration.
+type HookConfig struct {
+	// The media type used to serialize the payloads
+	// Possible values are `json` and `form`, the field is not specified the default is `form`
+	ContentType *string `json:"content_type,omitempty"`
+	// The possible values are 0 and 1.
+	// Setting it to 1 will allow skip certificate verification for the host,
+	// potentially exposing to MitM attacks: https://en.wikipedia.org/wiki/Man-in-the-middle_attack
+	InsecureSSL *string `json:"insecure_ssl,omitempty"`
+	URL         *string `json:"url,omitempty"`
+
+	// Secret is returned obfuscated by GitHub, but it can be set for outgoing requests.
+	Secret *string `json:"secret,omitempty"`
+}
+
 // GetHookConfiguration returns the configuration for the specified repository webhook.
 //
 // GitHub API docs: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository

diff --git a/github/repos_hooks_test.go b/github/repos_hooks_test.go
@@ -502,17 +502,15 @@ func TestBranchCreateHookRequest_Marshal(t *testing.T) {
 		Name:   "abc",
 		Events: []string{"1", "2", "3"},
 		Active: Bool(true),
-		Config: map[string]interface{}{
-			"thing": "@123",
-		},
+		Config: &HookConfig{ContentType: String("json")},
 	}
 
 	want := `{
 		"name": "abc",
 		"active": true,
 		"events": ["1","2","3"],
 		"config":{
-			"thing": "@123"
+			"content_type": "json"
 		}
 	}`
 
@@ -534,9 +532,7 @@ func TestBranchHook_Marshal(t *testing.T) {
 		LastResponse: map[string]interface{}{
 			"item": "item",
 		},
-		Config: map[string]interface{}{
-			"thing": "@123",
-		},
+		Config: &HookConfig{ContentType: String("json")},
 		Events: []string{"1", "2", "3"},
 		Active: Bool(true),
 	}
@@ -554,7 +550,7 @@ func TestBranchHook_Marshal(t *testing.T) {
 			"item": "item"
 		},
 		"config":{
-			"thing": "@123"
+			"content_type": "json"
 		},
 		"events": ["1","2","3"],
 		"active": true