Change ClientDeactivateThreshold type to string value (yorkie-team#471)

Change ClientDeactivateThreshold type to string to remove necessary type conversation in server. This will also ease client to get/update ClientDeactivateThreshold via time duration string format (ex: 1h30m)
karockai · Feb 21, 2023 · 923b398 · 923b398
1 parent c5b9a90
commit 923b398
Show file tree

Hide file tree

Showing 29 changed files with 332 additions and 250 deletions.
diff --git a/api/converter/from_pb.go b/api/converter/from_pb.go
@@ -18,7 +18,6 @@ package converter
 
 import (
 	"fmt"
-	gotime "time"
 
 	protoTypes "github.com/gogo/protobuf/types"
 
@@ -69,12 +68,13 @@ func FromProject(pbProject *api.Project) (*types.Project, error) {
 	if err != nil {
 		return nil, fmt.Errorf("convert updatedAt to timestamp: %w", err)
 	}
+
 	return &types.Project{
 		ID:                        types.ID(pbProject.Id),
 		Name:                      pbProject.Name,
 		AuthWebhookURL:            pbProject.AuthWebhookUrl,
 		AuthWebhookMethods:        pbProject.AuthWebhookMethods,
-		ClientDeactivateThreshold: gotime.Duration(pbProject.ClientDeactivateThreshold),
+		ClientDeactivateThreshold: pbProject.ClientDeactivateThreshold,
 		PublicKey:                 pbProject.PublicKey,
 		SecretKey:                 pbProject.SecretKey,
 		CreatedAt:                 createdAt,
@@ -665,8 +665,8 @@ func FromUpdatableProjectFields(pbProjectFields *api.UpdatableProjectFields) (*t
 	if pbProjectFields.AuthWebhookMethods != nil {
 		updatableProjectFields.AuthWebhookMethods = &pbProjectFields.AuthWebhookMethods.Methods
 	}
-	if pbProjectFields.ClientDeactivateThreshold != 0 {
-		updatableProjectFields.ClientDeactivateThreshold = gotime.Duration(pbProjectFields.ClientDeactivateThreshold)
+	if pbProjectFields.ClientDeactivateThreshold != nil {
+		updatableProjectFields.ClientDeactivateThreshold = &pbProjectFields.ClientDeactivateThreshold.Value
 	}
 
 	return updatableProjectFields, nil

diff --git a/api/converter/to_pb.go b/api/converter/to_pb.go
@@ -76,7 +76,7 @@ func ToProject(project *types.Project) (*api.Project, error) {
 		Name:                      project.Name,
 		AuthWebhookUrl:            project.AuthWebhookURL,
 		AuthWebhookMethods:        project.AuthWebhookMethods,
-		ClientDeactivateThreshold: int64(project.ClientDeactivateThreshold),
+		ClientDeactivateThreshold: project.ClientDeactivateThreshold,
 		PublicKey:                 project.PublicKey,
 		SecretKey:                 project.SecretKey,
 		CreatedAt:                 pbCreatedAt,
@@ -515,8 +515,10 @@ func ToUpdatableProjectFields(fields *types.UpdatableProjectFields) (*api.Updata
 	} else {
 		pbUpdatableProjectFields.AuthWebhookMethods = nil
 	}
-	if fields.ClientDeactivateThreshold != 0 {
-		pbUpdatableProjectFields.ClientDeactivateThreshold = int64(fields.ClientDeactivateThreshold)
+	if fields.ClientDeactivateThreshold != nil {
+		pbUpdatableProjectFields.ClientDeactivateThreshold = &protoTypes.StringValue{
+			Value: *fields.ClientDeactivateThreshold,
+		}
 	}
 	return pbUpdatableProjectFields, nil
 }
diff --git a/api/types/fields_validation.go b/api/types/fields_validation.go
@@ -32,6 +32,7 @@ const (
 	containNumberRegexString          = `[0-9]`
 	containSpecialCharRegexString     = `[\{\}\[\]\/?.,;:|\)*~!^\-_+<>@\#$%&\\\=\(\'\"\x60]`
 	alphaNumberSpecialCharRegexString = `^[a-zA-Z0-9\{\}\[\]\/?.,;:|\)*~!^\-_+<>@\#$%&\\\=\(\'\"\x60]+$`
+	timeDurationFormatRegexString     = `^(\d{1,2}h\s?)?(\d{1,2}m\s?)?(\d{1,2}s)?$`
 )
 
 var (
@@ -44,6 +45,7 @@ var (
 	containNumberRegex          = regexp.MustCompile(containNumberRegexString)
 	containSpecialCharRegex     = regexp.MustCompile(containSpecialCharRegexString)
 	alphaNumberSpecialCharRegex = regexp.MustCompile(alphaNumberSpecialCharRegexString)
+	timeDurationFormatRegex     = regexp.MustCompile(timeDurationFormatRegexString)
 )
 
 func isReservedProjectName(name string) bool {
@@ -74,6 +76,10 @@ func hasAlphaNumSpecial(str string) bool {
 	return isValid
 }
 
+func isValidTimeDurationStringFormat(str string) bool {
+	return timeDurationFormatRegex.MatchString(str)
+}
+
 func init() {
 	registerValidation("slug", func(level validator.FieldLevel) bool {
 		val := level.Field().String()
@@ -109,4 +115,10 @@ func init() {
 		return val == ""
 	})
 	registerTranslation("url|emptystring", "{0} must be a valid URL")
+
+	registerValidation("duration", func(level validator.FieldLevel) bool {
+		val := level.Field().String()
+		return isValidTimeDurationStringFormat(val)
+	})
+	registerTranslation("duration", "{0} must be a valid time duration string format")
 }
diff --git a/api/types/project.go b/api/types/project.go
@@ -39,7 +39,7 @@ type Project struct {
 
 	// ClientDeactivateThreshold is the time after which clients in
 	// specific project are considered deactivate for housekeeping.
-	ClientDeactivateThreshold time.Duration `bson:"client_deactivate_threshold"`
+	ClientDeactivateThreshold string `bson:"client_deactivate_threshold"`
 
 	// PublicKey is the API key of this project.
 	PublicKey string `json:"public_key"`

diff --git a/api/types/updatable_project_fields.go b/api/types/updatable_project_fields.go
@@ -19,7 +19,6 @@ package types
 
 import (
 	"errors"
-	"time"
 
 	"github.com/go-playground/validator/v10"
 )
@@ -39,12 +38,12 @@ type UpdatableProjectFields struct {
 	AuthWebhookMethods *[]string `bson:"auth_webhook_methods,omitempty" validate:"omitempty,invalid_webhook_method"`
 
 	// ClientDeactivateThreshold is the time after which clients in specific project are considered deactivate.
-	ClientDeactivateThreshold time.Duration `bson:"client_deactivate_threshold,omitempty" validate:"omitempty"`
+	ClientDeactivateThreshold *string `bson:"client_deactivate_threshold,omitempty" validate:"omitempty,min=2,duration"`
 }
 
 // Validate validates the UpdatableProjectFields.
 func (i *UpdatableProjectFields) Validate() error {
-	if i.Name == nil && i.AuthWebhookURL == nil && i.AuthWebhookMethods == nil && i.ClientDeactivateThreshold == 0 {
+	if i.Name == nil && i.AuthWebhookURL == nil && i.AuthWebhookMethods == nil && i.ClientDeactivateThreshold == nil {
 		return ErrEmptyProjectFields
 	}
 

diff --git a/api/types/updatable_project_fields_test.go b/api/types/updatable_project_fields_test.go
@@ -18,7 +18,6 @@ package types_test
 
 import (
 	"testing"
-	"time"
 
 	"github.com/stretchr/testify/assert"
 
@@ -34,12 +33,12 @@ func TestUpdatableProjectFields(t *testing.T) {
 			string(types.AttachDocument),
 			string(types.WatchDocuments),
 		}
-		newClientDeactivateThreshold := 1 * time.Hour
+		newClientDeactivateThreshold := "1h"
 		fields := &types.UpdatableProjectFields{
 			Name:                      &newName,
 			AuthWebhookURL:            &newAuthWebhookURL,
 			AuthWebhookMethods:        &newAuthWebhookMethods,
-			ClientDeactivateThreshold: newClientDeactivateThreshold,
+			ClientDeactivateThreshold: &newClientDeactivateThreshold,
 		}
 		assert.NoError(t, fields.Validate())
 
@@ -54,7 +53,7 @@ func TestUpdatableProjectFields(t *testing.T) {
 		fields = &types.UpdatableProjectFields{
 			Name:                      &newName,
 			AuthWebhookURL:            &newAuthWebhookURL,
-			ClientDeactivateThreshold: newClientDeactivateThreshold,
+			ClientDeactivateThreshold: &newClientDeactivateThreshold,
 		}
 		assert.NoError(t, fields.Validate())
 
@@ -66,7 +65,7 @@ func TestUpdatableProjectFields(t *testing.T) {
 			Name:                      &newName,
 			AuthWebhookURL:            &newAuthWebhookURL,
 			AuthWebhookMethods:        &newAuthWebhookMethods,
-			ClientDeactivateThreshold: newClientDeactivateThreshold,
+			ClientDeactivateThreshold: &newClientDeactivateThreshold,
 		}
 		assert.ErrorAs(t, fields.Validate(), &invalidFieldsError)
 	})