5d727becb4
Implemented UI error tracking. We use satellite analytics service to track the fact that UI error occurred and send minimal info to Segment (not Hubspot). We send only the fact that UI error occurred and the place where this error occurred. Extended notificator plugin error function to include the place where error occurred. I made the place argument nullable to be always explicitly provided (build fails if place is not provided). If place is not null then error event is triggered in the background. Issue: https://github.com/storj/storj-private/issues/107 Change-Id: I7d129fb29629979f5be6ff5dea37ad19b1a2397e
111 lines
2.8 KiB
Go
111 lines
2.8 KiB
Go
// Copyright (C) 2021 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package consoleapi
|
|
|
|
import (
|
|
"encoding/json"
|
|
"io"
|
|
"net/http"
|
|
|
|
"github.com/zeebo/errs"
|
|
"go.uber.org/zap"
|
|
|
|
"storj.io/storj/private/web"
|
|
"storj.io/storj/satellite/analytics"
|
|
"storj.io/storj/satellite/console"
|
|
)
|
|
|
|
// ErrAnalyticsAPI - console analytics api error type.
|
|
var ErrAnalyticsAPI = errs.Class("consoleapi analytics")
|
|
|
|
// Analytics is an api controller that exposes analytics related functionality.
|
|
type Analytics struct {
|
|
log *zap.Logger
|
|
service *console.Service
|
|
analytics *analytics.Service
|
|
}
|
|
|
|
// NewAnalytics is a constructor for api analytics controller.
|
|
func NewAnalytics(log *zap.Logger, service *console.Service, a *analytics.Service) *Analytics {
|
|
return &Analytics{
|
|
log: log,
|
|
service: service,
|
|
analytics: a,
|
|
}
|
|
}
|
|
|
|
type eventTriggeredBody struct {
|
|
EventName string `json:"eventName"`
|
|
Link string `json:"link"`
|
|
ErrorEventSource string `json:"errorEventSource"`
|
|
}
|
|
|
|
type pageVisitBody struct {
|
|
PageName string `json:"pageName"`
|
|
}
|
|
|
|
// EventTriggered tracks the occurrence of an arbitrary event on the client.
|
|
func (a *Analytics) EventTriggered(w http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
var err error
|
|
defer mon.Task()(&ctx)(&err)
|
|
|
|
body, err := io.ReadAll(r.Body)
|
|
if err != nil {
|
|
a.serveJSONError(w, http.StatusInternalServerError, err)
|
|
}
|
|
var et eventTriggeredBody
|
|
err = json.Unmarshal(body, &et)
|
|
if err != nil {
|
|
a.serveJSONError(w, http.StatusInternalServerError, err)
|
|
}
|
|
|
|
user, err := console.GetUser(ctx)
|
|
if err != nil {
|
|
a.serveJSONError(w, http.StatusUnauthorized, err)
|
|
return
|
|
}
|
|
|
|
if et.ErrorEventSource != "" {
|
|
a.analytics.TrackErrorEvent(user.ID, user.Email, et.ErrorEventSource)
|
|
} else if et.Link != "" {
|
|
a.analytics.TrackLinkEvent(et.EventName, user.ID, user.Email, et.Link)
|
|
} else {
|
|
a.analytics.TrackEvent(et.EventName, user.ID, user.Email)
|
|
}
|
|
w.WriteHeader(http.StatusOK)
|
|
}
|
|
|
|
// PageEventTriggered tracks the occurrence of an arbitrary page visit event on the client.
|
|
func (a *Analytics) PageEventTriggered(w http.ResponseWriter, r *http.Request) {
|
|
ctx := r.Context()
|
|
var err error
|
|
defer mon.Task()(&ctx)(&err)
|
|
|
|
body, err := io.ReadAll(r.Body)
|
|
if err != nil {
|
|
a.serveJSONError(w, http.StatusInternalServerError, err)
|
|
}
|
|
var pv pageVisitBody
|
|
err = json.Unmarshal(body, &pv)
|
|
if err != nil {
|
|
a.serveJSONError(w, http.StatusInternalServerError, err)
|
|
}
|
|
|
|
user, err := console.GetUser(ctx)
|
|
if err != nil {
|
|
a.serveJSONError(w, http.StatusUnauthorized, err)
|
|
return
|
|
}
|
|
|
|
a.analytics.PageVisitEvent(pv.PageName, user.ID, user.Email)
|
|
|
|
w.WriteHeader(http.StatusOK)
|
|
}
|
|
|
|
// serveJSONError writes JSON error to response output stream.
|
|
func (a *Analytics) serveJSONError(w http.ResponseWriter, status int, err error) {
|
|
web.ServeJSONError(a.log, w, status, err)
|
|
}
|