feat(application-server): add GitHub team synchronization (#342)

Co-authored-by: Dmytro Dmukh <[email protected]>
Co-authored-by: Felix T.J. Dietrich <[email protected]>

Author: 3 people

docs/dev/database/schema.mmd

@@ -228,6 +228,31 @@ erDiagram
         BIGINT repository_id PK,FK
     }
 
+    TeamV2 {
+        BIGINT id PK
+        TIMESTAMPTZ created_at
+        TIMESTAMPTZ updated_at
+        TEXT description
+        TEXT html_url
+        TIMESTAMPTZ last_synced_at
+        VARCHAR(255) name
+        VARCHAR(255) organization
+        BIGINT parent_id
+        VARCHAR(32) privacy
+    }
+
+    TeamV2Membership {
+        VARCHAR(32) role
+        BIGINT user_id PK,FK
+        BIGINT team_id PK,FK
+    }
+
+    TeamV2RepositoryPermission {
+        VARCHAR(32) permission "NOT NULL"
+        BIGINT repository_id PK,FK
+        BIGINT team_id PK,FK
+    }
+
     User {
         BIGINT id PK
         TIMESTAMPTZ created_at
@@ -290,6 +315,10 @@ erDiagram
     User }o--o{ TeamMember : belongs_to
     Repository }o--o{ TeamRepository : has
     Team }o--o{ TeamRepository : has
+    TeamV2 }o--o{ TeamV2Membership : belongs_to
+    User }o--o{ TeamV2Membership : belongs_to
+    Repository }o--o{ TeamV2RepositoryPermission : has
+    TeamV2 }o--o{ TeamV2RepositoryPermission : has
 
     %% Styling
     classDef primaryEntity fill:#e1f5fe,stroke:#01579b,stroke-width:2px

server/application-server/src/main/java/de/tum/in/www1/hephaestus/gitprovider/common/github/GitHubMessageHandler.java

@@ -57,4 +57,8 @@ public void onMessage(Message msg) {
      * @return The GHEvent.
      */
     protected abstract GHEvent getHandlerEvent();
+
+    protected boolean isOrganizationEvent() {
+        return false;
+    }
 }

server/application-server/src/main/java/de/tum/in/www1/hephaestus/gitprovider/common/github/GitHubMessageHandlerRegistry.java

@@ -10,19 +10,28 @@
 @Component
 public class GitHubMessageHandlerRegistry {
 
-    private final Map<GHEvent, GitHubMessageHandler<?>> handlerMap = new HashMap<>();
+    private final Map<GHEvent, GitHubMessageHandler<?>> repositoryHandlerMap = new HashMap<>();
+    private final Map<GHEvent, GitHubMessageHandler<?>> organizationHandlerMap = new HashMap<>();
 
     public GitHubMessageHandlerRegistry(GitHubMessageHandler<?>[] handlers) {
         for (GitHubMessageHandler<?> handler : handlers) {
-            handlerMap.put(handler.getHandlerEvent(), handler);
+            if (handler.isOrganizationEvent()) {
+                organizationHandlerMap.put(handler.getHandlerEvent(), handler);
+            } else {
+                repositoryHandlerMap.put(handler.getHandlerEvent(), handler);
+            }
         }
     }
 
     public GitHubMessageHandler<?> getHandler(GHEvent eventType) {
-        return handlerMap.get(eventType);
+        return repositoryHandlerMap.getOrDefault(eventType, organizationHandlerMap.get(eventType));
     }
 
-    public List<GHEvent> getSupportedEvents() {
-        return new ArrayList<>(handlerMap.keySet());
+    public List<GHEvent> getSupportedRepositoryEvents() {
+        return new ArrayList<>(repositoryHandlerMap.keySet());
+    }
+
+    public List<GHEvent> getSupportedOrganizationEvents() {
+        return new ArrayList<>(organizationHandlerMap.keySet());
     }
 }

server/application-server/src/main/java/de/tum/in/www1/hephaestus/gitprovider/repository/Repository.java

@@ -5,10 +5,13 @@
 import de.tum.in.www1.hephaestus.gitprovider.label.Label;
 import de.tum.in.www1.hephaestus.gitprovider.milestone.Milestone;
 import de.tum.in.www1.hephaestus.gitprovider.team.Team;
+import de.tum.in.www1.hephaestus.gitprovider.teamV2.TeamV2;
 import jakarta.persistence.CascadeType;
 import jakarta.persistence.Entity;
 import jakarta.persistence.EnumType;
 import jakarta.persistence.Enumerated;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.JoinTable;
 import jakarta.persistence.ManyToMany;
 import jakarta.persistence.OneToMany;
 import jakarta.persistence.Table;
@@ -86,6 +89,15 @@ public class Repository extends BaseGitServiceEntity {
     @ToString.Exclude
     private Set<Team> teams = new HashSet<>();
 
+    @ManyToMany
+    @JoinTable(
+        name = "team_v2_repository_permission",
+        joinColumns = @JoinColumn(name = "repository_id"),
+        inverseJoinColumns = @JoinColumn(name = "team_id")
+    )
+    @ToString.Exclude
+    private Set<TeamV2> teamsV2 = new HashSet<>();
+
     public enum Visibility {
         PUBLIC,
         PRIVATE,

server/application-server/src/main/java/de/tum/in/www1/hephaestus/gitprovider/team/TeamService.java

@@ -25,8 +25,7 @@ public class TeamService {
     private LabelRepository labelRepository;
 
     public List<TeamInfoDTO> getAllTeams() {
-        List<TeamInfoDTO> teams = teamRepository.findAll().stream().map(TeamInfoDTO::fromTeam).toList();
-        return teams;
+        return teamRepository.findAll().stream().map(TeamInfoDTO::fromTeam).toList();
     }
 
     public TeamInfoDTO hideTeam(Long id, Boolean hidden) {

server/application-server/src/main/java/de/tum/in/www1/hephaestus/gitprovider/teamV2/TeamV2.java

@@ -0,0 +1,86 @@
+package de.tum.in.www1.hephaestus.gitprovider.teamV2;
+
+import de.tum.in.www1.hephaestus.gitprovider.common.BaseGitServiceEntity;
+import de.tum.in.www1.hephaestus.gitprovider.teamV2.membership.TeamMembership;
+import de.tum.in.www1.hephaestus.gitprovider.teamV2.permission.TeamRepositoryPermission;
+import jakarta.persistence.*;
+import java.time.OffsetDateTime;
+import java.util.HashSet;
+import java.util.Set;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.ToString;
+
+@Entity
+@Table(name = "team_v2")
+@Getter
+@Setter
+@NoArgsConstructor
+@ToString(callSuper = true)
+public class TeamV2 extends BaseGitServiceEntity {
+
+    private String name;
+
+    @Column(columnDefinition = "TEXT")
+    private String description;
+
+    @Column(length = 32)
+    @Enumerated(EnumType.STRING)
+    private Privacy privacy;
+
+    private String organization;
+
+    @Column(columnDefinition = "TEXT")
+    private String htmlUrl;
+
+    private Long parentId;
+
+    private OffsetDateTime lastSyncedAt;
+
+    @OneToMany(mappedBy = "team", cascade = CascadeType.ALL, orphanRemoval = true)
+    @ToString.Exclude
+    private Set<TeamRepositoryPermission> repoPermissions = new HashSet<>();
+
+    @OneToMany(mappedBy = "team", cascade = CascadeType.ALL, orphanRemoval = true)
+    @ToString.Exclude
+    private Set<TeamMembership> memberships = new HashSet<>();
+
+    public void addMembership(TeamMembership membership) {
+        memberships.add(membership);
+        membership.setTeam(this);
+    }
+
+    public void removeMembership(TeamMembership membership) {
+        memberships.remove(membership);
+        membership.setTeam(null);
+    }
+
+    public void addRepoPermission(TeamRepositoryPermission permission) {
+        repoPermissions.add(permission);
+        permission.setTeam(this);
+    }
+
+    public void clearAndAddRepoPermissions(Set<TeamRepositoryPermission> fresh) {
+        repoPermissions.clear();
+        fresh.forEach(this::addRepoPermission);
+    }
+
+    public enum Privacy {
+        /** Only organization members can view or request access. */
+        SECRET,
+        /** Visible to all members of the organization. */
+        CLOSED,
+    }
+    // Ignored GitHub properties:
+    // - nodeId
+    // - slug
+    // - apiUrl               (API URL for this team)
+    // - members_url       (templated URL for member listing)
+    // - repositories_url  (templated URL for repos listing)
+    // - parent            (if this team has a parent team)
+    // - permissions       (maps to our repoPermissions, but scoped to the OAuth user)
+    // - members_count     (cached count; we page through listMembers())
+    // - repos_count       (cached count; we page through listRepositories())
+    // - privacy_level     (older name for privacy)
+}

server/application-server/src/main/java/de/tum/in/www1/hephaestus/gitprovider/teamV2/TeamV2Controller.java

@@ -0,0 +1,35 @@
+package de.tum.in.www1.hephaestus.gitprovider.teamV2;
+
+import java.util.List;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/teamsV2")
+public class TeamV2Controller {
+
+    private final TeamV2Repository teamRepo;
+    private final TeamV2InfoDTOConverter converter;
+
+    public TeamV2Controller(TeamV2Repository teamRepo, TeamV2InfoDTOConverter converter) {
+        this.teamRepo = teamRepo;
+        this.converter = converter;
+    }
+
+    @GetMapping
+    public ResponseEntity<List<TeamV2InfoDTO>> getAll() {
+        return ResponseEntity.ok(teamRepo.findAll().stream().map(converter::convert).toList());
+    }
+
+    @GetMapping("/{id}")
+    public ResponseEntity<TeamV2InfoDTO> getById(@PathVariable Long id) {
+        return teamRepo
+            .findById(id)
+            .map(converter::convert)
+            .map(ResponseEntity::ok)
+            .orElse(ResponseEntity.notFound().build());
+    }
+}

server/application-server/src/main/java/de/tum/in/www1/hephaestus/gitprovider/teamV2/TeamV2InfoDTO.java

@@ -0,0 +1,20 @@
+package de.tum.in.www1.hephaestus.gitprovider.teamV2;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import de.tum.in.www1.hephaestus.gitprovider.teamV2.TeamV2.Privacy;
+import java.time.OffsetDateTime;
+import org.springframework.lang.NonNull;
+
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public record TeamV2InfoDTO(
+    @NonNull Long id,
+    @NonNull String name,
+    Long parentId,
+    String description,
+    Privacy privacy,
+    String organization,
+    String htmlUrl,
+    OffsetDateTime lastSyncedAt,
+    int membershipCount,
+    int repoPermissionCount
+) {}

server/application-server/src/main/java/de/tum/in/www1/hephaestus/gitprovider/teamV2/TeamV2InfoDTOConverter.java

@@ -0,0 +1,25 @@
+package de.tum.in.www1.hephaestus.gitprovider.teamV2;
+
+import org.springframework.core.convert.converter.Converter;
+import org.springframework.lang.NonNull;
+import org.springframework.stereotype.Component;
+
+@Component
+public class TeamV2InfoDTOConverter implements Converter<TeamV2, TeamV2InfoDTO> {
+
+    @Override
+    public TeamV2InfoDTO convert(@NonNull TeamV2 source) {
+        return new TeamV2InfoDTO(
+            source.getId(),
+            source.getName(),
+            source.getParentId(),
+            source.getDescription(),
+            source.getPrivacy(),
+            source.getOrganization(),
+            source.getHtmlUrl(),
+            source.getLastSyncedAt(),
+            source.getMemberships().size(),
+            source.getRepoPermissions().size()
+        );
+    }
+}

server/application-server/src/main/java/de/tum/in/www1/hephaestus/gitprovider/teamV2/TeamV2Repository.java

@@ -0,0 +1,7 @@
+package de.tum.in.www1.hephaestus.gitprovider.teamV2;
+
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface TeamV2Repository extends JpaRepository<TeamV2, Long> {}