fix: fix bug with trailing version info not being properly stripped (… (#15223)

sreya · bcpeinhardt · web-flow · commit 971b1a87bdd8 · 2024-10-24T20:47:12.000+01:00
…#14963) Fixes a bug where excess version info was not being stripped properly from documentation links. Co-authored-by: Benjamin Peinhardt <61021968+bcpeinhardt@users.noreply.github.com>
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -804,8 +804,12 @@ func DefaultSupportLinks(docsURL string) []LinkConfig {
 	}
 }
 
+func removeTrailingVersionInfo(v string) string {
+	return strings.Split(strings.Split(v, "-")[0], "+")[0]
+}
+
 func DefaultDocsURL() string {
-	version := strings.Split(buildinfo.Version(), "-")[0]
+	version := removeTrailingVersionInfo(buildinfo.Version())
 	if version == "v0.0.0" {
 		return "https://coder.com/docs"
 	}
diff --git a/codersdk/deployment_internal_test.go b/codersdk/deployment_internal_test.go
@@ -0,0 +1,36 @@
+package codersdk
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestRemoveTrailingVersionInfo(t *testing.T) {
+	t.Parallel()
+
+	testCases := []struct {
+		Version                    string
+		ExpectedAfterStrippingInfo string
+	}{
+		{
+			Version:                    "v2.16.0+683a720",
+			ExpectedAfterStrippingInfo: "v2.16.0",
+		},
+		{
+			Version:                    "v2.16.0-devel+683a720",
+			ExpectedAfterStrippingInfo: "v2.16.0",
+		},
+		{
+			Version:                    "v2.16.0+683a720-devel",
+			ExpectedAfterStrippingInfo: "v2.16.0",
+		},
+	}
+
+	for _, tc := range testCases {
+		tc := tc
+
+		stripped := removeTrailingVersionInfo(tc.Version)
+		require.Equal(t, tc.ExpectedAfterStrippingInfo, stripped)
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -804,8 +804,12 @@ func DefaultSupportLinks(docsURL string) []LinkConfig {`
`804`	`804`	`}`
`805`	`805`	`}`
`806`	`806`
	`807`	`+func removeTrailingVersionInfo(v string) string {`
	`808`	`+ return strings.Split(strings.Split(v, "-")[0], "+")[0]`
	`809`	`+}`
	`810`	`+`
`807`	`811`	`func DefaultDocsURL() string {`
`808`		`- version := strings.Split(buildinfo.Version(), "-")[0]`
	`812`	`+ version := removeTrailingVersionInfo(buildinfo.Version())`
`809`	`813`	`if version == "v0.0.0" {`
`810`	`814`	`return "https://coder.com/docs"`
`811`	`815`	`}`