Merge 0.10 into feat/search-apis

nkshah2 · nkshah2 · commit bc017b57d7a3 · 2023-03-31T16:43:14.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [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
+-   Adds login with gitlab (for single tenant only) and bitbucket
 
 ## [0.10.2] - 2023-02-24
 -   Adds APIs and logic to the dashboard recipe to enable email password based login
diff --git a/coreDriverInterfaceSupported.json b/coreDriverInterfaceSupported.json
@@ -11,6 +11,7 @@
                 "2.15",
                 "2.16",
                 "2.17",
-                "2.18"
+                "2.18",
+                "2.19"
         ]
 }
diff --git a/examples/with-chi-oso/main.go b/examples/with-chi-oso/main.go
@@ -8,6 +8,7 @@ import (
 	"github.com/go-chi/cors"
 	"github.com/supertokens/supertokens-golang/examples/with-chi-oso/database"
 	"github.com/supertokens/supertokens-golang/examples/with-chi-oso/service"
+	"github.com/supertokens/supertokens-golang/recipe/dashboard"
 	"github.com/supertokens/supertokens-golang/recipe/emailverification"
 	"github.com/supertokens/supertokens-golang/recipe/emailverification/evmodels"
 	"github.com/supertokens/supertokens-golang/recipe/session"
@@ -60,6 +61,7 @@ func main() {
 				},
 			}),
 			session.Init(nil),
+			dashboard.Init(nil),
 		},
 	})
 	if err != nil {
diff --git a/examples/with-chi/main.go b/examples/with-chi/main.go
@@ -6,6 +6,7 @@ import (
 
 	"github.com/go-chi/chi/v5"
 	"github.com/go-chi/cors"
+	"github.com/supertokens/supertokens-golang/recipe/dashboard"
 	"github.com/supertokens/supertokens-golang/recipe/emailverification"
 	"github.com/supertokens/supertokens-golang/recipe/emailverification/evmodels"
 	"github.com/supertokens/supertokens-golang/recipe/session"
@@ -100,6 +101,7 @@ func main() {
 				},
 			}),
 			session.Init(nil),
+			dashboard.Init(nil),
 		},
 	})
 
diff --git a/examples/with-fiber/main.go b/examples/with-fiber/main.go
@@ -1,6 +1,7 @@
 package main
 
 import (
+	"github.com/supertokens/supertokens-golang/recipe/dashboard"
 	"log"
 	"net/http"
 
@@ -93,6 +94,7 @@ func main() {
 				},
 			}),
 			session.Init(nil),
+			dashboard.Init(nil),
 		},
 	})
 	if err != nil {
diff --git a/examples/with-gin/config/config.go b/examples/with-gin/config/config.go
@@ -1,6 +1,7 @@
 package config
 
 import (
+	"github.com/supertokens/supertokens-golang/recipe/dashboard"
 	"log"
 
 	"github.com/spf13/viper"
@@ -105,6 +106,7 @@ func Init() {
 				},
 			}),
 			session.Init(nil),
+			dashboard.Init(nil),
 			// thirdparty.Init(thirdpartyConfig),
 		},
 	})
diff --git a/examples/with-go-zero/main.go b/examples/with-go-zero/main.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	"encoding/json"
+	"github.com/supertokens/supertokens-golang/recipe/dashboard"
 	"log"
 	"net/http"
 	"strings"
@@ -92,6 +93,7 @@ func main() {
 				},
 			}),
 			session.Init(nil),
+			dashboard.Init(nil),
 		},
 	})
 	if err != nil {
diff --git a/examples/with-http/main.go b/examples/with-http/main.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	"encoding/json"
+	"github.com/supertokens/supertokens-golang/recipe/dashboard"
 	"net/http"
 	"strings"
 
@@ -91,6 +92,7 @@ func main() {
 				},
 			}),
 			session.Init(nil),
+			dashboard.Init(nil),
 		},
 	})
 
diff --git a/examples/with-labstack-echo/main.go b/examples/with-labstack-echo/main.go
@@ -3,6 +3,7 @@ package main
 import (
 	"encoding/json"
 	"errors"
+	"github.com/supertokens/supertokens-golang/recipe/dashboard"
 	"net/http"
 	"strings"
 
@@ -94,6 +95,7 @@ func main() {
 				},
 			}),
 			session.Init(nil),
+			dashboard.Init(nil),
 		},
 	})
 
diff --git a/examples/with-mux/main.go b/examples/with-mux/main.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	"encoding/json"
+	"github.com/supertokens/supertokens-golang/recipe/dashboard"
 	"net/http"
 
 	"github.com/gorilla/handlers"
@@ -92,6 +93,7 @@ func main() {
 				},
 			}),
 			session.Init(nil),
+			dashboard.Init(nil),
 		},
 	})
 
diff --git a/examples/with-twirp/cmd/server/main.go b/examples/with-twirp/cmd/server/main.go
@@ -14,6 +14,7 @@
 package main
 
 import (
+	"github.com/supertokens/supertokens-golang/recipe/dashboard"
 	"log"
 	"net/http"
 	"os"
@@ -111,6 +112,7 @@ func main() {
 				},
 			}),
 			session.Init(nil),
+			dashboard.Init(nil),
 		},
 	})
 
diff --git a/recipe/dashboard/api/analyticsPOST.go b/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
+}
diff --git a/recipe/dashboard/constants.go b/recipe/dashboard/constants.go
@@ -13,3 +13,4 @@ const userPasswordAPI = "/api/user/password"
 const signInAPI = "/api/signin"
 const signOutAPI = "/api/signout"
 const searchTagsAPI = "/api/search/tags"
+const dashboardAnalyticsAPI = "/api/analytics"
diff --git a/recipe/dashboard/recipe.go b/recipe/dashboard/recipe.go
@@ -168,6 +168,8 @@ func (r *Recipe) handleAPIRequest(id string, req *http.Request, res http.Respons
 			return search.SearchTagsGet(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")
 	})
diff --git a/recipe/dashboard/utils.go b/recipe/dashboard/utils.go
@@ -144,5 +144,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
 }
diff --git a/recipe/thirdparty/main.go b/recipe/thirdparty/main.go
@@ -98,6 +98,14 @@ func GoogleWorkspaces(config tpmodels.GoogleWorkspacesConfig) tpmodels.TypeProvi
 	return providers.GoogleWorkspaces(config)
 }
 
+func Bitbucket(config tpmodels.BitbucketConfig) tpmodels.TypeProvider {
+	return providers.Bitbucket(config)
+}
+
+func GitLab(config tpmodels.GitLabConfig) tpmodels.TypeProvider {
+	return providers.GitLab(config)
+}
+
 func Google(config tpmodels.GoogleConfig) tpmodels.TypeProvider {
 	return providers.Google(config)
 }
diff --git a/recipe/thirdparty/providers/bitbucket.go b/recipe/thirdparty/providers/bitbucket.go
diff --git a/recipe/thirdparty/providers/gitlab.go b/recipe/thirdparty/providers/gitlab.go
diff --git a/recipe/thirdparty/tpmodels/providers.go b/recipe/thirdparty/tpmodels/providers.go
diff --git a/supertokens/constants.go b/supertokens/constants.go
diff --git a/supertokens/supertokens.go b/supertokens/supertokens.go

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`	`"2.15",`
`12`	`12`	`"2.16",`
`13`	`13`	`"2.17",`
`14`		`- "2.18"`
	`14`	`+ "2.18",`
	`15`	`+ "2.19"`
`15`	`16`	`]`
`16`	`17`	`}`