Merge pull request #251 from supertokens/feat/dashboard-analytics

feat: Add telemetry API to dashboard recipe

Author: rishabhpoddar

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.10.4] - 2023-03-30
+
+-   Adds a telemetry API to the dashboard recipe
+
 ## [0.10.3] - 2023-03-29
 -   Adds unit test for Apple callback form post
 -   Updates all example apps to also initialise dashboard recipe

recipe/dashboard/api/analyticsPOST.go

@@ -0,0 +1,122 @@
+package api
+
+import (
+	"bytes"
+	"encoding/json"
+	"github.com/supertokens/supertokens-golang/recipe/dashboard/dashboardmodels"
+	"github.com/supertokens/supertokens-golang/supertokens"
+	"net/http"
+)
+
+type analyticsPostResponse struct {
+	Status string `json:"status"`
+}
+
+type analyticsPostRequestBody struct {
+	Email            *string `json:"email"`
+	DashboardVersion *string `json:"dashboardVersion"`
+}
+
+func AnalyticsPost(apiInterface dashboardmodels.APIInterface, options dashboardmodels.APIOptions) (analyticsPostResponse, error) {
+	supertokensInstance, instanceError := supertokens.GetInstanceOrThrowError()
+
+	if supertokens.IsRunningInTestMode() {
+		return analyticsPostResponse{
+			Status: "OK",
+		}, nil
+	}
+
+	if instanceError != nil {
+		return analyticsPostResponse{}, instanceError
+	}
+
+	if supertokensInstance.Telemetry != nil && !*supertokensInstance.Telemetry {
+		return analyticsPostResponse{
+			Status: "OK",
+		}, nil
+	}
+
+	body, err := supertokens.ReadFromRequest(options.Req)
+
+	if err != nil {
+		return analyticsPostResponse{}, err
+	}
+
+	var readBody analyticsPostRequestBody
+	err = json.Unmarshal(body, &readBody)
+	if err != nil {
+		return analyticsPostResponse{}, err
+	}
+
+	if readBody.Email == nil {
+		return analyticsPostResponse{}, supertokens.BadInputError{
+			Msg: "Required parameter 'email' is missing",
+		}
+	}
+
+	if readBody.DashboardVersion == nil {
+		return analyticsPostResponse{}, supertokens.BadInputError{
+			Msg: "Required parameter 'dashboardVersion' is missing",
+		}
+	}
+
+	data := map[string]interface{}{
+		"websiteDomain":    supertokensInstance.AppInfo.WebsiteDomain.GetAsStringDangerous(),
+		"apiDomain":        supertokensInstance.AppInfo.APIDomain.GetAsStringDangerous(),
+		"appName":          supertokensInstance.AppInfo.AppName,
+		"sdk":              "golang",
+		"sdkVersion":       supertokens.VERSION,
+		"email":            *readBody.Email,
+		"dashboardVersion": *readBody.DashboardVersion,
+	}
+
+	querier, err := supertokens.GetNewQuerierInstanceOrThrowError("")
+	if err != nil {
+		return analyticsPostResponse{}, err
+	}
+
+	response, err := querier.SendGetRequest("/telemetry", nil)
+	if err != nil {
+		// We don't send telemetry events if this fails
+		return analyticsPostResponse{
+			Status: "OK",
+		}, nil
+	}
+
+	exists := response["exists"].(bool)
+
+	if exists {
+		data["telemetryId"] = response["telemetryId"].(string)
+	}
+
+	numberOfUsers, err := supertokens.GetUserCount(nil)
+	if err != nil {
+		// We don't send telemetry events if this fails
+		return analyticsPostResponse{
+			Status: "OK",
+		}, nil
+	}
+
+	data["numberOfUsers"] = numberOfUsers
+
+	jsonData, err := json.Marshal(data)
+	if err != nil {
+		return analyticsPostResponse{}, err
+	}
+
+	url := "https://api.supertokens.com/0/st/telemetry"
+	req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
+	if err != nil {
+		return analyticsPostResponse{
+			Status: "OK",
+		}, nil
+	}
+	req.Header.Set("content-type", "application/json; charset=utf-8")
+	req.Header.Set("api-version", "3")
+	client := &http.Client{}
+	client.Do(req)
+
+	return analyticsPostResponse{
+		Status: "OK",
+	}, nil
+}

recipe/dashboard/constants.go

@@ -12,3 +12,4 @@ const userEmailVerifyTokenAPI = "/api/user/email/verify/token"
 const userPasswordAPI = "/api/user/password"
 const signInAPI = "/api/signin"
 const signOutAPI = "/api/signout"
+const dashboardAnalyticsAPI = "/api/analytics"

recipe/dashboard/recipe.go

@@ -165,6 +165,8 @@ func (r *Recipe) handleAPIRequest(id string, req *http.Request, res http.Respons
 			return userdetails.UserPasswordPut(r.APIImpl, options)
 		} else if id == signOutAPI {
 			return api.SignOutPost(r.APIImpl, options)
+		} else if id == dashboardAnalyticsAPI {
+			return api.AnalyticsPost(r.APIImpl, options)
 		}
 		return nil, errors.New("should never come here")
 	})

recipe/dashboard/utils.go

@@ -139,5 +139,10 @@ func getApiIdIfMatched(path supertokens.NormalisedURLPath, method string) (*stri
 		return &val, nil
 	}
 
+	if method == http.MethodPost && strings.HasSuffix(path.GetAsStringDangerous(), dashboardAnalyticsAPI) {
+		val := dashboardAnalyticsAPI
+		return &val, nil
+	}
+
 	return nil, nil
 }

supertokens/constants.go

@@ -21,10 +21,10 @@ const (
 )
 
 // VERSION current version of the lib
-const VERSION = "0.10.3"
+const VERSION = "0.10.4"
 
 var (
 	cdiSupported = []string{"2.8", "2.9", "2.10", "2.11", "2.12", "2.13", "2.14", "2.15", "2.16", "2.17", "2.18", "2.19"}
 )
 
-const DashboardVersion = "0.4"
+const DashboardVersion = "0.5"

supertokens/supertokens.go

@@ -16,7 +16,6 @@
 package supertokens
 
 import (
-	"bytes"
 	"encoding/json"
 	"errors"
 	"flag"
@@ -30,6 +29,7 @@ type superTokens struct {
 	SuperTokens           ConnectionInfo
 	RecipeModules         []RecipeModule
 	OnSuperTokensAPIError func(err error, req *http.Request, res http.ResponseWriter)
+	Telemetry             *bool
 }
 
 // this will be set to true if this is used in a test app environment
@@ -99,12 +99,9 @@ func supertokensInit(config TypeInput) error {
 		superTokens.RecipeModules = append(superTokens.RecipeModules, *recipeModule)
 	}
 
+	superTokens.Telemetry = config.Telemetry
 	superTokensInstance = superTokens
 
-	if config.Telemetry == nil || *config.Telemetry {
-		sendTelemetry()
-	}
-
 	return nil
 }
 
@@ -119,47 +116,6 @@ func GetInstanceOrThrowError() (*superTokens, error) {
 	return nil, errors.New("initialisation not done. Did you forget to call the SuperTokens.init function?")
 }
 
-func sendTelemetry() {
-	if IsRunningInTestMode() {
-		// if running in test mode, we do not want to send this.
-		return
-	}
-	querier, err := GetNewQuerierInstanceOrThrowError("")
-	if err != nil {
-		return
-	}
-
-	response, err := querier.SendGetRequest("/telemetry", nil)
-	if err != nil {
-		return
-	}
-	exists := response["exists"].(bool)
-
-	url := "https://api.supertokens.com/0/st/telemetry"
-
-	data := map[string]interface{}{
-		"appName":       superTokensInstance.AppInfo.AppName,
-		"websiteDomain": superTokensInstance.AppInfo.WebsiteDomain.GetAsStringDangerous(),
-		"sdk":           "golang",
-	}
-	if exists {
-		data["telemetryId"] = response["telemetryId"].(string)
-	}
-	jsonData, err := json.Marshal(data)
-	if err != nil {
-		return
-	}
-	req, err := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
-	if err != nil {
-		return
-	}
-	req.Header.Set("content-type", "application/json; charset=utf-8")
-	req.Header.Set("api-version", "2")
-
-	client := &http.Client{}
-	client.Do(req)
-}
-
 func (s *superTokens) middleware(theirHandler http.Handler) http.Handler {
 	LogDebugMessage("middleware: Started")
 	if theirHandler == nil {