Skip to content

Enhance/version check #878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Feb 13, 2023
26 changes: 19 additions & 7 deletions report-viewer/src/model/factories/OverviewFactory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ import { ComparisonListElement } from "../ComparisonListElement";
import { Cluster } from "@/model/Cluster";
import store from "@/store/store";
import { Version } from "../Version";
import versionJson from "../../version.json";

export class OverviewFactory {

// TODO: Find a better more visible position to store this
static reportViewerVersion: Version = {major: 4, minor: 0, patch: 0};
static reportViewerVersion: Version = versionJson["report_viewer_version"] !== undefined ? versionJson["report_viewer_version"] : {major: -1, minor: -1, patch: -1};

static getOverview(json: Record<string, unknown>): Overview {
const versionField = json.jplag_version as Record<string, number>;
Expand Down Expand Up @@ -82,11 +82,23 @@ 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.")
}
if(sessionStorage.getItem("versionAlert")===null) {
if (jsonVersion.major !== reportViewerVersion.major ||
jsonVersion.minor !== reportViewerVersion.minor ||
jsonVersion.patch !== reportViewerVersion.patch) {
if(reportViewerVersion.major === -1 && reportViewerVersion.minor === -1 && reportViewerVersion.patch === -1){
console.warn("The report viewer's version cannot be read from version.json file. Please configure it correctly.");
}
if (jsonVersion.major === 0 && jsonVersion.minor === 0 && jsonVersion.patch === 0) {
alert("The development version(0.0.0) of JPlag is used.");
} else {
console.warn("The result's version tag does not fit the report viewer's version. Trying to read it anyhow but be careful.");
alert("The result's version(" + jsonVersion.major + "." + jsonVersion.minor + "." + jsonVersion.patch + ") tag does not fit the report viewer's version(" + reportViewerVersion.major + "." + reportViewerVersion.minor + "." + reportViewerVersion.patch + "). " +
"Trying to read it anyhow but be careful.")
}
}
sessionStorage.setItem("versionAlert","true");
}
}

private static saveSubmissionsToComparisonNameMap(json: Record<string, unknown>){
Expand Down
7 changes: 7 additions & 0 deletions report-viewer/src/version.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"report_viewer_version": {
"major": 0,
"minor": 0,
"patch": 0
}
}
3 changes: 2 additions & 1 deletion report-viewer/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
"dom",
"dom.iterable",
"scripthost"
]
],
"resolveJsonModule": true,
},
"include": [
"src/**/*.ts",
Expand Down