Add first GitHub entities and automatically fetch them for the leaderboard

.gitignore

@@ -162,4 +162,6 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-node_modules/
+node_modules/
+
+application-local.yml

server/application-server/HELP.md

@@ -1,38 +1,53 @@
 # Getting Started
 
+### Local development
+
+The Spring Boot Maven Plugin supports running your application with a local development environment. To do this, you can use the `spring-boot:run` goal:
+
+```shell
+mvn spring-boot:run
+```
+
+This will start your application in a local development environment. You can access the application at `http://localhost:8080`.
+
+Setting environment variables works through profile-based `application.yml` files. For local development, create a `application-local.yml` file overwriting the original properties. See [Using the Plugin :: Spring Boot](https://docs.spring.io/spring-boot/maven-plugin/using.html#using.overriding-command-line) for more information.
+
 ### Reference Documentation
+
 For further reference, please consider the following sections:
 
-* [Official Apache Maven documentation](https://maven.apache.org/guides/index.html)
-* [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/3.3.2/maven-plugin/reference/html/)
-* [Create an OCI image](https://docs.spring.io/spring-boot/docs/3.3.2/maven-plugin/reference/html/#build-image)
-* [Docker Compose Support](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#features.docker-compose)
-* [Spring Boot DevTools](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#using.devtools)
-* [Spring Web](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#web)
-* [Spring Security](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#web.security)
-* [Spring Data JPA](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#data.sql.jpa-and-spring-data)
-* [Spring Boot Actuator](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#actuator)
-* [Liquibase Migration](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#howto.data-initialization.migration-tool.liquibase)
-* [OAuth2 Client](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#web.security.oauth2.client)
-* [OAuth2 Resource Server](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#web.security.oauth2.server)
+-   [Official Apache Maven documentation](https://maven.apache.org/guides/index.html)
+-   [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/3.3.2/maven-plugin/reference/html/)
+-   [Create an OCI image](https://docs.spring.io/spring-boot/docs/3.3.2/maven-plugin/reference/html/#build-image)
+-   [Docker Compose Support](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#features.docker-compose)
+-   [Spring Boot DevTools](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#using.devtools)
+-   [Spring Web](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#web)
+-   [Spring Security](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#web.security)
+-   [Spring Data JPA](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#data.sql.jpa-and-spring-data)
+-   [Spring Boot Actuator](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#actuator)
+-   [Liquibase Migration](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#howto.data-initialization.migration-tool.liquibase)
+-   [OAuth2 Client](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#web.security.oauth2.client)
+-   [OAuth2 Resource Server](https://docs.spring.io/spring-boot/docs/3.3.2/reference/htmlsingle/index.html#web.security.oauth2.server)
 
 ### Guides
+
 The following guides illustrate how to use some features concretely:
 
-* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/)
-* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/)
-* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/)
-* [Securing a Web Application](https://spring.io/guides/gs/securing-web/)
-* [Spring Boot and OAuth2](https://spring.io/guides/tutorials/spring-boot-oauth2/)
-* [Authenticating a User with LDAP](https://spring.io/guides/gs/authenticating-ldap/)
-* [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/)
-* [Building a RESTful Web Service with Spring Boot Actuator](https://spring.io/guides/gs/actuator-service/)
+-   [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/)
+-   [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/)
+-   [Building REST services with Spring](https://spring.io/guides/tutorials/rest/)
+-   [Securing a Web Application](https://spring.io/guides/gs/securing-web/)
+-   [Spring Boot and OAuth2](https://spring.io/guides/tutorials/spring-boot-oauth2/)
+-   [Authenticating a User with LDAP](https://spring.io/guides/gs/authenticating-ldap/)
+-   [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/)
+-   [Building a RESTful Web Service with Spring Boot Actuator](https://spring.io/guides/gs/actuator-service/)
 
 ### Docker Compose support
+
 This project contains a Docker Compose file named `compose.yaml`.
 In this file, the following services have been defined:
 
-* postgres: [`postgres:latest`](https://hub.docker.com/_/postgres)
+-   postgres: [`postgres:latest`](https://hub.docker.com/_/postgres)
 
 Please review the tags of the used images and set them to the same as you're running in production.
 
@@ -42,4 +57,3 @@ Due to Maven's design, elements are inherited from the parent POM to the project
 While most of the inheritance is fine, it also inherits unwanted elements like `<license>` and `<developers>` from the parent.
 To prevent this, the project POM contains empty overrides for these elements.
 If you manually switch to a different parent and actually want the inheritance, you need to remove those overrides.
-

server/application-server/pom.xml

@@ -29,6 +29,7 @@
 	</scm>
 	<properties>
 		<java.version>21</java.version>
+		<app.profiles>local,dev</app.profiles>
 	</properties>
 	<dependencies>
 		<dependency>
@@ -120,6 +121,12 @@
 			<artifactId>spring-modulith-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.kohsuke</groupId>
+			<artifactId>github-api</artifactId>
+			<version>1.324</version>
+		</dependency>
+
 	</dependencies>
 
 	<dependencyManagement>
@@ -158,6 +165,7 @@
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-maven-plugin</artifactId>
 				<configuration>
+					<profiles>${app.profiles}</profiles>
 					<jvmArguments>-Dspring.application.admin.enabled=true</jvmArguments>
 					<excludes>
 						<exclude>

server/application-server/src/main/java/de/tum/in/www1/hephaestus/Application.java

@@ -1,15 +1,29 @@
 package de.tum.in.www1.hephaestus;
 
+import org.springframework.boot.CommandLineRunner;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
 import org.springframework.modulith.Modulithic;
 
+import de.tum.in.www1.hephaestus.codereview.CodeReviewService;
+import de.tum.in.www1.hephaestus.codereview.repository.Repository;
+
 @SpringBootApplication
 @Modulithic(systemName = "Hephaestus")
+@EnableConfigurationProperties(EnvConfig.class)
 public class Application {
 
 	public static void main(String[] args) {
 		SpringApplication.run(Application.class, args);
 	}
 
+	@Bean
+	CommandLineRunner commandLineRunner(CodeReviewService service) {
+		return args -> {
+			Repository repo = service.fetchRepository("ls1intum/hephaestus");
+			System.out.println("Got repo: " + repo);
+		};
+	}
 }

server/application-server/src/main/java/de/tum/in/www1/hephaestus/EnvConfig.java

@@ -0,0 +1,17 @@
+package de.tum.in.www1.hephaestus;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+@ConfigurationProperties(prefix = "environment")
+public class EnvConfig {
+
+    private String githubPat;
+
+    public EnvConfig(String githubPat) {
+        this.githubPat = githubPat;
+    }
+
+    public String getGithubPat() {
+        return githubPat;
+    }
+}

server/application-server/src/main/java/de/tum/in/www1/hephaestus/SecurityConfig.java

@@ -1,6 +1,5 @@
 package de.tum.in.www1.hephaestus;
 
-import java.util.Arrays;
 import java.util.List;
 
 import org.springframework.context.annotation.Bean;
@@ -20,14 +19,13 @@ public class SecurityConfig {
     @Bean
     public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
         http
-		    .csrf(csrf -> csrf.disable())
-            .cors(cors -> cors.configurationSource(corsConfigurationSource()))
-            .authorizeHttpRequests(authorizeRequests -> authorizeRequests
-                .requestMatchers("/admin/**").authenticated()
-                .anyRequest().permitAll()
-            )
-            .formLogin(Customizer.withDefaults())
-            .logout(Customizer.withDefaults());
+                .csrf(csrf -> csrf.disable())
+                .cors(cors -> cors.configurationSource(corsConfigurationSource()))
+                .authorizeHttpRequests(authorizeRequests -> authorizeRequests
+                        .requestMatchers("/admin/**").authenticated()
+                        .anyRequest().permitAll())
+                .formLogin(Customizer.withDefaults())
+                .logout(Customizer.withDefaults());
 
         return http.build();
     }
@@ -38,7 +36,7 @@ CorsConfigurationSource corsConfigurationSource() {
         configuration.applyPermitDefaultValues();
         configuration.setAllowedMethods(List.of("GET", "POST", "PUT", "DELETE", "OPTIONS", "HEAD"));
         UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
-        source.registerCorsConfiguration("/**",configuration);
+        source.registerCorsConfiguration("/**", configuration);
         return source;
     }
 }

server/application-server/src/main/java/de/tum/in/www1/hephaestus/codereview/CodeReviewController.java

@@ -0,0 +1,30 @@
+package de.tum.in.www1.hephaestus.codereview;
+
+import java.io.IOException;
+
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import de.tum.in.www1.hephaestus.codereview.repository.Repository;
+
+@RestController
+@RequestMapping("/codereview")
+public class CodeReviewController {
+    private final CodeReviewService codeReviewService;
+
+    public CodeReviewController(CodeReviewService codeReviewService) {
+        this.codeReviewService = codeReviewService;
+    }
+
+    @PutMapping("/repository/{nameWithOwner}")
+    public Repository addRepository(@PathVariable String nameWithOwner) {
+        try {
+            return codeReviewService.fetchRepository(nameWithOwner);
+        } catch (IOException e) {
+            e.printStackTrace();
+            return null;
+        }
+    }
+}

server/application-server/src/main/java/de/tum/in/www1/hephaestus/codereview/CodeReviewService.java

@@ -0,0 +1,157 @@
+package de.tum.in.www1.hephaestus.codereview;
+
+import java.io.IOException;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import org.kohsuke.github.GHPullRequest;
+import org.kohsuke.github.GHRepository;
+import org.kohsuke.github.GitHub;
+import org.kohsuke.github.GitHubBuilder;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Service;
+
+import de.tum.in.www1.hephaestus.EnvConfig;
+import de.tum.in.www1.hephaestus.codereview.comment.IssueComment;
+import de.tum.in.www1.hephaestus.codereview.comment.IssueCommentConverter;
+import de.tum.in.www1.hephaestus.codereview.comment.IssueCommentRepository;
+import de.tum.in.www1.hephaestus.codereview.pullrequest.PullRequest;
+import de.tum.in.www1.hephaestus.codereview.pullrequest.PullRequestConverter;
+import de.tum.in.www1.hephaestus.codereview.pullrequest.PullRequestRepository;
+import de.tum.in.www1.hephaestus.codereview.repository.Repository;
+import de.tum.in.www1.hephaestus.codereview.repository.RepositoryConverter;
+import de.tum.in.www1.hephaestus.codereview.repository.RepositoryRepository;
+import de.tum.in.www1.hephaestus.codereview.user.User;
+import de.tum.in.www1.hephaestus.codereview.user.UserConverter;
+import de.tum.in.www1.hephaestus.codereview.user.UserRepository;
+
+@Service
+public class CodeReviewService {
+
+        private static final Logger logger = LoggerFactory.getLogger(CodeReviewService.class);
+
+        private GitHub github;
+
+        private final RepositoryRepository repositoryRepository;
+        private final PullRequestRepository pullrequestRepository;
+        private final IssueCommentRepository commentRepository;
+        private final UserRepository userRepository;
+
+        public CodeReviewService(EnvConfig envConfig, RepositoryRepository repositoryRepository,
+                        PullRequestRepository pullrequestRepository, IssueCommentRepository commentRepository,
+                        UserRepository actorRepository) {
+                logger.info("Hello from CodeReviewService!");
+
+                this.repositoryRepository = repositoryRepository;
+                this.pullrequestRepository = pullrequestRepository;
+                this.commentRepository = commentRepository;
+                this.userRepository = actorRepository;
+
+                try {
+                        github = new GitHubBuilder().withOAuthToken(envConfig.getGithubPat()).build();
+                } catch (IOException e) {
+                        logger.error("Error while creating GitHub client: " + e.getMessage());
+                        return;
+                }
+        }
+
+        /**
+         * Rest API implementation of fetching a Github repository.
+         * 
+         * @return The repository corresponding to the given nameWithOwner.
+         * @throws IOException
+         */
+        public Repository fetchRepository(String nameWithOwner) throws IOException {
+                if (github == null) {
+                        logger.error("GitHub client not initialized correctly!");
+                        return null;
+                }
+
+                // Avoid double fetching of the same repository
+                Repository existingRepository = repositoryRepository.findByNameWithOwner(nameWithOwner);
+                if (existingRepository != null) {
+                        logger.info("Found existing repository: " + existingRepository);
+                        return existingRepository;
+                }
+
+                GHRepository ghRepo = github.getRepository(nameWithOwner);
+                Repository repository = new RepositoryConverter().convert(ghRepo);
+                if (repository == null) {
+                        logger.error("Error while fetching repository!");
+                        return null;
+                }
+                // preliminary save to make it referenceable
+                repositoryRepository.save(repository);
+
+                PullRequestConverter prConverter = new PullRequestConverter();
+
+                // Retrieve PRs in pages of 10
+                Set<PullRequest> prs = ghRepo.queryPullRequests().list().withPageSize(10).toList().stream().map(pr -> {
+                        PullRequest pullrequest = prConverter.convert(pr);
+                        pullrequest.setRepository(repository);
+                        pullrequestRepository.save(pullrequest);
+                        try {
+                                Set<IssueComment> comments = getCommentsFromGHPullRequest(pr, pullrequest);
+                                pullrequest.setComments(comments);
+                                commentRepository.saveAll(comments);
+                        } catch (IOException e) {
+                                logger.error("Error while fetching PR comments!");
+                                pullrequest.setComments(new HashSet<>());
+                        }
+                        try {
+                                pullrequest.setAuthor(getActorFromGHUser(pr.getUser()));
+                        } catch (IOException e) {
+                                logger.error("Error while fetching PR author!");
+                                pullrequest.setAuthor(null);
+                        }
+
+                        return pullrequest;
+                }).collect(Collectors.toSet());
+                repository.setPullRequests(prs);
+                pullrequestRepository.saveAll(prs);
+                repositoryRepository.save(repository);
+                return repository;
+        }
+
+        /**
+         * Retrieves the comments of a given pull request.
+         * 
+         * @param pr          The GH pull request.
+         * @param pullrequest Stored PR to which the comments belong.
+         * @return The comments of the given pull request.
+         * @throws IOException
+         */
+        private Set<IssueComment> getCommentsFromGHPullRequest(GHPullRequest pr, PullRequest pullrequest)
+                        throws IOException {
+                IssueCommentConverter commentConverter = new IssueCommentConverter();
+                Set<IssueComment> comments = pr.queryComments().list().toList().stream()
+                                .map(comment -> {
+                                        IssueComment c = commentConverter.convert(comment);
+                                        c.setPullrequest(pullrequest);
+                                        User author;
+                                        try {
+                                                author = getActorFromGHUser(comment.getUser());
+                                                author.addComment(c);
+                                                author.addPullrequest(pullrequest);
+                                        } catch (IOException e) {
+                                                logger.error("Error while fetching author!");
+                                                author = null;
+                                        }
+                                        c.setAuthor(author);
+                                        return c;
+                                }).collect(Collectors.toSet());
+                return comments;
+        }
+
+        private User getActorFromGHUser(org.kohsuke.github.GHUser user) {
+                User ghUser = userRepository.findUser(user.getLogin()).orElse(null);
+                if (ghUser == null) {
+                        ghUser = new UserConverter().convert(user);
+                        userRepository.save(ghUser);
+                }
+                return ghUser;
+
+        }
+}