Merge pull request #4721 from linuxfoundation/unicron-port-user-api-to-golang

Port '/v2/user/<uuid>' py API to '/v3/user-compat/<uuid>' go API

Author: lukaszgryglicki

cla-backend-go/swagger/cla.v1.yaml

@@ -141,6 +141,34 @@ paths:
       tags:
         - users
 
+  /user-compat/{userID}:
+    parameters:
+      - $ref: "#/parameters/x-request-id"
+      - $ref: "#/parameters/userPathUuid"
+    get:
+      summary: Get user by ID (returns data in the same format as Py V2 API)
+      security: [ ]
+      operationId: getUserCompat
+      responses:
+        '200':
+          description: 'Success'
+          headers:
+            x-request-id:
+              type: string
+              description: The unique request ID value - assigned/set by the API Gateway based on the session
+          schema:
+            $ref: '#/definitions/user-compat'
+        '400':
+          $ref: '#/responses/invalid-request'
+        '401':
+          $ref: '#/responses/unauthorized'
+        '403':
+          $ref: '#/responses/forbidden'
+        '404':
+          $ref: '#/responses/not-found'
+      tags:
+        - users
+
   /users/{userID}:
     get:
       summary: Get User by ID
@@ -2429,6 +2457,13 @@ paths:
 
 # Common parameters
 parameters:
+  userPathUuid:
+    name: userID
+    in: path
+    required: true
+    description: The user ID (UUID string)
+    type: string
+    pattern: '^[a-fA-F0-9]{8}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{4}-?[a-fA-F0-9]{12}$' # this is any UUID, not only v4
   x-request-id:
     name: X-REQUEST-ID
     description: The unique request ID value - assigned/set by the API Gateway based on the login session
@@ -2677,6 +2712,9 @@ definitions:
   user:
     $ref: './common/user.yaml'
 
+  user-compat:
+    $ref: './common/user-compat.yaml'
+
   user-update:
     type: object
     title: User
@@ -2690,6 +2728,8 @@ definitions:
         type: string
       lfEmail:
         type: string
+      lfSub:
+        type: string
       lfUsername:
         type: string
       companyID:

cla-backend-go/swagger/common/user-compat.yaml

@@ -0,0 +1,101 @@
+# Copyright The Linux Foundation and each contributor to CommunityBridge.
+# SPDX-License-Identifier: MIT
+
+type: object
+x-nullable: false
+title: User Model in Py V2 format
+description: User Model - in Py V2 - minimal fields needed by FE
+properties:
+  user_id:
+    description: User's UUID
+    $ref: './common/properties/uuid.yaml'
+    x-omitempty: false
+    x-nullable: false
+  user_external_id:
+    description: External user ID
+    $ref: './common/properties/external-id.yaml'
+    x-omitempty: false
+    x-nullable: true
+  user_emails:
+    description: Set of user emails (may be empty)
+    type: array
+    items:
+      type: string
+      format: email
+      example: [email protected]
+    example: ["[email protected]"]
+    x-omitempty: false
+    x-nullable: false
+  user_name:
+    description: User's name
+    type: string
+    example: "Jane Smith"
+    x-omitempty: false
+    x-nullable: true
+  user_company_id:
+    description: User's company ID
+    $ref: './common/properties/uuid.yaml'
+    x-omitempty: false
+    x-nullable: true
+  user_github_id:
+    description: User's GitHub numeric ID
+    type: string
+    example: "123456"
+    x-omitempty: false
+    x-nullable: true
+  user_github_username:
+    description: User's GitHub username
+    type: string
+    example: "lukaszgryglicki"
+    x-omitempty: false
+    x-nullable: true
+  user_gitlab_id:
+    description: User's GitLab numeric ID
+    type: string
+    example: "78910"
+    x-omitempty: false
+    x-nullable: true
+  user_gitlab_username:
+    description: User's GitLab username
+    type: string
+    example: "gitlabUser"
+    x-omitempty: false
+    x-nullable: true
+  user_ldap_id:
+    description: User's LDAP ID
+    type: string
+    x-omitempty: false
+    x-nullable: true
+  note:
+    description: Optional admin note
+    type: string
+    example: "Pending verification"
+    x-omitempty: false
+    x-nullable: true
+  lf_email:
+    description: LF email
+    $ref: './common/properties/email.yaml'
+    x-omitempty: false
+    x-nullable: true
+  lf_username:
+    description: Linux Foundation username
+    type: string
+    example: "janesmith"
+    x-omitempty: false
+    x-nullable: true
+  lf_sub:
+    type: string
+    x-omitempty: false
+    x-nullable: true
+  is_sanctioned:
+    type: boolean
+    description: "Is this user OFAC sanctioned? This field comes from users's company"
+    example: true
+    x-omitempty: false
+    x-nullable: true
+  version:
+    type: string
+    description: the version identifier for this record
+    example: 'v1'
+    x-omitempty: false
+    x-nullable: false

cla-backend-go/swagger/common/user.yaml

@@ -22,6 +22,8 @@ properties:
     $ref: './common/properties/email.yaml'
   lfUsername:
     type: string
+  lfSub:
+    type: string
   companyID:
     $ref: './common/properties/internal-id.yaml'
     description: the user's optional company ID

cla-backend-go/users/handlers.go

@@ -248,6 +248,28 @@ func Configure(api *operations.ClaAPI, service Service, eventsService events.Ser
 		return users.NewSearchUsersOK().WithPayload(userModel)
 
 	})
+
+	// Get User by ID compat handler
+	api.UsersGetUserCompatHandler = users.GetUserCompatHandlerFunc(func(params users.GetUserCompatParams) middleware.Responder {
+		f := logrus.Fields{"" +
+			"functionName": "users.GetUserCompatHandlerFunc",
+			"paramsUserID": params.UserID,
+		}
+
+		userModel, err := service.GetUser(params.UserID)
+		if err != nil {
+			log.WithFields(f).Warnf("error retrieving user for user_id: %s, error: %+v", params.UserID, err)
+			return users.NewGetUserCompatBadRequest().WithPayload(errorResponse(err))
+		}
+
+		compatModel, err := service.ConvertUserModelToUserCompatModel(userModel)
+		if err != nil {
+			log.WithFields(f).Warnf("error converting user model to compat model for user_id: %s, error: %+v", params.UserID, err)
+			return users.NewGetUserCompatBadRequest().WithPayload(errorResponse(err))
+		}
+		log.WithFields(f).Debugf("returning compat user model %+v from user model %+v for user_id: %s", compatModel, userModel, params.UserID)
+		return users.NewGetUserCompatOK().WithPayload(compatModel)
+	})
 }
 
 type codedResponse interface {

cla-backend-go/users/models.go

@@ -21,6 +21,7 @@ type DBUser struct {
 	UserGitlabUsername string   `json:"user_gitlab_username"`
 	UserCompanyID      string   `json:"user_company_id"`
 	Note               string   `json:"note"`
+	LFSub              string   `json:"lf_sub"`
 }
 
 type UserEmails struct {

cla-backend-go/users/repository.go

@@ -129,6 +129,12 @@ func (repo repository) CreateUser(user *models.User) (*models.User, error) {
 		}
 	}
 
+	if user.LfSub != "" {
+		attributes["lf_sub"] = &dynamodb.AttributeValue{
+			S: aws.String(user.LfSub),
+		}
+	}
+
 	if len(user.Emails) > 0 {
 		attributes["user_emails"] = &dynamodb.AttributeValue{
 			SS: utils.ArrayStringPointer(user.Emails),
@@ -363,6 +369,13 @@ func (repo repository) Save(user *models.UserUpdate) (*models.User, error) {
 		updateExpression = updateExpression + " #E = :e, "
 	}
 
+	if user.LfSub != "" && oldUserModel.LfSub != user.LfSub {
+		log.WithFields(f).Debugf("building query - adding lf_sub: %s", user.LfSub)
+		expressionAttributeNames["#SU"] = aws.String("lf_sub")
+		expressionAttributeValues[":su"] = &dynamodb.AttributeValue{S: aws.String(user.LfSub)}
+		updateExpression = updateExpression + " #SU = :su, "
+	}
+
 	if user.UserExternalID != "" && oldUserModel.UserExternalID != user.UserExternalID {
 		log.WithFields(f).Debugf("building query - adding user_external_id: %s", user.UserExternalID)
 		expressionAttributeNames["#UE"] = aws.String("user_external_id")
@@ -1313,6 +1326,7 @@ func convertDBUserModel(user DBUser) *models.User {
 		UserExternalID: user.UserExternalID,
 		Admin:          user.Admin,
 		LfEmail:        strfmt.Email(user.LFEmail),
+		LfSub:          user.LFSub,
 		LfUsername:     user.LFUsername,
 		DateCreated:    user.DateCreated,
 		DateModified:   user.DateModified,
@@ -1336,6 +1350,7 @@ func buildUserProjection() expression.ProjectionBuilder {
 		expression.Name("user_company_id"),
 		expression.Name("admin"),
 		expression.Name("lf_email"),
+		expression.Name("lf_sub"),
 		expression.Name("lf_username"),
 		expression.Name("user_name"),
 		expression.Name("user_emails"),

cla-backend-go/users/service.go

@@ -6,6 +6,7 @@ package users
 import (
 	"errors"
 
+	"github.com/go-openapi/strfmt"
 	"github.com/linuxfoundation/easycla/cla-backend-go/events"
 	"github.com/linuxfoundation/easycla/cla-backend-go/gen/v1/models"
 	"github.com/linuxfoundation/easycla/cla-backend-go/user"
@@ -27,6 +28,7 @@ type Service interface {
 	GetUserByGitLabUsername(gitlabUsername string) (*models.User, error)
 	SearchUsers(field string, searchTerm string, fullMatch bool) (*models.Users, error)
 	UpdateUserCompanyID(userID, companyID, note string) error
+	ConvertUserModelToUserCompatModel(*models.User) (*models.UserCompat, error)
 }
 
 type service struct {
@@ -192,3 +194,46 @@ func (s service) SearchUsers(searchField string, searchTerm string, fullMatch bo
 func (s service) UpdateUserCompanyID(userID, companyID, note string) error {
 	return s.repo.UpdateUserCompanyID(userID, companyID, note)
 }
+
+func stringPtr(s string) *string {
+	if s == "" {
+		return nil
+	}
+	return &s
+}
+
+func boolPtr(b bool) *bool {
+	return &b
+}
+
+// ConvertUserModelToUserCompatModel converts User to UserCompat
+func (s service) ConvertUserModelToUserCompatModel(user *models.User) (*models.UserCompat, error) {
+	userEmails := make([]strfmt.Email, len(user.Emails))
+	for i, e := range user.Emails {
+		userEmails[i] = strfmt.Email(e)
+	}
+
+	var lfEmail *strfmt.Email
+	if user.LfEmail != "" {
+		lfEmail = &user.LfEmail
+	}
+
+	return &models.UserCompat{
+		IsSanctioned:       boolPtr(user.IsSanctioned),
+		LfEmail:            lfEmail,
+		LfSub:              stringPtr(user.LfSub),
+		LfUsername:         stringPtr(user.LfUsername),
+		Note:               stringPtr(user.Note),
+		UserCompanyID:      stringPtr(user.CompanyID),
+		UserEmails:         userEmails,
+		UserExternalID:     stringPtr(user.UserExternalID),
+		UserGithubID:       stringPtr(user.GithubID),
+		UserGithubUsername: stringPtr(user.GithubUsername),
+		UserGitlabID:       stringPtr(user.GitlabID),
+		UserGitlabUsername: stringPtr(user.GitlabUsername),
+		UserID:             user.UserID,
+		UserLdapID:         nil,
+		UserName:           stringPtr(user.Username),
+		Version:            "v1",
+	}, nil
+}

cla-backend-go/v2/signatures/mock_users/mock_service.go

@@ -100,6 +100,7 @@ def get_health(request):
 #
 
 
+# LG: This is ported to golang and no longer used in dev (still used in prod)
 @hug.get("/user/{user_id}", versions=2)
 def get_user(user_id: hug.types.uuid):
     """