codecharta-visualization 1.119.1 → 1.120.0

package/app/codeCharta/util/fileDownloader.ts

@@ -1,124 +0,0 @@
-import {
-	AttributeDescriptors,
-	AttributeTypes,
-	BlacklistItem,
-	BlacklistType,
-	CodeMapNode,
-	Edge,
-	FileMeta,
-	FileSettings,
-	NodeType
-} from "../codeCharta.model"
-import { LoadFileService } from "../services/loadFile/loadFile.service"
-import { ExportCCFile } from "../codeCharta.api.model"
-import { hierarchy } from "d3-hierarchy"
-import { clone } from "./clone"
-import { UNARY_METRIC } from "../state/selectors/accumulatedData/metricData/nodeMetricData.calculator"
-
-export type DownloadableSetting = "Nodes" | "AttributeTypes" | "AttributeDescriptors" | "Edges" | "Excludes" | "Flattens" | "MarkedPackages"
-
-export class FileDownloader {
-	static downloadCurrentMap(
-		map: CodeMapNode,
-		fileMeta: FileMeta,
-		fileSettings: FileSettings,
-		downloadSettings: DownloadableSetting[],
-		fileName: string
-	) {
-		const exportCCFile = this.getProjectDataAsCCJsonFormat(map, fileMeta, fileSettings, downloadSettings)
-		const newFileNameWithExtension = fileName + LoadFileService.CC_FILE_EXTENSION
-		this.downloadData(JSON.stringify(exportCCFile), newFileNameWithExtension)
-	}
-
-	private static getProjectDataAsCCJsonFormat(
-		map: CodeMapNode,
-		fileMeta: FileMeta,
-		fileSettings: FileSettings,
-		downloadSettings: DownloadableSetting[]
-	): ExportCCFile {
-		return {
-			projectName: fileMeta.projectName,
-			apiVersion: fileMeta.apiVersion,
-			fileChecksum: fileMeta.fileChecksum,
-			nodes: [this.undecorateMap(map)],
-			attributeTypes: downloadSettings.includes("AttributeTypes") ? this.getAttributeTypesForJSON(fileSettings.attributeTypes) : {},
-			attributeDescriptors: downloadSettings.includes("AttributeDescriptors")
-				? this.getAttributeDescriptorsForJSON(fileSettings.attributeDescriptors)
-				: {},
-			edges: downloadSettings.includes("Edges") ? this.undecorateEdges(fileSettings.edges) : [],
-			markedPackages: downloadSettings.includes("MarkedPackages") ? fileSettings.markedPackages : [],
-			blacklist: this.getBlacklistToDownload(downloadSettings, fileSettings.blacklist)
-		}
-	}
-
-	private static getBlacklistToDownload(downloadSettings: DownloadableSetting[], blacklist: BlacklistItem[]) {
-		const mergedBlacklist = []
-
-		if (downloadSettings.includes("Flattens")) {
-			mergedBlacklist.push(
-				...this.getFilteredBlacklist(blacklist, "flatten").map(x => {
-					return { path: x.path, type: "hide" }
-				})
-			)
-		}
-
-		if (downloadSettings.includes("Excludes")) {
-			mergedBlacklist.push(...this.getFilteredBlacklist(blacklist, "exclude"))
-		}
-		return mergedBlacklist
-	}
-
-	private static getAttributeTypesForJSON(attributeTypes: AttributeTypes) {
-		if (Object.keys(attributeTypes.edges).length === 0 && Object.keys(attributeTypes.nodes).length === 0) {
-			return {}
-		}
-		return attributeTypes
-	}
-
-	private static getAttributeDescriptorsForJSON(attributeDescriptors: AttributeDescriptors) {
-		if (Object.keys(attributeDescriptors).length === 0) {
-			return {}
-		}
-		return attributeDescriptors
-	}
-
-	private static getFilteredBlacklist(blacklist: BlacklistItem[], type: BlacklistType) {
-		return blacklist.filter(x => x.type === type)
-	}
-
-	private static undecorateMap(map: CodeMapNode) {
-		const copy = clone(map)
-		for (const { data } of hierarchy(copy)) {
-			delete data.isExcluded
-			delete data.isFlattened
-			delete data.edgeAttributes
-			delete data.path
-			if (data.type === NodeType.FOLDER) {
-				data.attributes = {}
-			} else {
-				delete data.attributes[UNARY_METRIC]
-			}
-		}
-		return copy
-	}
-
-	private static undecorateEdges(edges: Edge[]) {
-		const copy = clone(edges)
-		for (const edge of copy) {
-			delete edge.visible
-		}
-		return copy
-	}
-
-	static downloadData(data: string, fileName: string) {
-		const blob = new Blob([data], { type: "text/json" })
-		const mouseEvent = document.createEvent("MouseEvents")
-		const link = document.createElement("a")
-
-		link.download = fileName
-		link.href = window.URL.createObjectURL(blob)
-		link.dataset.downloadurl = ["text/json", link.download, link.href].join(":")
-		mouseEvent.initMouseEvent("click", true, false, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null)
-		link.dispatchEvent(mouseEvent)
-	}
-}

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

@@ -1,207 +0,0 @@
-import { ExportBlacklistType, ExportCCFile } from "../codeCharta.api.model"
-import { AttributeTypeValue, CCFile, NameDataPair } from "../codeCharta.model"
-import { getCCFile, getCCFileAndDecorateFileChecksum, getSelectedFilesSize } from "./fileHelper"
-import { TEST_ATTRIBUTE_DESCRIPTORS_HALF_FILLED, TEST_FILE_CONTENT } from "./dataMocks"
-import { clone } from "./clone"
-import { FileSelectionState, FileState } from "../model/files/files"
-import packageJson from "../../../package.json"
-import md5 from "md5"
-
-describe("FileHelper", () => {
-	let fileContent: ExportCCFile
-
-	beforeEach(() => {
-		fileContent = clone(TEST_FILE_CONTENT)
-	})
-
-	describe("getCCFile", () => {
-		it("should build a CCFile", () => {
-			const nameDataPair: NameDataPair = { content: fileContent, fileName: "fileName", fileSize: 30 }
-			const result = getCCFile(nameDataPair)
-
-			expect(result).toMatchSnapshot()
-		})
-
-		it("should convert old blacklist type", () => {
-			fileContent.blacklist = [{ path: "foo", type: ExportBlacklistType.hide }]
-
-			const nameDataPair: NameDataPair = { content: fileContent, fileName: "fileName", fileSize: 30 }
-			const result = getCCFile(nameDataPair)
-
-			expect(result.settings.fileSettings.blacklist).toEqual([{ path: "foo", type: "flatten" }])
-		})
-
-		it("should ignore old attribute types", () => {
-			fileContent.attributeTypes = {
-				nodes: [{ mcc: AttributeTypeValue.absolute }],
-				edges: [{ pairingRate: AttributeTypeValue.relative }]
-			}
-
-			const nameDataPair: NameDataPair = { content: fileContent, fileName: "fileName", fileSize: 30 }
-			const result = getCCFile(nameDataPair)
-
-			expect(result.settings.fileSettings.attributeTypes).toEqual({ nodes: {}, edges: {} })
-		})
-
-		it("should return empty attributeTypes", () => {
-			fileContent.attributeTypes = {}
-
-			const nameDataPair: NameDataPair = { content: fileContent, fileName: "fileName", fileSize: 30 }
-			const result = getCCFile(nameDataPair)
-
-			expect(result.settings.fileSettings.attributeTypes).toEqual({ nodes: {}, edges: {} })
-		})
-
-		it("should return empty attributeTypes if the property doesn't exist", () => {
-			fileContent.attributeTypes = undefined
-
-			const nameDataPair: NameDataPair = { content: fileContent, fileName: "fileName", fileSize: 30 }
-			const result = getCCFile(nameDataPair)
-
-			expect(result.settings.fileSettings.attributeTypes).toEqual({ nodes: {}, edges: {} })
-		})
-
-		it("should return attributeTypes if nodes exist", () => {
-			fileContent.attributeTypes = {
-				nodes: { test: AttributeTypeValue.absolute },
-				edges: {}
-			}
-
-			const nameDataPair: NameDataPair = { content: fileContent, fileName: "fileName", fileSize: 30 }
-			const result = getCCFile(nameDataPair)
-
-			expect(result.settings.fileSettings.attributeTypes).toEqual({
-				nodes: { test: AttributeTypeValue.absolute },
-				edges: {}
-			})
-		})
-
-		it("should return attributeTypes if nodes exist", () => {
-			fileContent.attributeDescriptors = TEST_ATTRIBUTE_DESCRIPTORS_HALF_FILLED
-
-			const nameDataPair: NameDataPair = { content: fileContent, fileName: "fileName", fileSize: 30 }
-			const result = getCCFile(nameDataPair)
-
-			expect(result.settings.fileSettings.attributeDescriptors).toEqual(TEST_ATTRIBUTE_DESCRIPTORS_HALF_FILLED)
-		})
-	})
-
-	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)
-		})
-	})
-
-	describe("getCCFileAndDecorateFileChecksum", () => {
-		it("should resolve a json string in version 1.3 and higher and decorate checksum", () => {
-			const expectedMD5 = md5('{"apiVersion":"1.3"}')
-			const ccFile = getCCFileAndDecorateFileChecksum('{"checksum":"","data":{"apiVersion":"1.3"}}')
-
-			expect(ccFile.apiVersion).toBe("1.3")
-			expect(ccFile.fileChecksum).toBe(expectedMD5)
-		})
-
-		it("should resolve a json string in version 1.3 and higher and does not decorate checksum", () => {
-			const ccFile = getCCFileAndDecorateFileChecksum('{"checksum":"fake-checksum","data":{"apiVersion":"1.3"}}')
-
-			expect(ccFile.apiVersion).toBe("1.3")
-			expect(ccFile.fileChecksum).toBe("fake-checksum")
-		})
-
-		it("should resolve a json string in version less than 1.3 and decorate checksum", () => {
-			const expectedMD5 = md5('{"apiVersion":"1.2"}')
-			const ccFile = getCCFileAndDecorateFileChecksum('{"apiVersion":"1.2"}')
-
-			expect(ccFile.apiVersion).toBe("1.2")
-			expect(ccFile.fileChecksum).toBe(expectedMD5)
-		})
-
-		it("should resolve a json string in version less than 1.3 and does not decorate checksum", () => {
-			const ccFile = getCCFileAndDecorateFileChecksum('{"fileChecksum":"fake-checksum","apiVersion":"1.2"}')
-
-			expect(ccFile.apiVersion).toBe("1.2")
-			expect(ccFile.fileChecksum).toBe("fake-checksum")
-		})
-
-		it("should resolve a json object in version 1.3 and higher and decorate checksum", () => {
-			const expectedMD5 = md5('{"apiVersion":"1.3"}')
-			const ccFile = getCCFileAndDecorateFileChecksum({ checksum: "", data: { apiVersion: "1.3" } as ExportCCFile })
-
-			expect(ccFile.apiVersion).toBe("1.3")
-			expect(ccFile.fileChecksum).toBe(expectedMD5)
-		})
-
-		it("should resolve a json object in version 1.3 and higher and does not decorate checksum", () => {
-			const ccFile = getCCFileAndDecorateFileChecksum({ checksum: "fake-checksum", data: { apiVersion: "1.3" } as ExportCCFile })
-
-			expect(ccFile.apiVersion).toBe("1.3")
-			expect(ccFile.fileChecksum).toBe("fake-checksum")
-		})
-
-		it("should resolve a json object in version less than 1.3 and decorate checksum", () => {
-			const expectedMD5 = md5('{"apiVersion":"1.2"}')
-			const ccFile = getCCFileAndDecorateFileChecksum({ apiVersion: "1.2" } as ExportCCFile)
-
-			expect(ccFile.apiVersion).toBe("1.2")
-			expect(ccFile.fileChecksum).toBe(expectedMD5)
-		})
-
-		it("should resolve a json object in version less than 1.2 and does not decorate checksum", () => {
-			const ccFile = getCCFileAndDecorateFileChecksum({ fileChecksum: "fake-checksum", apiVersion: "1.2" } as ExportCCFile)
-
-			expect(ccFile.apiVersion).toBe("1.2")
-			expect(ccFile.fileChecksum).toBe("fake-checksum")
-		})
-
-		it("should return null on invalid input data", () => {
-			const ccFile = getCCFileAndDecorateFileChecksum("broken json")
-
-			expect(ccFile).toBeNull()
-		})
-	})
-})

package/app/codeCharta/util/fileHelper.ts

@@ -1,95 +0,0 @@
-import { ExportBlacklistType, ExportCCFile, ExportWrappedCCFile, OldAttributeTypes } from "../codeCharta.api.model"
-import { AttributeDescriptors, AttributeTypes, BlacklistItem, CCFile, NameDataPair } from "../codeCharta.model"
-import { FileSelectionState, FileState } from "../model/files/files"
-import md5 from "md5"
-import { clone } from "./clone"
-
-export function getCCFile(file: NameDataPair): CCFile {
-	const fileContent = file.content
-	return {
-		fileMeta: {
-			fileName: file.fileName,
-			fileChecksum: fileContent.fileChecksum,
-			projectName: fileContent.projectName,
-			apiVersion: fileContent.apiVersion,
-			exportedFileSize: file.fileSize,
-			repoCreationDate: fileContent.repoCreationDate || ""
-		},
-		settings: {
-			fileSettings: {
-				edges: fileContent.edges || [],
-				attributeTypes: getAttributeTypes(fileContent.attributeTypes),
-				attributeDescriptors: getAttributeDescriptors(fileContent.attributeDescriptors),
-				blacklist: potentiallyUpdateBlacklistTypes(fileContent.blacklist || []),
-				markedPackages: fileContent.markedPackages || []
-			}
-		},
-		map: clone(fileContent.nodes[0])
-	}
-}
-
-function getAttributeTypes(attributeTypes: AttributeTypes | OldAttributeTypes): AttributeTypes {
-	if (!attributeTypes || Array.isArray(attributeTypes.nodes) || Array.isArray(attributeTypes.edges)) {
-		return {
-			nodes: {},
-			edges: {}
-		}
-	}
-
-	return {
-		nodes: attributeTypes.nodes ?? {},
-		edges: attributeTypes.edges ?? {}
-	}
-}
-
-function getAttributeDescriptors(attributeDescriptors: AttributeDescriptors): AttributeDescriptors {
-	return attributeDescriptors || {}
-}
-
-function potentiallyUpdateBlacklistTypes(blacklist): BlacklistItem[] {
-	for (const entry of blacklist) {
-		if (entry.type === ExportBlacklistType.hide) {
-			entry.type = "flatten"
-		}
-	}
-	return blacklist
-}
-
-export function getSelectedFilesSize(files: FileState[]) {
-	let totalFileSize = 0
-	for (const file of files) {
-		if (file.selectedAs !== FileSelectionState.None) {
-			totalFileSize += file.file.fileMeta.exportedFileSize
-		}
-	}
-
-	return totalFileSize
-}
-
-export function getCCFileAndDecorateFileChecksum(jsonInput: string | ExportWrappedCCFile | ExportCCFile): ExportCCFile | null {
-	let mappedFile: ExportCCFile = null
-
-	try {
-		const fileContent: ExportCCFile | ExportWrappedCCFile =
-			typeof jsonInput === "string"
-				? (JSON.parse(jsonInput) as ExportWrappedCCFile | ExportCCFile)
-				: (jsonInput as ExportWrappedCCFile | ExportCCFile)
-
-		if ("data" in fileContent && "checksum" in fileContent) {
-			mappedFile = fileContent.data
-			mappedFile.fileChecksum = fileContent.checksum || md5(JSON.stringify(fileContent.data))
-
-			return mappedFile
-		}
-
-		if (!fileContent.fileChecksum) {
-			const jsonInputString = typeof jsonInput === "string" ? jsonInput : JSON.stringify(jsonInput)
-			fileContent.fileChecksum = md5(jsonInputString)
-		}
-		return fileContent
-	} catch {
-		// Explicitly ignored
-	}
-
-	return mappedFile
-}

package/app/codeCharta/util/fileNameHelper.spec.ts

@@ -1,103 +0,0 @@
-import { FileNameHelper } from "./fileNameHelper"
-import { stubDate } from "../../../mocks/dateMock.helper"
-
-describe("FileNameHelper", () => {
-	stubDate(new Date(Date.UTC(2018, 11, 14, 9, 39)))
-	const newDate = "2018-12-14_09-39"
-
-	describe("getNewFileName", () => {
-		it("should not have multiple timestamps", () => {
-			const fileName = "foo_2019-04-22_18-01.cc.json"
-			const newFileName = `foo_${newDate}`
-
-			const result = FileNameHelper.getNewFileName(fileName, false)
-
-			expect(result).toEqual(newFileName)
-		})
-
-		it("should insert the valid date", () => {
-			const fileName = "prefix.name.suffix.cc.json"
-			const newFileName = `prefix.name.suffix_${newDate}`
-
-			const result = FileNameHelper.getNewFileName(fileName, false)
-
-			expect(result).toEqual(newFileName)
-		})
-
-		it("should insert the date and use .cc.json as ending instead of just .json", () => {
-			const fileName = "prefix.name.suffix.json"
-			const newFileName = `prefix.name.suffix_${newDate}`
-
-			const result = FileNameHelper.getNewFileName(fileName, false)
-
-			expect(result).toEqual(newFileName)
-		})
-
-		it("should replace the date with the valid one", () => {
-			const fileName = "prefix.name.suffix_2000-01-01_01-01.cc.json"
-			const newFileName = `prefix.name.suffix_${newDate}`
-
-			const result = FileNameHelper.getNewFileName(fileName, false)
-
-			expect(result).toEqual(newFileName)
-		})
-	})
-
-	describe("withoutCCExtension", () => {
-		it("should remove .cc.json", () => {
-			const fileName = "prefix.name.suffix.cc.json"
-
-			const actual = FileNameHelper.withoutCCExtension(fileName)
-
-			expect(actual).toBe("prefix.name.suffix")
-		})
-
-		it("should remove .json", () => {
-			const fileName = "prefix.name.suffix.json"
-
-			const actual = FileNameHelper.withoutCCExtension(fileName)
-
-			expect(actual).toBe("prefix.name.suffix")
-		})
-
-		it("should not remove .cc.json as part of a filename", () => {
-			const fileName = "prefix.name.cc.json.suffix.cc.json"
-
-			const actual = FileNameHelper.withoutCCExtension(fileName)
-
-			expect(actual).toBe("prefix.name.cc.json.suffix")
-		})
-
-		it("should remove .json extension once", () => {
-			const fileName = "prefix.name.cc.json.gz.json"
-
-			const actual = FileNameHelper.withoutCCExtension(fileName)
-
-			expect(actual).toBe("prefix.name.cc.json.gz")
-		})
-
-		it("should remove .cc.json extension once", () => {
-			const fileName = "prefix.name.cc.json.cc.json"
-
-			const actual = FileNameHelper.withoutCCExtension(fileName)
-
-			expect(actual).toBe("prefix.name.cc.json")
-		})
-
-		it("should remove .cc.json.gz extension once", () => {
-			const fileName = "prefix.name.cc.json.gz.cc.json.gz"
-
-			const actual = FileNameHelper.withoutCCExtension(fileName)
-
-			expect(actual).toBe("prefix.name.cc.json.gz")
-		})
-
-		it("should not remove any extensions that are not .cc.json.gz", () => {
-			const fileName = "prefix.name.something.txt.jsonl.tar"
-
-			const actual = FileNameHelper.withoutCCExtension(fileName)
-
-			expect(actual).toBe("prefix.name.something.txt.jsonl.tar")
-		})
-	})
-})

package/app/codeCharta/util/fileNameHelper.ts

@@ -1,40 +0,0 @@
-import { LoadFileService } from "../services/loadFile/loadFile.service"
-
-const dateRegex = /_\d{4}(?:-\d{1,2}){2}_\d{1,2}-\d{1,2}\./
-
-export class FileNameHelper {
-	private static JSON_EXTENSION = ".json"
-
-	static getNewFileName(fileName: string, isDeltaState: boolean) {
-		return `${this.getFileNameWithoutTimestamp(fileName, isDeltaState)}_${this.getNewTimestamp()}`
-	}
-
-	static getNewTimestamp() {
-		const date = new Date()
-		return FileNameHelper.getFormattedTimestamp(date)
-	}
-
-	static getFormattedTimestamp(date: Date) {
-		return date.toISOString().slice(0, 16).replace("T", "_").replace(":", "-")
-	}
-
-	private static getFileNameWithoutTimestamp(fileName: string, isDeltaState: boolean) {
-		if (!isDeltaState) {
-			const dateMatch = dateRegex.exec(fileName)
-			if (dateMatch) {
-				return fileName.slice(0, dateMatch.index)
-			}
-			if (fileName.endsWith(LoadFileService.CC_FILE_EXTENSION)) {
-				return fileName.slice(0, -LoadFileService.CC_FILE_EXTENSION.length)
-			}
-			if (fileName.endsWith(FileNameHelper.JSON_EXTENSION)) {
-				return fileName.slice(0, -FileNameHelper.JSON_EXTENSION.length)
-			}
-		}
-		return fileName
-	}
-
-	static withoutCCExtension(fileName: string) {
-		return fileName.replace(/(\.cc)?(\.json)?(\.gz)?$/, "")
-	}
-}