Feature/44 update information for only news person (#45)

jeanphi-baconnais · web-flow · commit 445ba60a4609 · 2026-04-01T15:37:35.000+02:00
✨ Update contribution mecanism to improve performance
diff --git a/.agent/skills/verify_and_update_documentation/SKILL.md b/.agent/skills/verify_and_update_documentation/SKILL.md
@@ -0,0 +1,31 @@
+---
+name: Verify and Update Documentation
+description: Guidelines to ensure that the documentation (README, architecture, etc.) is kept up to date with code modifications.
+---
+
+# Verify and Update Documentation
+
+In this project, we aim to maintain high-quality and accurate documentation. Every code modification should trigger a review of the existing documentation to ensure it remains consistent with the implementation.
+
+## Guidelines
+
+1. **Check for Documentation Impact**: Before finalizing a task, ask yourself:
+   - Does this change a public API or a REST endpoint?
+   - Does this add, remove, or modify a configuration property in `application.properties`?
+   - Does this change the underlying data model (Firestore, Beans)?
+   - Does this add a new feature or dependency?
+
+2. **Files to Monitor**:
+   - `README.md`: Ensure installation steps, configuration, and feature descriptions are current.
+   - `docs/architecture.excalidraw`: Update if the high-level architecture changes.
+   - `CHANGELOG.md`: Record significant changes, bug fixes, or performance improvements.
+   - `application.properties`: Ensure all new properties are documented or have sensible defaults.
+
+3.  **Update Process**:
+    - If a change is significant, update the relevant file immediately.
+    - If you add a new configuration property, ensure it's explained in the `README.md` or a dedicated configuration section.
+    - If you optimize a workflow (like the stats refresh), consider if the "How it works" section in the documentation needs a refresh.
+
+4. **Self-Verification**:
+   - Verify that the updated documentation is syntactically correct (Markdown).
+   - Ensure that all links and references in the documentation are still valid.
diff --git a/.quarkus/cli/plugins/quarkus-cli-catalog.json b/.quarkus/cli/plugins/quarkus-cli-catalog.json
@@ -0,0 +1,13 @@
+{
+  "version" : "v1",
+  "lastUpdate" : "31/03/2026 22:29:51",
+  "plugins" : {
+    "tls" : {
+      "name" : "tls",
+      "type" : "extension",
+      "location" : "io.quarkus:quarkus-tls-registry-cli:3.34.1@fatjar",
+      "description" : null,
+      "inProjectCatalog" : false
+    }
+  }
+}
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ One objective of this project is to highlight Zenika members for their open sour
 To do this, data is scanned from both **GitHub** and **GitLab** and saved in a private Database on GCP.
 Data is used to find and list projects maintained or forked by Zenika Members, as well as their open source contributions.
 
-## 🗄️ Tech 
+## 🗄️ Tech Stack
 
 Using:
 - [Quarkus](https://quarkus.io/)
diff --git a/src/main/java/zenika/oss/stats/beans/ZenikaMember.java b/src/main/java/zenika/oss/stats/beans/ZenikaMember.java
@@ -3,6 +3,7 @@
 import zenika.oss.stats.beans.github.GitHubMember;
 import zenika.oss.stats.beans.gitlab.GitLabMember;
 
+
 public class ZenikaMember {
 
     private String id;
diff --git a/src/main/java/zenika/oss/stats/config/FirestoreCollections.java b/src/main/java/zenika/oss/stats/config/FirestoreCollections.java
@@ -1,14 +1,23 @@
 package zenika.oss.stats.config;
 
+import org.eclipse.microprofile.config.ConfigProvider;
+
 public enum FirestoreCollections {
     PROJECTS("projects"),
     MEMBERS("members"),
     STATS("stats"),
     ;
 
-    public final String value;
+    private final String baseName;
+
+    FirestoreCollections(String baseName) {
+        this.baseName = baseName;
+    }
 
-    FirestoreCollections(String value) {
-        this.value = value;
+    public String getValue() {
+        String prefix = ConfigProvider.getConfig()
+                .getOptionalValue("firestore.collection.prefix", String.class)
+                .orElse("");
+        return prefix + baseName;
     }
 }
diff --git a/src/main/java/zenika/oss/stats/mapper/ZenikaMemberMapper.java b/src/main/java/zenika/oss/stats/mapper/ZenikaMemberMapper.java
@@ -5,6 +5,8 @@
 import zenika.oss.stats.beans.github.GitHubMember;
 import zenika.oss.stats.beans.gitlab.GitLabMember;
 
+import java.util.HashMap;
+import java.util.Map;
 import java.util.UUID;
 
 public class ZenikaMemberMapper {
@@ -29,6 +31,24 @@ public static ZenikaMember mapFirestoreZenikaMemberToZenikaMember(QueryDocumentS
 
     }
 
+    /**
+     * Map a ZenikaMember to a Firestore Map.
+     * 
+     * @param member : the member to map.
+     * @return a map for Firestore.
+     */
+    public static Map<String, Object> mapZenikaMemberToMap(ZenikaMember member) {
+        Map<String, Object> map = new HashMap<>();
+
+        map.put("firstname", member.getFirstname());
+        map.put("name", member.getName());
+        map.put("city", member.getCity());
+        map.put("gitHubAccount", member.getGitHubAccount());
+        map.put("gitlabAccount", member.getGitlabAccount());
+
+        return map;
+    }
+
     /**
      * Create a ZenikaMember from a GitHub Member.
      * 
diff --git a/src/main/java/zenika/oss/stats/ressources/workflow/WorkflowRessources.java b/src/main/java/zenika/oss/stats/ressources/workflow/WorkflowRessources.java
@@ -18,7 +18,9 @@
 import zenika.oss.stats.mapper.ZenikaMemberMapper;
 import zenika.oss.stats.services.FirestoreServices;
 import zenika.oss.stats.services.GitHubServices;
+import zenika.oss.stats.services.GitLabServices;
 
+import java.time.LocalDate;
 import java.util.List;
 import java.util.Set;
 import java.util.stream.Collectors;
@@ -30,6 +32,9 @@ public class WorkflowRessources {
     @Inject
     GitHubServices gitHubServices;
 
+    @Inject
+    GitLabServices gitLabServices;
+
     @Inject
     FirestoreServices firestoreServices;
 
@@ -108,22 +113,55 @@ public Response savePersonalProjects() throws DatabaseException {
     @Produces(MediaType.TEXT_PLAIN)
     public Response saveStatsForYear(@PathParam("year") int year) throws DatabaseException {
 
-        firestoreServices.deleteStatsBySourceForYear(year, "GitHub");
+        int currentYear = LocalDate.now().getYear();
+        boolean isCurrentYear = (year == currentYear);
+
+        if (isCurrentYear) {
+            firestoreServices.deleteStatsBySourceForYear(year, "GitHub");
+            firestoreServices.deleteStatsBySourceForYear(year, "GitLab");
+        }
 
         List<ZenikaMember> zMembers = firestoreServices.getAllMembers();
 
         for (ZenikaMember zenikaMember : zMembers) {
+            // GitHub
             if (zenikaMember.getGitHubAccount() != null) {
-                System.out.print("🔎 Check information for " + zenikaMember.getGitHubAccount().getLogin());
-                List<CustomStatsContributionsUserByMonth> stats = gitHubServices
-                        .getContributionsForTheCurrentYear(zenikaMember.getGitHubAccount().getLogin(), year);
-                List<StatsContribution> statsList = StatsMapper.mapGitHubStatisticsToStatsContributions(
-                        zenikaMember, year, stats);
-                System.out.println("... ✅");
-
-                if (!statsList.isEmpty()) {
-                    for (StatsContribution stat : statsList) {
-                        firestoreServices.saveStats(stat);
+                // For past years, skip if stats already exist
+                if (!isCurrentYear && firestoreServices.hasStatsForMemberAndYear(zenikaMember.getId(), year, "GitHub")) {
+                    System.out.println("⏭️ Skip GitHub information for " + zenikaMember.getGitHubAccount().getLogin() + " (already exists)");
+                } else {
+                    System.out.print("🔎 Check GitHub information for " + zenikaMember.getGitHubAccount().getLogin());
+                    List<CustomStatsContributionsUserByMonth> stats = gitHubServices
+                            .getContributionsForTheCurrentYear(zenikaMember.getGitHubAccount().getLogin(), year);
+                    List<StatsContribution> statsList = StatsMapper.mapGitHubStatisticsToStatsContributions(
+                            zenikaMember, year, stats);
+                    System.out.println("... ✅");
+
+                    if (!statsList.isEmpty()) {
+                        for (StatsContribution stat : statsList) {
+                            firestoreServices.saveStats(stat);
+                        }
+                    }
+                }
+            }
+
+            // GitLab
+            if (zenikaMember.getGitlabAccount() != null) {
+                // For past years, skip if stats already exist
+                if (!isCurrentYear && firestoreServices.hasStatsForMemberAndYear(zenikaMember.getId(), year, "GitLab")) {
+                    System.out.println("⏭️ Skip GitLab information for " + zenikaMember.getGitlabAccount().getUsername() + " (already exists)");
+                } else {
+                    System.out.print("🔎 Check GitLab information for " + zenikaMember.getGitlabAccount().getUsername());
+                    List<CustomStatsContributionsUserByMonth> stats = gitLabServices
+                            .getContributionsForTheCurrentYear(zenikaMember.getGitlabAccount().getUsername(), year);
+                    List<StatsContribution> statsList = StatsMapper.mapGitLabStatisticsToStatsContributions(
+                            zenikaMember, year, stats);
+                    System.out.println("... ✅");
+
+                    if (!statsList.isEmpty()) {
+                        for (StatsContribution stat : statsList) {
+                            firestoreServices.saveStats(stat);
+                        }
                     }
                 }
             }
@@ -149,11 +187,6 @@ public Response saveStatsForAGitHubAccountForAYear(@PathParam("githubMember") St
             return Response.status(Response.Status.NOT_FOUND).entity("Member not found").build();
         }
 
-        // Specific delete for this member is tricky with the new deterministic ID
-        // without a specific method,
-        // but for now we can just use the Upsert behavior of set() in saveStats.
-        // Or we could implement deleteStatsByMemberAndSourceForYear.
-
         List<CustomStatsContributionsUserByMonth> stats = gitHubServices.getContributionsForTheCurrentYear(githubMember,
                 year);
 
diff --git a/src/main/java/zenika/oss/stats/services/FirestoreServices.java b/src/main/java/zenika/oss/stats/services/FirestoreServices.java
@@ -33,12 +33,12 @@ public class FirestoreServices {
      */
     @CacheInvalidateAll(cacheName = "members-cache")
     public void createMember(ZenikaMember zMember) throws DatabaseException {
-        createDocument(zMember, FirestoreCollections.MEMBERS.value, zMember.getId());
+        createDocument(ZenikaMemberMapper.mapZenikaMemberToMap(zMember), FirestoreCollections.MEMBERS.getValue(), zMember.getId());
     }
 
     @CacheResult(cacheName = "members-cache")
     public List<ZenikaMember> getAllMembers() throws DatabaseException {
-        CollectionReference zmembers = firestore.collection(FirestoreCollections.MEMBERS.value);
+        CollectionReference zmembers = firestore.collection(FirestoreCollections.MEMBERS.getValue());
         ApiFuture<QuerySnapshot> querySnapshot = zmembers.get();
         try {
             return querySnapshot.get().getDocuments().stream()
@@ -58,7 +58,7 @@ public List<ZenikaMember> getAllMembers() throws DatabaseException {
      */
     @CacheInvalidateAll(cacheName = "contributions-cache")
     public void deleteStatsForAGitHubAccountForAYear(String githubMember, int year) throws DatabaseException {
-        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.value);
+        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.getValue());
         Query query = zStats.whereEqualTo("githubHandle", githubMember).whereEqualTo("year", String.valueOf(year));
         ApiFuture<QuerySnapshot> querySnapshot = query.get();
         try {
@@ -93,7 +93,7 @@ public void saveStats(StatsContribution statsContribution) throws DatabaseExcept
                     statsContribution.getIdZenikaMember(),
                     statsContribution.getSource());
 
-            firestore.collection(FirestoreCollections.STATS.value)
+            firestore.collection(FirestoreCollections.STATS.getValue())
                     .document(documentId)
                     .set(statsContribution)
                     .get();
@@ -111,7 +111,7 @@ public void saveStats(StatsContribution statsContribution) throws DatabaseExcept
      */
     @CacheInvalidateAll(cacheName = "contributions-cache")
     public void deleteStatsBySourceForYear(int year, String source) throws DatabaseException {
-        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.value);
+        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.getValue());
         Query query = zStats.whereEqualTo("year", String.valueOf(year)).whereEqualTo("source", source);
         deleteDocumentsByQuery(query);
     }
@@ -147,7 +147,7 @@ private void deleteDocumentsByQuery(Query query) throws DatabaseException {
      */
     @CacheInvalidateAll(cacheName = "projects-cache")
     public void createProject(Project project) throws DatabaseException {
-        createDocument(project, FirestoreCollections.PROJECTS.value, project.getId());
+        createDocument(project, FirestoreCollections.PROJECTS.getValue(), project.getId());
     }
 
     /**
@@ -157,7 +157,7 @@ public void createProject(Project project) throws DatabaseException {
      */
     @CacheResult(cacheName = "projects-cache")
     public List<Project> getAllProjects() throws DatabaseException {
-        CollectionReference zProjects = firestore.collection(FirestoreCollections.PROJECTS.value);
+        CollectionReference zProjects = firestore.collection(FirestoreCollections.PROJECTS.getValue());
         ApiFuture<QuerySnapshot> querySnapshot = zProjects.get();
         try {
             return querySnapshot.get().getDocuments().stream()
@@ -209,7 +209,7 @@ public void deleteAllGitHubOrganizationProjects() throws DatabaseException {
     }
 
     private void deleteProjectsBySource(String source) throws DatabaseException {
-        CollectionReference zProjects = firestore.collection(FirestoreCollections.PROJECTS.value);
+        CollectionReference zProjects = firestore.collection(FirestoreCollections.PROJECTS.getValue());
         Query query = zProjects.whereEqualTo("source", source);
         ApiFuture<QuerySnapshot> querySnapshot = query.get();
         try {
@@ -246,7 +246,7 @@ public void deleteAllMembers() throws DatabaseException {
     @CacheInvalidateAll(cacheName = "members-cache")
     public void deleteMember(String memberId) throws DatabaseException {
         try {
-            firestore.collection(FirestoreCollections.MEMBERS.value)
+            firestore.collection(FirestoreCollections.MEMBERS.getValue())
                     .document(memberId)
                     .delete()
                     .get();
@@ -280,10 +280,10 @@ public <T> void createDocument(T document, String collectionPath, String documen
      * @throws DatabaseException exception
      */
     public <T> void deleteAllDocuments(FirestoreCollections collectionType) throws DatabaseException {
-        if (collectionType.value == null) {
+        if (collectionType.getValue() == null) {
             throw new IllegalArgumentException("Collection name cannot be null");
         }
-        CollectionReference collection = firestore.collection(collectionType.value);
+        CollectionReference collection = firestore.collection(collectionType.getValue());
         ApiFuture<QuerySnapshot> querySnapshot = collection.get();
         try {
             List<QueryDocumentSnapshot> documents = querySnapshot.get().getDocuments();
@@ -302,7 +302,7 @@ public <T> void deleteAllDocuments(FirestoreCollections collectionType) throws D
 
     @CacheResult(cacheName = "contributions-cache")
     public List<StatsContribution> getStatsForYear(int year) throws DatabaseException {
-        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.value);
+        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.getValue());
         Query query = zStats.whereEqualTo("year", String.valueOf(year));
         ApiFuture<QuerySnapshot> querySnapshot = query.get();
         try {
@@ -317,7 +317,7 @@ public List<StatsContribution> getStatsForYear(int year) throws DatabaseExceptio
     @CacheResult(cacheName = "contributions-cache")
     public List<StatsContribution> getContributionsForAMemberOrderByYear(String memberId) throws DatabaseException {
         List<StatsContribution> stats = null;
-        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.value);
+        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.getValue());
         Query query = zStats.whereEqualTo("githubHandle", memberId);
         ApiFuture<QuerySnapshot> querySnapshot = query.get();
         try {
@@ -337,7 +337,7 @@ public List<StatsContribution> getContributionsForAMemberOrderByYear(String memb
     @CacheResult(cacheName = "contributions-cache")
     public List<StatsContribution> getContributionsForZenikaMember(String zenikaMemberId) throws DatabaseException {
         List<StatsContribution> stats = null;
-        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.value);
+        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.getValue());
         Query query = zStats.whereEqualTo("idZenikaMember", zenikaMemberId);
         ApiFuture<QuerySnapshot> querySnapshot = query.get();
         try {
@@ -357,7 +357,7 @@ public List<StatsContribution> getContributionsForZenikaMember(String zenikaMemb
     public List<StatsContribution> getContributionsForAYearAndMonthOrderByMonth(int year, String month)
             throws DatabaseException {
         List<StatsContribution> stats = null;
-        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.value);
+        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.getValue());
         Query query = zStats.whereEqualTo("year", String.valueOf(year)).whereEqualTo("month", month);
         ApiFuture<QuerySnapshot> querySnapshot = query.get();
         try {
@@ -374,7 +374,7 @@ public List<StatsContribution> getContributionsForAYearAndMonthOrderByMonth(int
 
     @CacheResult(cacheName = "contributions-cache")
     public List<StatsContribution> getAllStats() throws DatabaseException {
-        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.value);
+        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.getValue());
         ApiFuture<QuerySnapshot> querySnapshot = zStats.get();
         try {
             return querySnapshot.get().getDocuments().stream()
@@ -384,4 +384,26 @@ public List<StatsContribution> getAllStats() throws DatabaseException {
             throw new DatabaseException(exception);
         }
     }
+
+    /**
+     * Check if a member has any statistics records for a specific year and source.
+     *
+     * @param memberId the internal Zenika member ID.
+     * @param year     the year to check.
+     * @param source   the source (GitHub or GitLab).
+     * @return true if at least one record exists.
+     * @throws DatabaseException if the database query fails.
+     */
+    public boolean hasStatsForMemberAndYear(String memberId, int year, String source) throws DatabaseException {
+        CollectionReference zStats = firestore.collection(FirestoreCollections.STATS.getValue());
+        Query query = zStats.whereEqualTo("idZenikaMember", memberId)
+                .whereEqualTo("year", String.valueOf(year))
+                .whereEqualTo("source", source)
+                .limit(1);
+        try {
+            return !query.get().get().getDocuments().isEmpty();
+        } catch (InterruptedException | ExecutionException e) {
+            throw new DatabaseException(e);
+        }
+    }
 }
diff --git a/src/main/java/zenika/oss/stats/ui/JavelitDashboard.java b/src/main/java/zenika/oss/stats/ui/JavelitDashboard.java
@@ -42,7 +42,7 @@ void onStart(@Observes StartupEvent ev) {
             Jt.header("📊 Opensource Statistics Dashbord").use();
             Jt.subheader("Welcome to the Zenika Open Source contributions dashboard").use();
             Jt.markdown(
-                    "This dashboard get publics datas from GitHub (and GitLab as soon)")
+                    "This dashboard get publics datas from GitHub")
                     .use();
 
             var tabs = Jt.tabs(List.of("🙋 Members", "🚀 Members Projects", "🏢 Zenika Open Source Projects",
diff --git a/src/main/java/zenika/oss/stats/ui/tabs/ContributionsTab.java b/src/main/java/zenika/oss/stats/ui/tabs/ContributionsTab.java
diff --git a/src/main/java/zenika/oss/stats/ui/tabs/OrganizationProjectsTab.java b/src/main/java/zenika/oss/stats/ui/tabs/OrganizationProjectsTab.java
diff --git a/src/main/java/zenika/oss/stats/ui/tabs/ProjectsTab.java b/src/main/java/zenika/oss/stats/ui/tabs/ProjectsTab.java
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
