Refactor endpoint and DTO to only transmit Theia Config

ls1intum · Feb 18, 2025 · 69a685f · 69a685f
1 parent 2df48e6
commit 69a685f
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 22 deletions.
diff --git a/...to/ProgrammingExerciseBuildConfigDTO.java → ...to/ProgrammingExerciseTheiaConfigDTO.java b/...to/ProgrammingExerciseBuildConfigDTO.java → ...to/ProgrammingExerciseTheiaConfigDTO.java
@@ -3,5 +3,5 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
-public record ProgrammingExerciseBuildConfigDTO(String theiaImage) {
+public record ProgrammingExerciseTheiaConfigDTO(String theiaImage) {
 }
diff --git a/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseResource.java b/src/main/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseResource.java
@@ -76,9 +76,9 @@
 import de.tum.cit.aet.artemis.programming.domain.ProgrammingLanguage;
 import de.tum.cit.aet.artemis.programming.dto.BuildLogStatisticsDTO;
 import de.tum.cit.aet.artemis.programming.dto.CheckoutDirectoriesDTO;
-import de.tum.cit.aet.artemis.programming.dto.ProgrammingExerciseBuildConfigDTO;
 import de.tum.cit.aet.artemis.programming.dto.ProgrammingExerciseResetOptionsDTO;
 import de.tum.cit.aet.artemis.programming.dto.ProgrammingExerciseTestCaseStateDTO;
+import de.tum.cit.aet.artemis.programming.dto.ProgrammingExerciseTheiaConfigDTO;
 import de.tum.cit.aet.artemis.programming.repository.BuildLogStatisticsEntryRepository;
 import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseBuildConfigRepository;
 import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseRepository;
@@ -500,18 +500,18 @@ public ResponseEntity<ProgrammingExercise> getProgrammingExercise(@PathVariable
     }
 
     /**
-     * GET /programming-exercises/:exerciseId/build-config : get the build config of "exerciseId" programmingExercise.
+     * GET /programming-exercises/:exerciseId/theia-config : get the theia config for the programmingExercise.
      *
-     * @param exerciseId the id of the programmingExercise to retrieve the config for
-     * @return the ResponseEntity with status 200 (OK) and with body the programmingExerciseBuildConfig, or with status 404 (Not Found)
+     * @param exerciseId the id of the programmingExercise to retrieve the configuration for
+     * @return the ResponseEntity with status 200 (OK) and with body the TheiaConfigDTO, or with status 404 (Not Found)
      */
-    @GetMapping("programming-exercises/{exerciseId}/build-config")
+    @GetMapping("programming-exercises/{exerciseId}/theia-config")
     @EnforceAtLeastStudentInExercise
-    public ResponseEntity<ProgrammingExerciseBuildConfigDTO> getBuildConfig(@PathVariable long exerciseId) {
-        log.debug("REST request to get build config of ProgrammingExercise : {}", exerciseId);
-        var buildConfig = new ProgrammingExerciseBuildConfigDTO(programmingExerciseBuildConfigRepository.getTheiaImageByProgrammingExerciseId(exerciseId));
+    public ResponseEntity<ProgrammingExerciseTheiaConfigDTO> getBuildConfig(@PathVariable long exerciseId) {
+        log.debug("REST request to get theia image of ProgrammingExercise : {}", exerciseId);
+        var imageDTO = new ProgrammingExerciseTheiaConfigDTO(programmingExerciseBuildConfigRepository.getTheiaImageByProgrammingExerciseId(exerciseId));
 
-        return ResponseEntity.ok().body(buildConfig);
+        return ResponseEntity.ok().body(imageDTO);
     }
 
     /**

diff --git a/src/main/webapp/app/entities/programming/programming-exercise-theia.config.ts b/src/main/webapp/app/entities/programming/programming-exercise-theia.config.ts
@@ -0,0 +1,3 @@
+export class ProgrammingExerciseTheiaConfig {
+    public theiaImage?: string;
+}
diff --git a/src/main/webapp/app/exercises/programming/manage/services/programming-exercise.service.ts b/src/main/webapp/app/exercises/programming/manage/services/programming-exercise.service.ts
@@ -22,8 +22,8 @@ import { Participation } from 'app/entities/participation/participation.model';
 import { PlagiarismResultDTO } from 'app/exercises/shared/plagiarism/types/PlagiarismResultDTO';
 import { ImportOptions } from 'app/types/programming-exercises';
 import { CheckoutDirectoriesDto } from 'app/entities/programming/checkout-directories-dto';
-import { ProgrammingExerciseBuildConfig } from 'app/entities/programming/programming-exercise-build.config';
 import { RepositoryType } from 'app/exercises/programming/shared/code-editor/model/code-editor.model';
+import { ProgrammingExerciseTheiaConfig } from 'app/entities/programming/programming-exercise-theia.config';
 
 export type EntityResponseType = HttpResponse<ProgrammingExercise>;
 export type EntityArrayResponseType = HttpResponse<ProgrammingExercise[]>;
@@ -619,8 +619,8 @@ export class ProgrammingExerciseService {
         return this.http.get<BuildLogStatisticsDTO>(`${this.resourceUrl}/${exerciseId}/build-log-statistics`);
     }
 
-    getBuildConfig(exerciseId: number): Observable<ProgrammingExerciseBuildConfig> {
-        return this.http.get<ProgrammingExerciseBuildConfig>(`${this.resourceUrl}/${exerciseId}/build-config`);
+    getTheiaConfig(exerciseId: number): Observable<ProgrammingExerciseTheiaConfig> {
+        return this.http.get<ProgrammingExerciseTheiaConfig>(`${this.resourceUrl}/${exerciseId}/theia-config`);
     }
 
     /** Imports a programming exercise from a given zip file **/

diff --git a/src/main/webapp/app/shared/components/code-button/code-button.component.ts b/src/main/webapp/app/shared/components/code-button/code-button.component.ts
@@ -446,9 +446,10 @@ export class CodeButtonComponent implements OnInit {
         if (profileInfo.activeProfiles?.includes(PROFILE_THEIA) && this.exercise()) {
             // Theia requires the Build Config of the programming exercise to be set
             // @ts-expect-error (The exercise is not undefined here)
-            this.programmingExerciseSerice.getBuildConfig(this.exercise().id!).subscribe((buildConfig) => {
+            this.programmingExerciseSerice.getTheiaConfig(this.exercise().id!).subscribe((theiaConfig) => {
+                // Merge the theiaConfig (containing the theiaImage) into the buildConfig
                 // @ts-expect-error (The exercise is not undefined here)
-                this.exercise().buildConfig = buildConfig;
+                this.exercise().buildConfig = { ...this.exercise()?.buildConfig, ...theiaConfig };
 
                 // Set variables now, sanitize later on
                 this.theiaPortalURL = profileInfo.theiaPortalURL ?? '';

diff --git a/src/test/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseResourceTest.java b/src/test/java/de/tum/cit/aet/artemis/programming/web/ProgrammingExerciseResourceTest.java
@@ -17,7 +17,7 @@
 import de.tum.cit.aet.artemis.core.util.RequestUtilService;
 import de.tum.cit.aet.artemis.exercise.participation.util.ParticipationUtilService;
 import de.tum.cit.aet.artemis.programming.domain.ProgrammingExercise;
-import de.tum.cit.aet.artemis.programming.dto.ProgrammingExerciseBuildConfigDTO;
+import de.tum.cit.aet.artemis.programming.dto.ProgrammingExerciseTheiaConfigDTO;
 import de.tum.cit.aet.artemis.programming.repository.ProgrammingExerciseBuildConfigRepository;
 import de.tum.cit.aet.artemis.programming.util.ProgrammingExerciseUtilService;
 import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationIndependentTest;
@@ -71,10 +71,10 @@ void setup() {
     @Test
     @WithMockUser(username = TEST_PREFIX + "student1", roles = { "USER", "STUDENT" })
     void testBuildConfigOnlyReturnsRestrictedSetOfInformation() throws Exception {
-        ProgrammingExerciseBuildConfigDTO buildConfig = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/build-config", HttpStatus.OK,
-                ProgrammingExerciseBuildConfigDTO.class);
+        ProgrammingExerciseTheiaConfigDTO imageDTO = request.get("/api/programming-exercises/" + programmingExercise.getId() + "/theia-config", HttpStatus.OK,
+                ProgrammingExerciseTheiaConfigDTO.class);
 
         // Count the number of fields in the record, this makes sure that only the expected fields are returned
-        assertThat(buildConfig.getClass().getDeclaredFields().length).isEqualTo(1);
+        assertThat(imageDTO.getClass().getDeclaredFields().length).isEqualTo(1);
     }
 }
diff --git a/src/test/javascript/spec/component/shared/code-button.component.spec.ts b/src/test/javascript/spec/component/shared/code-button.component.spec.ts
@@ -21,6 +21,7 @@ import { ExerciseActionButtonComponent } from '../../../../../main/webapp/app/sh
 import { ProgrammingExerciseService } from 'app/exercises/programming/manage/services/programming-exercise.service';
 import { ProgrammingExerciseBuildConfig } from 'app/entities/programming/programming-exercise-build.config';
 import { PROFILE_THEIA } from 'app/app.constants';
+import { ProgrammingExerciseTheiaConfig } from 'app/entities/programming/programming-exercise-theia.config';
 
 describe('CodeButtonComponent', () => {
     let component: CodeButtonComponent;
@@ -455,12 +456,12 @@ describe('CodeButtonComponent', () => {
             },
             false,
         ],
-    ])('%s', async (description, profileInfo, programmingExercise, buildConfig, expectedVisibility) => {
+    ])('%s', async (description, profileInfo, programmingExercise, theiaConfig, expectedVisibility) => {
         const getProfileInfoStub = jest.spyOn(profileService, 'getProfileInfo');
         getProfileInfoStub.mockReturnValue(of(profileInfo as ProfileInfo));
 
-        const getBuildconfigStub = jest.spyOn(programmingExerciseService, 'getBuildConfig');
-        getBuildconfigStub.mockReturnValue(of(buildConfig as ProgrammingExerciseBuildConfig));
+        const getTheiaConfigStub = jest.spyOn(programmingExerciseService, 'getTheiaConfig');
+        getTheiaConfigStub.mockReturnValue(of(theiaConfig as ProgrammingExerciseTheiaConfig));
 
         // Expand the programmingExercise by given properties
         fixture.componentRef.setInput('exercise', {