Leaderboard: Custom Sliding Time Window

server/application-server/openapi.yaml

@@ -94,6 +94,19 @@ paths:
       tags:
       - leaderboard
       operationId: getLeaderboard
+      parameters:
+      - name: before
+        in: query
+        required: false
+        schema:
+          type: string
+          format: date-time
+      - name: after
+        in: query
+        required: false
+        schema:
+          type: string
+          format: date-time
       responses:
         "200":
           description: OK

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

@@ -1,10 +1,13 @@
 package de.tum.in.www1.hephaestus.leaderboard;
 
+import java.time.OffsetDateTime;
 import java.util.List;
+import java.util.Optional;
 
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
@@ -18,7 +21,8 @@ public LeaderboardController(LeaderboardService leaderboardService) {
     }
 
     @GetMapping
-    public ResponseEntity<List<LeaderboardEntry>> getLeaderboard() {
-        return ResponseEntity.ok(leaderboardService.createLeaderboard());
+    public ResponseEntity<List<LeaderboardEntry>> getLeaderboard(@RequestParam Optional<OffsetDateTime> before,
+            @RequestParam Optional<OffsetDateTime> after) {
+        return ResponseEntity.ok(leaderboardService.createLeaderboard(before, after));
     }
 }

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

@@ -8,6 +8,7 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.stream.Collectors;
@@ -36,14 +37,17 @@ public LeaderboardService(UserService userService) {
         this.userService = userService;
     }
 
-    public List<LeaderboardEntry> createLeaderboard() {
+    public List<LeaderboardEntry> createLeaderboard(Optional<OffsetDateTime> before, Optional<OffsetDateTime> after) {
         logger.info("Creating leaderboard dataset");
 
         List<User> users = userService.getAllUsers();
-        logger.info("Leaderboard has " + users.size() + " users");
 
-        OffsetDateTime cutOffTime = new Date(System.currentTimeMillis() - 1000 * 60 * 60 * 24 * timeframe)
-                .toInstant().atOffset(ZoneOffset.UTC);
+        OffsetDateTime afterCutOff = after.isPresent() ? after.get()
+                : new Date(System.currentTimeMillis() - 1000 * 60 * 60 * 24 * timeframe).toInstant()
+                        .atOffset(ZoneOffset.UTC);
+
+        logger.info("Leaderboard has " + users.size() + " users with cut-off time " + afterCutOff + " and before time "
+                + before);
 
         List<LeaderboardEntry> leaderboard = users.stream().map(user -> {
             if (user.getType() != UserType.USER) {
@@ -55,8 +59,8 @@ public List<LeaderboardEntry> createLeaderboard() {
             Set<PullRequestReviewDTO> commentSet = new HashSet<>();
 
             user.getReviews().stream()
-                    .filter(review -> (review.getCreatedAt() != null && review.getCreatedAt().isAfter(cutOffTime))
-                            || (review.getUpdatedAt() != null && review.getUpdatedAt().isAfter(cutOffTime)))
+                    .filter(review -> isInTimeframe(review.getCreatedAt(), before, afterCutOff)
+                            || isInTimeframe(review.getUpdatedAt(), before, afterCutOff))
                     .forEach(review -> {
                         if (review.getPullRequest().getAuthor().getLogin().equals(user.getLogin())) {
                             return;
@@ -99,6 +103,10 @@ public List<LeaderboardEntry> createLeaderboard() {
         return leaderboard;
     }
 
+    private boolean isInTimeframe(OffsetDateTime date, Optional<OffsetDateTime> before, OffsetDateTime after) {
+        return date != null && (before.isPresent() && date.isAfter(before.get()) || date.isBefore(after));
+    }
+
     /**
      * Calculates the score for a given pull request.
      * Possible values: 1, 3, 7, 17, 33.

server/application-server/src/main/resources/application.yml

@@ -33,7 +33,7 @@ springdoc:
 monitoring:
     runOnStartup: true
     # Fetching timeframe in days
-    timeframe: 7
+    timeframe: 1
     repository-sync-cron: "0 0 * * * *"
     repositories: ls1intum/Artemis
 

webapp/src/app/core/modules/openapi/api/leaderboard.service.ts

@@ -96,13 +96,25 @@ export class LeaderboardService implements LeaderboardServiceInterface {
     }
 
     /**
+     * @param before 
+     * @param after 
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
      * @param reportProgress flag to report request and response progress.
      */
-    public getLeaderboard(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<Array<LeaderboardEntry>>;
-    public getLeaderboard(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<HttpResponse<Array<LeaderboardEntry>>>;
-    public getLeaderboard(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<HttpEvent<Array<LeaderboardEntry>>>;
-    public getLeaderboard(observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<any> {
+    public getLeaderboard(before?: string, after?: string, observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<Array<LeaderboardEntry>>;
+    public getLeaderboard(before?: string, after?: string, observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<HttpResponse<Array<LeaderboardEntry>>>;
+    public getLeaderboard(before?: string, after?: string, observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<HttpEvent<Array<LeaderboardEntry>>>;
+    public getLeaderboard(before?: string, after?: string, observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<any> {
+
+        let localVarQueryParameters = new HttpParams({encoder: this.encoder});
+        if (before !== undefined && before !== null) {
+          localVarQueryParameters = this.addToHttpParams(localVarQueryParameters,
+            <any>before, 'before');
+        }
+        if (after !== undefined && after !== null) {
+          localVarQueryParameters = this.addToHttpParams(localVarQueryParameters,
+            <any>after, 'after');
+        }
 
         let localVarHeaders = this.defaultHeaders;
 
@@ -144,6 +156,7 @@ export class LeaderboardService implements LeaderboardServiceInterface {
         return this.httpClient.request<Array<LeaderboardEntry>>('get', `${this.configuration.basePath}${localVarPath}`,
             {
                 context: localVarHttpContext,
+                params: localVarQueryParameters,
                 responseType: <any>responseType_,
                 withCredentials: this.configuration.withCredentials,
                 headers: localVarHeaders,

webapp/src/app/core/modules/openapi/api/leaderboard.serviceInterface.ts

@@ -27,7 +27,9 @@ export interface LeaderboardServiceInterface {
     /**
      * 
      * 
+     * @param before 
+     * @param after 
      */
-    getLeaderboard(extraHttpRequestParams?: any): Observable<Array<LeaderboardEntry>>;
+    getLeaderboard(before?: string, after?: string, extraHttpRequestParams?: any): Observable<Array<LeaderboardEntry>>;
 
 }

webapp/src/app/home/home.component.ts

@@ -1,4 +1,5 @@
 import { Component, inject } from '@angular/core';
+import { ActivatedRoute } from '@angular/router';
 import { injectQuery } from '@tanstack/angular-query-experimental';
 import { LeaderboardService } from 'app/core/modules/openapi/api/leaderboard.service';
 import { LeaderboardComponent } from 'app/home/leaderboard/leaderboard.component';
@@ -13,9 +14,21 @@ import { lastValueFrom } from 'rxjs';
 export class HomeComponent {
   leaderboardService = inject(LeaderboardService);
 
+  // timeframe for leaderboard
+  // example: 2024-09-19T10:15:30+01:00
+  protected after: string | undefined = undefined;
+  protected before: string | undefined = undefined;
+
+  constructor() {
+    inject(ActivatedRoute).queryParamMap.subscribe((params) => {
+      this.after = params.get('after')?.replace(' ', '+') ?? undefined;
+      this.before = params.get('before')?.replace(' ', '+') ?? undefined;
+    });
+  }
+
   query = injectQuery(() => ({
     queryKey: ['leaderboard'],
-    queryFn: async () => lastValueFrom(this.leaderboardService.getLeaderboard()),
+    queryFn: async () => lastValueFrom(this.leaderboardService.getLeaderboard(this.before, this.after)),
     gcTime: Infinity
   }));
 }