feat: deprecate UUID users (#86)

* feat: deprecate uuid * test: fix and add unit tests * feat: add migration sql to drop uuid column in users table * refactor: remove unused method * feat: add id as response, replacement for uuid * test: update case * feat: update the compass yaml example * refactor: remove unused variable and documentation * feat: separate drop uuid users column to another MR --------- Co-authored-by: Muhammad Luthfi Fahlevi <[email protected]>
goto · Nov 26, 2024 · 6119ad8 · 6119ad8
1 parent f2972f1
commit 6119ad8
Show file tree

Hide file tree

Showing 47 changed files with 405 additions and 571 deletions.
diff --git a/cli/root.go b/cli/root.go
@@ -33,8 +33,8 @@ var rootCmd = &cobra.Command{
 }
 
 func New(cliConfig *Config) *cobra.Command {
-	if cliConfig.Client.ServerHeaderKeyUUID == "" {
-		cliConfig.Client.ServerHeaderKeyUUID = cliConfig.Service.Identity.HeaderKeyUUID
+	if cliConfig.Client.ServerHeaderKeyEmail == "" {
+		cliConfig.Client.ServerHeaderKeyEmail = cliConfig.Service.Identity.HeaderValueEmail
 	}
 
 	rootCmd.PersistentPreRunE = func(subCmd *cobra.Command, args []string) error {

diff --git a/compass.yaml.example b/compass.yaml.example
@@ -44,7 +44,6 @@ service:
     port: 8080
     request_timeout: 10s
     identity:
-        headerkey_uuid: Compass-User-UUID
         headerkey_email: Compass-User-Email
         provider_default_name: shield
     grpc:
@@ -72,8 +71,8 @@ worker:
 
 client:
     host: localhost:8081
-    serverheaderkey_uuid: Compass-User-UUID // if ommited, will use value on service.identity.headerkey_uuid
-    serverheadervalue_uuid: [email protected]
+    serverheaderkey_email: Compass-User-Email // if ommited, will use value on service.identity.headerkey_email
+    serverheadervalue_email: [email protected]
 
 asset:
     additional_types:

diff --git a/core/asset/patch.go b/core/asset/patch.go
@@ -54,7 +54,6 @@ func buildOwners(data interface{}) []user.User {
 	buildOwner := func(data map[string]interface{}) user.User {
 		return user.User{
 			ID:       getString("id", data),
-			UUID:     getString("uuid", data),
 			Email:    getString("email", data),
 			Provider: getString("provider", data),
 		}

diff --git a/core/asset/service_test.go b/core/asset/service_test.go
@@ -408,7 +408,7 @@ func TestService_DeleteAsset(t *testing.T) {
 			Err: errors.New("unknown error"),
 		},
 		{
-			Description: `should call DeleteByURN on repositories by fetching URN when given a UUID`,
+			Description: `should call DeleteByURN on repositories by fetching URN when given an ID`,
 			ID:          assetID,
 			Setup: func(ctx context.Context, ar *mocks.AssetRepository, dr *mocks.DiscoveryRepository, lr *mocks.LineageRepository) {
 				ar.EXPECT().GetByID(ctx, assetID).Return(asset.Asset{ID: assetID, URN: urn}, nil)
@@ -419,7 +419,7 @@ func TestService_DeleteAsset(t *testing.T) {
 			Err: nil,
 		},
 		{
-			Description: `should call DeleteByURN on repositories when not given a UUID`,
+			Description: `should call DeleteByURN on repositories when not given an ID`,
 			ID:          urn,
 			Setup: func(ctx context.Context, ar *mocks.AssetRepository, dr *mocks.DiscoveryRepository, lr *mocks.LineageRepository) {
 				ar.EXPECT().DeleteByURN(ctx, urn).Return(nil)

diff --git a/core/user/context_test.go b/core/user/context_test.go
@@ -10,7 +10,7 @@ import (
 
 func TestContext(t *testing.T) {
 	t.Run("should return passed user if exist in context", func(t *testing.T) {
-		passedUser := user.User{UUID: "uuid", Email: "email"}
+		passedUser := user.User{Email: "[email protected]"}
 		userCtx := user.NewContext(context.Background(), passedUser)
 		actual := user.FromContext(userCtx)
 		if !cmp.Equal(passedUser, actual) {

diff --git a/core/user/errors.go b/core/user/errors.go
@@ -8,41 +8,33 @@ import (
 var ErrNoUserInformation = errors.New("no user information")
 
 type NotFoundError struct {
-	UUID  string
 	Email string
 }
 
 func (e NotFoundError) Error() string {
 	cause := "could not find user"
-	if e.UUID != "" {
-		cause += fmt.Sprintf(" with uuid \"%s\"", e.UUID)
-	}
 	if e.Email != "" {
 		cause += fmt.Sprintf(" with email \"%s\"", e.Email)
 	}
 	return cause
 }
 
 type DuplicateRecordError struct {
-	UUID  string
 	Email string
 }
 
 func (e DuplicateRecordError) Error() string {
 	cause := "duplicate user"
-	if e.UUID != "" {
-		cause += fmt.Sprintf(" with uuid \"%s\"", e.UUID)
-	}
 	if e.Email != "" {
 		cause += fmt.Sprintf(" with email \"%s\"", e.Email)
 	}
 	return cause
 }
 
 type InvalidError struct {
-	UUID string
+	Email string
 }
 
 func (e InvalidError) Error() string {
-	return fmt.Sprintf("empty field with uuid \"%s\"", e.UUID)
+	return fmt.Sprintf("empty field with email %q", e.Email)
 }
diff --git a/core/user/errors_test.go b/core/user/errors_test.go
@@ -16,18 +16,18 @@ func TestErrors(t *testing.T) {
 	testCases := []testCase{
 		{
 			Description:    "not found error return correct error string",
-			Err:            user.NotFoundError{UUID: "uuid", Email: "email"},
-			ExpectedString: "could not find user with uuid \"uuid\" with email \"email\"",
+			Err:            user.NotFoundError{Email: "[email protected]"},
+			ExpectedString: "could not find user with email \"[email protected]\"",
 		},
 		{
 			Description:    "duplicate error return correct error string",
-			Err:            user.DuplicateRecordError{UUID: "uuid", Email: "email"},
-			ExpectedString: "duplicate user with uuid \"uuid\" with email \"email\"",
+			Err:            user.DuplicateRecordError{Email: "[email protected]"},
+			ExpectedString: "duplicate user with email \"[email protected]\"",
 		},
 		{
 			Description:    "invalid error return correct error string",
-			Err:            user.InvalidError{UUID: "uuid"},
-			ExpectedString: "empty field with uuid \"uuid\"",
+			Err:            user.InvalidError{Email: "[email protected]"},
+			ExpectedString: "empty field with email \"[email protected]\"",
 		},
 	}
 

diff --git a/core/user/mocks/user_repository.go b/core/user/mocks/user_repository.go
diff --git a/core/user/service.go b/core/user/service.go
@@ -2,8 +2,6 @@ package user
 
 import (
 	"context"
-	"errors"
-
 	"github.com/goto/salt/log"
 )
 
@@ -13,32 +11,20 @@ type Service struct {
 	logger     log.Logger
 }
 
-// ValidateUser checks if user uuid is already in DB
+// ValidateUser checks if user email is already in DB
 // if exist in DB, return user ID, if not exist in DB, create a new one
-func (s *Service) ValidateUser(ctx context.Context, uuid, email string) (string, error) {
-	if uuid == "" {
+func (s *Service) ValidateUser(ctx context.Context, email string) (string, error) {
+	if email == "" {
 		return "", ErrNoUserInformation
 	}
 
-	usr, err := s.repository.GetByUUID(ctx, uuid)
-	if err == nil {
-		if usr.ID != "" {
-			return usr.ID, nil
-		}
-		err := errors.New("fetched user uuid from DB is empty")
-		s.logger.Error(err.Error())
-		return "", err
-	}
-
-	uid, err := s.repository.UpsertByEmail(ctx, &User{
-		UUID:  uuid,
-		Email: email,
-	})
+	userID, err := s.repository.GetOrInsertByEmail(ctx, &User{Email: email})
 	if err != nil {
-		s.logger.Error("error when UpsertByEmail in ValidateUser service", "err", err.Error())
+		s.logger.Error("error when GetOrInsertByEmail in ValidateUser service", "err", err.Error())
 		return "", err
 	}
-	return uid, nil
+
+	return userID, nil
 }
 
 // NewService initializes user service