feat: added new endpoints to better see skipped Ids and expose emails

Author: nicoalee

casbin/casbin_auth_policy.csv

@@ -32,6 +32,8 @@ p, PARTICIPANT,         /api/participantdata,
 p, GUEST,               /api/participantdata,                                           POST
 p, ADMIN,               /api/participantdata/{studyId}/{taskOrder},                     GET
 p, ORGANIZATION_MEMBER, /api/participantdata/{studyId}/{taskOrder},                     GET
+p, ADMIN,               /api/participantdata/{studyId},                                 GET
+p, ORGANIZATION_MEMBER, /api/participantdata/{studyId},                                 GET
 
 p, ADMIN,               /api/tasks,                                                     GET
 p, ORGANIZATION_MEMBER, /api/tasks,                                                     GET

src/controllers/ParticipantData.controller.go

@@ -39,3 +39,31 @@ func (s *ParticipantDataController) GetParticipantDataByStudyIdAndTaskOrder(e ec
 	}
 	return common.SendHTTPOkWithBody(e, taskData)
 }
+
+// GetParticipantDataByStudyIdWithFilters gets participant data for a study with optional metadata filters via query parameters
+func (s *ParticipantDataController) GetParticipantDataByStudyIdWithFilters(e echo.Context) error {
+	axonlogger.InfoLogger.Println("============= PARTICIPANTDATA CONTROLLER: GetParticipantDataByStudyIdWithFilters() =============")
+	studyId := e.Param("studyId")
+
+	userId, ok := e.Get("id").(string)
+	if !ok {
+		return common.SendHTTPBadRequest(e)
+	}
+
+	// Extract all query parameters as filters
+	// This makes the endpoint extensible - any query param will be treated as a metadata filter
+	filters := make(map[string]string)
+	queryParams := e.QueryParams()
+	for key, values := range queryParams {
+		if len(values) > 0 {
+			// Use the first value if multiple values are provided for the same key
+			filters[key] = values[0]
+		}
+	}
+
+	participantData, httpStatus := participantDataServiceImpl.GetParticipantDataByStudyIdWithFilters(studyId, userId, filters)
+	if !common.HTTPRequestIsSuccessful(httpStatus.Status) {
+		return e.JSON(httpStatus.Status, httpStatus)
+	}
+	return common.SendHTTPOkWithBody(e, participantData)
+}

src/database/ParticipantData.database.go

@@ -78,7 +78,6 @@ func (s *ParticipantDataRepository) CreateParticipantData(participantData models
 			axonlogger.ErrorLogger.Println("could not save participant data", err)
 			return models.HTTPStatus{Status: http.StatusInternalServerError, Message: http.StatusText(http.StatusInternalServerError)}
 		}
-
 	}
 
 	axonlogger.InfoLogger.Println("Successfully uploaded task data [studyId, userId, taskOrder]:", participantData.StudyID, participantData.UserID, participantData.TaskOrder)
@@ -143,3 +142,46 @@ func (s *ParticipantDataRepository) GetAllParticipantDataByStudyIdAndTaskOrder(s
 
 	return participantData, models.HTTPStatus{Status: http.StatusOK, Message: http.StatusText(http.StatusOK)}
 }
+
+// GetParticipantDataByStudyIdWithFilters gets all participant data for the given study id with optional metadata filters
+// It returns a 200 or 500 status code
+// The filters parameter is a map of JSON path keys to values (e.g., map["wasSkipped"]="true")
+func (s *ParticipantDataRepository) GetParticipantDataByStudyIdWithFilters(studyId uint, filters map[string]string) ([]models.ParticipantData, models.HTTPStatus) {
+	axonlogger.InfoLogger.Println("PARTICIPANTDATA DATABASE: GetParticipantDataByStudyIdWithFilters()")
+
+	defer func() {
+		if err := recover(); err != nil {
+			axonlogger.ErrorLogger.Println("there was an error getting the participant data list with filters", err)
+		}
+	}()
+
+	participantData := []models.ParticipantData{}
+	
+	// Build the base query
+	query := `
+		SELECT user_id, study_id, task_order, participant_type, submitted_at, metadata, data 
+		FROM participant_data 
+		WHERE study_id = ?`
+	
+	// Create slice to hold query arguments
+	args := []interface{}{studyId}
+	
+	// Handle specific filter: wasSkipped
+	if skippedValue, exists := filters["wasSkipped"]; exists {
+		// Use CAST(... AS CHAR) to convert JSON boolean to string for comparison
+		query += ` AND metadata->>'$.wasSkipped' = ?`
+		args = append(args, skippedValue)
+	}
+	
+	query += ";"
+	
+	if httpStatus := baseRepositoryImpl.GetAllBy(
+		&participantData,
+		query,
+		args...,
+	); !common.HTTPRequestIsSuccessful(httpStatus.Status) {
+		return participantData, httpStatus
+	}
+
+	return participantData, models.HTTPStatus{Status: http.StatusOK, Message: http.StatusText(http.StatusOK)}
+}

src/models/StudyUser.model.go

@@ -39,6 +39,7 @@ type StudyUser struct {
 // StudyUserSummary
 type StudyUserSummary struct {
 	UserId  uint   `json:"userId"`
+	Email   string `json:"email"`
 	Studies []uint `json:"studies"`
 }
 

src/services/ParticipantData.service.go

@@ -51,3 +51,36 @@ func (s *ParticipantDataService) GetParticipantDataByStudyIdAndTaskOrder(studyId
 	return participantDataRepositoryImpl.GetAllParticipantDataByStudyIdAndTaskOrder(studyId, taskOrder)
 
 }
+
+// GetParticipantDataByStudyIdWithFilters gets participant data for a given study id with optional metadata filters.
+// It returns a 200, 403, or 500 status code
+func (s *ParticipantDataService) GetParticipantDataByStudyIdWithFilters(studyIdFromPath string, userId string, filters map[string]string) ([]models.ParticipantData, models.HTTPStatus) {
+	axonlogger.InfoLogger.Println("PARTICIPANTDATA SERVICE: GetParticipantDataByStudyIdWithFilters()")
+	studyId, convertStudyIdErr := convertStringToUint8(studyIdFromPath)
+	if convertStudyIdErr != nil {
+		axonlogger.WarningLogger.Println(convertStudyIdErr)
+		return []models.ParticipantData{}, models.HTTPStatus{Status: http.StatusInternalServerError, Message: http.StatusText(http.StatusInternalServerError)}
+	}
+
+	parsedUserId, getUserIdError := convertStringToUint8(userId)
+	if getUserIdError != nil {
+		axonlogger.WarningLogger.Println(getUserIdError)
+		return []models.ParticipantData{}, models.HTTPStatus{Status: http.StatusInternalServerError, Message: http.StatusText(http.StatusInternalServerError)}
+	}
+
+	user, getUserHttpStatus := userRepositoryImpl.GetUserById(parsedUserId)
+	if !common.HTTPRequestIsSuccessful(getUserHttpStatus.Status) {
+		return []models.ParticipantData{}, getUserHttpStatus
+	}
+
+	study, getStudyHttpStatus := studyRepositoryImpl.GetStudyById(studyId)
+	if !common.HTTPRequestIsSuccessful(getStudyHttpStatus.Status) {
+		return []models.ParticipantData{}, getStudyHttpStatus
+	}
+
+	if user.Organization.ID != study.Owner.Organization.ID && (user.Role != common.ADMIN && user.Role != common.ORGANIZATION_MEMBER) {
+		return []models.ParticipantData{}, models.HTTPStatus{Status: http.StatusForbidden, Message: http.StatusText(http.StatusForbidden)}
+	}
+
+	return participantDataRepositoryImpl.GetParticipantDataByStudyIdWithFilters(studyId, filters)
+}

src/services/StudyUser.service.go

@@ -149,7 +149,13 @@ func (s *StudyUserService) GetStudyUserSummary() ([]models.StudyUserSummary, mod
 	var studyUserSummary = make([]models.StudyUserSummary, len(studyUsersMap))
 	index := 0
 	for key, studiesSlice := range studyUsersMap {
+		user, httpStatus := userRepositoryImpl.GetUserById(key)
+		if !common.HTTPRequestIsSuccessful(httpStatus.Status) {
+			axonlogger.ErrorLogger.Println("encountered an error while getting user by id", httpStatus)
+			continue
+		}
 		studyUserSummary[index].UserId = key
+		studyUserSummary[index].Email = user.Email
 		studyUserSummary[index].Studies = studiesSlice
 		index++
 	}

src/setup/Router.go

@@ -79,6 +79,7 @@ func setUpParticipantDataRoutes(group *echo.Group) {
 	studyData := group.Group("/participantdata")
 	studyData.POST("", participantDataControllerImpl.CreateParticipantData)
 	studyData.GET("/:studyId/:taskOrder", participantDataControllerImpl.GetParticipantDataByStudyIdAndTaskOrder)
+	studyData.GET("/:studyId", participantDataControllerImpl.GetParticipantDataByStudyIdWithFilters)
 }
 
 func setUpSummaryRoutes(group *echo.Group) {