Merge pull request #8900 from internet-development/caidanw/app-1413-clean-up-canonical-urls

feat: implement canonical URL filter to clean parameters for SEO

bskyweb/cmd/bskyweb/filters.go

@@ -0,0 +1,28 @@
+package main
+
+import (
+	"net/url"
+
+	"github.com/flosch/pongo2/v6"
+)
+
+func init() {
+	pongo2.RegisterFilter("canonicalize_url", filterCanonicalizeURL)
+}
+
+func filterCanonicalizeURL(in *pongo2.Value, param *pongo2.Value) (*pongo2.Value, *pongo2.Error) {
+	urlStr := in.String()
+
+	parsedURL, err := url.Parse(urlStr)
+	if err != nil {
+		// If parsing fails, return the original URL
+		return in, nil
+	}
+
+	// Remove query parameters and fragment
+	parsedURL.RawQuery = ""
+	parsedURL.Fragment = ""
+
+	// Return the cleaned URL
+	return pongo2.AsValue(parsedURL.String()), nil
+}

bskyweb/cmd/bskyweb/filters_test.go

@@ -0,0 +1,61 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/flosch/pongo2/v6"
+)
+
+func TestCanonicalizeURLFilter(t *testing.T) {
+	tests := []struct {
+		name     string
+		input    string
+		expected string
+	}{
+		{
+			name:     "clean URL",
+			input:    "https://bsky.app/profile/user",
+			expected: "https://bsky.app/profile/user",
+		},
+		{
+			name:     "URL with query params",
+			input:    "https://bsky.app/profile/user?utm_source=test",
+			expected: "https://bsky.app/profile/user",
+		},
+		{
+			name:     "URL with multiple params",
+			input:    "https://bsky.app/profile/user?utm_source=twitter&utm_campaign=test",
+			expected: "https://bsky.app/profile/user",
+		},
+		{
+			name:     "URL with fragment",
+			input:    "https://bsky.app/profile/user#section",
+			expected: "https://bsky.app/profile/user",
+		},
+		{
+			name:     "URL with both params and fragment",
+			input:    "https://bsky.app/profile/user?param=1#section",
+			expected: "https://bsky.app/profile/user",
+		},
+		{
+			name:     "malformed URL",
+			input:    "not-a-url",
+			expected: "not-a-url", // Should return original on error
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			inputValue := pongo2.AsValue(tt.input)
+			result, err := filterCanonicalizeURL(inputValue, nil)
+			if err != nil {
+				t.Errorf("filterCanonicalizeURL() error = %v", err)
+				return
+			}
+
+			if result.String() != tt.expected {
+				t.Errorf("filterCanonicalizeURL() = %v, want %v", result.String(), tt.expected)
+			}
+		})
+	}
+}

bskyweb/templates/post.html

@@ -14,7 +14,7 @@
   <meta property="profile:username" content="{{ profileView.Handle }}">
   {%- if requestURI %}
   <meta property="og:url" content="{{ requestURI }}">
-  <link rel="canonical" href="{{ requestURI }}" />
+  <link rel="canonical" href="{{ requestURI|canonicalize_url }}" />
   {% endif -%}
   {%- if postView.Author.DisplayName %}
   <meta property="og:title" content="{{ postView.Author.DisplayName }} (@{{ postView.Author.Handle }})">

bskyweb/templates/profile.html

@@ -15,7 +15,7 @@
   <meta property="profile:username" content="{{ profileView.Handle }}">
   {%- if requestURI %}
   <meta property="og:url" content="{{ requestURI }}">
-  <link rel="canonical" href="{{ requestURI }}" />
+  <link rel="canonical" href="{{ requestURI|canonicalize_url }}" />
   {% endif -%}
   {%- if profileView.DisplayName %}
   <meta property="og:title" content="{{ profileView.DisplayName }} (@{{ profileView.Handle }})">