Files
3x-ui/internal/web/service/xray_setting_geodata_test.go
T
Kuzz007 2736f9beb3 feat(xray): autocomplete geosite/geoip categories in the routing rule editor
Writing a routing rule today means remembering exact geosite:/geoip:/
ext:file:code syntax by hand, with no way to discover what categories
actually exist in the .dat files sitting in the bin folder -- including
custom ones like geosite_roscom.dat added via the Geodata auto-update
feature. The Domain/IP fields in the rule editor now suggest categories
as you type (e.g. "you" -> "geosite:youtube"), built live from whatever
.dat files are actually on disk, while still accepting any free-typed
value exactly as before.

Backend: GET /panel/api/xray/getGeodataCategories scans the bin folder,
parses matched geosite*/geoip*.dat files via xray-core's own exported
protobuf types, and formats each category as the exact rule syntax
xray-core's parser accepts -- geosite:/geoip: for the default files,
ext:<file>:<code> for anything else (there's no shorthand for custom
files). Cached in memory keyed by each file's (name, size, modTime) so
a request-time scan is cheap until a file actually changes.

Frontend: the Domain/IP inputs become Select "tags" fields fed by a new
useGeodataCategories() query hook, with an explicit substring filter so
"you" matches "geosite:youtube" (not a prefix). The array<->CSV-string
adapter lives entirely at the FormField transform boundary, so the
underlying form schema and saved rule shape are unchanged.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-26 17:13:07 +03:00

213 lines
6.8 KiB
Go

package service
import (
"os"
"path/filepath"
"slices"
"sort"
"testing"
"time"
"github.com/mhsanaei/3x-ui/v3/internal/config"
"github.com/xtls/xray-core/common/geodata"
"google.golang.org/protobuf/proto"
)
func writeGeoSiteFixture(t *testing.T, dir, name string, codes ...string) {
t.Helper()
list := &geodata.GeoSiteList{}
for _, c := range codes {
list.Entry = append(list.Entry, &geodata.GeoSite{Code: c})
}
data, err := proto.Marshal(list)
if err != nil {
t.Fatalf("marshal fixture geosite list: %v", err)
}
if err := os.WriteFile(filepath.Join(dir, name), data, 0o644); err != nil {
t.Fatalf("write fixture %s: %v", name, err)
}
}
func writeGeoIPFixture(t *testing.T, dir, name string, codes ...string) {
t.Helper()
list := &geodata.GeoIPList{}
for _, c := range codes {
list.Entry = append(list.Entry, &geodata.GeoIP{Code: c})
}
data, err := proto.Marshal(list)
if err != nil {
t.Fatalf("marshal fixture geoip list: %v", err)
}
if err := os.WriteFile(filepath.Join(dir, name), data, 0o644); err != nil {
t.Fatalf("write fixture %s: %v", name, err)
}
}
func TestScanGeodataFiles(t *testing.T) {
dir := t.TempDir()
writeGeoSiteFixture(t, dir, "geosite.dat", "CN")
writeGeoSiteFixture(t, dir, "geosite_roscom.dat", "SOME-CODE")
writeGeoIPFixture(t, dir, "geoip.dat", "PRIVATE")
writeGeoIPFixture(t, dir, "GEOIP_RU.DAT", "RU") // case-insensitive match
if err := os.WriteFile(filepath.Join(dir, "config.json"), []byte("{}"), 0o644); err != nil {
t.Fatalf("write unrelated file: %v", err)
}
if err := os.Mkdir(filepath.Join(dir, "geosite_dir.dat"), 0o755); err != nil {
t.Fatalf("mkdir geosite_dir.dat: %v", err)
}
entries := scanGeodataFiles(dir)
names := make([]string, 0, len(entries))
for _, e := range entries {
names = append(names, e.name)
}
sort.Strings(names)
want := []string{"GEOIP_RU.DAT", "geoip.dat", "geosite.dat", "geosite_roscom.dat"}
sort.Strings(want)
if !slices.Equal(names, want) {
t.Fatalf("scanGeodataFiles names = %v, want %v", names, want)
}
for _, e := range entries {
switch e.name {
case "geosite.dat", "geosite_roscom.dat":
if e.kind != geositeFile {
t.Errorf("%s: kind = %v, want geositeFile", e.name, e.kind)
}
case "geoip.dat", "GEOIP_RU.DAT":
if e.kind != geoipFile {
t.Errorf("%s: kind = %v, want geoipFile", e.name, e.kind)
}
}
}
}
func TestScanGeodataFilesMissingDir(t *testing.T) {
entries := scanGeodataFiles(filepath.Join(t.TempDir(), "does-not-exist"))
if len(entries) != 0 {
t.Fatalf("expected no entries for a missing dir, got %v", entries)
}
}
func TestParseGeodataFile(t *testing.T) {
dir := t.TempDir()
writeGeoSiteFixture(t, dir, "geosite.dat", "CN", "YOUTUBE")
writeGeoIPFixture(t, dir, "geoip_rosip.dat", "RU")
siteCodes, err := parseGeodataFile(geodataFileEntry{
name: "geosite.dat", path: filepath.Join(dir, "geosite.dat"), kind: geositeFile,
})
if err != nil {
t.Fatalf("parseGeodataFile(geosite.dat): %v", err)
}
if !slices.Equal(siteCodes, []string{"CN", "YOUTUBE"}) {
t.Fatalf("parseGeodataFile(geosite.dat) = %v, want [CN YOUTUBE]", siteCodes)
}
ipCodes, err := parseGeodataFile(geodataFileEntry{
name: "geoip_rosip.dat", path: filepath.Join(dir, "geoip_rosip.dat"), kind: geoipFile,
})
if err != nil {
t.Fatalf("parseGeodataFile(geoip_rosip.dat): %v", err)
}
if !slices.Equal(ipCodes, []string{"RU"}) {
t.Fatalf("parseGeodataFile(geoip_rosip.dat) = %v, want [RU]", ipCodes)
}
}
func TestFormatGeodataSuggestion(t *testing.T) {
tests := []struct {
name string
kind geodataFileKind
code string
want string
}{
{name: "geosite.dat", kind: geositeFile, code: "CN", want: "geosite:cn"},
{name: "geoip.dat", kind: geoipFile, code: "PRIVATE", want: "geoip:private"},
{name: "geosite_roscom.dat", kind: geositeFile, code: "SOME-CODE", want: "ext:geosite_roscom.dat:some-code"},
{name: "geoip_rosip.dat", kind: geoipFile, code: "RU", want: "ext:geoip_rosip.dat:ru"},
}
for _, tt := range tests {
entry := geodataFileEntry{name: tt.name, kind: tt.kind}
if got := formatGeodataSuggestion(entry, tt.code); got != tt.want {
t.Errorf("formatGeodataSuggestion(%q, %q) = %q, want %q", tt.name, tt.code, got, tt.want)
}
}
}
func TestGeodataFingerprintOf(t *testing.T) {
a := []geodataFileEntry{
{name: "geoip.dat", size: 100, modTime: time.Unix(1, 0)},
{name: "geosite.dat", size: 200, modTime: time.Unix(2, 0)},
}
b := []geodataFileEntry{ // same content, different order
{name: "geosite.dat", size: 200, modTime: time.Unix(2, 0)},
{name: "geoip.dat", size: 100, modTime: time.Unix(1, 0)},
}
if !slices.Equal(geodataFingerprintOf(a), geodataFingerprintOf(b)) {
t.Fatal("fingerprints should be equal regardless of input order")
}
c := []geodataFileEntry{
{name: "geoip.dat", size: 999, modTime: time.Unix(1, 0)}, // size changed
{name: "geosite.dat", size: 200, modTime: time.Unix(2, 0)},
}
if slices.Equal(geodataFingerprintOf(a), geodataFingerprintOf(c)) {
t.Fatal("fingerprints should differ when a file's size changes")
}
}
func TestGetGeodataCategories_SkipsMalformedFile(t *testing.T) {
dir := t.TempDir()
writeGeoSiteFixture(t, dir, "geosite.dat", "CN")
// An unterminated varint (continuation bit set on every byte) is
// guaranteed to fail proto.Unmarshal, unlike an arbitrary text string
// which might accidentally parse as protobuf garbage.
if err := os.WriteFile(filepath.Join(dir, "geosite_broken.dat"), []byte{0xFF, 0xFF, 0xFF}, 0o644); err != nil {
t.Fatalf("write broken fixture: %v", err)
}
entries := scanGeodataFiles(dir)
result := buildGeodataCategories(entries)
if !slices.Contains(result.Domain, "geosite:cn") {
t.Fatalf("expected the valid file's category to survive, got %v", result.Domain)
}
}
func TestGetGeodataCategories_EndToEnd(t *testing.T) {
dir := t.TempDir()
t.Setenv("XUI_BIN_FOLDER", dir)
if config.GetBinFolderPath() != dir {
t.Fatalf("XUI_BIN_FOLDER override not respected: got %q, want %q", config.GetBinFolderPath(), dir)
}
writeGeoSiteFixture(t, dir, "geosite.dat", "CN")
writeGeoIPFixture(t, dir, "geoip.dat", "PRIVATE")
writeGeoSiteFixture(t, dir, "geosite_roscom.dat", "SOME-CODE")
svc := &XraySettingService{}
result := svc.GetGeodataCategories()
if !slices.Contains(result.Domain, "geosite:cn") {
t.Errorf("Domain = %v, want to contain geosite:cn", result.Domain)
}
if !slices.Contains(result.Domain, "ext:geosite_roscom.dat:some-code") {
t.Errorf("Domain = %v, want to contain ext:geosite_roscom.dat:some-code", result.Domain)
}
if !slices.Contains(result.IP, "geoip:private") {
t.Errorf("IP = %v, want to contain geoip:private", result.IP)
}
// Cache must reflect a file that appears after the first call.
writeGeoIPFixture(t, dir, "geoip_rosip.dat", "RU")
result = svc.GetGeodataCategories()
if !slices.Contains(result.IP, "ext:geoip_rosip.dat:ru") {
t.Errorf("IP after adding a new file = %v, want to contain ext:geoip_rosip.dat:ru", result.IP)
}
}