feat(sub): add template variables to subscription metadata (#6163)

2026-08-16 08:10:58 +00:00 · 2026-08-15 17:38:29 +02:00
parent 8c8556ab32
commit 2d669fa4b7
22 changed files with 457 additions and 108 deletions
@@ -0,0 +1,132 @@
+package sub
+
+import (
+	"testing"
+
+	"github.com/mhsanaei/3x-ui/v3/internal/database"
+	"github.com/mhsanaei/3x-ui/v3/internal/database/model"
+)
+
+func TestRenderSubPlaceholders(t *testing.T) {
+	data := subPlaceholderData{
+		SubID: "sub-123",
+		Context: remarkContext{client: model.Client{
+			Email:  "Ilnur",
+			ID:     "abcdef12-3456-7890-abcd-ef1234567890",
+			SubID:  "sub-123",
+			TgID:   42,
+			Enable: true,
+		}},
+		HasCtx: true,
+	}
+
+	tests := []struct {
+		name string
+		tmpl string
+		data subPlaceholderData
+		want string
+	}{
+		{
+			name: "identity tokens",
+			tmpl: "{{EMAIL}}/{{ID}}/{{SHORT_ID}}/{{SUB_ID}}/{{TELEGRAM_ID}}",
+			data: data,
+			want: "Ilnur/abcdef12-3456-7890-abcd-ef1234567890/abcdef12/sub-123/42",
+		},
+		{
+			name: "no template",
+			tmpl: "isVPN",
+			data: subPlaceholderData{SubID: "sub-123"},
+			want: "isVPN",
+		},
+		{
+			name: "unsupported tokens stay literal",
+			tmpl: "{{SUB_ID}}/{{INBOUND}}/{{TRAFFIC_LEFT}}/{{PROTOCOL}}/{EMAIL}",
+			data: subPlaceholderData{SubID: "sub-123"},
+			want: "sub-123/{{INBOUND}}/{{TRAFFIC_LEFT}}/{{PROTOCOL}}/{EMAIL}",
+		},
+		{
+			name: "URL values are escaped",
+			tmpl: "https://support.example/?email={{EMAIL}}&sub={{SUB_ID}}",
+			data: subPlaceholderData{
+				SubID: "sub id",
+				Context: remarkContext{client: model.Client{
+					Email: "john doe@example.com",
+					SubID: "sub id",
+				}},
+				HasCtx: true,
+				Escape: true,
+			},
+			want: "https://support.example/?email=john+doe%40example.com&sub=sub+id",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := renderSubPlaceholders(tt.tmpl, tt.data); got != tt.want {
+				t.Fatalf("renderSubPlaceholders() = %q, want %q", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestMetadataForSubRequestDoesNotExpandFallbackProfileURL(t *testing.T) {
+	a := &SUBController{
+		subTitle:      "isVPN",
+		subSupportUrl: "https://support.example/",
+	}
+	fallback := "https://sub.example.com/sub/sub-123?x={{EMAIL}}"
+
+	metadata := a.metadataForSubRequest(func() *SubService {
+		t.Fatal("metadataForSubRequest loaded a subscription context without configured placeholders")
+		return nil
+	}, "sub-123", fallback)
+
+	if metadata.ProfileURL != fallback {
+		t.Fatalf("ProfileURL = %q, want untouched fallback %q", metadata.ProfileURL, fallback)
+	}
+}
+
+func TestMetadataForSubRequestUsesStableClientIdentity(t *testing.T) {
+	initSubDB(t)
+	db := database.GetDB()
+	first := model.ClientRecord{
+		Email:  "john doe@example.com",
+		SubID:  "sub-123",
+		UUID:   "abcdef12-3456-7890-abcd-ef1234567890",
+		TgID:   42,
+		Enable: true,
+	}
+	second := model.ClientRecord{
+		Email:  "jane@example.com",
+		SubID:  "sub-123",
+		UUID:   "fedcba98-3456-7890-abcd-ef1234567890",
+		TgID:   99,
+		Enable: true,
+	}
+	if err := db.Create(&first).Error; err != nil {
+		t.Fatalf("seed first client: %v", err)
+	}
+	if err := db.Create(&second).Error; err != nil {
+		t.Fatalf("seed second client: %v", err)
+	}
+
+	a := &SUBController{
+		subTitle:      "isVPN — {{EMAIL}}",
+		subSupportUrl: "https://support.example/?email={{EMAIL}}&tg={{TELEGRAM_ID}}",
+		subProfileUrl: "https://profile.example/account/{{ID}}",
+		subAnnounce:   "Subscription {{SUB_ID}}",
+	}
+	metadata := a.metadataForSubRequest(func() *SubService { return &SubService{} }, "sub-123", "https://fallback.example/{{EMAIL}}")
+
+	if metadata.Title != "isVPN — john doe@example.com" {
+		t.Fatalf("Title = %q", metadata.Title)
+	}
+	if metadata.SupportURL != "https://support.example/?email=john+doe%40example.com&tg=42" {
+		t.Fatalf("SupportURL = %q", metadata.SupportURL)
+	}
+	if metadata.ProfileURL != "https://profile.example/account/abcdef12-3456-7890-abcd-ef1234567890" {
+		t.Fatalf("ProfileURL = %q", metadata.ProfileURL)
+	}
+	if metadata.Announce != "Subscription sub-123" {
+		t.Fatalf("Announce = %q", metadata.Announce)
+	}
+}