fix(pkg/blockbuilder): make settings fields nilable

qdm12 · Jun 14, 2023 · 42276e5 · 42276e5
1 parent 55c6711
commit 42276e5
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 36 deletions.
diff --git a/internal/setup/block.go b/internal/setup/block.go
@@ -12,9 +12,9 @@ func BuildBlockBuilder(userSettings settings.Block,
 	client *http.Client) (blockBuilder *blockbuilder.Builder) {
 	settings := blockbuilder.Settings{
 		Client:            client,
-		BlockMalicious:    *userSettings.BlockMalicious,
-		BlockAds:          *userSettings.BlockAds,
-		BlockSurveillance: *userSettings.BlockSurveillance,
+		BlockMalicious:    userSettings.BlockMalicious,
+		BlockAds:          userSettings.BlockAds,
+		BlockSurveillance: userSettings.BlockSurveillance,
 	}
 
 	settings.AllowedHosts = make([]string, len(userSettings.AllowedHosts))

diff --git a/pkg/blockbuilder/all_test.go b/pkg/blockbuilder/all_test.go
@@ -36,23 +36,23 @@ func Test_Builder_BuildAll(t *testing.T) { //nolint:cyclop,maintidx
 	}{
 		"none blocked": {
 			settings: Settings{
-				BlockMalicious:    false,
-				BlockAds:          false,
-				BlockSurveillance: false,
+				BlockMalicious:    ptrTo(false),
+				BlockAds:          ptrTo(false),
+				BlockSurveillance: ptrTo(false),
 			},
 		},
 		"all blocked without lists": {
 			settings: Settings{
-				BlockMalicious:    true,
-				BlockAds:          true,
-				BlockSurveillance: true,
+				BlockMalicious:    ptrTo(true),
+				BlockAds:          ptrTo(true),
+				BlockSurveillance: ptrTo(true),
 			},
 		},
 		"all blocked with lists": {
 			settings: Settings{
-				BlockMalicious:    true,
-				BlockAds:          true,
-				BlockSurveillance: true,
+				BlockMalicious:    ptrTo(true),
+				BlockAds:          ptrTo(true),
+				BlockSurveillance: ptrTo(true),
 			},
 			maliciousHosts: httpCase{
 				content: []byte("malicious.com"),
@@ -77,9 +77,9 @@ func Test_Builder_BuildAll(t *testing.T) { //nolint:cyclop,maintidx
 		},
 		"all blocked with allowed hostnames": {
 			settings: Settings{
-				BlockMalicious:    true,
-				BlockAds:          true,
-				BlockSurveillance: true,
+				BlockMalicious:    ptrTo(true),
+				BlockAds:          ptrTo(true),
+				BlockSurveillance: ptrTo(true),
 				AllowedHosts:      []string{"ads.com"},
 			},
 			maliciousHosts: httpCase{
@@ -105,9 +105,9 @@ func Test_Builder_BuildAll(t *testing.T) { //nolint:cyclop,maintidx
 		},
 		"blocked with additional blocked IP addresses": {
 			settings: Settings{
-				BlockMalicious:    true,
-				BlockAds:          false,
-				BlockSurveillance: false,
+				BlockMalicious:    ptrTo(true),
+				BlockAds:          ptrTo(false),
+				BlockSurveillance: ptrTo(false),
 				AddBlockedIPs:     []netip.Addr{netip.AddrFrom4([4]byte{1, 2, 3, 7})},
 			},
 			maliciousHosts: httpCase{
@@ -121,9 +121,9 @@ func Test_Builder_BuildAll(t *testing.T) { //nolint:cyclop,maintidx
 		},
 		"all blocked with lists and one error": {
 			settings: Settings{
-				BlockMalicious:    true,
-				BlockAds:          true,
-				BlockSurveillance: true,
+				BlockMalicious:    ptrTo(true),
+				BlockAds:          ptrTo(true),
+				BlockSurveillance: ptrTo(true),
 			},
 			maliciousHosts: httpCase{
 				content: []byte("malicious.com"),
@@ -151,9 +151,9 @@ func Test_Builder_BuildAll(t *testing.T) { //nolint:cyclop,maintidx
 		},
 		"all blocked with errors": {
 			settings: Settings{
-				BlockMalicious:    true,
-				BlockAds:          true,
-				BlockSurveillance: true,
+				BlockMalicious:    ptrTo(true),
+				BlockAds:          ptrTo(true),
+				BlockSurveillance: ptrTo(true),
 			},
 			maliciousHosts: httpCase{
 				err: errors.New("malicious hostnames"),
@@ -195,15 +195,15 @@ func Test_Builder_BuildAll(t *testing.T) { //nolint:cyclop,maintidx
 			}{
 				m: make(map[string]int),
 			}
-			if tc.settings.BlockMalicious {
+			if *tc.settings.BlockMalicious {
 				clientCalls.m[maliciousBlockListIPsURL] = 0
 				clientCalls.m[maliciousBlockListHostnamesURL] = 0
 			}
-			if tc.settings.BlockAds {
+			if *tc.settings.BlockAds {
 				clientCalls.m[adsBlockListIPsURL] = 0
 				clientCalls.m[adsBlockListHostnamesURL] = 0
 			}
-			if tc.settings.BlockSurveillance {
+			if *tc.settings.BlockSurveillance {
 				clientCalls.m[surveillanceBlockListIPsURL] = 0
 				clientCalls.m[surveillanceBlockListHostnamesURL] = 0
 			}

diff --git a/pkg/blockbuilder/builder.go b/pkg/blockbuilder/builder.go
@@ -17,9 +17,9 @@ func New(settings Settings) *Builder {
 
 	return &Builder{
 		client:               settings.Client,
-		blockMalicious:       settings.BlockMalicious,
-		blockAds:             settings.BlockAds,
-		blockSurveillance:    settings.BlockSurveillance,
+		blockMalicious:       *settings.BlockMalicious,
+		blockAds:             *settings.BlockAds,
+		blockSurveillance:    *settings.BlockSurveillance,
 		allowedHosts:         settings.AllowedHosts,
 		allowedIPs:           settings.AllowedIPs,
 		allowedIPPrefixes:    settings.AllowedIPPrefixes,

diff --git a/pkg/blockbuilder/helpers_test.go b/pkg/blockbuilder/helpers_test.go
@@ -4,6 +4,10 @@ import (
 	"net/netip"
 )
 
+func ptrTo[T any](x T) *T {
+	return &x
+}
+
 func convertIPsToString(ips []netip.Addr) (ipStrings []string) {
 	ipStrings = make([]string, len(ips))
 	for i := range ips {

diff --git a/pkg/blockbuilder/settings.go b/pkg/blockbuilder/settings.go
@@ -14,9 +14,9 @@ import (
 
 type Settings struct {
 	Client               *http.Client
-	BlockMalicious       bool
-	BlockAds             bool
-	BlockSurveillance    bool
+	BlockMalicious       *bool
+	BlockAds             *bool
+	BlockSurveillance    *bool
 	AllowedHosts         []string
 	AllowedIPs           []netip.Addr
 	AllowedIPPrefixes    []netip.Prefix
@@ -27,6 +27,9 @@ type Settings struct {
 
 func (s *Settings) SetDefaults() {
 	s.Client = gosettings.DefaultPointerRaw(s.Client, http.DefaultClient)
+	s.BlockMalicious = gosettings.DefaultPointer(s.BlockMalicious, false)
+	s.BlockAds = gosettings.DefaultPointer(s.BlockAds, false)
+	s.BlockSurveillance = gosettings.DefaultPointer(s.BlockSurveillance, false)
 }
 
 var hostRegex = regexp.MustCompile(`^([a-zA-Z0-9]|[a-zA-Z0-9_][a-zA-Z0-9\-_]{0,61}[a-zA-Z0-9_])(\.([a-zA-Z0-9]|[a-zA-Z0-9_][a-zA-Z0-9\-_]{0,61}[a-zA-Z0-9]))*$`) //nolint:lll
@@ -60,13 +63,13 @@ func (s *Settings) ToLinesNode() (node *gotree.Node) {
 	node = gotree.New("Filter build settings:")
 
 	var blockedCategories []string
-	if s.BlockMalicious {
+	if *s.BlockMalicious {
 		blockedCategories = append(blockedCategories, "malicious")
 	}
-	if s.BlockSurveillance {
+	if *s.BlockSurveillance {
 		blockedCategories = append(blockedCategories, "surveillance")
 	}
-	if s.BlockAds {
+	if *s.BlockAds {
 		blockedCategories = append(blockedCategories, "ads")
 	}