Skip to content

chore: makeParentDependedOnChildren optimisation only affected nodes in the graph is computed #36161

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.

Sign up for GitHub

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
vsvamsi1 merged 2 commits into from
Sep 11, 2024
Merged

chore: makeParentDependedOnChildren optimisation only affected nodes in the graph is computed #36161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1703b36
working makeParentsDependedOnChildren optimisation 90% reduction in l…
vsvamsi1 Sep 6, 2024
902f465
review comment fix
vsvamsi1 Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion app/client/src/entities/DependencyMap/DependencyMapUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export class DependencyMapUtils {
return { success: false, cyclicNode: node, error };
}
}

// this function links childNode to its parent as a dependency for the entire dependencyGraph
static makeParentsDependOnChildren(dependencyMap: DependencyMap) {
const dependencies = dependencyMap.rawDependencies;
for (const [node, deps] of dependencies.entries()) {
Expand All @@ -49,6 +49,25 @@ export class DependencyMapUtils {
return dependencyMap;
}

// this function links childNode to its parent as a dependency for only affectedNodes in the graph
static linkAffectedChildNodesToParent(
dependencyMap: DependencyMap,
affectedSet: Set<string>,
) {
const dependencies = dependencyMap.rawDependencies;
for (const [node, deps] of dependencies.entries()) {
if (affectedSet.has(node)) {
DependencyMapUtils.makeParentsDependOnChild(dependencyMap, node);
}
deps.forEach((dep) => {
if (affectedSet.has(dep)) {
DependencyMapUtils.makeParentsDependOnChild(dependencyMap, dep);
}
});
}
return dependencyMap;
}

static makeParentsDependOnChild = (
dependencyMap: DependencyMap,
child: string,
Expand Down
64 changes: 64 additions & 0 deletions app/client/src/entities/DependencyMap/__tests__/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2708,6 +2708,70 @@ describe("Tests for DependencyMapUtils", () => {
"Api1",
]);
}
describe("linkAffectedChildNodesToParent", () => {
const createSomeDependencyMap = () => {
const dependencyMap = new DependencyMap();
dependencyMap.addNodes({
tableWidget: true,
apiData: true,
"tableWidget.tableData": true,
"apiData.data": true,
"apiData.allData": true,
"apiData.allData.paginatedData": true,
});
dependencyMap.addDependency("tableWidget", ["tableWidget.tableData"]);
return dependencyMap;
};

test("should link child node to its parentNode as a dependant", () => {
const dependencyMap = createSomeDependencyMap();
dependencyMap.addDependency("tableWidget.tableData", ["apiData.data"]);
// although "apiData.data" was attached as a dependency to "tableWidget.tableData", it's parent "apiData" also needs to be linked to "apiData.data"
expect(dependencyMap.rawDependencies.get("apiData")).toEqual(undefined);
const affectedNodes = new Set(["apiData.data"]);
DependencyMapUtils.linkAffectedChildNodesToParent(
dependencyMap,
affectedNodes,
);
// after linkAffectedChildNodesToParent execution "apiData" does get linked to "apiData.data"
expect(dependencyMap.rawDependencies.get("apiData")).toEqual(
new Set(["apiData.data"]),
);
});
test("should not link child node to its parentNode as a dependant when the child node is not affected ", () => {
const dependencyMap = createSomeDependencyMap();
dependencyMap.addDependency("tableWidget.tableData", ["apiData.data"]);
// although "apiData.data" was attached as a dependency to "tableWidget.tableData", it's parent "apiData" also needs to be linked to "apiData.data"
expect(dependencyMap.rawDependencies.get("apiData")).toEqual(undefined);
const emptyAffectedNodes = new Set([]);
DependencyMapUtils.linkAffectedChildNodesToParent(
dependencyMap,
emptyAffectedNodes,
);
expect(dependencyMap.rawDependencies.get("apiData")).toEqual(undefined);
});

test("should link child node to its grand parent node as a dependant", () => {
const dependencyMap = createSomeDependencyMap();
dependencyMap.addDependency("tableWidget.tableData", [
"apiData.allData.paginatedData",
]);
expect(dependencyMap.rawDependencies.get("apiData")).toEqual(undefined);
const affectedNodes = new Set(["apiData.allData.paginatedData"]);

DependencyMapUtils.linkAffectedChildNodesToParent(
dependencyMap,
affectedNodes,
);
// after linkAffectedChildNodesToParent execution "apiData.allData.paginatedData" get linked to "apiData.data" and its parent "apiData.data" gets linked to "apiData"
expect(dependencyMap.getDirectDependencies("apiData")).toEqual([
"apiData.allData",
]);
expect(dependencyMap.getDirectDependencies("apiData.allData")).toEqual([
"apiData.allData.paginatedData",
]);
});
});
describe("makeParentsDependOnChild", () => {
const createSomeDependencyMap = () => {
const dependencyMap = new DependencyMap();
Expand Down
66 changes: 55 additions & 11 deletions app/client/src/workers/common/DependencyMap/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {
} from "ee/workers/Evaluation/Actions";
import { isWidgetActionOrJsObject } from "ee/entities/DataTree/utils";
import { getValidEntityType } from "workers/common/DataTreeEvaluator/utils";
import type DependencyMap from "entities/DependencyMap";

export function createDependencyMap(
dataTreeEvalRef: DataTreeEvaluator,
Expand Down Expand Up @@ -72,6 +73,30 @@ export function createDependencyMap(
inverseDependencies: dependencyMap.inverseDependencies,
};
}
const addingAffectedNodesToList = (
affectedNodes: Set<string>,
addedNodes: string[],
) => {
addedNodes.forEach((v) => affectedNodes.add(v));
};

const addNodesToDependencyMap =
(affectedNodes: Set<string>, dependencyMap: DependencyMap) =>
(addedNodes: Record<string, true>, strict?: boolean) => {
const didUpdateDep = dependencyMap.addNodes(addedNodes, strict);
if (didUpdateDep) {
addingAffectedNodesToList(affectedNodes, Object.keys(addedNodes));
}
return didUpdateDep;
};

const setDependenciesToDependencyMap =
(affectedNodes: Set<string>, dependencyMap: DependencyMap) =>
(node: string, dependencies: string[]) => {
dependencyMap.addDependency(node, dependencies);

addingAffectedNodesToList(affectedNodes, [node, ...dependencies]);
};

export const updateDependencyMap = ({
configTree,
Expand All @@ -91,7 +116,15 @@ export const updateDependencyMap = ({
const { allKeys, dependencyMap, oldConfigTree, oldUnEvalTree } =
dataTreeEvalRef;
let { errors: dataTreeEvalErrors } = dataTreeEvalRef;

const affectedNodes: Set<string> = new Set();
const addNodesToDepedencyMapFn = addNodesToDependencyMap(
affectedNodes,
dependencyMap,
);
const setDependenciesToDepedencyMapFn = setDependenciesToDependencyMap(
affectedNodes,
dependencyMap,
);
translatedDiffs.forEach((dataTreeDiff) => {
const {
event,
Expand All @@ -117,15 +150,18 @@ export const updateDependencyMap = ({
});
// If a new entity is added, add setter functions to all nodes
if (entityName === fullPropertyPath) {
const didUpdateDep = dependencyMap.addNodes(
getEntitySetterFunctions(entityConfig, entityName, entity),
const addedNodes = getEntitySetterFunctions(
entityConfig,
entityName,
entity,
);
if (didUpdateDep) didUpdateDependencyMap = true;
didUpdateDependencyMap =
addNodesToDepedencyMapFn(addedNodes) || didUpdateDependencyMap;
}

const didUpdateDep = dependencyMap.addNodes(allAddedPaths, false);

if (didUpdateDep) didUpdateDependencyMap = true;
didUpdateDependencyMap =
addNodesToDepedencyMapFn(allAddedPaths, false) ||
didUpdateDependencyMap;

if (isWidgetActionOrJsObject(entity)) {
if (!isDynamicLeaf(unEvalDataTree, fullPropertyPath, configTree)) {
Expand All @@ -141,7 +177,9 @@ export const updateDependencyMap = ({
([path, pathDependencies]) => {
const { errors: extractDependencyErrors, references } =
extractInfoFromBindings(pathDependencies, allKeys);
dependencyMap.addDependency(path, references);

setDependenciesToDepedencyMapFn(path, references);

didUpdateDependencyMap = true;
dataTreeEvalErrors = dataTreeEvalErrors.concat(
extractDependencyErrors,
Expand All @@ -158,7 +196,9 @@ export const updateDependencyMap = ({
);
const { errors: extractDependencyErrors, references } =
extractInfoFromBindings(entityPathDependencies, allKeys);
dependencyMap.addDependency(fullPropertyPath, references);

setDependenciesToDepedencyMapFn(fullPropertyPath, references);

didUpdateDependencyMap = true;
dataTreeEvalErrors = dataTreeEvalErrors.concat(
extractDependencyErrors,
Expand Down Expand Up @@ -218,7 +258,8 @@ export const updateDependencyMap = ({
);
const { errors: extractDependencyErrors, references } =
extractInfoFromBindings(entityPathDependencies, allKeys);
dependencyMap.addDependency(fullPropertyPath, references);
setDependenciesToDepedencyMapFn(fullPropertyPath, references);

didUpdateDependencyMap = true;
dataTreeEvalErrors = dataTreeEvalErrors.concat(
extractDependencyErrors,
Expand All @@ -237,7 +278,10 @@ export const updateDependencyMap = ({
const updateChangedDependenciesStart = performance.now();

if (didUpdateDependencyMap) {
DependencyMapUtils.makeParentsDependOnChildren(dependencyMap);
DependencyMapUtils.linkAffectedChildNodesToParent(
dependencyMap,
affectedNodes,
);
dataTreeEvalRef.sortedDependencies = dataTreeEvalRef.sortDependencies(
dependencyMap,
translatedDiffs,
Expand Down