Merge pull request #253 from supertokens/feat/search-apis

rishabhpoddar · web-flow · commit a2cce6392a76 · 2023-03-31T17:05:59.000+05:30
feat: Add search APIs to dashboard recipe
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+## [0.10.5] - 2023-03-31
+
+-   Adds search APIs to the dashboard recipe
+
 ## [0.10.4] - 2023-03-30
 
 -   Adds a telemetry API to the dashboard recipe
diff --git a/coreDriverInterfaceSupported.json b/coreDriverInterfaceSupported.json
@@ -12,6 +12,7 @@
                 "2.16",
                 "2.17",
                 "2.18",
-                "2.19"
+                "2.19",
+                "2.20"
         ]
 }
diff --git a/recipe/dashboard/api/implementation.go b/recipe/dashboard/api/implementation.go
@@ -16,6 +16,8 @@
 package api
 
 import (
+	"strconv"
+
 	"github.com/supertokens/supertokens-golang/recipe/dashboard/dashboardmodels"
 	"github.com/supertokens/supertokens-golang/supertokens"
 )
@@ -52,6 +54,20 @@ func MakeAPIImplementation() dashboardmodels.APIInterface {
 
 		authMode := string(options.Config.AuthMode)
 
+		isSearchEnabled := false
+		querier, err := supertokens.GetNewQuerierInstanceOrThrowError(options.RecipeID)
+		if err != nil {
+			return "", err
+		}
+		cdiVersion, err := querier.GetQuerierAPIVersion()
+		if err != nil {
+			return "", err
+		}
+		if supertokens.MaxVersion(cdiVersion, "2.20") == cdiVersion {
+			// Only enable search for CDI version 2.20 and above
+			isSearchEnabled = true
+		}
+
 		return `
 		<html>
 		<head>
@@ -61,6 +77,7 @@ func MakeAPIImplementation() dashboardmodels.APIInterface {
 						window.dashboardAppPath = "` + dashboardAppPath + `"
 						window.connectionURI = "` + connectionURI + `"
 						window.authMode = "` + authMode + `"
+						window.isSearchEnabled = "` + strconv.FormatBool(isSearchEnabled) + `"
 				</script>
 				<script defer src="` + bundleDomain + `/static/js/bundle.js"></script></head>
 				<link href="` + bundleDomain + `/static/css/main.css" rel="stylesheet" type="text/css">
diff --git a/recipe/dashboard/api/search/tagsGet.go b/recipe/dashboard/api/search/tagsGet.go
@@ -0,0 +1,44 @@
+/* Copyright (c) 2022, VRAI Labs and/or its affiliates. All rights reserved.
+*
+* This software is licensed under the Apache License, Version 2.0 (the
+* "License") as published by the Apache Software Foundation.
+*
+* You may not use this file except in compliance with the License. You may
+* obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+* License for the specific language governing permissions and limitations
+* under the License.
+ */
+
+package search
+
+import (
+	"github.com/supertokens/supertokens-golang/recipe/dashboard/dashboardmodels"
+	"github.com/supertokens/supertokens-golang/supertokens"
+)
+
+type searchTagsResponse struct {
+	Status string        `json:"status"`
+	Tags   []interface{} `json:"tags"`
+}
+
+func SearchTagsGet(apiImplementation dashboardmodels.APIInterface, options dashboardmodels.APIOptions) (searchTagsResponse, error) {
+	querier, querierErr := supertokens.GetNewQuerierInstanceOrThrowError("dashboard")
+
+	if querierErr != nil {
+		return searchTagsResponse{}, querierErr
+	}
+
+	apiResponse, apiErr := querier.SendGetRequest("/user/search/tags", nil)
+	if apiErr != nil {
+		return searchTagsResponse{}, apiErr
+	}
+
+	return searchTagsResponse{
+		Status: "OK",
+		Tags:   apiResponse["tags"].([]interface{}),
+	}, nil
+}
diff --git a/recipe/dashboard/api/usersGet.go b/recipe/dashboard/api/usersGet.go
@@ -1,7 +1,9 @@
 package api
 
 import (
+	"net/url"
 	"strconv"
+	"strings"
 	"sync"
 
 	"github.com/supertokens/supertokens-golang/recipe/dashboard/dashboardmodels"
@@ -64,7 +66,24 @@ func UsersGet(apiImplementation dashboardmodels.APIInterface, options dashboardm
 
 	var usersResponse supertokens.UserPaginationResult
 
-	if timeJoinedOrder == "ASC" {
+	u, err := url.Parse(req.URL.String())
+	if err != nil {
+		return UsersGetResponse{}, err
+	}
+
+	queryParams, err := url.ParseQuery(u.RawQuery)
+	if err != nil {
+		return UsersGetResponse{}, err
+	}
+
+	queryParamsObject := map[string]string{}
+	for i, s := range queryParams {
+		queryParamsObject[i] = strings.Join(s, ";")
+	}
+
+	if len(queryParamsObject) != 0 {
+		usersResponse, err = supertokens.GetUsersWithSearchParams(timeJoinedOrder, paginationTokenPtr, &limit, nil, queryParamsObject)
+	} else if timeJoinedOrder == "ASC" {
 		usersResponse, err = supertokens.GetUsersOldestFirst(paginationTokenPtr, &limit, nil)
 	} else {
 		usersResponse, err = supertokens.GetUsersNewestFirst(paginationTokenPtr, &limit, nil)
diff --git a/recipe/dashboard/constants.go b/recipe/dashboard/constants.go
@@ -12,4 +12,5 @@ const userEmailVerifyTokenAPI = "/api/user/email/verify/token"
 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
@@ -20,6 +20,7 @@ import (
 	"net/http"
 
 	"github.com/supertokens/supertokens-golang/recipe/dashboard/api"
+	"github.com/supertokens/supertokens-golang/recipe/dashboard/api/search"
 	"github.com/supertokens/supertokens-golang/recipe/dashboard/api/userdetails"
 	"github.com/supertokens/supertokens-golang/recipe/dashboard/dashboardmodels"
 	"github.com/supertokens/supertokens-golang/supertokens"
@@ -163,6 +164,8 @@ func (r *Recipe) handleAPIRequest(id string, req *http.Request, res http.Respons
 			return userdetails.UserEmailVerifyTokenPost(r.APIImpl, options)
 		} else if id == userPasswordAPI {
 			return userdetails.UserPasswordPut(r.APIImpl, options)
+		} else if id == searchTagsAPI {
+			return search.SearchTagsGet(r.APIImpl, options)
 		} else if id == signOutAPI {
 			return api.SignOutPost(r.APIImpl, options)
 		} else if id == dashboardAnalyticsAPI {
diff --git a/recipe/dashboard/utils.go b/recipe/dashboard/utils.go
@@ -139,6 +139,11 @@ func getApiIdIfMatched(path supertokens.NormalisedURLPath, method string) (*stri
 		return &val, nil
 	}
 
+	if method == http.MethodGet && strings.HasSuffix(path.GetAsStringDangerous(), searchTagsAPI) {
+		val := searchTagsAPI
+		return &val, nil
+	}
+
 	if method == http.MethodPost && strings.HasSuffix(path.GetAsStringDangerous(), dashboardAnalyticsAPI) {
 		val := dashboardAnalyticsAPI
 		return &val, nil
diff --git a/supertokens/constants.go b/supertokens/constants.go
@@ -21,10 +21,10 @@ const (
 )
 
 // VERSION current version of the lib
-const VERSION = "0.10.4"
+const VERSION = "0.10.5"
 
 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"}
+	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", "2.20"}
 )
 
-const DashboardVersion = "0.5"
+const DashboardVersion = "0.6"
diff --git a/supertokens/main.go b/supertokens/main.go
@@ -60,11 +60,11 @@ func GetUserCount(includeRecipeIds *[]string) (float64, error) {
 }
 
 func GetUsersOldestFirst(paginationToken *string, limit *int, includeRecipeIds *[]string) (UserPaginationResult, error) {
-	return getUsers("ASC", paginationToken, limit, includeRecipeIds)
+	return GetUsersWithSearchParams("ASC", paginationToken, limit, includeRecipeIds, nil)
 }
 
 func GetUsersNewestFirst(paginationToken *string, limit *int, includeRecipeIds *[]string) (UserPaginationResult, error) {
-	return getUsers("DESC", paginationToken, limit, includeRecipeIds)
+	return GetUsersWithSearchParams("DESC", paginationToken, limit, includeRecipeIds, nil)
 }
 
 func DeleteUser(userId string) error {
diff --git a/supertokens/supertokens.go b/supertokens/supertokens.go
@@ -276,16 +276,19 @@ type UserPaginationResult struct {
 }
 
 // TODO: Add tests
-func getUsers(timeJoinedOrder string, paginationToken *string, limit *int, includeRecipeIds *[]string) (UserPaginationResult, error) {
+func GetUsersWithSearchParams(timeJoinedOrder string, paginationToken *string, limit *int, includeRecipeIds *[]string, searchParams map[string]string) (UserPaginationResult, error) {
 
 	querier, err := GetNewQuerierInstanceOrThrowError("")
 	if err != nil {
 		return UserPaginationResult{}, err
 	}
 
-	requestBody := map[string]string{
-		"timeJoinedOrder": timeJoinedOrder,
+	requestBody := map[string]string{}
+	if searchParams != nil {
+		requestBody = searchParams
 	}
+	requestBody["timeJoinedOrder"] = timeJoinedOrder
+
 	if limit != nil {
 		requestBody["limit"] = strconv.Itoa(*limit)
 	}
@@ -352,7 +355,7 @@ func deleteUser(userId string) error {
 		return err
 	}
 
-	if maxVersion(cdiVersion, "2.10") == cdiVersion {
+	if MaxVersion(cdiVersion, "2.10") == cdiVersion {
 		_, err = querier.SendPostRequest("/user/remove", map[string]interface{}{
 			"userId": userId,
 		})
diff --git a/supertokens/userIdMapping.go b/supertokens/userIdMapping.go
@@ -30,7 +30,7 @@ func CreateUserIdMapping(supertokensUserId string, externalUserId string, extern
 	if err != nil {
 		return CreateUserIdMappingResult{}, err
 	}
-	if maxVersion(cdiVersion, "2.15") != cdiVersion {
+	if MaxVersion(cdiVersion, "2.15") != cdiVersion {
 		return CreateUserIdMappingResult{}, errors.New("Please upgrade the SuperTokens core to >= 3.15.0")
 	}
 
@@ -88,7 +88,7 @@ func GetUserIdMapping(userId string, userIdType *UserIdType) (GetUserIdMappingRe
 	if err != nil {
 		return GetUserIdMappingResult{}, err
 	}
-	if maxVersion(cdiVersion, "2.15") != cdiVersion {
+	if MaxVersion(cdiVersion, "2.15") != cdiVersion {
 		return GetUserIdMappingResult{}, errors.New("Please upgrade the SuperTokens core to >= 3.15.0")
 	}
 
@@ -140,7 +140,7 @@ func DeleteUserIdMapping(userId string, userIdType *UserIdType, force *bool) (De
 	if err != nil {
 		return DeleteUserIdMappingResult{}, err
 	}
-	if maxVersion(cdiVersion, "2.15") != cdiVersion {
+	if MaxVersion(cdiVersion, "2.15") != cdiVersion {
 		return DeleteUserIdMappingResult{}, errors.New("Please upgrade the SuperTokens core to >= 3.15.0")
 	}
 
@@ -178,7 +178,7 @@ func UpdateOrDeleteUserIdMappingInfo(userId string, userIdType *UserIdType, exte
 	if err != nil {
 		return UpdateOrDeleteUserIdMappingInfoResult{}, err
 	}
-	if maxVersion(cdiVersion, "2.15") != cdiVersion {
+	if MaxVersion(cdiVersion, "2.15") != cdiVersion {
 		return UpdateOrDeleteUserIdMappingInfoResult{}, errors.New("Please upgrade the SuperTokens core to >= 3.15.0")
 	}
 
diff --git a/supertokens/utils.go b/supertokens/utils.go
@@ -123,13 +123,13 @@ func getLargestVersionFromIntersection(v1 []string, v2 []string) *string {
 	}
 	maxVersionSoFar := intersection[0]
 	for i := 1; i < len(intersection); i++ {
-		maxVersionSoFar = maxVersion(intersection[i], maxVersionSoFar)
+		maxVersionSoFar = MaxVersion(intersection[i], maxVersionSoFar)
 	}
 	return &maxVersionSoFar
 }
 
 // MaxVersion returns max of v1 and v2
-func maxVersion(version1 string, version2 string) string {
+func MaxVersion(version1 string, version2 string) string {
 	var splittedv1 = strings.Split(version1, ".")
 	var splittedv2 = strings.Split(version2, ".")
 	var minLength = len(splittedv1)

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`"2.16",`
`13`	`13`	`"2.17",`
`14`	`14`	`"2.18",`
`15`		`- "2.19"`
	`15`	`+ "2.19",`
	`16`	`+ "2.20"`
`16`	`17`	`]`
`17`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,10 @@ const (`
`21`	`21`	`)`
`22`	`22`
`23`	`23`	`// VERSION current version of the lib`
`24`		`-const VERSION = "0.10.4"`
	`24`	`+const VERSION = "0.10.5"`
`25`	`25`
`26`	`26`	`var (`
`27`		`- 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"}`
	`27`	`+ 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", "2.20"}`
`28`	`28`	`)`
`29`	`29`
`30`		`-const DashboardVersion = "0.5"`
	`30`	`+const DashboardVersion = "0.6"`
Original file line number	Diff line number	Diff line change
`@@ -60,11 +60,11 @@ func GetUserCount(includeRecipeIds *[]string) (float64, error) {`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`func GetUsersOldestFirst(paginationToken string, limit int, includeRecipeIds *[]string) (UserPaginationResult, error) {`
`63`		`- return getUsers("ASC", paginationToken, limit, includeRecipeIds)`
	`63`	`+ return GetUsersWithSearchParams("ASC", paginationToken, limit, includeRecipeIds, nil)`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`func GetUsersNewestFirst(paginationToken string, limit int, includeRecipeIds *[]string) (UserPaginationResult, error) {`
`67`		`- return getUsers("DESC", paginationToken, limit, includeRecipeIds)`
	`67`	`+ return GetUsersWithSearchParams("DESC", paginationToken, limit, includeRecipeIds, nil)`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`func DeleteUser(userId string) error {`