Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions protocol/register.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@ import (
"github.com/sagernet/sing-box/adapter/outbound"
"github.com/sagernet/sing-box/include"

"github.com/getlantern/sing-box-extensions/protocol/algeneva"
"github.com/getlantern/sing-box-extensions/protocol/amnezia"
"github.com/getlantern/sing-box-extensions/protocol/group"
"github.com/getlantern/sing-box-extensions/protocol/water"

"github.com/getlantern/sing-box-extensions/protocol/algeneva"
"github.com/getlantern/sing-box-extensions/protocol/outline"
"github.com/getlantern/sing-box-extensions/protocol/water"
)

var supportedProtocols = []string{
Expand Down
150 changes: 150 additions & 0 deletions tracker/datacap/client.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
package datacap

import (
"bytes"
"context"
"crypto/tls"
"encoding/json"
"fmt"
"io"
"net/http"
"os"
"strings"
"time"
)

// Client handles communication with the datacap sidecar service.
type Client struct {
httpClient *http.Client
baseURL string
}

// ClientConfig holds configuration for the datacap client.
type ClientConfig struct {
BaseURL string
Timeout time.Duration
InsecureSkipVerify bool
}

// NewClient creates a new datacap client.
// The baseURL can be overridden by the DATACAP_URL environment variable.
// Supports both HTTP and HTTPS. For HTTPS, uses system's trusted certificates by default.
func NewClient(baseURL string, timeout time.Duration) *Client {
return NewClientWithConfig(ClientConfig{
BaseURL: baseURL,
Timeout: timeout,
InsecureSkipVerify: false,
})
}

// NewClientWithConfig creates a new datacap client with advanced configuration.
func NewClientWithConfig(config ClientConfig) *Client {
// Check for environment variable override
if envURL := os.Getenv("DATACAP_URL"); envURL != "" {
config.BaseURL = envURL
}

// Ensure HTTPS if not explicitly HTTP
if config.BaseURL != "" && !strings.HasPrefix(config.BaseURL, "http://") && !strings.HasPrefix(config.BaseURL, "https://") {
config.BaseURL = "https://" + config.BaseURL
}

// Create HTTP client with TLS configuration
transport := &http.Transport{
TLSClientConfig: &tls.Config{
InsecureSkipVerify: config.InsecureSkipVerify,
},
MaxIdleConns: 100,
MaxIdleConnsPerHost: 10,
IdleConnTimeout: 90 * time.Second,
}

return &Client{
httpClient: &http.Client{
Timeout: config.Timeout,
Transport: transport,
},
baseURL: config.BaseURL,
}
}

// DataCapStatus represents the response from the GET /data-cap/{deviceId} endpoint.
type DataCapStatus struct {
Throttle bool `json:"throttle"`
RemainingBytes int64 `json:"remainingBytes"`
CapLimit int64 `json:"capLimit"`
ExpiryTime int64 `json:"expiryTime"`
}

// DataCapReport represents the request body for POST /data-cap/ endpoint.
type DataCapReport struct {
DeviceID string `json:"deviceId"`
CountryCode string `json:"countryCode"`
Platform string `json:"platform"`
BytesUsed int64 `json:"bytesUsed"`
}

func (c *Client) GetDataCapStatus(ctx context.Context, deviceID string) (*DataCapStatus, error) {
url := fmt.Sprintf("%s/data-cap/%s", c.baseURL, deviceID)

req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
if err != nil {
return nil, fmt.Errorf("failed to create request: %w", err)
}
req.Header.Set("Accept", "application/json")

resp, err := c.httpClient.Do(req)
if err != nil {
return nil, fmt.Errorf("failed to query datacap status: %w", err)
}
defer resp.Body.Close()

if resp.StatusCode != http.StatusOK {
body, _ := io.ReadAll(resp.Body)
return nil, fmt.Errorf("datacap status request failed with status %d: %s", resp.StatusCode, string(body))
}

var status DataCapStatus
if err := json.NewDecoder(resp.Body).Decode(&status); err != nil {
return nil, fmt.Errorf("failed to decode datacap status: %w", err)
}

return &status, nil
}

// ReportDataCapConsumption sends data consumption report to the sidecar.
// Endpoint: POST /data-cap/
// This tracks usage and returns updated cap status.
func (c *Client) ReportDataCapConsumption(ctx context.Context, report *DataCapReport) (*DataCapStatus, error) {
url := fmt.Sprintf("%s/data-cap/", c.baseURL)

jsonData, err := json.Marshal(report)
if err != nil {
return nil, fmt.Errorf("failed to marshal report: %w", err)
}

req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewBuffer(jsonData))
if err != nil {
return nil, fmt.Errorf("failed to create request: %w", err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Accept", "application/json")

resp, err := c.httpClient.Do(req)
if err != nil {
return nil, fmt.Errorf("failed to report datacap consumption: %w", err)
}
defer resp.Body.Close()

if resp.StatusCode != http.StatusOK && resp.StatusCode != http.StatusAccepted {
body, _ := io.ReadAll(resp.Body)
return nil, fmt.Errorf("datacap report request failed with status %d: %s", resp.StatusCode, string(body))
}

var status DataCapStatus
if err := json.NewDecoder(resp.Body).Decode(&status); err != nil {
return nil, fmt.Errorf("failed to decode datacap status: %w", err)
}

return &status, nil
}
231 changes: 231 additions & 0 deletions tracker/datacap/client_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,231 @@
package datacap

import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"testing"
"time"
)

func TestDataCapClient(t *testing.T) {
// Create a test server
statusCalled := false
reportCalled := false

server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path == "/data-cap/test-device-123" && r.Method == http.MethodGet {
statusCalled = true
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
w.Write([]byte(`{"throttle":false,"remainingBytes":9663676416,"capLimit":10737418240,"expiryTime":1700179200}`))
} else if r.URL.Path == "/data-cap/" && r.Method == http.MethodPost {
reportCalled = true
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
w.Write([]byte(`{"throttle":false,"remainingBytes":9663676416,"capLimit":10737418240,"expiryTime":1700179200}`))
} else {
t.Errorf("unexpected path: %s %s", r.Method, r.URL.Path)
w.WriteHeader(http.StatusNotFound)
}
}))
defer server.Close()

// Create client
client := NewClient(server.URL, 5*time.Second)

// Test GetDataCapStatus
ctx := context.Background()
status, err := client.GetDataCapStatus(ctx, "test-device-123")
if err != nil {
t.Fatalf("GetDataCapStatus failed: %v", err)
}

if !statusCalled {
t.Error("status endpoint was not called")
}

if !status.Throttle {
// Expected: throttle should be false
} else {
t.Error("expected throttle=false, got true")
}

if status.RemainingBytes != 9663676416 {
t.Errorf("expected remainingBytes=9663676416, got %d", status.RemainingBytes)
}

if status.CapLimit != 10737418240 {
t.Errorf("expected capLimit=10737418240, got %d", status.CapLimit)
}

if status.ExpiryTime != 1700179200 {
t.Errorf("expected expiryTime=1700179200, got %d", status.ExpiryTime)
}

// Test ReportDataCapConsumption
report := &DataCapReport{
DeviceID: "test-device-123",
CountryCode: "US",
Platform: "android",
BytesUsed: 1048576,
}

status, err = client.ReportDataCapConsumption(ctx, report)
if err != nil {
t.Fatalf("ReportDataCapConsumption failed: %v", err)
}

if !reportCalled {
t.Error("report endpoint was not called")
}

if status == nil {
t.Fatal("expected status response, got nil")
}
}

func TestDataCapClientInvalidURL(t *testing.T) {
client := NewClient("http://invalid-url-that-does-not-exist:9999", 1*time.Second)

ctx := context.Background()
_, err := client.GetDataCapStatus(ctx, "test-device")
if err == nil {
t.Error("expected error for invalid URL, got nil")
}
}

func TestDataCapClientTimeout(t *testing.T) {
// Create a server that sleeps longer than timeout
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(2 * time.Second)
w.WriteHeader(http.StatusOK)
}))
defer server.Close()

// Create client with short timeout
client := NewClient(server.URL, 100*time.Millisecond)

ctx := context.Background()
_, err := client.GetDataCapStatus(ctx, "test-device")
if err == nil {
t.Error("expected timeout error, got nil")
}
}

func TestDataCapClientThrottleTrue(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
// Device is over cap, should be throttled
w.Write([]byte(`{"throttle":true,"remainingBytes":0,"capLimit":1073741824,"expiryTime":1700179200}`))
}))
defer server.Close()

client := NewClient(server.URL, 5*time.Second)
ctx := context.Background()

status, err := client.GetDataCapStatus(ctx, "test-device")
if err != nil {
t.Fatalf("GetDataCapStatus failed: %v", err)
}

if !status.Throttle {
t.Error("expected throttle=true, got false")
}

if status.RemainingBytes != 0 {
t.Errorf("expected remainingBytes=0, got %d", status.RemainingBytes)
}
}

func TestDataCapClientAcceptHeader(t *testing.T) {
acceptHeaderReceived := false

server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// Verify Accept header is set
if r.Header.Get("Accept") == "application/json" {
acceptHeaderReceived = true
}
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
w.Write([]byte(`{"throttle":false,"remainingBytes":1000000,"capLimit":1073741824,"expiryTime":1700179200}`))
}))
defer server.Close()

client := NewClient(server.URL, 5*time.Second)
ctx := context.Background()

_, err := client.GetDataCapStatus(ctx, "test-device")
if err != nil {
t.Fatalf("GetDataCapStatus failed: %v", err)
}

if !acceptHeaderReceived {
t.Error("Accept: application/json header was not sent")
}
}

func TestDataCapReportWithPlatform(t *testing.T) {
platformReceived := false
var receivedPlatform string

server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method == http.MethodPost {
// Parse the request body
var report DataCapReport
if err := json.NewDecoder(r.Body).Decode(&report); err == nil {
if report.Platform != "" {
platformReceived = true
receivedPlatform = report.Platform
}
}
}
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
w.Write([]byte(`{"throttle":false,"remainingBytes":9663676416,"capLimit":10737418240,"expiryTime":1700179200}`))
}))
defer server.Close()

client := NewClient(server.URL, 5*time.Second)
ctx := context.Background()

report := &DataCapReport{
DeviceID: "test-device",
CountryCode: "US",
Platform: "ios",
BytesUsed: 1048576,
}

_, err := client.ReportDataCapConsumption(ctx, report)
if err != nil {
t.Fatalf("ReportDataCapConsumption failed: %v", err)
}

if !platformReceived {
t.Error("platform field was not received")
}

if receivedPlatform != "ios" {
t.Errorf("expected platform=ios, got %s", receivedPlatform)
}
}

func TestDataCapClientWithHTTPS(t *testing.T) {
client := NewClient("datacap-sidecar.example.com", 5*time.Second)

if client.baseURL != "https://datacap-sidecar.example.com" {
t.Errorf("expected HTTPS URL, got %s", client.baseURL)
}
}

func TestDataCapClientEnvironmentVariable(t *testing.T) {
t.Setenv("DATACAP_URL", "https://env-override.example.com")

client := NewClient("https://default.example.com", 5*time.Second)

if client.baseURL != "https://env-override.example.com" {
t.Errorf("expected environment variable URL, got %s", client.baseURL)
}
}
Loading
Loading