Add tests, Fix minor bugs, Apply refactorings #1491

CHANGELOG.md

@@ -9,6 +9,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 
 ### Added 🚀
 
+-   Download and upload Custom Configurations is now possible ([#1472](https://github.com/MaibornWolff/codecharta/issues/1472))
+    -   Open the Custom Configs menu in the toolbar on top of the map
+    -   Next to the `plus` Button you can see two new buttons: Upload and download.
+        -   Download: If you already have added Custom Configs you can download them by clicking the download button.
+            -   Custom Configs which are applicable for the currently selected map(s) will be downloaded as `.cc.config.json` files.
+        -   Upload: Click the upload button and specify your Custom Config file (`<file-name>.cc.config.json`)
+            -   Already existing Custom Configs will be skipped.
+            -   Different Custom Configs with same names will be renamed.
+            -   Another way to upload your Custom Configs is to upload a `.cc.json` file together with one or multiple `.cc.config.json` files using the default `Load .cc.json map` button in the upper left corner.
+    -   The Configs are stored to the local storage of your browser.
+        -   If a limit of `768KB` is exceeded you will see a warning when trying to add a new Custom Config.
+        -   You can click the displayed "download and purge" button to download/backup at least 6 months old Configs and then purge them from the local storage to make space for new ones.
+        -   If we cannot purge any Configs, you might have to do that by your own by deleting specific Configs manually.
+
 ### Changed
 
 ### Removed 🗑
@@ -17,6 +31,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 
 -   Re-enabled color selection for folders and on hover ([#1544](https://github.com/MaibornWolff/codecharta/pull/1544))
 -   Labels do not take delta height into account ([#1523](https://github.com/MaibornWolff/codecharta/issues/1523))
+-   The calculation of the map resolution scale factor was wrong ([#1491](https://github.com/MaibornWolff/codecharta/issues/1491))
+    -   The factor is used to decrease the map resolution especially for big maps to avoid performance issues.
+    -   Now only the selected maps will be considered for the calculation. Unselected maps will be skipped.
 
 ### Chore 👨‍💻 👩‍💻
 

visualization/app/codeCharta/ui/codeMap/codeMap.render.service.ts

@@ -8,30 +8,6 @@ import { CodeMapArrowService } from "./codeMap.arrow.service"
 import { CodeMapNode, Node } from "../../codeCharta.model"
 import { StoreService } from "../../state/store.service"
 import { isDeltaState } from "../../model/files/files.helper"
-import { FileState } from "../../model/files/files"
-
-const ONE_MB = 1024 * 1024
-
-export enum MAP_RESOLUTION_SCALE {
-	SMALL_MAP = 1,
-	MEDIUM_MAP = 0.5,
-	BIG_MAP = 0.25
-}
-export function getMapResolutionScaleFactor(files: FileState[]) {
-	let totalFileSize = 0
-	for (const file of files) {
-		totalFileSize += file.file.fileMeta.exportedFileSize
-	}
-
-	switch (true) {
-		case totalFileSize >= 7 * ONE_MB:
-			return 0.25
-		case totalFileSize >= 2 * ONE_MB:
-			return 0.5
-		default:
-			return 1
-	}
-}
 
 export class CodeMapRenderService {
 	constructor(

visualization/app/codeCharta/ui/codeMap/rendering/geometryGenerator.ts

@@ -16,7 +16,7 @@ import {
 	RepeatWrapping,
 	DoubleSide
 } from "three"
-import { getMapResolutionScaleFactor, MAP_RESOLUTION_SCALE } from "../codeMap.render.service"
+import { getMapResolutionScaleFactor, MAP_RESOLUTION_SCALE } from "../../../util/codeMapHelper"
 
 export interface BoxMeasures {
 	x: number

visualization/app/codeCharta/ui/fileChooser/fileChooser.component.spec.ts

@@ -74,41 +74,45 @@ describe("fileChooserController", () => {
 
 			const file1 = {
 				name: "invalid.and.missing.md5.checksum.cc.json",
-				size: 42
+				size: 43
 			} as File
 
 			const file2 = {
 				name: "invalid.and.empty.md5.checksum.cc.json",
-				size: 42
+				size: 44
 			} as File
 
 			const file3 = {
 				name: "invalid.and.nulled.md5.checksum.cc.json",
-				size: 42
+				size: 45
 			} as File
 
 			fileChooserController["addNameDataPair"](file0, '{"fileChecksum":"invalid-but-present-md5-checksum"}')
 
 			expect(fileChooserController["files"].length).toBe(1)
 			expect(fileChooserController["files"][0].fileName).toBe("invalid.with.md5.checksum.cc.json")
+			expect(fileChooserController["files"][0].fileSize).toBe(42)
 			expect(fileChooserController["files"][0].content.fileChecksum).toBe("invalid-but-present-md5-checksum")
 
 			fileChooserController["addNameDataPair"](file1, "{}")
 
 			expect(fileChooserController["files"].length).toBe(2)
 			expect(fileChooserController["files"][1].fileName).toBe("invalid.and.missing.md5.checksum.cc.json")
+			expect(fileChooserController["files"][1].fileSize).toBe(43)
 			expect(fileChooserController["files"][1].content.fileChecksum).toBe("99914b932bd37a50b983c5e7c90ae93b")
 
 			fileChooserController["addNameDataPair"](file2, '{"fileChecksum":""}')
 
 			expect(fileChooserController["files"].length).toBe(3)
 			expect(fileChooserController["files"][2].fileName).toBe("invalid.and.empty.md5.checksum.cc.json")
+			expect(fileChooserController["files"][2].fileSize).toBe(44)
 			expect(fileChooserController["files"][2].content.fileChecksum).toBe("21a6f66227ae28300d656b8107765e7f")
 
 			fileChooserController["addNameDataPair"](file3, '{"fileChecksum":null}')
 
 			expect(fileChooserController["files"].length).toBe(4)
 			expect(fileChooserController["files"][3].fileName).toBe("invalid.and.nulled.md5.checksum.cc.json")
+			expect(fileChooserController["files"][3].fileSize).toBe(45)
 			expect(fileChooserController["files"][3].content.fileChecksum).toBe("44f0fdb79d97053b25dce38611c117f0")
 		})
 	})

visualization/app/codeCharta/util/__snapshots__/aggregationGenerator.spec.ts.snap

@@ -4,7 +4,7 @@ exports[`AggregationGenerator multipleService aggregation of four maps 1`] = `
 Object {
   "fileMeta": Object {
     "apiVersion": "1.2",
-    "exportedFileSize": 1800000,
+    "exportedFileSize": 1200000,
     "fileChecksum": "md5-file1;md5-file2;md5-file1;md5-file2;md5-file1;md5-file2",
     "fileName": "file_aggregation_of_file1_and_file2_and_file1_and_file2",
     "projectName": "project_aggregation_of_Sample_Project_and_Sample_Project_and_Sample_Project_and_Sample_Project",

visualization/app/codeCharta/util/aggregationGenerator.ts

@@ -106,5 +106,6 @@ export class AggregationGenerator {
 	private static resetVariables() {
 		this.projectNameArray = []
 		this.fileNameArray = []
+		this.fileSizesSum = 0
 	}
 }

visualization/app/codeCharta/util/codeMapHelper.spec.ts

@@ -0,0 +1,137 @@
+import { CCFile } from "../codeCharta.model"
+import packageJson from "../../../package.json"
+import { getMapResolutionScaleFactor, MAP_RESOLUTION_SCALE } from "./codeMapHelper"
+import { FileSelectionState, FileState } from "../model/files/files"
+
+describe("CodeMapHelper", () => {
+	describe("getMapResolutionScaleFactor", () => {
+		it("should get map resolution scale factor SMALL for a single and multiple maps", () => {
+			const smallFile1 = {
+				fileMeta: {
+					fileName: "file1",
+					fileChecksum: "invalid-md5-checksum-1",
+					projectName: "Sample Project",
+					apiVersion: packageJson.codecharta.apiVersion,
+					exportedFileSize: 1024 // 1MB
+				}
+			} as CCFile
+
+			const smallFile2 = {
+				fileMeta: {
+					fileName: "file1",
+					fileChecksum: "invalid-md5-checksum-1",
+					projectName: "Sample Project",
+					apiVersion: packageJson.codecharta.apiVersion,
+					exportedFileSize: 1023 * 1024 // nearly 1 MB
+				}
+			} as CCFile
+
+			const fileStateSingle: FileState[] = [{ file: smallFile1, selectedAs: FileSelectionState.Single }]
+
+			expect(getMapResolutionScaleFactor(fileStateSingle)).toBe(MAP_RESOLUTION_SCALE.SMALL_MAP)
+
+			const fileStateMultiple: FileState[] = [
+				{
+					file: smallFile1,
+					selectedAs: FileSelectionState.Partial
+				},
+				{
+					file: smallFile2,
+					selectedAs: FileSelectionState.Partial
+				}
+			]
+
+			expect(getMapResolutionScaleFactor(fileStateMultiple)).toBe(MAP_RESOLUTION_SCALE.SMALL_MAP)
+		})
+
+		it("should get map resolution scale factor MEDIUM for a single map", () => {
+			const oneMBFile = {
+				fileMeta: {
+					fileName: "file1",
+					fileChecksum: "invalid-md5-checksum-1",
+					projectName: "Sample Project",
+					apiVersion: packageJson.codecharta.apiVersion,
+					exportedFileSize: 2048 * 1024 // 2MB
+				}
+			} as CCFile
+
+			const fileStateSingle: FileState[] = [{ file: oneMBFile, selectedAs: FileSelectionState.Single }]
+
+			expect(getMapResolutionScaleFactor(fileStateSingle)).toBe(MAP_RESOLUTION_SCALE.MEDIUM_MAP)
+		})
+
+		it("should get map resolution scale factor MEDIUM for multiple maps", () => {
+			const almostOneMBFile = {
+				fileMeta: {
+					fileName: "file1",
+					fileChecksum: "invalid-md5-checksum-1",
+					projectName: "Sample Project",
+					apiVersion: packageJson.codecharta.apiVersion,
+					exportedFileSize: 1023 * 1024 // nearly one MB
+				}
+			} as CCFile
+
+			const sixMBFile = {
+				fileMeta: {
+					fileName: "file1",
+					fileChecksum: "invalid-md5-checksum-1",
+					projectName: "Sample Project",
+					apiVersion: packageJson.codecharta.apiVersion,
+					exportedFileSize: 1024 * 1024 * 6 // 6MB
+				}
+			} as CCFile
+
+			const fileStateMultiple: FileState[] = [
+				{ file: almostOneMBFile, selectedAs: FileSelectionState.Partial },
+				{ file: sixMBFile, selectedAs: FileSelectionState.Partial }
+			]
+
+			expect(getMapResolutionScaleFactor(fileStateMultiple)).toBe(MAP_RESOLUTION_SCALE.MEDIUM_MAP)
+		})
+
+		it("should get map resolution scale factor BIG for single map", () => {
+			const bigFile1 = {
+				fileMeta: {
+					fileName: "file1",
+					fileChecksum: "invalid-md5-checksum-1",
+					projectName: "Sample Project",
+					apiVersion: packageJson.codecharta.apiVersion,
+					exportedFileSize: 1024 * 1024 * 20 // 20MB
+				}
+			} as CCFile
+
+			const fileStateSingle: FileState[] = [{ file: bigFile1, selectedAs: FileSelectionState.Partial }]
+
+			expect(getMapResolutionScaleFactor(fileStateSingle)).toBe(MAP_RESOLUTION_SCALE.BIG_MAP)
+		})
+
+		it("should get map resolution scale factor BIG for multiple maps", () => {
+			const fiveMBFile = {
+				fileMeta: {
+					fileName: "file1",
+					fileChecksum: "invalid-md5-checksum-1",
+					projectName: "Sample Project",
+					apiVersion: packageJson.codecharta.apiVersion,
+					exportedFileSize: 1024 * 1024 * 5 // 5MB
+				}
+			} as CCFile
+
+			const twoMBFile = {
+				fileMeta: {
+					fileName: "file1",
+					fileChecksum: "invalid-md5-checksum-1",
+					projectName: "Sample Project",
+					apiVersion: packageJson.codecharta.apiVersion,
+					exportedFileSize: 1024 * 1024 * 2 // 2MB
+				}
+			} as CCFile
+
+			const fileStateMultiple: FileState[] = [
+				{ file: fiveMBFile, selectedAs: FileSelectionState.Partial },
+				{ file: twoMBFile, selectedAs: FileSelectionState.Partial }
+			]
+
+			expect(getMapResolutionScaleFactor(fileStateMultiple)).toBe(MAP_RESOLUTION_SCALE.BIG_MAP)
+		})
+	})
+})

visualization/app/codeCharta/util/codeMapHelper.ts

@@ -1,6 +1,8 @@
 import { hierarchy, HierarchyNode } from "d3-hierarchy"
 import { BlacklistItem, BlacklistType, CodeMapNode, MarkedPackage } from "../codeCharta.model"
 import ignore from "ignore"
+import { FileState } from "../model/files/files"
+import { getSelectedFilesSize } from "./fileHelper"
 
 export function getAnyCodeMapNodeFromPath(path: string, root: CodeMapNode) {
 	const matchingNode = hierarchy(root).find(({ data }) => data.path === path)
@@ -110,3 +112,23 @@ export function isBlacklisted(node: CodeMapNode) {
 export function isLeaf(node: CodeMapNode | HierarchyNode<unknown>) {
 	return node.children === undefined || node.children.length === 0
 }
+
+export enum MAP_RESOLUTION_SCALE {
+	SMALL_MAP = 1,
+	MEDIUM_MAP = 0.5,
+	BIG_MAP = 0.25
+}
+
+export function getMapResolutionScaleFactor(files: FileState[]) {
+	const oneMB = 1024 * 1024
+	const totalFilesSizeKB = getSelectedFilesSize(files)
+
+	switch (true) {
+		case totalFilesSizeKB >= 7 * oneMB:
+			return MAP_RESOLUTION_SCALE.BIG_MAP
+		case totalFilesSizeKB >= 2 * oneMB:
+			return MAP_RESOLUTION_SCALE.MEDIUM_MAP
+		default:
+			return MAP_RESOLUTION_SCALE.SMALL_MAP
+	}
+}

visualization/app/codeCharta/util/deltaGenerator.spec.ts

@@ -89,6 +89,15 @@ describe("deltaGenerator", () => {
 		expect(result.map).toMatchSnapshot()
 	})
 
+	it("should sum the size of the comparison and reference File", () => {
+		NodeDecorator.decorateMapWithPathAttribute(fileA)
+		NodeDecorator.decorateMapWithPathAttribute(fileB)
+
+		const result = DeltaGenerator.getDeltaFile(fileA, fileB)
+
+		expect(result.fileMeta.exportedFileSize).toBe(fileA.fileMeta.exportedFileSize + fileB.fileMeta.exportedFileSize)
+	})
+
 	it("checking delta calculation between two attribute lists", () => {
 		const a = { a: 100, b: 10, c: 1 }
 		const b = { a: 110, b: 11, c: 0 }

visualization/app/codeCharta/util/fileHelper.spec.ts

@@ -1,8 +1,10 @@
 import { ExportBlacklistType, ExportCCFile } from "../codeCharta.api.model"
-import { AttributeTypeValue, BlacklistType, NameDataPair } from "../codeCharta.model"
-import { getCCFile } from "./fileHelper"
+import { AttributeTypeValue, BlacklistType, CCFile, NameDataPair } from "../codeCharta.model"
+import { getCCFile, getSelectedFilesSize } from "./fileHelper"
 import { TEST_FILE_CONTENT } from "./dataMocks"
 import { clone } from "./clone"
+import { FileSelectionState, FileState } from "../model/files/files"
+import packageJson from "../../../package.json"
 
 describe("FileHelper", () => {
 	let fileContent: ExportCCFile
@@ -58,4 +60,55 @@ describe("FileHelper", () => {
 			expect(result.settings.fileSettings.attributeTypes).toEqual({ nodes: {}, edges: {} })
 		})
 	})
+
+	describe("getSelectedFilesSize", () => {
+		it("should sum up sizes of selected files", () => {
+			const file1 = {
+				fileMeta: {
+					fileName: "file1",
+					fileChecksum: "invalid-md5-checksum-1",
+					projectName: "Sample Project",
+					apiVersion: packageJson.codecharta.apiVersion,
+					exportedFileSize: 10
+				}
+			} as CCFile
+
+			const file2 = {
+				fileMeta: {
+					fileName: "file2",
+					fileChecksum: "invalid-md5-checksum-2",
+					projectName: "Sample Project",
+					apiVersion: packageJson.codecharta.apiVersion,
+					exportedFileSize: 10
+				}
+			} as CCFile
+
+			const unselectedFile = {
+				fileMeta: {
+					fileName: "unselectedFile",
+					fileChecksum: "invalid-md5-checksum-3",
+					projectName: "Sample Project",
+					apiVersion: packageJson.codecharta.apiVersion,
+					exportedFileSize: 10
+				}
+			} as CCFile
+
+			const severalFiles: FileState[] = [
+				{
+					file: file1,
+					selectedAs: FileSelectionState.Partial
+				},
+				{
+					file: file2,
+					selectedAs: FileSelectionState.Comparison
+				},
+				{
+					file: unselectedFile,
+					selectedAs: FileSelectionState.None
+				}
+			]
+
+			expect(getSelectedFilesSize(severalFiles)).toBe(20)
+		})
+	})
 })