Browse Source

Merge pull request #691 from jplag/report-viewer-fix

Quick fix for matches not display properly in the report viewer.
Timur Sağlam 4 years ago
parent
commit
7c28aaef90

+ 5 - 1
.gitignore

@@ -5,7 +5,7 @@ target/
 
 *.class
 
-result
+
 
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
@@ -28,3 +28,7 @@ hs_err_pid*
 
 # ANTLR
 .antlr/
+
+# default result file name, should never be commited
+result/
+result.zip

+ 6 - 4
core/src/main/java/de/jplag/reporting/reportobject/ReportObjectFactory.java

@@ -27,10 +27,10 @@ import de.jplag.Language;
 import de.jplag.Submission;
 import de.jplag.reporting.jsonfactory.ComparisonReportWriter;
 import de.jplag.reporting.jsonfactory.ToDiskWriter;
-import de.jplag.reporting.reportobject.mapper.ClusteringResultMapper;
 import de.jplag.reporting.reportobject.mapper.MetricMapper;
 import de.jplag.reporting.reportobject.model.Metric;
 import de.jplag.reporting.reportobject.model.OverviewReport;
+import de.jplag.reporting.reportobject.model.Version;
 
 /**
  * Factory class, responsible for converting a JPlagResult object to Overview and Comparison DTO classes and writing it
@@ -42,6 +42,9 @@ public class ReportObjectFactory {
     private static final ToDiskWriter fileWriter = new ToDiskWriter();
     public static final String OVERVIEW_FILE_NAME = "overview.json";
     public static final String SUBMISSIONS_FOLDER = "submissions";
+
+    // TODO: This shall be moved to a better visible and upgradable position. Shall be fixed in a future version.
+    public static final Version REPORT_VIEWER_VERSION = new Version(4, 0, 0);
     private Map<String, String> submissionNameToIdMap;
     private Function<Submission, String> submissionToIdFunction;
     private Map<String, Map<String, String>> submissionNameToNameToComparisonFileName;
@@ -139,9 +142,8 @@ public class ReportObjectFactory {
         folders.addAll(result.getOptions().oldSubmissionDirectories());
 
         String baseCodePath = result.getOptions().hasBaseCode() ? result.getOptions().baseCodeSubmissionDirectory().getName() : "";
-        ClusteringResultMapper clusteringResultMapper = new ClusteringResultMapper(submissionToIdFunction);
 
-        OverviewReport overviewReport = new OverviewReport(folders.stream().map(File::getPath).toList(), // submissionFolderPath
+        OverviewReport overviewReport = new OverviewReport(REPORT_VIEWER_VERSION, folders.stream().map(File::getPath).toList(), // submissionFolderPath
                 baseCodePath, // baseCodeFolderPath
                 result.getOptions().language().getName(), // language
                 result.getOptions().fileSuffixes(), // fileExtensions
@@ -153,7 +155,7 @@ public class ReportObjectFactory {
                 getDate(),// dateOfExecution
                 result.getDuration(), // executionTime
                 getMetrics(result),// metrics
-                clusteringResultMapper.map(result)); // clusters
+                List.of()); // clusters (deactivated for now)
 
         fileWriter.saveAsJSON(overviewReport, path, OVERVIEW_FILE_NAME);
 

+ 2 - 0
core/src/main/java/de/jplag/reporting/reportobject/model/OverviewReport.java

@@ -8,6 +8,8 @@ import com.fasterxml.jackson.annotation.JsonProperty;
 
 public record OverviewReport(
 
+        @JsonProperty("jplag_version") Version version,
+
         @JsonProperty("submission_folder_path") List<String> submissionFolderPath,
 
         @JsonProperty("base_code_folder_path") String baseCodeFolderPath,

+ 13 - 0
core/src/main/java/de/jplag/reporting/reportobject/model/Version.java

@@ -0,0 +1,13 @@
+package de.jplag.reporting.reportobject.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * This record represents a version number according to <a href="https://semver.org/">https://semver.org/</a>. This
+ * version number is used to compare generated result.zip files with the version of the report-viewer.
+ * @param major MAJOR version when you make incompatible API changes
+ * @param minor MINOR version when you add functionality in a backwards compatible manner
+ * @param patch PATCH version when you make backwards compatible bug fixes
+ */
+public record Version(@JsonProperty("major") int major, @JsonProperty("minor") int minor, @JsonProperty("patch") int patch) {
+}

+ 2 - 0
core/src/test/java/de/jplag/reporting/reportobject/mapper/ClusteringResultMapperTest.java

@@ -7,6 +7,7 @@ import static org.mockito.Mockito.when;
 import java.util.Arrays;
 import java.util.List;
 
+import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import de.jplag.JPlagResult;
@@ -18,6 +19,7 @@ public class ClusteringResultMapperTest {
     private final ClusteringResultMapper clusteringResultMapper = new ClusteringResultMapper(Submission::getName);
 
     @Test
+    @Disabled("Skipped for now because cluster serialization is deactivated.")
     public void test() {
         // given
         JPlagResult resultMock = mock(JPlagResult.class);

+ 1 - 0
report-viewer/package.json

@@ -4,6 +4,7 @@
   "private": true,
   "scripts": {
     "serve": "vue-cli-service serve",
+    "dev": "vue-cli-service serve",
     "build": "vue-cli-service build",
     "lint": "vue-cli-service lint"
   },

+ 1 - 1
report-viewer/src/components/FilesContainer.vue

@@ -58,7 +58,7 @@ export default defineComponent({
      * Matche of submission.
      */
     matches: {
-     type: Map<string,MatchInSingleFile>,
+     type: Map<string,MatchInSingleFile[]>,
       required: true,
     },
   },

+ 5 - 0
report-viewer/src/model/Version.ts

@@ -0,0 +1,5 @@
+export type Version = {
+    major: number,
+    minor: number,
+    patch: number
+}

+ 13 - 0
report-viewer/src/model/factories/ComparisonFactory.ts

@@ -21,6 +21,13 @@ export class ComparisonFactory {
     );
 
     const matches = json.matches as Array<Record<string, unknown>>;
+    
+    // TODO: Quick fix for issue #658, requires deeper insights to be resolved completely
+    matches.forEach((match: Record<string, unknown>) => {
+      match["file1"] = this.removePathFromFileName(match["file1"] as string ?? "");
+      match["file2"] = this.removePathFromFileName(match["file2"] as string ?? "");
+    })
+
     const colors = this.generateColorsForMatches(matches.length);
     const coloredMatches = matches.map((match, index) =>
       this.mapMatch(match, colors[index])
@@ -71,9 +78,11 @@ export class ComparisonFactory {
     matches.forEach((val) => {
       const name =
         index === 1 ? (val.firstFile as string) : (val.secondFile as string);
+
       if (!acc.get(name)) {
         acc.set(name, []);
       }
+
       if (index === 1) {
         const newVal: MatchInSingleFile = {
           start: val.startInFirst as number,
@@ -99,6 +108,10 @@ export class ComparisonFactory {
     return acc;
   }
 
+  private static removePathFromFileName(filePath: string): string {
+    return  filePath.substring(filePath.lastIndexOf("\\") + 1).substring(filePath.lastIndexOf("/") + 1);
+  }
+
   private static generateColorsForMatches(num: number): Array<string> {
     const colors = [];
     const hueDelta = Math.trunc(360 / num);

+ 21 - 0
report-viewer/src/model/factories/OverviewFactory.ts

@@ -3,10 +3,23 @@ import { Metric } from "../Metric";
 import { ComparisonListElement } from "../ComparisonListElement";
 import { Cluster } from "@/model/Cluster";
 import store from "@/store/store";
+import { Version } from "../Version";
 
 export class OverviewFactory {
 
+  // TODO: Find a better more visible position to store this
+  static reportViewerVersion: Version = {major: 4, minor: 0, patch: 0};
+
   static getOverview(json: Record<string, unknown>): Overview {
+    const versionField = json.jplag_version as Record<string, number>;
+    const jplagVersion: Version = {
+      major: versionField.major,
+      minor: versionField.minor,
+      patch: versionField.patch
+    }
+
+    OverviewFactory.compareVersions(jplagVersion, this.reportViewerVersion);
+
     const submissionFolder = json.submission_folder_path as Array<string>;
     const baseCodeFolder = "";
     const language = json.language as string;
@@ -68,6 +81,14 @@ export class OverviewFactory {
     );
   }
 
+  static compareVersions(jsonVersion: Version, reportViewerVersion: Version) {
+    if(jsonVersion.major !== reportViewerVersion.major ||
+       jsonVersion.minor !== reportViewerVersion.minor ||
+       jsonVersion.patch !== reportViewerVersion.patch) {
+        console.warn("The result's version tag does not fit the report viewer's version. Trying to read it anyhow but be careful.")
+       }
+  }
+
   private static  saveSubmissionsToComparisonNameMap(json: Record<string, unknown>){
     const submissionIdsToComparisonName =
     json.submission_ids_to_comparison_file_name as Map<

+ 1 - 0
report-viewer/vue.config.js

@@ -11,5 +11,6 @@ module.exports = defineConfig({
         chunks: "all",
       },
     },
+    devtool: 'source-map'
   },
 });