feat: Update backend to filter challenges by difficulty (#1030)

* Add Challenge.difficulty to OA description

* Fix EnumConverterConfiguration

* Minor update

* Add property and filter for incentive

* Comment out incentives because it's an array

* Discard incentive for now

* Scaffold custom challenge repository for advanced search

* Add Pageable support to custom repository

* Implement status and difficulty filter with querydsl

* Connect new querydsl code

* Cleanup

* Minor update to OA description

apps/challenge-service/.openapi-generator-ignore

@@ -26,6 +26,3 @@ README.md
 **/application.properties
 **/model/dto/*AllOf*.java
 **/OpenApiGeneratorApplication.java
-
-# The template of this file has a bug: the Dto suffix is not included
-**/EnumConverterConfiguration.java

apps/challenge-service/.openapi-generator/FILES

@@ -9,6 +9,7 @@ src/main/java/org/sagebionetworks/challenge/configuration/HomeController.java
 src/main/java/org/sagebionetworks/challenge/configuration/SpringDocConfiguration.java
 src/main/java/org/sagebionetworks/challenge/model/dto/BasicErrorDto.java
 src/main/java/org/sagebionetworks/challenge/model/dto/ChallengeCreateRequestDto.java
+src/main/java/org/sagebionetworks/challenge/model/dto/ChallengeDifficultyDto.java
 src/main/java/org/sagebionetworks/challenge/model/dto/ChallengeDto.java
 src/main/java/org/sagebionetworks/challenge/model/dto/ChallengeStatusDto.java
 src/main/java/org/sagebionetworks/challenge/model/dto/ChallengesPageDto.java

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/api/ChallengeApi.java

@@ -15,6 +15,7 @@
 import javax.validation.Valid;
 import javax.validation.constraints.*;
 import org.sagebionetworks.challenge.model.dto.BasicErrorDto;
+import org.sagebionetworks.challenge.model.dto.ChallengeDifficultyDto;
 import org.sagebionetworks.challenge.model.dto.ChallengeStatusDto;
 import org.sagebionetworks.challenge.model.dto.ChallengesPageDto;
 import org.springframework.http.ResponseEntity;
@@ -35,7 +36,9 @@ default ChallengeApiDelegate getDelegate() {
    *
    * @param pageNumber The page number (optional, default to 0)
    * @param pageSize The number of items in a single page (optional, default to 100)
-   * @param status Array of challenge status used to filter the results. (optional)
+   * @param status An array of challenge status used to filter the results. (optional)
+   * @param difficulty An array of challenge difficulty levels used to filter the results.
+   *     (optional)
    * @return Success (status code 200) or Invalid request (status code 400) or The request cannot be
    *     fulfilled due to an unexpected server error (status code 500)
    */
@@ -95,10 +98,16 @@ default ResponseEntity<ChallengesPageDto> listChallenges(
           Integer pageSize,
       @Parameter(
               name = "status",
-              description = "Array of challenge status used to filter the results.")
+              description = "An array of challenge status used to filter the results.")
           @Valid
           @RequestParam(value = "status", required = false)
-          List<ChallengeStatusDto> status) {
-    return getDelegate().listChallenges(pageNumber, pageSize, status);
+          List<ChallengeStatusDto> status,
+      @Parameter(
+              name = "difficulty",
+              description = "An array of challenge difficulty levels used to filter the results.")
+          @Valid
+          @RequestParam(value = "difficulty", required = false)
+          List<ChallengeDifficultyDto> difficulty) {
+    return getDelegate().listChallenges(pageNumber, pageSize, status, difficulty);
   }
 }

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/api/ChallengeApiDelegate.java

@@ -3,6 +3,7 @@
 import java.util.List;
 import java.util.Optional;
 import javax.annotation.Generated;
+import org.sagebionetworks.challenge.model.dto.ChallengeDifficultyDto;
 import org.sagebionetworks.challenge.model.dto.ChallengeStatusDto;
 import org.sagebionetworks.challenge.model.dto.ChallengesPageDto;
 import org.springframework.http.HttpStatus;
@@ -26,13 +27,18 @@ default Optional<NativeWebRequest> getRequest() {
    *
    * @param pageNumber The page number (optional, default to 0)
    * @param pageSize The number of items in a single page (optional, default to 100)
-   * @param status Array of challenge status used to filter the results. (optional)
+   * @param status An array of challenge status used to filter the results. (optional)
+   * @param difficulty An array of challenge difficulty levels used to filter the results.
+   *     (optional)
    * @return Success (status code 200) or Invalid request (status code 400) or The request cannot be
    *     fulfilled due to an unexpected server error (status code 500)
    * @see ChallengeApi#listChallenges
    */
   default ResponseEntity<ChallengesPageDto> listChallenges(
-      Integer pageNumber, Integer pageSize, List<ChallengeStatusDto> status) {
+      Integer pageNumber,
+      Integer pageSize,
+      List<ChallengeStatusDto> status,
+      List<ChallengeDifficultyDto> difficulty) {
     getRequest()
         .ifPresent(
             request -> {

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/api/ChallengeApiDelegateImpl.java

@@ -1,6 +1,7 @@
 package org.sagebionetworks.challenge.api;
 
 import java.util.List;
+import org.sagebionetworks.challenge.model.dto.ChallengeDifficultyDto;
 import org.sagebionetworks.challenge.model.dto.ChallengeStatusDto;
 import org.sagebionetworks.challenge.model.dto.ChallengesPageDto;
 import org.sagebionetworks.challenge.service.ChallengeService;
@@ -15,8 +16,12 @@ public class ChallengeApiDelegateImpl implements ChallengeApiDelegate {
 
   @Override
   public ResponseEntity<ChallengesPageDto> listChallenges(
-      Integer pageNumber, Integer pageSize, List<ChallengeStatusDto> status) {
-    return ResponseEntity.ok(challengeService.listChallenges(pageNumber, pageSize, status));
+      Integer pageNumber,
+      Integer pageSize,
+      List<ChallengeStatusDto> status,
+      List<ChallengeDifficultyDto> difficulty) {
+    return ResponseEntity.ok(
+        challengeService.listChallenges(pageNumber, pageSize, status, difficulty));
   }
 
   // @Override

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/configuration/EnumConverterConfiguration.java

@@ -1,5 +1,6 @@
 package org.sagebionetworks.challenge.configuration;
 
+import org.sagebionetworks.challenge.model.dto.ChallengeDifficultyDto;
 import org.sagebionetworks.challenge.model.dto.ChallengeStatusDto;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -8,6 +9,16 @@
 @Configuration
 public class EnumConverterConfiguration {
 
+  @Bean
+  Converter<String, ChallengeDifficultyDto> challengeDifficultyConverter() {
+    return new Converter<String, ChallengeDifficultyDto>() {
+      @Override
+      public ChallengeDifficultyDto convert(String source) {
+        return ChallengeDifficultyDto.fromValue(source);
+      }
+    };
+  }
+
   @Bean
   Converter<String, ChallengeStatusDto> challengeStatusConverter() {
     return new Converter<String, ChallengeStatusDto>() {

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/model/dto/ChallengeCreateRequestDto.java

@@ -22,6 +22,9 @@ public class ChallengeCreateRequestDto {
   @JsonProperty("status")
   private ChallengeStatusDto status;
 
+  @JsonProperty("difficulty")
+  private ChallengeDifficultyDto difficulty;
+
   public ChallengeCreateRequestDto name(String name) {
     this.name = name;
     return this;
@@ -64,6 +67,26 @@ public void setStatus(ChallengeStatusDto status) {
     this.status = status;
   }
 
+  public ChallengeCreateRequestDto difficulty(ChallengeDifficultyDto difficulty) {
+    this.difficulty = difficulty;
+    return this;
+  }
+
+  /**
+   * Get difficulty
+   *
+   * @return difficulty
+   */
+  @Valid
+  @Schema(name = "difficulty", required = false)
+  public ChallengeDifficultyDto getDifficulty() {
+    return difficulty;
+  }
+
+  public void setDifficulty(ChallengeDifficultyDto difficulty) {
+    this.difficulty = difficulty;
+  }
+
   @Override
   public boolean equals(Object o) {
     if (this == o) {
@@ -74,12 +97,13 @@ public boolean equals(Object o) {
     }
     ChallengeCreateRequestDto challengeCreateRequest = (ChallengeCreateRequestDto) o;
     return Objects.equals(this.name, challengeCreateRequest.name)
-        && Objects.equals(this.status, challengeCreateRequest.status);
+        && Objects.equals(this.status, challengeCreateRequest.status)
+        && Objects.equals(this.difficulty, challengeCreateRequest.difficulty);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(name, status);
+    return Objects.hash(name, status, difficulty);
   }
 
   @Override
@@ -88,6 +112,7 @@ public String toString() {
     sb.append("class ChallengeCreateRequestDto {\n");
     sb.append("    name: ").append(toIndentedString(name)).append("\n");
     sb.append("    status: ").append(toIndentedString(status)).append("\n");
+    sb.append("    difficulty: ").append(toIndentedString(difficulty)).append("\n");
     sb.append("}");
     return sb.toString();
   }

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/model/dto/ChallengeDifficultyDto.java

@@ -0,0 +1,43 @@
+package org.sagebionetworks.challenge.model.dto;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+import java.util.*;
+import javax.annotation.Generated;
+import javax.validation.constraints.*;
+
+/** The difficulty level of a challenge. */
+@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
+public enum ChallengeDifficultyDto {
+  GOOD_FOR_BEGINNERS("good_for_beginners"),
+
+  INTERMEDIATE("intermediate"),
+
+  ADVANCED("advanced");
+
+  private String value;
+
+  ChallengeDifficultyDto(String value) {
+    this.value = value;
+  }
+
+  @JsonValue
+  public String getValue() {
+    return value;
+  }
+
+  @Override
+  public String toString() {
+    return String.valueOf(value);
+  }
+
+  @JsonCreator
+  public static ChallengeDifficultyDto fromValue(String value) {
+    for (ChallengeDifficultyDto b : ChallengeDifficultyDto.values()) {
+      if (b.value.equals(value)) {
+        return b;
+      }
+    }
+    throw new IllegalArgumentException("Unexpected value '" + value + "'");
+  }
+}

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/model/dto/ChallengeDto.java

@@ -24,6 +24,9 @@ public class ChallengeDto {
   @JsonProperty("status")
   private ChallengeStatusDto status;
 
+  @JsonProperty("difficulty")
+  private ChallengeDifficultyDto difficulty;
+
   @JsonProperty("id")
   private Long id;
 
@@ -77,6 +80,26 @@ public void setStatus(ChallengeStatusDto status) {
     this.status = status;
   }
 
+  public ChallengeDto difficulty(ChallengeDifficultyDto difficulty) {
+    this.difficulty = difficulty;
+    return this;
+  }
+
+  /**
+   * Get difficulty
+   *
+   * @return difficulty
+   */
+  @Valid
+  @Schema(name = "difficulty", required = false)
+  public ChallengeDifficultyDto getDifficulty() {
+    return difficulty;
+  }
+
+  public void setDifficulty(ChallengeDifficultyDto difficulty) {
+    this.difficulty = difficulty;
+  }
+
   public ChallengeDto id(Long id) {
     this.id = id;
     return this;
@@ -154,14 +177,15 @@ public boolean equals(Object o) {
     ChallengeDto challenge = (ChallengeDto) o;
     return Objects.equals(this.name, challenge.name)
         && Objects.equals(this.status, challenge.status)
+        && Objects.equals(this.difficulty, challenge.difficulty)
         && Objects.equals(this.id, challenge.id)
         && Objects.equals(this.createdAt, challenge.createdAt)
         && Objects.equals(this.updatedAt, challenge.updatedAt);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(name, status, id, createdAt, updatedAt);
+    return Objects.hash(name, status, difficulty, id, createdAt, updatedAt);
   }
 
   @Override
@@ -170,6 +194,7 @@ public String toString() {
     sb.append("class ChallengeDto {\n");
     sb.append("    name: ").append(toIndentedString(name)).append("\n");
     sb.append("    status: ").append(toIndentedString(status)).append("\n");
+    sb.append("    difficulty: ").append(toIndentedString(difficulty)).append("\n");
     sb.append("    id: ").append(toIndentedString(id)).append("\n");
     sb.append("    createdAt: ").append(toIndentedString(createdAt)).append("\n");
     sb.append("    updatedAt: ").append(toIndentedString(updatedAt)).append("\n");

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/model/entity/ChallengeEntity.java

@@ -32,6 +32,9 @@ public class ChallengeEntity {
   @Column(nullable = false)
   private String status;
 
+  @Column(nullable = false)
+  private String difficulty;
+
   // @Column(nullable = false)
   // private String email;
 

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/model/mapper/ChallengeMapper.java

@@ -1,5 +1,6 @@
 package org.sagebionetworks.challenge.model.mapper;
 
+import org.sagebionetworks.challenge.model.dto.ChallengeDifficultyDto;
 import org.sagebionetworks.challenge.model.dto.ChallengeDto;
 import org.sagebionetworks.challenge.model.dto.ChallengeStatusDto;
 import org.sagebionetworks.challenge.model.entity.ChallengeEntity;
@@ -22,6 +23,7 @@ public ChallengeDto convertToDto(ChallengeEntity entity, Object... args) {
     if (entity != null) {
       BeanUtils.copyProperties(entity, user);
       user.setStatus(ChallengeStatusDto.fromValue(entity.getStatus()));
+      user.setDifficulty(ChallengeDifficultyDto.fromValue(entity.getDifficulty()));
     }
     return user;
   }

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/model/repository/ChallengeFilter.java

@@ -0,0 +1,16 @@
+package org.sagebionetworks.challenge.model.repository;
+
+import java.util.List;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class ChallengeFilter {
+  private List<String> status;
+  private List<String> difficulty;
+}

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/model/repository/ChallengeRepository.java

@@ -5,7 +5,4 @@
 import org.springframework.data.querydsl.QuerydslPredicateExecutor;
 
 public interface ChallengeRepository
-    extends JpaRepository<ChallengeEntity, Long>, QuerydslPredicateExecutor<ChallengeEntity> {
-
-  // Optional<ChallengeEntity> findByLogin(String login);
-}
+    extends JpaRepository<ChallengeEntity, Long>, QuerydslPredicateExecutor<ChallengeEntity> {}

apps/challenge-service/src/main/java/org/sagebionetworks/challenge/model/repository/ChallengeRepositoryCustom.java

@@ -0,0 +1,10 @@
+package org.sagebionetworks.challenge.model.repository;
+
+import org.sagebionetworks.challenge.model.entity.ChallengeEntity;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+
+public interface ChallengeRepositoryCustom {
+
+  Page<ChallengeEntity> findAll(Pageable pageable, ChallengeFilter filter);
+}