Refactor/2318/migrate node serach service

CHANGELOG.md

@@ -5,7 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/)
 
-## [unreleased] (Added 🚀 | Changed | Removed 🗑 | Fixed 🐞 | Chore 👨‍💻 👩‍💻)
+## [unreleased] (Added 🚀 | Changed | Deprecated | Removed 🗑 | Fixed 🐞 | Security)
+
+### Changed
+
+-   Chore: Remove `nodeSearch.service.ts` and `searchedNodePaths` from store as they can be derived from `searchPattern`.
 
 ## [1.83.1] - 2021-11-10
 

visualization/app/codeCharta/codeCharta.model.ts

@@ -121,7 +121,6 @@ export interface DynamicSettings {
 	distributionMetric: string
 	edgeMetric: string
 	focusedNodePath: string
-	searchedNodePaths: Set<string>
 	searchPattern: string
 	margin: number
 	colorRange: ColorRange

visualization/app/codeCharta/state/injector.service.ts

@@ -44,7 +44,6 @@ import { DistributionMetricService } from "./store/dynamicSettings/distributionM
 import { ColorMetricService } from "./store/dynamicSettings/colorMetric/colorMetric.service"
 import { AreaMetricService } from "./store/dynamicSettings/areaMetric/areaMetric.service"
 import { BlacklistService } from "./store/fileSettings/blacklist/blacklist.service"
-import { NodeSearchService } from "./nodeSearch.service"
 import { IsPresentationModeService } from "./store/appSettings/isPresentationMode/isPresentationMode.service"
 import { MetricDataService } from "./store/metricData/metricData.service"
 import { ExperimentalFeaturesEnabledService } from "./store/appSettings/enableExperimentalFeatures/experimentalFeaturesEnabled.service"
@@ -100,7 +99,6 @@ export class InjectorService {
 		private colorMetricService: ColorMetricService,
 		private areaMetricService: AreaMetricService,
 		private blacklistService: BlacklistService,
-		private nodeSearchService: NodeSearchService,
 		private isPresentationModeService: IsPresentationModeService,
 		private layoutAlgorithmService: LayoutAlgorithmService,
 		private maxTreeMapFilesService: MaxTreeMapFilesService,

visualization/app/codeCharta/state/selectors/searchedNodes/getNodesByGitignorePath.spec.ts

@@ -0,0 +1,82 @@
+import { TEST_FILE_WITH_PATHS } from "../../../util/dataMocks"
+import { getNodesByGitignorePath } from "./getNodesByGitignorePath"
+
+describe("getNodesByGitignorePath", () => {
+	it("should retrieve no nodes for an empty search", () => {
+		const searchedNodes = getNodesByGitignorePath(TEST_FILE_WITH_PATHS.map, "")
+
+		expect(searchedNodes.length).toBe(0)
+	})
+
+	it("should retrieve no nodes if searched within nothing", () => {
+		const searchedNodes = getNodesByGitignorePath(undefined, "")
+
+		expect(searchedNodes.length).toBe(0)
+	})
+
+	it("should find nodes based on a wildcard search", () => {
+		const searchedNodes = getNodesByGitignorePath(TEST_FILE_WITH_PATHS.map, "*small*")
+
+		expect(searchedNodes.length).toBe(2)
+		expect(searchedNodes[0].path).toBe("/root/Parent Leaf/small leaf")
+		expect(searchedNodes[1].path).toBe("/root/Parent Leaf/other small leaf")
+	})
+
+	it("should find nodes based on string search", () => {
+		const searchedNodes = getNodesByGitignorePath(TEST_FILE_WITH_PATHS.map, "small")
+
+		expect(searchedNodes.length).toBe(2)
+		expect(searchedNodes[0].path).toBe("/root/Parent Leaf/small leaf")
+		expect(searchedNodes[1].path).toBe("/root/Parent Leaf/other small leaf")
+	})
+
+	it("should find no nodes based on prefix search with non existing prefix", () => {
+		const searchedNodes = getNodesByGitignorePath(TEST_FILE_WITH_PATHS.map, "oot/*")
+
+		expect(searchedNodes.length).toBe(0)
+	})
+
+	it("should find all nodes based on prefix search with prefix of root node", () => {
+		const searchedNodes = getNodesByGitignorePath(TEST_FILE_WITH_PATHS.map, "root*")
+
+		expect(searchedNodes.length).toBe(6)
+	})
+
+	it("should find nodes based on exact match", () => {
+		const searchedNodes = getNodesByGitignorePath(TEST_FILE_WITH_PATHS.map, '"/root/Parent Leaf"')
+
+		expect(searchedNodes.length).toBe(4)
+		expect(searchedNodes[0].path).toBe("/root/Parent Leaf")
+		expect(searchedNodes[1].path).toBe("/root/Parent Leaf/small leaf")
+		expect(searchedNodes[2].path).toBe("/root/Parent Leaf/other small leaf")
+		expect(searchedNodes[3].path).toBe("/root/Parent Leaf/empty folder")
+	})
+
+	it("should not ignore a leading whitespace with exact match", () => {
+		const searchedNodes = getNodesByGitignorePath(TEST_FILE_WITH_PATHS.map, '" /root/Parent Leaf"')
+
+		expect(searchedNodes.length).toBe(0)
+	})
+
+	it("should find nodes based on inverted search", () => {
+		const searchedNodes = getNodesByGitignorePath(TEST_FILE_WITH_PATHS.map, "!leaf")
+
+		expect(searchedNodes.length).toBe(1)
+		expect(searchedNodes[0].path).toBe("/root")
+	})
+
+	it("should find nodes based on multiple inverted search", () => {
+		const searchedNodes = getNodesByGitignorePath(TEST_FILE_WITH_PATHS.map, " \tsmall, \tbig")
+		expect(searchedNodes.length).toBe(3)
+		expect(searchedNodes[0].path).toBe("/root/big leaf")
+		expect(searchedNodes[1].path).toBe("/root/Parent Leaf/small leaf")
+		expect(searchedNodes[2].path).toBe("/root/Parent Leaf/other small leaf")
+
+		const invertedSearchedNodes = getNodesByGitignorePath(TEST_FILE_WITH_PATHS.map, "! \tsmall, \tbig")
+
+		expect(invertedSearchedNodes.length).toBe(3)
+		expect(invertedSearchedNodes[0].path).toBe("/root")
+		expect(invertedSearchedNodes[1].path).toBe("/root/Parent Leaf")
+		expect(invertedSearchedNodes[2].path).toBe("/root/Parent Leaf/empty folder")
+	})
+})

visualization/app/codeCharta/state/selectors/searchedNodes/getNodesByGitignorePath.ts

@@ -0,0 +1,19 @@
+import { hierarchy } from "d3-hierarchy"
+
+import { CodeMapNode } from "../../../codeCharta.model"
+import { returnIgnore, transformPath } from "../../../util/codeMapHelper"
+
+export function getNodesByGitignorePath(root: CodeMapNode, gitignorePath: string) {
+	gitignorePath = gitignorePath.trimStart()
+	if (gitignorePath.length === 0 || !root) {
+		return []
+	}
+	const ignoreResults = returnIgnore(gitignorePath)
+	const filtered = []
+	for (const { data } of hierarchy(root)) {
+		if (ignoreResults.ignoredNodePaths.ignores(transformPath(data.path)) === ignoreResults.condition) {
+			filtered.push(data)
+		}
+	}
+	return filtered
+}

visualization/app/codeCharta/state/selectors/searchedNodes/searchedNodePaths.selector.ts

@@ -0,0 +1,4 @@
+import { createSelector } from "../../angular-redux/store"
+import { searchedNodesSelector } from "./searchedNodes.selector"
+
+export const searchedNodePathsSelector = createSelector([searchedNodesSelector], searchedNodes => new Set(searchedNodes.map(x => x.path)))

visualization/app/codeCharta/state/selectors/searchedNodes/searchedNodes.selector.ts

@@ -0,0 +1,8 @@
+import { createSelector } from "../../angular-redux/store"
+import { getNodesByGitignorePath } from "./getNodesByGitignorePath"
+import { unifiedMapNodeSelector } from "../accumulatedData/unifiedMapNode.selector"
+import { searchPatternSelector } from "../../store/dynamicSettings/searchPattern/searchPattern.selector"
+
+export const searchedNodesSelector = createSelector([unifiedMapNodeSelector, searchPatternSelector], (unifiedMapNode, searchPattern) =>
+	getNodesByGitignorePath(unifiedMapNode, searchPattern)
+)

visualization/app/codeCharta/state/state.module.ts

@@ -44,7 +44,6 @@ import { AreaMetricService } from "./store/dynamicSettings/areaMetric/areaMetric
 import { BlacklistService } from "./store/fileSettings/blacklist/blacklist.service"
 import { InjectorService } from "./injector.service"
 import { StoreService } from "./store.service"
-import { NodeSearchService } from "./nodeSearch.service"
 import "../codeCharta.module"
 import camelCase from "lodash.camelcase"
 import { IsPresentationModeService } from "./store/appSettings/isPresentationMode/isPresentationMode.service"
@@ -106,7 +105,6 @@ angular
 	.service(camelCase(BlacklistService.name), BlacklistService)
 	.service(camelCase(InjectorService.name), InjectorService)
 	.service(camelCase(StoreService.name), StoreService)
-	.service(camelCase(NodeSearchService.name), NodeSearchService)
 	.service(camelCase(LayoutAlgorithmService.name), LayoutAlgorithmService)
 	.service(camelCase(MaxTreeMapFilesService.name), MaxTreeMapFilesService)
 	.service(camelCase(SharpnessModeService.name), SharpnessModeService)

visualization/app/codeCharta/state/store/dynamicSettings/dynamicSettings.actions.ts

@@ -12,7 +12,6 @@ import { defaultEdgeMetric } from "./edgeMetric/edgeMetric.actions"
 import { defaultFocusedNodePath } from "./focusedNodePath/focusedNodePath.actions"
 import { defaultHeightMetric } from "./heightMetric/heightMetric.actions"
 import { defaultMargin } from "./margin/margin.actions"
-import { defaultSearchedNodePaths } from "./searchedNodePaths/searchedNodePaths.actions"
 import { defaultSearchPattern } from "./searchPattern/searchPattern.actions"
 
 export enum DynamicSettingsActions {
@@ -44,7 +43,6 @@ export const defaultDynamicSettings: DynamicSettings = {
 	distributionMetric: defaultDistributionMetric,
 	edgeMetric: defaultEdgeMetric,
 	focusedNodePath: defaultFocusedNodePath,
-	searchedNodePaths: defaultSearchedNodePaths,
 	searchPattern: defaultSearchPattern,
 	margin: defaultMargin,
 	colorRange: defaultColorRange

visualization/app/codeCharta/state/store/dynamicSettings/dynamicSettings.reducer.ts

@@ -6,7 +6,6 @@ import { edgeMetric } from "./edgeMetric/edgeMetric.reducer"
 import { colorRange } from "./colorRange/colorRange.reducer"
 import { margin } from "./margin/margin.reducer"
 import { searchPattern } from "./searchPattern/searchPattern.reducer"
-import { searchedNodePaths } from "./searchedNodePaths/searchedNodePaths.reducer"
 import { focusedNodePath } from "./focusedNodePath/focusedNodePath.reducer"
 import { heightMetric } from "./heightMetric/heightMetric.reducer"
 import { distributionMetric } from "./distributionMetric/distributionMetric.reducer"
@@ -23,7 +22,6 @@ const dynamicSettings = combineReducers({
 	colorRange,
 	margin,
 	searchPattern,
-	searchedNodePaths,
 	focusedNodePath,
 	heightMetric,
 	distributionMetric,