develop -> main

build.gradle

@@ -30,6 +30,8 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-data-redis'
     implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
 
+    implementation 'net.logstash.logback:logstash-logback-encoder:8.0'
+
     implementation 'io.jsonwebtoken:jjwt-api:0.12.3'
 
     implementation 'org.jsoup:jsoup:1.15.3'
@@ -79,6 +81,9 @@ dependencies {
     implementation 'io.github.resilience4j:resilience4j-spring-boot3:2.1.0'
     implementation 'org.springframework.boot:spring-boot-starter-aop'
 
+    // userAgent parser
+    implementation 'com.github.ua-parser:uap-java:1.4.4'
+
     implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
     annotationProcessor "com.querydsl:querydsl-apt:5.0.0:jakarta"
     annotationProcessor "jakarta.annotation:jakarta.annotation-api"

src/main/java/in/koreatech/koin/admin/abtest/controller/AbtestApi.java

@@ -0,0 +1,213 @@
+package in.koreatech.koin.admin.abtest.controller;
+
+import static in.koreatech.koin.domain.user.model.UserType.ADMIN;
+import static io.swagger.v3.oas.annotations.enums.ParameterIn.PATH;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+
+import in.koreatech.koin.admin.abtest.dto.AbtestAdminAssignRequest;
+import in.koreatech.koin.admin.abtest.dto.AbtestAssignRequest;
+import in.koreatech.koin.admin.abtest.dto.AbtestAssignResponse;
+import in.koreatech.koin.admin.abtest.dto.AbtestCloseRequest;
+import in.koreatech.koin.admin.abtest.dto.AbtestDevicesResponse;
+import in.koreatech.koin.admin.abtest.dto.AbtestRequest;
+import in.koreatech.koin.admin.abtest.dto.AbtestResponse;
+import in.koreatech.koin.admin.abtest.dto.AbtestUsersResponse;
+import in.koreatech.koin.admin.abtest.dto.AbtestsResponse;
+import in.koreatech.koin.global.auth.Auth;
+import in.koreatech.koin.global.auth.UserId;
+import in.koreatech.koin.global.useragent.UserAgent;
+import in.koreatech.koin.global.useragent.UserAgentInfo;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.validation.Valid;
+
+@RequestMapping("/abtest")
+@Tag(name = "(NORMAL, ADMIN) Abtest : AB테스트", description = "AB테스트를 관리한다.")
+public interface AbtestApi {
+
+    @ApiResponses(
+        value = {
+            @ApiResponse(responseCode = "200"),
+            @ApiResponse(responseCode = "400", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "401", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "403", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "404", content = @Content(schema = @Schema(hidden = true)))
+        }
+    )
+    @Operation(summary = "(ADMIN) 실험 생성")
+    @PostMapping
+    ResponseEntity<AbtestResponse> createAbtest(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @RequestBody @Valid AbtestRequest request
+    );
+
+    @ApiResponses(
+        value = {
+            @ApiResponse(responseCode = "200"),
+            @ApiResponse(responseCode = "400", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "401", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "403", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "404", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "409", content = @Content(schema = @Schema(hidden = true)))
+        }
+    )
+    @Operation(summary = "(ADMIN) 실험 수정")
+    @PutMapping("/{id}")
+    ResponseEntity<AbtestResponse> putAbtest(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @PathVariable("id") Integer abtestId,
+        @RequestBody @Valid AbtestRequest request
+    );
+
+    @ApiResponses(
+        value = {
+            @ApiResponse(responseCode = "204"),
+            @ApiResponse(responseCode = "401", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "403", content = @Content(schema = @Schema(hidden = true))),
+        }
+    )
+    @Operation(summary = "(ADMIN) 실험 삭제")
+    @DeleteMapping("/{id}")
+    ResponseEntity<Void> deleteAbtest(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @PathVariable("id") Integer abtestId
+    );
+
+    @ApiResponses(
+        value = {
+            @ApiResponse(responseCode = "200"),
+            @ApiResponse(responseCode = "401", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "403", content = @Content(schema = @Schema(hidden = true)))
+        }
+    )
+    @Operation(summary = "(ADMIN) 실험 목록 조회")
+    @PostMapping
+    ResponseEntity<AbtestsResponse> getAbtests(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @RequestParam(required = false) Integer page,
+        @RequestParam(required = false) Integer limit
+    );
+
+    @ApiResponses(
+        value = {
+            @ApiResponse(responseCode = "200"),
+            @ApiResponse(responseCode = "401", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "403", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "404", content = @Content(schema = @Schema(hidden = true)))
+        }
+    )
+    @Operation(summary = "(ADMIN) 실험 단건 조회")
+    @PostMapping("/{id}")
+    ResponseEntity<AbtestResponse> getAbtest(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @Parameter(in = PATH) @PathVariable("id") Integer articleId
+    );
+
+    @ApiResponses(
+        value = {
+            @ApiResponse(responseCode = "200"),
+            @ApiResponse(responseCode = "401", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "403", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "404", content = @Content(schema = @Schema(hidden = true))),
+        }
+    )
+    @Operation(summary = "(ADMIN) 실험 종료")
+    @PostMapping("/close/{id}")
+    ResponseEntity<Void> closeAbtest(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @PathVariable("id") Integer abtestId,
+        @RequestBody @Valid AbtestCloseRequest abtestCloseRequest
+    );
+
+    @ApiResponses(
+        value = {
+            @ApiResponse(responseCode = "200"),
+            @ApiResponse(responseCode = "401", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "403", content = @Content(schema = @Schema(hidden = true))),
+        }
+    )
+    @Operation(summary = "(ADMIN) 이름으로 유저 목록 조회")
+    @GetMapping("/user")
+    ResponseEntity<AbtestUsersResponse> getUsersByName(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @RequestParam(value = "name") String userName
+    );
+
+    @ApiResponses(
+        value = {
+            @ApiResponse(responseCode = "200"),
+            @ApiResponse(responseCode = "401", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "403", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "404", content = @Content(schema = @Schema(hidden = true))),
+        }
+    )
+    @Operation(summary = "(ADMIN) 유저 id로 디바이스 목록 조회")
+    @GetMapping("/user/{id}/device")
+    ResponseEntity<AbtestDevicesResponse> getDevicesByUserId(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @PathVariable(value = "id") Integer userId
+    );
+
+    @ApiResponses(
+        value = {
+            @ApiResponse(responseCode = "200"),
+            @ApiResponse(responseCode = "401", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "403", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "404", content = @Content(schema = @Schema(hidden = true))),
+        }
+    )
+    @Operation(summary = "(ADMIN) 실험군 수동 편입")
+    @PostMapping("/{id}/move")
+    ResponseEntity<Void> assignAbtestVariableByAdmin(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @PathVariable(value = "id") Integer abtestId,
+        @RequestBody @Valid AbtestAdminAssignRequest abtestAdminAssignRequest
+    );
+
+    @ApiResponses(
+        value = {
+            @ApiResponse(responseCode = "200"),
+            @ApiResponse(responseCode = "400", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "404", content = @Content(schema = @Schema(hidden = true)))
+        }
+    )
+    @Operation(summary = "(NORMAL) 자신의 실험군 조회")
+    @GetMapping("/me")
+    ResponseEntity<String> getMyAbtestVariable(
+        @RequestHeader("accessHistoryId") Integer accessHistoryId,
+        @UserAgent UserAgentInfo userAgentInfo,
+        @UserId Integer userId,
+        @RequestParam(name = "title") String title
+    );
+
+    @ApiResponses(
+        value = {
+            @ApiResponse(responseCode = "200"),
+            @ApiResponse(responseCode = "400", content = @Content(schema = @Schema(hidden = true))),
+            @ApiResponse(responseCode = "404", content = @Content(schema = @Schema(hidden = true)))
+        }
+    )
+    @Operation(summary = "(NORMAL) 실험군 최초 편입")
+    @PostMapping("/assign")
+    ResponseEntity<AbtestAssignResponse> assignAbtestVariable(
+        @RequestHeader("accessHistoryId") Integer accessHistoryId,
+        @UserAgent UserAgentInfo userAgentInfo,
+        @UserId Integer userId,
+        @RequestBody @Valid AbtestAssignRequest abtestAssignRequest
+    );
+}

src/main/java/in/koreatech/koin/admin/abtest/controller/AbtestController.java

@@ -0,0 +1,149 @@
+package in.koreatech.koin.admin.abtest.controller;
+
+import static in.koreatech.koin.domain.user.model.UserType.ADMIN;
+import static io.swagger.v3.oas.annotations.enums.ParameterIn.PATH;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+import in.koreatech.koin.admin.abtest.dto.AbtestAdminAssignRequest;
+import in.koreatech.koin.admin.abtest.dto.AbtestAssignRequest;
+import in.koreatech.koin.admin.abtest.dto.AbtestAssignResponse;
+import in.koreatech.koin.admin.abtest.dto.AbtestCloseRequest;
+import in.koreatech.koin.admin.abtest.dto.AbtestDevicesResponse;
+import in.koreatech.koin.admin.abtest.dto.AbtestRequest;
+import in.koreatech.koin.admin.abtest.dto.AbtestResponse;
+import in.koreatech.koin.admin.abtest.dto.AbtestUsersResponse;
+import in.koreatech.koin.admin.abtest.dto.AbtestsResponse;
+import in.koreatech.koin.admin.abtest.service.AbtestService;
+import in.koreatech.koin.global.auth.Auth;
+import in.koreatech.koin.global.auth.UserId;
+import in.koreatech.koin.global.useragent.UserAgent;
+import in.koreatech.koin.global.useragent.UserAgentInfo;
+import io.swagger.v3.oas.annotations.Parameter;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/abtest")
+public class AbtestController implements AbtestApi {
+
+    private final AbtestService abtestService;
+
+    @PostMapping
+    public ResponseEntity<AbtestResponse> createAbtest(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @RequestBody @Valid AbtestRequest request
+    ) {
+        AbtestResponse response = abtestService.createAbtest(request);
+        return ResponseEntity.ok(response);
+    }
+
+    @PutMapping("/{id}")
+    public ResponseEntity<AbtestResponse> putAbtest(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @PathVariable("id") Integer abtestId,
+        @RequestBody @Valid AbtestRequest request
+    ) {
+        AbtestResponse response = abtestService.putAbtest(abtestId, request);
+        return ResponseEntity.ok(response);
+    }
+
+    @DeleteMapping("/{id}")
+    public ResponseEntity<Void> deleteAbtest(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @PathVariable("id") Integer abtestId
+    ) {
+        abtestService.deleteAbtest(abtestId);
+        return ResponseEntity.noContent().build();
+    }
+
+    @GetMapping
+    public ResponseEntity<AbtestsResponse> getAbtests(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @RequestParam(required = false) Integer page,
+        @RequestParam(required = false) Integer limit
+    ) {
+        AbtestsResponse response = abtestService.getAbtests(page, limit);
+        return ResponseEntity.ok(response);
+    }
+
+    @GetMapping("/{id}")
+    public ResponseEntity<AbtestResponse> getAbtest(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @Parameter(in = PATH) @PathVariable("id") Integer abtestId
+    ) {
+        AbtestResponse response = abtestService.getAbtest(abtestId);
+        return ResponseEntity.ok(response);
+    }
+
+    @PostMapping("/close/{id}")
+    public ResponseEntity<Void> closeAbtest(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @PathVariable("id") Integer abtestId,
+        @RequestBody @Valid AbtestCloseRequest abtestCloseRequest
+    ) {
+        abtestService.closeAbtest(abtestId, abtestCloseRequest);
+        return ResponseEntity.ok().build();
+    }
+
+    @GetMapping("/user")
+    public ResponseEntity<AbtestUsersResponse> getUsersByName(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @RequestParam(value = "name") String userName
+    ) {
+        AbtestUsersResponse response = abtestService.getUsersByName(userName);
+        return ResponseEntity.ok(response);
+    }
+
+    @GetMapping("/user/{userId}/device")
+    public ResponseEntity<AbtestDevicesResponse> getDevicesByUserId(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @PathVariable(value = "userId") Integer userId
+    ) {
+        AbtestDevicesResponse response = abtestService.getDevicesByUserId(userId);
+        return ResponseEntity.ok(response);
+    }
+
+    @PostMapping("/{id}/move")
+    public ResponseEntity<Void> assignAbtestVariableByAdmin(
+        @Auth(permit = {ADMIN}) Integer adminId,
+        @PathVariable(value = "id") Integer abtestId,
+        @RequestBody @Valid AbtestAdminAssignRequest abtestAdminAssignRequest
+    ) {
+        abtestService.assignVariableByAdmin(abtestId, abtestAdminAssignRequest);
+        return ResponseEntity.ok().build();
+    }
+
+    @GetMapping("/me")
+    public ResponseEntity<String> getMyAbtestVariable(
+        @RequestHeader("access_history_id") Integer accessHistoryId,
+        @UserAgent UserAgentInfo userAgentInfo,
+        @UserId Integer userId,
+        @RequestParam(name = "title") String title
+    ) {
+        String response = abtestService.getMyVariable(accessHistoryId, userAgentInfo, userId, title);
+        return ResponseEntity.ok(response);
+    }
+
+    @PostMapping("/assign")
+    public ResponseEntity<AbtestAssignResponse> assignAbtestVariable(
+        @RequestHeader(value = "access_history_id", required = false) Integer accessHistoryId,
+        @UserAgent UserAgentInfo userAgentInfo,
+        @UserId Integer userId,
+        @RequestBody @Valid AbtestAssignRequest abtestAssignRequest
+    ) {
+        AbtestAssignResponse response = abtestService.assignVariable(accessHistoryId, userAgentInfo, userId, abtestAssignRequest);
+        return ResponseEntity.ok(response);
+    }
+}