refactor: rename ga package to sdk

hrp/internal/sdk/client.go

@@ -0,0 +1,76 @@
+package sdk
+
+import (
+	"fmt"
+	"net/http"
+	"net/url"
+	"reflect"
+	"time"
+)
+
+const (
+	gaAPIDebugURL = "https://www.google-analytics.com/debug/collect" // used for debug
+	gaAPIURL      = "https://www.google-analytics.com/collect"
+)
+
+type GAClient struct {
+	TrackingID string       `form:"tid"` // Tracking ID / Property ID, XX-XXXXXXX-X
+	ClientID   string       `form:"cid"` // Anonymous Client ID
+	Version    string       `form:"v"`   // Version
+	httpClient *http.Client // http client session
+}
+
+// NewGAClient creates a new GAClient object with the trackingID and clientID.
+func NewGAClient(trackingID, clientID string) *GAClient {
+	return &GAClient{
+		TrackingID: trackingID,
+		ClientID:   clientID,
+		Version:    "1", // constant v1
+		httpClient: &http.Client{
+			Timeout: 5 * time.Second,
+		},
+	}
+}
+
+// SendEvent sends one event to Google Analytics
+func (g *GAClient) SendEvent(e IEvent) error {
+	var data url.Values
+	if event, ok := e.(UserTimingTracking); ok {
+		event.duration = time.Since(event.startTime)
+		data = event.ToUrlValues()
+	} else {
+		data = e.ToUrlValues()
+	}
+
+	// append common params
+	data.Add("v", g.Version)
+	data.Add("tid", g.TrackingID)
+	data.Add("cid", g.ClientID)
+
+	resp, err := g.httpClient.PostForm(gaAPIURL, data)
+	if err != nil {
+		return err
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != 200 {
+		return fmt.Errorf("response status: %d", resp.StatusCode)
+	}
+	return nil
+}
+
+func structToUrlValues(i interface{}) (values url.Values) {
+	values = url.Values{}
+	iVal := reflect.ValueOf(i)
+	for i := 0; i < iVal.NumField(); i++ {
+		formTagName := iVal.Type().Field(i).Tag.Get("form")
+		if formTagName == "" {
+			continue
+		}
+		if iVal.Field(i).IsZero() {
+			continue
+		}
+		values.Set(formTagName, fmt.Sprint(iVal.Field(i)))
+	}
+	return
+}

hrp/internal/sdk/client_test.go

@@ -0,0 +1,30 @@
+package sdk
+
+import (
+	"testing"
+)
+
+func TestSendEvents(t *testing.T) {
+	event := EventTracking{
+		Category: "unittest",
+		Action:   "SendEvents",
+		Value:    123,
+	}
+	err := gaClient.SendEvent(event)
+	if err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestStructToUrlValues(t *testing.T) {
+	event := EventTracking{
+		Category: "unittest",
+		Action:   "convert",
+		Label:    "v0.3.0",
+		Value:    123,
+	}
+	val := structToUrlValues(event)
+	if val.Encode() != "ea=convert&ec=unittest&el=v0.3.0&ev=123" {
+		t.Fail()
+	}
+}

hrp/internal/sdk/events.go

@@ -0,0 +1,71 @@
+package sdk
+
+import (
+	"fmt"
+	"net/url"
+	"time"
+
+	"github.com/httprunner/httprunner/hrp/internal/version"
+)
+
+type IEvent interface {
+	ToUrlValues() url.Values
+}
+
+type EventTracking struct {
+	HitType  string `form:"t"`  // Event hit type = event
+	Category string `form:"ec"` // Required. Event Category.
+	Action   string `form:"ea"` // Required. Event Action.
+	Label    string `form:"el"` // Optional. Event label, used as version.
+	Value    int    `form:"ev"` // Optional. Event value, must be non-negative integer
+}
+
+func (e EventTracking) StartTiming(variable string) UserTimingTracking {
+	return UserTimingTracking{
+		HitType:   "timing",
+		Category:  e.Category,
+		Variable:  variable,
+		Label:     e.Label,
+		startTime: time.Now(), // starts the timer
+	}
+}
+
+func (e EventTracking) ToUrlValues() url.Values {
+	e.HitType = "event"
+	e.Label = version.VERSION
+	return structToUrlValues(e)
+}
+
+type UserTimingTracking struct {
+	HitType   string `form:"t"`   // Timing hit type
+	Category  string `form:"utc"` // Required. user timing category. e.g. jsonLoader
+	Variable  string `form:"utv"` // Required. timing variable. e.g. load
+	Duration  string `form:"utt"` // Required. time took duration.
+	Label     string `form:"utl"` // Optional. user timing label. e.g jQuery
+	startTime time.Time
+	duration  time.Duration // time took duration
+}
+
+func (e UserTimingTracking) ToUrlValues() url.Values {
+	e.HitType = "timing"
+	e.Label = version.VERSION
+	e.Duration = fmt.Sprintf("%d", int64(e.duration.Seconds()*1000))
+	return structToUrlValues(e)
+}
+
+type Exception struct {
+	HitType     string `form:"t"`   // Hit Type = exception
+	Description string `form:"exd"` // exception description. i.e. IOException
+	IsFatal     string `form:"exf"` // if the exception was fatal
+	isFatal     bool
+}
+
+func (e Exception) ToUrlValues() url.Values {
+	e.HitType = "exception"
+	if e.isFatal {
+		e.IsFatal = "1"
+	} else {
+		e.IsFatal = "0"
+	}
+	return structToUrlValues(e)
+}

hrp/internal/sdk/init.go

@@ -0,0 +1,50 @@
+package sdk
+
+import (
+	"fmt"
+
+	"github.com/denisbrodbeck/machineid"
+	"github.com/getsentry/sentry-go"
+	"github.com/google/uuid"
+	"github.com/rs/zerolog/log"
+
+	"github.com/httprunner/httprunner/hrp/internal/version"
+)
+
+const (
+	trackingID = "UA-114587036-1" // Tracking ID for Google Analytics
+	sentryDSN  = "https://cff5efc69b1a4325a4cf873f1e70c13a@o334324.ingest.sentry.io/6070292"
+)
+
+var gaClient *GAClient
+
+func init() {
+	// init GA client
+	clientID, err := machineid.ProtectedID("hrp")
+	if err != nil {
+		nodeUUID, _ := uuid.NewUUID()
+		clientID = nodeUUID.String()
+	}
+	gaClient = NewGAClient(trackingID, clientID)
+
+	// init sentry sdk
+	err = sentry.Init(sentry.ClientOptions{
+		Dsn:              sentryDSN,
+		Release:          fmt.Sprintf("httprunner@%s", version.VERSION),
+		AttachStacktrace: true,
+	})
+	if err != nil {
+		log.Error().Err(err).Msg("init sentry sdk failed!")
+		return
+	}
+	sentry.ConfigureScope(func(scope *sentry.Scope) {
+		scope.SetLevel(sentry.LevelError)
+		scope.SetUser(sentry.User{
+			ID: clientID,
+		})
+	})
+}
+
+func SendEvent(e IEvent) error {
+	return gaClient.SendEvent(e)
+}