docs: warn about using experimental features

favonia · Sep 25, 2024 · 9450ade · 9450ade
1 parent 57f6568
commit 9450ade
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 8 deletions.
diff --git a/internal/config/env_notifier.go b/internal/config/env_notifier.go
@@ -12,6 +12,10 @@ func ReadAndAppendShoutrrrURL(ppfmt pp.PP, key string, field *notifier.Notifier)
 		return true
 	}
 
+	ppfmt.Hintf(pp.HintExperimentalShoutrrr,
+		"You are using the experimental shoutrrr support added in 1.12.0. Please report bugs at %s",
+		pp.IssueReportingURL)
+
 	s, ok := notifier.NewShoutrrr(ppfmt, vals)
 	if !ok {
 		return false

diff --git a/internal/config/env_notifier_test.go b/internal/config/env_notifier_test.go
@@ -32,15 +32,17 @@ func TestReadAndAppendShoutrrrURL(t *testing.T) {
 				t.Helper()
 				require.Nil(t, n)
 			},
-			true, nil,
+			true,
+			nil,
 		},
 		"empty": {
 			true, "", nil,
 			func(t *testing.T, n not) {
 				t.Helper()
 				require.Nil(t, n)
 			},
-			true, nil,
+			true,
+			nil,
 		},
 		"generic": {
 			true, "generic+https://example.com/api/v1/postStuff",
@@ -55,7 +57,9 @@ func TestReadAndAppendShoutrrrURL(t *testing.T) {
 				require.Equal(t, []string{"Generic"}, s.ServiceDescriptions)
 			},
 			true,
-			nil,
+			func(m *mocks.MockPP) {
+				m.EXPECT().Hintf(pp.HintExperimentalShoutrrr, "You are using the experimental shoutrrr support added in 1.12.0. Please report bugs at %s", pp.IssueReportingURL) //nolint:lll
+			},
 		},
 		"ill-formed": {
 			true, "meow-meow-meow://cute",
@@ -66,6 +70,7 @@ func TestReadAndAppendShoutrrrURL(t *testing.T) {
 			},
 			false,
 			func(m *mocks.MockPP) {
+				m.EXPECT().Hintf(pp.HintExperimentalShoutrrr, "You are using the experimental shoutrrr support added in 1.12.0. Please report bugs at %s", pp.IssueReportingURL) //nolint:lll
 				m.EXPECT().Noticef(pp.EmojiUserError, `Could not create shoutrrr client: %v`, gomock.Any())
 			},
 		},
@@ -82,7 +87,9 @@ func TestReadAndAppendShoutrrrURL(t *testing.T) {
 				require.Equal(t, []string{"Generic", "Pushover"}, s.ServiceDescriptions)
 			},
 			true,
-			nil,
+			func(m *mocks.MockPP) {
+				m.EXPECT().Hintf(pp.HintExperimentalShoutrrr, "You are using the experimental shoutrrr support added in 1.12.0. Please report bugs at %s", pp.IssueReportingURL) //nolint:lll
+			},
 		},
 	} {
 		t.Run(name, func(t *testing.T) {

diff --git a/internal/config/env_provider.go b/internal/config/env_provider.go
@@ -122,6 +122,9 @@ func ReadProvider(ppfmt pp.PP, key, keyDeprecated string, field *provider.Provid
 			)
 			return false
 		}
+		ppfmt.Hintf(pp.HintExperimentalLocalWithInterface,
+			`You are using the experimental provider "local:%s" added in 1.15.0. Please report bugs at %s`,
+			parts[1], pp.IssueReportingURL)
 		*field = provider.NewLocalWithInterface(parts[1])
 		return true
 	case len(parts) == 2 && parts[0] == "url":

diff --git a/internal/config/env_provider_test.go b/internal/config/env_provider_test.go
@@ -155,7 +155,12 @@ func TestReadProvider(t *testing.T) {
 		"cloudflare.doh":   {true, "    \tcloudflare.doh   ", false, "", none, doh, true, nil},
 		"none":             {true, "   none   ", false, "", trace, none, true, nil},
 		"local":            {true, "   local   ", false, "", trace, local, true, nil},
-		"local:lo":         {true, "   local   :  lo ", false, "", trace, localLoopback, true, nil},
+		"local:lo": {
+			true, "   local   :  lo ", false, "", trace, localLoopback, true,
+			func(m *mocks.MockPP) {
+				m.EXPECT().Hintf(pp.HintExperimentalLocalWithInterface, `You are using the experimental provider "local:%s" added in 1.15.0. Please report bugs at %s`, "lo", pp.IssueReportingURL) //nolint:lll
+			},
+		},
 		"local:": {
 			true, "   local: ", false, "", trace, trace, false,
 			func(m *mocks.MockPP) {

diff --git a/internal/config/env_waf.go b/internal/config/env_waf.go
@@ -27,6 +27,10 @@ func ReadAndAppendWAFListNames(ppfmt pp.PP, key string, field *[]api.WAFList) bo
 		return true
 	}
 
+	ppfmt.Hintf(pp.HintExperimentalWAF,
+		"You're using the new WAF list manipulation feature (added in 1.14.0). Please report bugs at %s",
+		pp.IssueReportingURL)
+
 	lists := make([]api.WAFList, 0, len(vals))
 
 	for _, val := range vals {

diff --git a/internal/config/env_waf_test.go b/internal/config/env_waf_test.go
@@ -35,14 +35,22 @@ func TestReadAndAppendWAFListNames(t *testing.T) {
 			nil,
 			[]api.WAFList{{AccountID: "hey", Name: "hello"}},
 			true,
-			nil,
+			func(m *mocks.MockPP) {
+				m.EXPECT().Hintf(pp.HintExperimentalWAF,
+					"You're using the new WAF list manipulation feature (added in 1.14.0). Please report bugs at %s",
+					pp.IssueReportingURL)
+			},
 		},
 		"two": {
 			true, "hey/hello,here/aloha",
 			nil,
 			[]api.WAFList{{AccountID: "hey", Name: "hello"}, {AccountID: "here", Name: "aloha"}},
 			true,
-			nil,
+			func(m *mocks.MockPP) {
+				m.EXPECT().Hintf(pp.HintExperimentalWAF,
+					"You're using the new WAF list manipulation feature (added in 1.14.0). Please report bugs at %s",
+					pp.IssueReportingURL)
+			},
 		},
 		"one+two": {
 			true, "hey/hello,here/aloha",
@@ -53,14 +61,21 @@ func TestReadAndAppendWAFListNames(t *testing.T) {
 				{AccountID: "here", Name: "aloha"},
 			},
 			true,
-			nil,
+			func(m *mocks.MockPP) {
+				m.EXPECT().Hintf(pp.HintExperimentalWAF,
+					"You're using the new WAF list manipulation feature (added in 1.14.0). Please report bugs at %s",
+					pp.IssueReportingURL)
+			},
 		},
 		"invalid-format": {
 			true, "+++",
 			[]api.WAFList{{AccountID: "there", Name: "ciao"}},
 			[]api.WAFList{{AccountID: "there", Name: "ciao"}},
 			false,
 			func(m *mocks.MockPP) {
+				m.EXPECT().Hintf(pp.HintExperimentalWAF,
+					"You're using the new WAF list manipulation feature (added in 1.14.0). Please report bugs at %s",
+					pp.IssueReportingURL)
 				m.EXPECT().Noticef(pp.EmojiUserError, `List %q should be in format "account-id/list-name"`, "+++")
 			},
 		},
@@ -75,6 +90,9 @@ func TestReadAndAppendWAFListNames(t *testing.T) {
 			},
 			true,
 			func(m *mocks.MockPP) {
+				m.EXPECT().Hintf(pp.HintExperimentalWAF,
+					"You're using the new WAF list manipulation feature (added in 1.14.0). Please report bugs at %s",
+					pp.IssueReportingURL)
 				m.EXPECT().Noticef(pp.EmojiUserWarning, "List name %q contains invalid character %q", "!!!", "!")
 			},
 		},

diff --git a/internal/pp/hint.go b/internal/pp/hint.go
@@ -16,4 +16,7 @@ const (
 	HintMismatchedRecordAttributes
 	HintMismatchedWAFListAttributes
 	Hint1111Blockage
+	HintExperimentalShoutrrr           // introduced in 1.12.0
+	HintExperimentalWAF                // introduced in 1.14.0
+	HintExperimentalLocalWithInterface // introduced in 1.15.0
 )