Skip to content
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

Jump to bottom

Automatically remove unused nodes with side effects #2690

Merged
merged 1 commit into from
Mar 20, 2024
Merged

Automatically remove unused nodes with side effects #2690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
84 changes: 84 additions & 0 deletions src/common/nodes/optimize.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
import { Edge, Node } from 'reactflow';
import { EdgeData, NodeData } from '../common-types';
import { SchemaMap } from '../SchemaMap';
import { getEffectivelyDisabledNodes } from './disabled';
import { getNodesWithSideEffects } from './sideEffect';

const trimEdges = (
nodes: Iterable<Node<NodeData>>,
edges: readonly Edge<EdgeData>[]
): Edge<EdgeData>[] => {
const nodeIds = new Set<string>();
for (const n of nodes) {
nodeIds.add(n.id);
}

return edges.filter((e) => nodeIds.has(e.source) && nodeIds.has(e.target));
};

const removeUnusedSideEffectNodes = (
nodes: readonly Node<NodeData>[],
edges: readonly Edge<EdgeData>[],
schemata: SchemaMap
): Node<NodeData>[] => {
// eslint-disable-next-line no-param-reassign
edges = trimEdges(nodes, edges);

const connectedNodes = new Set([...edges.map((e) => e.source), ...edges.map((e) => e.target)]);

return nodes.filter((n) => {
if (connectedNodes.has(n.id)) {
// the node isn't unused
return true;
}

const schema = schemata.get(n.data.schemaId);
if (!schema.hasSideEffects) {
// we only care about nodes with side effects
return true;
}

// if all inputs don't require connections, that's fine too
const requireConnection = schema.inputs.some((i) => i.kind === 'generic' && !i.optional);
if (!requireConnection) {
return true;
}

// the is unused, has side effects, and requires connections
return false;
});
};

interface OptimizedChain {
nodes: Node<NodeData>[];
edges: Edge<EdgeData>[];
report: {
/** How many effectively disabled nodes were removed. */
removedDisabled: number;
/** How many side-effect-free nodes were removed. */
removedSideEffectFree: number;
};
}

export const optimizeChain = (
unoptimizedNodes: readonly Node<NodeData>[],
unoptimizedEdges: readonly Edge<EdgeData>[],
schemata: SchemaMap
): OptimizedChain => {
// remove disabled nodes
const disabledNodes = new Set(getEffectivelyDisabledNodes(unoptimizedNodes, unoptimizedEdges));
const enabledNodes = unoptimizedNodes.filter((n) => !disabledNodes.has(n));

// remove nodes without side effects
let withEffect = getNodesWithSideEffects(enabledNodes, unoptimizedEdges, schemata);
withEffect = removeUnusedSideEffectNodes(withEffect, unoptimizedEdges, schemata);

return {
nodes: withEffect,
edges: trimEdges(withEffect, unoptimizedEdges),
report: {
removedDisabled: disabledNodes.size,
removedSideEffectFree: enabledNodes.length - withEffect.length,
},
};
};
15 changes: 4 additions & 11 deletions src/main/cli/run.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@ import { applyOverrides, readOverrideFile } from '../../common/input-override';
import { log } from '../../common/log';
import { checkNodeValidity } from '../../common/nodes/checkNodeValidity';
import { getConnectedInputs } from '../../common/nodes/connectedInputs';
import { getEffectivelyDisabledNodes } from '../../common/nodes/disabled';
import { ChainLineage } from '../../common/nodes/lineage';
import { optimizeChain } from '../../common/nodes/optimize';
import { parseFunctionDefinitions } from '../../common/nodes/parseFunctionDefinitions';
import { getNodesWithSideEffects } from '../../common/nodes/sideEffect';
import { toBackendJson } from '../../common/nodes/toBackendJson';
import { TypeState } from '../../common/nodes/TypeState';
import { SaveFile } from '../../common/SaveFile';
Expand Down Expand Up @@ -214,20 +213,14 @@ export const runChainInCli = async (args: RunArguments) => {
applyOverrides(saveFile.nodes, saveFile.edges, schemata, overrideFile);
}

const disabledNodes = new Set(
getEffectivelyDisabledNodes(saveFile.nodes, saveFile.edges).map((n) => n.id)
);
const nodesToOptimize = saveFile.nodes.filter((n) => !disabledNodes.has(n.id));
const nodes = getNodesWithSideEffects(nodesToOptimize, saveFile.edges, schemata);
const nodesById = new Map(nodes.map((n) => [n.id, n]));
const edges = saveFile.edges.filter((e) => nodesById.has(e.source) && nodesById.has(e.target));
const { nodes, edges, report } = optimizeChain(saveFile.nodes, saveFile.edges, schemata);

// show an error if there are no nodes to run
if (nodes.length === 0) {
let message;
if (nodesToOptimize.length > 0) {
if (report.removedSideEffectFree > 0) {
message = 'There are no nodes that have an effect. Try to view or output images/files.';
} else if (disabledNodes.size > 0) {
} else if (report.removedDisabled > 0) {
message = 'All nodes are disabled. There are no nodes to run.';
} else {
message = 'There are no nodes to run.';
Expand Down
34 changes: 17 additions & 17 deletions src/renderer/contexts/ExecutionContext.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ import { log } from '../../common/log';
import { checkFeatures } from '../../common/nodes/checkFeatures';
import { checkNodeValidity } from '../../common/nodes/checkNodeValidity';
import { getConnectedInputs } from '../../common/nodes/connectedInputs';
import { getEffectivelyDisabledNodes } from '../../common/nodes/disabled';
import { getNodesWithSideEffects } from '../../common/nodes/sideEffect';
import { optimizeChain } from '../../common/nodes/optimize';
import { toBackendJson } from '../../common/nodes/toBackendJson';
import { ipcRenderer } from '../../common/safeIpc';
import { getChainnerScope } from '../../common/types/chainner-scope';
Expand Down Expand Up @@ -139,8 +138,16 @@ export const ExecutionProvider = memo(({ children }: React.PropsWithChildren<{}>
setManualOutputType,
clearManualOutputTypes,
} = useContext(GlobalContext);
const { schemata, url, backend, ownsBackend, restartingRef, features, featureStates } =
useContext(BackendContext);
const {
schemata,
url,
backend,
ownsBackend,
restartingRef,
features,
featureStates,
categories,
} = useContext(BackendContext);
const { packageSettings } = useSettings();

const { sendAlert, sendToast } = useContext(AlertBoxContext);
Expand Down Expand Up @@ -345,24 +352,15 @@ export const ExecutionProvider = memo(({ children }: React.PropsWithChildren<{}>
}, [status, nodeChanges, edgeChanges, sendToast]);

const runNodes = useCallback(async () => {
const allNodes = getNodes();
const allEdges = getEdges();

const disabledNodes = new Set(
getEffectivelyDisabledNodes(allNodes, allEdges).map((n) => n.id)
);
const nodesToOptimize = allNodes.filter((n) => !disabledNodes.has(n.id));
const nodes = getNodesWithSideEffects(nodesToOptimize, allEdges, schemata);
const nodeIds = new Set(nodes.map((n) => n.id));
const edges = allEdges.filter((e) => nodeIds.has(e.source) && nodeIds.has(e.target));
const { nodes, edges, report } = optimizeChain(getNodes(), getEdges(), schemata);

// show an error if there are no nodes to run
if (nodes.length === 0) {
let message;
if (nodesToOptimize.length > 0) {
if (report.removedSideEffectFree > 0) {
message =
'There are no nodes that have an effect. Try to view or output images/files.';
} else if (disabledNodes.size > 0) {
} else if (report.removedDisabled > 0) {
message = 'All nodes are disabled. There are no nodes to run.';
} else {
message = 'There are no nodes to run.';
Expand All @@ -375,7 +373,8 @@ export const ExecutionProvider = memo(({ children }: React.PropsWithChildren<{}>
const invalidNodes = nodes.flatMap((node) => {
const functionInstance = typeStateRef.current.functions.get(node.data.id);
const schema = schemata.get(node.data.schemaId);
const { category, name } = schema;
const { name } = schema;
const category = categories.get(schema.category)?.name ?? schema.category;

const validity = bothValid(
checkFeatures(schema.features, features, featureStates),
Expand Down Expand Up @@ -448,6 +447,7 @@ export const ExecutionProvider = memo(({ children }: React.PropsWithChildren<{}>
getNodes,
getEdges,
schemata,
categories,
sendAlert,
typeStateRef,
chainLineageRef,
Expand Down