Merge branch 'contributor-activity' into 'main'

add contributor data extraction, GitHub social activity fetching

See merge request ExplorViz/code/code-agent!13

Author: malte-hansen

build.gradle

@@ -23,6 +23,9 @@ dependencies {
     implementation 'io.quarkus:quarkus-rest-jackson'
     implementation 'io.quarkus:quarkus-grpc'
 
+    // GraphQL Client
+    implementation 'io.quarkus:quarkus-smallrye-graphql-client'
+
     implementation 'com.google.protobuf:protobuf-java-util'
 
     // Java Parsing

src/main/java/net/explorviz/code/analysis/api/AnalysisRequest.java

@@ -54,6 +54,10 @@ public void setRoot(final String root) {
   private String applicationRoot;
   private List<ApplicationSpec> applications;
 
+  private boolean fetchSocialData = false;
+  private String fetchEndDate;
+  private Integer socialDataTimeFrameDays;
+
   public AnalysisRequest() {
   }
 
@@ -185,6 +189,30 @@ public void setCommitAnalysisLimit(final Integer commitAnalysisLimit) {
     this.commitAnalysisLimit = commitAnalysisLimit;
   }
 
+  public boolean isFetchSocialData() {
+    return fetchSocialData;
+  }
+
+  public void setFetchSocialData(final boolean fetchSocialData) {
+    this.fetchSocialData = fetchSocialData;
+  }
+
+  public String getFetchEndDate() {
+    return fetchEndDate;
+  }
+
+  public void setFetchEndDate(final String fetchEndDate) {
+    this.fetchEndDate = fetchEndDate;
+  }
+
+  public Integer getSocialDataTimeFrameDays() {
+    return socialDataTimeFrameDays;
+  }
+
+  public void setSocialDataTimeFrameDays(final Integer socialDataTimeFrameDays) {
+    this.socialDataTimeFrameDays = socialDataTimeFrameDays;
+  }
+
   /**
    * Converts this request to an AnalysisConfig.
    *
@@ -214,7 +242,11 @@ public AnalysisConfig toConfig() {
         .startCommit(Optional.ofNullable(startCommit))
         .endCommit(Optional.ofNullable(endCommit))
         .commitAnalysisLimit(Optional.ofNullable(commitAnalysisLimit))
-        .landscapeToken((landscapeToken != null && !landscapeToken.isBlank()) ? landscapeToken : "mytokenvalue");
+        .landscapeToken((landscapeToken != null && !landscapeToken.isBlank()) ? landscapeToken : "mytokenvalue")
+        .applicationRoot(Optional.ofNullable(applicationRoot))
+        .fetchSocialData(fetchSocialData)
+        .socialDataTimeFrameDays(Optional.ofNullable(socialDataTimeFrameDays))
+        .fetchEndDate(Optional.ofNullable(fetchEndDate).filter(s -> !s.isEmpty()));
 
     if (!paths.isEmpty()) {
       builder.applicationPaths(paths);

src/main/java/net/explorviz/code/analysis/export/DataExporter.java

@@ -2,8 +2,10 @@
 
 import java.util.Map;
 import net.explorviz.code.proto.CommitData;
+import net.explorviz.code.proto.ContributorData;
 import net.explorviz.code.proto.FileData;
 import net.explorviz.code.proto.StateData;
+import net.explorviz.code.proto.TrackableResourceEvent;
 
 /**
  * A DataExporter handles the export of {@link FileData}, {@link CommitData} and request of {@link StateData}.
@@ -17,6 +19,8 @@ StateData getStateData(final String repositoryName, final String branchName, fin
 
   void persistCommit(final CommitData commitData);
 
+  void persistTrackableResourceEvent(final TrackableResourceEvent trackableResourceEvent);
+
   boolean isRemote();
 
   boolean isInvalidCommitHash(final String hash);

src/main/java/net/explorviz/code/analysis/export/GrpcExporter.java

@@ -5,11 +5,15 @@
 import java.util.Map;
 import net.explorviz.code.proto.CommitData;
 import net.explorviz.code.proto.CommitServiceGrpc;
+import net.explorviz.code.proto.ContributorData;
+import net.explorviz.code.proto.ContributorServiceGrpc;
 import net.explorviz.code.proto.FileData;
 import net.explorviz.code.proto.FileDataServiceGrpc;
 import net.explorviz.code.proto.StateData;
 import net.explorviz.code.proto.StateDataRequest;
 import net.explorviz.code.proto.StateDataServiceGrpc;
+import net.explorviz.code.proto.TrackableResourceEvent;
+import net.explorviz.code.proto.TrackableResourceServiceGrpc;
 import org.eclipse.microprofile.config.inject.ConfigProperty;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -32,6 +36,12 @@ public final class GrpcExporter implements DataExporter {
   //
   @GrpcClient(GRPC_CLIENT_NAME)
   /* package */ StateDataServiceGrpc.StateDataServiceBlockingStub stateDataGrpcClient;
+  //
+  @GrpcClient(GRPC_CLIENT_NAME)
+  /* package */ ContributorServiceGrpc.ContributorServiceBlockingStub contributorDataGrpcClient;
+  //
+  @GrpcClient(GRPC_CLIENT_NAME)
+    /* package */ TrackableResourceServiceGrpc.TrackableResourceServiceBlockingStub trackableResourceGrpcClient;
 
   @ConfigProperty(name = "explorviz.landscape.token")
   /* default */ String landscapeTokenProperty;
@@ -92,7 +102,25 @@ public void persistCommit(final CommitData commitData) {
         LOGGER.error(e.getMessage());
       }
     }
+  }
 
+  @Override
+  public void persistTrackableResourceEvent(final TrackableResourceEvent trackableResourceEvent) {
+    LOGGER.info(
+        "Sending TrackableResourceEvent {} for {} #{}",
+        trackableResourceEvent.getAnnotationType(),
+        trackableResourceEvent.getResourceType(),
+        trackableResourceEvent.getResourceId()
+    );
+    try {
+      trackableResourceGrpcClient.persistTrackableResourceEvent(trackableResourceEvent);
+    } catch (final Exception e) {
+      if (LOGGER.isErrorEnabled()) {
+        LOGGER.error("Failed to send trackable resource event {}: {}", trackableResourceEvent.getAnnotationId(),
+            e.getMessage());
+        LOGGER.debug("Detailed event data: {}", trackableResourceEvent);
+      }
+    }
   }
 
   @Override

src/main/java/net/explorviz/code/analysis/export/JsonExporter.java

@@ -6,9 +6,11 @@
 import java.nio.file.Paths;
 import java.util.Map;
 import net.explorviz.code.proto.CommitData;
+import net.explorviz.code.proto.ContributorData;
 import net.explorviz.code.proto.FileData;
 import net.explorviz.code.proto.StateData;
 import net.explorviz.code.proto.StateDataRequest;
+import net.explorviz.code.proto.TrackableResourceEvent;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -174,6 +176,17 @@ public void persistCommit(final CommitData commitData) {
     this.commitCount++;
   }
 
+  @Override
+  public void persistTrackableResourceEvent(final TrackableResourceEvent trackableResourceEvent) {
+    try {
+      final String json = unescapeHtml(JsonFormat.printer().print(trackableResourceEvent));
+      final String fileName = "TrackableResourceEvent" + trackableResourceEvent.getResourceId() + JSON_FILE_EXTENSION;
+      Files.write(Paths.get(storageDirectory, fileName), json.getBytes());
+    } catch (IOException e) { // NOPMD
+      throw new RuntimeException(e); // NOPMD
+    }
+  }
+
   @Override
   public boolean isRemote() {
     return false;

src/main/java/net/explorviz/code/analysis/export/VoidExporter.java

@@ -2,8 +2,10 @@
 
 import java.util.Map;
 import net.explorviz.code.proto.CommitData;
+import net.explorviz.code.proto.ContributorData;
 import net.explorviz.code.proto.FileData;
 import net.explorviz.code.proto.StateData;
+import net.explorviz.code.proto.TrackableResourceEvent;
 
 /**
  * Dummy to dump the data into void.
@@ -27,6 +29,11 @@ public void persistCommit(final CommitData commitData) {
     // DO NOTHING
   }
 
+  @Override
+  public void persistTrackableResourceEvent(final TrackableResourceEvent trackableResourceEvent) {
+    // DO NOTHING
+  }
+
   @Override
   public boolean isRemote() {
     return false;

src/main/java/net/explorviz/code/analysis/git/GitMetricCollector.java

@@ -2,6 +2,8 @@
 
 import net.explorviz.code.analysis.handler.AbstractFileDataHandler;
 import net.explorviz.code.analysis.types.FileDescriptor;
+import net.explorviz.code.proto.ContributorData;
+import net.explorviz.code.proto.ContributorData.Builder;
 import org.eclipse.jgit.revwalk.RevCommit;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -62,4 +64,30 @@ public static void addFileGitMetrics(final AbstractFileDataHandler fileDataHandl
       }
     }
   }
+
+  /** 
+   * Creates a ContributorData object based on the given commit, landscape token and repository name.
+   *
+   * @param commit the commit to extract contributor information from
+   * @param landscapeToken the landscape token to set in the ContributorData
+   * @param repositoryName the repository name to set in the ContributorData
+   * @return a ContributorData object containing the contributor information
+   */
+  public static ContributorData createContributorData(
+        final RevCommit commit,
+        final String landscapeToken,
+        final String repositoryName
+      
+  ) {
+    String name = commit.getAuthorIdent().getName();
+    String email = commit.getAuthorIdent().getEmailAddress();
+
+    Builder builder = ContributorData.newBuilder()
+        .setGitUsername(name)
+        .setEmail(email)
+        .setLandscapeToken(landscapeToken)
+        .setRepositoryName(repositoryName);
+
+    return builder.build();
+  }
 }

src/main/java/net/explorviz/code/analysis/handler/CommitReportHandler.java

@@ -6,6 +6,7 @@
 import java.util.List;
 import net.explorviz.code.analysis.types.FileDescriptor;
 import net.explorviz.code.proto.CommitData;
+import net.explorviz.code.proto.ContributorData;
 import net.explorviz.code.proto.FileIdentifier;
 
 /**
@@ -18,13 +19,15 @@ public class CommitReportHandler { // NOPMD
   private final List<FileIdentifier> deletedFiles = new ArrayList<>();
   private final List<FileIdentifier> modifiedFiles = new ArrayList<>();
   private CommitData.Builder builder;
+  private ContributorData.Builder contributorBuilder;
 
   /**
    * Creates a blank handler, use
    * {@link CommitReportHandler#init(String, String, String)} to initialize it.
    */
   public CommitReportHandler() {
     this.builder = CommitData.newBuilder();
+    this.contributorBuilder = ContributorData.newBuilder();
   }
 
   /**
@@ -33,6 +36,7 @@ public CommitReportHandler() {
    */
   public void clear() {
     this.builder = CommitData.newBuilder();
+    this.contributorBuilder = ContributorData.newBuilder();
     this.addedFiles.clear();
     this.deletedFiles.clear();
     this.modifiedFiles.clear();
@@ -96,6 +100,10 @@ public void setCommitDate(final Timestamp commitDate) {
     builder.setCommitDate(commitDate);
   }
 
+  public void setAuthor(final ContributorData contributorData) {
+    builder.setAuthor(contributorData);
+  }
+
   /**
    * Returns the commit data. * * @return commit data object
    */

src/main/java/net/explorviz/code/analysis/service/AnalysisConfig.java

@@ -1,5 +1,8 @@
 package net.explorviz.code.analysis.service;
 
+import java.sql.Date;
+import java.time.Instant;
+import java.util.Collections;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -17,7 +20,8 @@ public record AnalysisConfig(Optional<String> repoPath, Optional<String> repoRem
     boolean calculateMetrics,
     Optional<String> startCommit, Optional<String> endCommit,
     Optional<Integer> commitAnalysisLimit,
-    String landscapeToken) {
+    String landscapeToken,
+    boolean fetchSocialData, Optional<String> fetchEndDate, Optional<Integer> socialDataTimeFrameDays) {
 
   /**
    * Path filter passed to Git diffs: union of all application roots, or global filters when appropriate.
@@ -91,6 +95,11 @@ public static class Builder {
     private String applicationName = "";
     private List<ApplicationPath> explicitApplicationPaths;
 
+    // Social data analysis
+    private boolean fetchSocialData = false;
+    private Optional<String> fetchEndDate = Optional.empty();
+    private Optional<Integer> socialDataTimeFrameDays = Optional.empty();
+
     public Builder repoPath(final Optional<String> repoPath) {
       this.repoPath = repoPath;
       return this;
@@ -161,6 +170,21 @@ public Builder applicationName(final String applicationName) {
       return this;
     }
 
+    public Builder fetchSocialData(final boolean fetchSocialData) {
+      this.fetchSocialData = fetchSocialData;
+      return this;
+    }
+
+    public Builder fetchEndDate(final Optional<String> fetchEndDate) {
+      this.fetchEndDate = fetchEndDate;
+      return this;
+    }
+
+    public Builder socialDataTimeFrameDays(final Optional<Integer> socialDataTimeFrameDays) {
+      this.socialDataTimeFrameDays = socialDataTimeFrameDays;
+      return this;
+    }
+    
     public Builder applicationPaths(final List<ApplicationPath> paths) {
       this.explicitApplicationPaths = paths;
       return this;
@@ -188,7 +212,10 @@ public AnalysisConfig build() {
           startCommit,
           endCommit,
           commitAnalysisLimit,
-          landscapeToken);
+          landscapeToken,
+          fetchSocialData,
+          fetchEndDate,
+          socialDataTimeFrameDays);
     }
   }