Merge branch 'main' into feature/lecture-interface-models

Author: IlijazM

.github/workflows/deploy-docker-image-on-release.yml

@@ -4,8 +4,6 @@ on:
   push:
     branches:
       - "main"
-      - "feature/bugfinder-backend"
-      - "feature/lecture-interface-models"
     tags:
       - "v*"
   pull_request:

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 GamifyIT – A Web-based Gaming Platform for Computer Science Education in the First Semesters
+Copyright (c) 2022 Aaron Schmid, Florian Wüst, Gilian Rehm, Ilijaz Mehmedovic, Jonathan Scholz, Leon Hofmeister, Leon Layer, Levi Otterbach, Martin Lautenschlager, Max Kästner, Michael Linder & Timo Schnaible
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

src/main/java/de/unistuttgart/bugfinder/gameresult/GameResultController.java

@@ -26,7 +26,7 @@ public GameResultDTO saveGameResult(
     jwtValidatorService.validateTokenOrThrow(accessToken);
     final String userId = jwtValidatorService.extractUserId(accessToken);
     log.debug("save game result for userId {}: {}", userId, gameResultDTO);
-    gameResultService.saveGameResult(gameResultDTO, userId);
+    gameResultService.saveGameResult(gameResultDTO, userId, accessToken);
     return gameResultDTO;
   }
 }

src/main/java/de/unistuttgart/bugfinder/gameresult/GameResultService.java

@@ -36,14 +36,25 @@ public class GameResultService {
   @Autowired
   private ResultClient resultClient;
 
-  public void saveGameResult(final GameResultDTO gameResultDTO, final String userId) {
+  /**
+   * Casts a GameResultDTO to GameResult and submits to overworld backend.
+   *
+   * @param gameResultDTO extern gameResultDTO
+   * @param userId id of the user
+   * @param accessToken accessToken of the user
+   * @throws IllegalArgumentException if at least one of the arguments is null
+   */
+  public void saveGameResult(final GameResultDTO gameResultDTO, final String userId, final String accessToken) {
+    if (gameResultDTO == null || userId == null || accessToken == null) {
+      throw new IllegalArgumentException("At least one argument is null");
+    }
     final OverworldResultDTO resultDTO = new OverworldResultDTO(
       gameResultDTO.getConfigurationId(),
       calculateScore(gameResultDTO),
       userId
     );
     try {
-      resultClient.submit(resultDTO);
+      resultClient.submit(accessToken, resultDTO);
     } catch (final FeignException.BadGateway badGateway) {
       final String warning =
         "The Overworld backend is currently not available. The result was NOT saved. Please try again later.";

src/main/java/de/unistuttgart/bugfinder/gameresult/ResultClient.java

@@ -1,10 +1,17 @@
 package de.unistuttgart.bugfinder.gameresult;
 
 import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.CookieValue;
 import org.springframework.web.bind.annotation.PostMapping;
 
 @FeignClient(value = "resultClient", url = "${overworld.url}/internal")
 public interface ResultClient {
+  /**
+   * Submits the resultDTO to the Overworld-Backend
+   *
+   * @param accessToken the users access token
+   * @param resultDTO the player submitted result, trimmed down to the data needed for the overworld
+   */
   @PostMapping("/submit-game-pass")
-  void submit(OverworldResultDTO resultDTO);
+  void submit(@CookieValue("access_token") final String accessToken, final OverworldResultDTO resultDTO);
 }