@eagleoutice/flowr 2.2.11 → 2.2.13

package/dataflow/graph/dataflowgraph-builder.d.ts

@@ -3,9 +3,12 @@ import type { AstIdMap } from '../../r-bridge/lang-4.x/ast/model/processing/deco
 import type { DataflowFunctionFlowInformation, FunctionArgument } from './graph';
 import { DataflowGraph } from './graph';
 import type { REnvironmentInformation } from '../environments/environment';
-import type { DataflowGraphVertexUse } from './vertex';
+import type { DataflowGraphVertexAstLink, DataflowGraphVertexUse, FunctionOriginInformation } from './vertex';
 import type { ControlDependency } from '../info';
 import type { LinkTo } from '../../queries/catalog/call-context-query/call-context-query-format';
+import type { FlowrSearchLike } from '../../search/flowr-search-builder';
+import type { Pipeline } from '../../core/steps/pipeline/pipeline';
+import type { FlowrSearchInput } from '../../search/flowr-search';
 export declare function emptyGraph(idMap?: AstIdMap): DataflowGraphBuilder;
 export type DataflowGraphEdgeTarget = NodeId | (readonly NodeId[]);
 /**
@@ -44,6 +47,8 @@ export declare class DataflowGraphBuilder extends DataflowGraph {
         onlyBuiltIn?: boolean;
         environment?: REnvironmentInformation;
         controlDependencies?: ControlDependency[];
+        origin?: FunctionOriginInformation[];
+        link?: DataflowGraphVertexAstLink;
     }, asRoot?: boolean): this;
     /** automatically adds argument links if they do not already exist */
     private addArgumentLinks;
@@ -82,8 +87,9 @@ export declare class DataflowGraphBuilder extends DataflowGraph {
         controlDependencies?: ControlDependency[];
     }, asRoot?: boolean): this;
     private edgeHelper;
+    private queryHelper;
     /**
-     * Adds a **read edge** (E1).
+     * Adds a **read edge**.
      *
      * @param from - NodeId of the source vertex
      * @param to   - Either a single or multiple target ids.
@@ -91,30 +97,62 @@ export declare class DataflowGraphBuilder extends DataflowGraph {
      */
     reads(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
-     * Adds a **defined-by edge** (E2), with from as defined variable, and to
+     * Adds a **read edge** with a query for the from and/or to vertices.
+     *
+     * @param from - Either a node id or a query to find the node id.
+     * @param to - Either a node id or a query to find the node id.
+     * @param data - The data to search in i.e. the dataflow graph.
+     */
+    readsQuery<P extends Pipeline>(from: FromQueryParam, to: ToQueryParam, data: FlowrSearchInput<P>): this;
+    /**
+     * Adds a **defined-by edge** with from as defined variable, and to
      * as a variable/function contributing to its definition.
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     definedBy(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
-     * Adds a **call edge** (E5) with from as caller, and to as callee.
+     * Adds a **defined-by edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    definedByQuery<P extends Pipeline>(from: FromQueryParam, to: ToQueryParam, data: FlowrSearchInput<P>): this;
+    /**
+     * Adds a **call edge** with from as caller, and to as callee.
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     calls(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
-     * Adds a **return edge** (E6) with from as function, and to as exit point.
+     * Adds a **call edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    callsQuery<P extends Pipeline>(from: FromQueryParam, to: ToQueryParam, data: FlowrSearchInput<P>): this;
+    /**
+     * Adds a **return edge** with from as function, and to as exit point.
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     returns(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
-     * Adds a **defines-on-call edge** (E7) with from as variable, and to as its definition
+     * Adds a **return edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    returnsQuery<P extends Pipeline>(from: FromQueryParam, to: ToQueryParam, data: FlowrSearchInput<P>): this;
+    /**
+     * Adds a **defines-on-call edge** with from as variable, and to as its definition
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     definesOnCall(from: NodeId, to: DataflowGraphEdgeTarget): this;
+    /**
+     * Adds a **defines-on-call edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    definesOnCallQuery<P extends Pipeline>(from: FromQueryParam, to: ToQueryParam, data: FlowrSearchInput<P>): this;
     /**
      * Adds a **defined-by-on-call edge** with from as definition, and to as variable.
      *
@@ -122,23 +160,47 @@ export declare class DataflowGraphBuilder extends DataflowGraph {
      */
     definedByOnCall(from: NodeId, to: DataflowGraphEdgeTarget): this;
     /**
-     * Adds an **argument edge** (E9) with from as function call, and to as argument.
+     * Adds a **defined-by-on-call edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    definedByOnCallQuery<P extends Pipeline>(from: FromQueryParam, to: ToQueryParam, data: FlowrSearchInput<P>): this;
+    /**
+     * Adds an **argument edge** with from as function call, and to as argument.
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     argument(from: NodeId, to: DataflowGraphEdgeTarget): this;
+    /**
+     * Adds a **argument edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    argumentQuery<P extends Pipeline>(from: FromQueryParam, to: ToQueryParam, data: FlowrSearchInput<P>): this;
     /**
      * Adds a **non-standard evaluation edge** with from as vertex, and to as vertex.
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     nse(from: NodeId, to: DataflowGraphEdgeTarget): this;
+    /**
+     * Adds a **non-standard evaluation edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    nseQuery<P extends Pipeline>(from: FromQueryParam, to: ToQueryParam, data: FlowrSearchInput<P>): this;
     /**
      * Adds a **side-effect-on-call edge** with from as vertex, and to as vertex.
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     sideEffectOnCall(from: NodeId, to: DataflowGraphEdgeTarget): this;
+    /**
+     * Adds a **side-effect-on-call edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    sideEffectOnCallQuery<P extends Pipeline>(from: FromQueryParam, to: ToQueryParam, data: FlowrSearchInput<P>): this;
     /**
      * explicitly overwrite the root ids of the graph,
      * this is just an easier variant in case you working with a lot of functions this saves you a lot of `false` flags.
@@ -146,3 +208,13 @@ export declare class DataflowGraphBuilder extends DataflowGraph {
     overwriteRootIds(ids: readonly NodeId[]): this;
 }
 export declare function getBuiltInSideEffect(name: string): LinkTo<RegExp> | undefined;
+interface Query {
+    query: FlowrSearchLike;
+}
+type FromQueryParam = {
+    nodeId: NodeId;
+} | Query;
+type ToQueryParam = {
+    target: DataflowGraphEdgeTarget;
+} | Query;
+export {};

package/dataflow/graph/dataflowgraph-builder.js

@@ -12,6 +12,8 @@ const r_function_call_1 = require("../../r-bridge/lang-4.x/ast/model/nodes/r-fun
 const built_in_1 = require("../environments/built-in");
 const edge_1 = require("./edge");
 const default_builtin_config_1 = require("../environments/default-builtin-config");
+const flowr_search_executor_1 = require("../../search/flowr-search-executor");
+const assert_1 = require("../../util/assert");
 function emptyGraph(idMap) {
     return new DataflowGraphBuilder(idMap);
 }
@@ -59,7 +61,7 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
      * (i.e., be a valid entry point), or is it nested (e.g., as part of a function definition)
      */
     call(id, name, args, info, asRoot = true) {
-        const onlyBuiltInAuto = info?.reads?.length === 1 && info?.reads[0] === built_in_1.BuiltIn;
+        const onlyBuiltInAuto = info?.reads?.length === 1 && (0, built_in_1.isBuiltIn)(info?.reads[0]);
         this.addVertex({
             tag: vertex_1.VertexType.FunctionCall,
             id: (0, node_id_1.normalizeIdToNumberIfPossible)(id),
@@ -67,7 +69,9 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
             args: args.map(a => a === r_function_call_1.EmptyArgument ? r_function_call_1.EmptyArgument : { ...a, nodeId: (0, node_id_1.normalizeIdToNumberIfPossible)(a.nodeId), controlDependencies: undefined }),
             environment: (info?.onlyBuiltIn || onlyBuiltInAuto) ? undefined : info?.environment ?? (0, environment_1.initializeCleanEnvironments)(),
             cds: info?.controlDependencies?.map(c => ({ ...c, id: (0, node_id_1.normalizeIdToNumberIfPossible)(c.id) })),
-            onlyBuiltin: info?.onlyBuiltIn ?? onlyBuiltInAuto ?? false
+            onlyBuiltin: info?.onlyBuiltIn ?? onlyBuiltInAuto ?? false,
+            origin: info?.origin ?? [(0, default_builtin_config_1.getDefaultProcessor)(name) ?? 'function'],
+            link: info?.link
         }, asRoot);
         this.addArgumentLinks(id, args);
         if (info?.returns) {
@@ -170,8 +174,28 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
         }
         return this.addEdge((0, node_id_1.normalizeIdToNumberIfPossible)(from), (0, node_id_1.normalizeIdToNumberIfPossible)(to), type);
     }
+    queryHelper(from, to, data, type) {
+        let fromId;
+        if ('nodeId' in from) {
+            fromId = from.nodeId;
+        }
+        else {
+            const result = (0, flowr_search_executor_1.runSearch)(from.query, data);
+            (0, assert_1.guard)(result.length === 1, `from query result should yield exactly one node, but yielded ${result.length}`);
+            fromId = result[0].node.info.id;
+        }
+        let toIds;
+        if ('target' in to) {
+            toIds = to.target;
+        }
+        else {
+            const result = (0, flowr_search_executor_1.runSearch)(to.query, data);
+            toIds = result.map(r => r.node.info.id);
+        }
+        return this.edgeHelper(fromId, toIds, type);
+    }
     /**
-     * Adds a **read edge** (E1).
+     * Adds a **read edge**.
      *
      * @param from - NodeId of the source vertex
      * @param to   - Either a single or multiple target ids.
@@ -181,7 +205,17 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
         return this.edgeHelper(from, to, edge_1.EdgeType.Reads);
     }
     /**
-     * Adds a **defined-by edge** (E2), with from as defined variable, and to
+     * Adds a **read edge** with a query for the from and/or to vertices.
+     *
+     * @param from - Either a node id or a query to find the node id.
+     * @param to - Either a node id or a query to find the node id.
+     * @param data - The data to search in i.e. the dataflow graph.
+     */
+    readsQuery(from, to, data) {
+        return this.queryHelper(from, to, data, edge_1.EdgeType.Reads);
+    }
+    /**
+     * Adds a **defined-by edge** with from as defined variable, and to
      * as a variable/function contributing to its definition.
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
@@ -190,7 +224,15 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
         return this.edgeHelper(from, to, edge_1.EdgeType.DefinedBy);
     }
     /**
-     * Adds a **call edge** (E5) with from as caller, and to as callee.
+     * Adds a **defined-by edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    definedByQuery(from, to, data) {
+        return this.queryHelper(from, to, data, edge_1.EdgeType.DefinedBy);
+    }
+    /**
+     * Adds a **call edge** with from as caller, and to as callee.
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
@@ -198,7 +240,15 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
         return this.edgeHelper(from, to, edge_1.EdgeType.Calls);
     }
     /**
-     * Adds a **return edge** (E6) with from as function, and to as exit point.
+     * Adds a **call edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    callsQuery(from, to, data) {
+        return this.queryHelper(from, to, data, edge_1.EdgeType.Calls);
+    }
+    /**
+     * Adds a **return edge** with from as function, and to as exit point.
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
@@ -206,13 +256,29 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
         return this.edgeHelper(from, to, edge_1.EdgeType.Returns);
     }
     /**
-     * Adds a **defines-on-call edge** (E7) with from as variable, and to as its definition
+     * Adds a **return edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    returnsQuery(from, to, data) {
+        return this.queryHelper(from, to, data, edge_1.EdgeType.Returns);
+    }
+    /**
+     * Adds a **defines-on-call edge** with from as variable, and to as its definition
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     definesOnCall(from, to) {
         return this.edgeHelper(from, to, edge_1.EdgeType.DefinesOnCall);
     }
+    /**
+     * Adds a **defines-on-call edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    definesOnCallQuery(from, to, data) {
+        return this.queryHelper(from, to, data, edge_1.EdgeType.DefinesOnCall);
+    }
     /**
      * Adds a **defined-by-on-call edge** with from as definition, and to as variable.
      *
@@ -222,13 +288,29 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
         return this.edgeHelper(from, to, edge_1.EdgeType.DefinedByOnCall);
     }
     /**
-     * Adds an **argument edge** (E9) with from as function call, and to as argument.
+     * Adds a **defined-by-on-call edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    definedByOnCallQuery(from, to, data) {
+        return this.queryHelper(from, to, data, edge_1.EdgeType.DefinedByOnCall);
+    }
+    /**
+     * Adds an **argument edge** with from as function call, and to as argument.
      *
      * @see {@link DataflowGraphBuilder#reads|reads} for parameters.
      */
     argument(from, to) {
         return this.edgeHelper(from, to, edge_1.EdgeType.Argument);
     }
+    /**
+     * Adds a **argument edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    argumentQuery(from, to, data) {
+        return this.queryHelper(from, to, data, edge_1.EdgeType.Argument);
+    }
     /**
      * Adds a **non-standard evaluation edge** with from as vertex, and to as vertex.
      *
@@ -237,6 +319,14 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     nse(from, to) {
         return this.edgeHelper(from, to, edge_1.EdgeType.NonStandardEvaluation);
     }
+    /**
+     * Adds a **non-standard evaluation edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    nseQuery(from, to, data) {
+        return this.queryHelper(from, to, data, edge_1.EdgeType.NonStandardEvaluation);
+    }
     /**
      * Adds a **side-effect-on-call edge** with from as vertex, and to as vertex.
      *
@@ -245,6 +335,14 @@ class DataflowGraphBuilder extends graph_1.DataflowGraph {
     sideEffectOnCall(from, to) {
         return this.edgeHelper(from, to, edge_1.EdgeType.SideEffectOnCall);
     }
+    /**
+     * Adds a **side-effect-on-call edge** with a query for the from and/or to vertices.
+     *
+     * @see {@link DataflowGraphBuilder#readsQuery|readsQuery} for parameters.
+     */
+    sideEffectOnCallQuery(from, to, data) {
+        return this.queryHelper(from, to, data, edge_1.EdgeType.SideEffectOnCall);
+    }
     /**
      * explicitly overwrite the root ids of the graph,
      * this is just an easier variant in case you working with a lot of functions this saves you a lot of `false` flags.

package/dataflow/graph/diff-dataflow-graph.d.ts

@@ -0,0 +1,16 @@
+import type { FunctionArgument, OutgoingEdges } from './graph';
+import type { GenericDiffConfiguration, GenericDifferenceInformation } from '../../util/diff';
+import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
+import type { GraphDiffContext, NamedGraph } from '../../util/diff-graph';
+import { GraphDifferenceReport } from '../../util/diff-graph';
+/**
+ * Compare two dataflow graphs and return a report on the differences.
+ * If you simply want to check whether they equal, use {@link GraphDifferenceReport#isEqual|`<result>.isEqual()`}.
+ *
+ * @see {@link diffOfControlFlowGraphs} - for control flow graphs
+ */
+export declare function diffOfDataflowGraphs(left: NamedGraph, right: NamedGraph, config?: Partial<GenericDiffConfiguration>): GraphDifferenceReport;
+export declare function equalFunctionArguments(fn: NodeId, a: false | readonly FunctionArgument[], b: false | readonly FunctionArgument[]): boolean;
+export declare function diffFunctionArguments(fn: NodeId, a: false | readonly FunctionArgument[], b: false | readonly FunctionArgument[], ctx: GenericDifferenceInformation<GraphDifferenceReport>): void;
+export declare function diffVertices(ctx: GraphDiffContext): void;
+export declare function diffEdges(ctx: GraphDiffContext, id: NodeId, lEdges: OutgoingEdges | undefined, rEdges: OutgoingEdges | undefined): void;

package/dataflow/graph/{diff.js → diff-dataflow-graph.js}

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataflowDifferenceReport = void 0;
 exports.diffOfDataflowGraphs = diffOfDataflowGraphs;
 exports.equalFunctionArguments = equalFunctionArguments;
 exports.diffFunctionArguments = diffFunctionArguments;
@@ -9,59 +8,29 @@ exports.diffEdges = diffEdges;
 const graph_1 = require("./graph");
 const diff_1 = require("../../util/diff");
 const json_1 = require("../../util/json");
-const arrays_1 = require("../../util/arrays");
+const arrays_1 = require("../../util/collections/arrays");
 const vertex_1 = require("./vertex");
 const edge_1 = require("./edge");
 const node_id_1 = require("../../r-bridge/lang-4.x/ast/model/processing/node-id");
 const diff_2 = require("../environments/diff");
 const r_function_call_1 = require("../../r-bridge/lang-4.x/ast/model/nodes/r-function-call");
 const info_1 = require("../info");
-class DataflowDifferenceReport {
-    _comments = undefined;
-    _problematic = undefined;
-    addComment(comment, ...related) {
-        if (this._comments === undefined) {
-            this._comments = [comment];
-        }
-        else {
-            this._comments.push(comment);
-        }
-        if (related.length > 0) {
-            if (this._problematic === undefined) {
-                this._problematic = [...related];
-            }
-            else {
-                this._problematic.push(...related);
-            }
-        }
-    }
-    comments() {
-        return this._comments;
-    }
-    problematic() {
-        return this._problematic;
-    }
-    isEqual() {
-        return this._comments === undefined;
+const diff_graph_1 = require("../../util/diff-graph");
+/**
+ * Compare two dataflow graphs and return a report on the differences.
+ * If you simply want to check whether they equal, use {@link GraphDifferenceReport#isEqual|`<result>.isEqual()`}.
+ *
+ * @see {@link diffOfControlFlowGraphs} - for control flow graphs
+ */
+function diffOfDataflowGraphs(left, right, config) {
+    if (left.graph === right.graph) {
+        return new diff_graph_1.GraphDifferenceReport();
     }
+    const ctx = (0, diff_graph_1.initDiffContext)(left, right, config);
+    diffDataflowGraph(ctx);
+    return ctx.report;
 }
-exports.DataflowDifferenceReport = DataflowDifferenceReport;
-function initDiffContext(left, right, config) {
-    return {
-        left: left.graph,
-        leftname: left.name,
-        right: right.graph,
-        rightname: right.name,
-        report: new DataflowDifferenceReport(),
-        position: '',
-        config: {
-            rightIsSubgraph: false,
-            leftIsSubgraph: false,
-            ...config
-        }
-    };
-}
-function diff(ctx) {
+function diffDataflowGraph(ctx) {
     diffRootVertices(ctx);
     diffVertices(ctx);
     diffOutgoingEdges(ctx);
@@ -102,14 +71,6 @@ function diffRootVertices(ctx) {
     (0, diff_1.setDifference)(ctx.left.rootIds(), ctx.right.rootIds(), { ...ctx, position: `${ctx.position}Root vertices differ in graphs. ` });
     (0, diff_1.setDifference)(new Set([...ctx.left.unknownSideEffects].map(n => typeof n === 'object' ? n.id : n)), new Set([...ctx.right.unknownSideEffects].map(n => typeof n === 'object' ? n.id : n)), { ...ctx, position: `${ctx.position}Unknown side effects differ in graphs. ` });
 }
-function diffOfDataflowGraphs(left, right, config) {
-    if (left.graph === right.graph) {
-        return new DataflowDifferenceReport();
-    }
-    const ctx = initDiffContext(left, right, config);
-    diff(ctx);
-    return ctx.report;
-}
 function diffFunctionArgumentsReferences(fn, a, b, ctx) {
     if (a === '<value>' || b === '<value>') {
         if (a !== b) {
@@ -121,7 +82,7 @@ function diffFunctionArgumentsReferences(fn, a, b, ctx) {
 }
 function equalFunctionArguments(fn, a, b) {
     const ctx = {
-        report: new DataflowDifferenceReport(),
+        report: new diff_graph_1.GraphDifferenceReport(),
         leftname: 'left',
         rightname: 'right',
         position: '',
@@ -200,6 +161,19 @@ function diffVertices(ctx) {
             }
         }
         (0, info_1.diffControlDependencies)(lInfo.cds, rInfo.cds, { ...ctx, position: `Vertex ${id} differs in controlDependencies. ` });
+        if (lInfo.origin !== undefined || rInfo.origin !== undefined) {
+            // compare arrays
+            const equalArrays = lInfo.origin && rInfo.origin && (0, arrays_1.arrayEqual)(lInfo.origin, rInfo.origin);
+            if (!equalArrays) {
+                ctx.report.addComment(`Vertex ${id} differs in origin. ${ctx.leftname}: ${JSON.stringify(lInfo.origin, json_1.jsonReplacer)} vs ${ctx.rightname}: ${JSON.stringify(rInfo.origin, json_1.jsonReplacer)}`, { tag: 'vertex', id });
+            }
+        }
+        if (lInfo.link !== undefined || rInfo.link !== undefined) {
+            const equal = lInfo.link && rInfo.link && (0, arrays_1.arrayEqual)(lInfo.link.origin, rInfo.link.origin);
+            if (!equal) {
+                ctx.report.addComment(`Vertex ${id} differs in link. ${ctx.leftname}: ${JSON.stringify(lInfo.link, json_1.jsonReplacer)} vs ${ctx.rightname}: ${JSON.stringify(rInfo.link, json_1.jsonReplacer)}`, { tag: 'vertex', id });
+            }
+        }
         if ((lInfo.environment === undefined && rInfo.environment !== undefined && !ctx.config.leftIsSubgraph)
             || (lInfo.environment !== undefined && rInfo.environment === undefined && !ctx.config.rightIsSubgraph)) {
             /* only diff them if specified at all */
@@ -282,4 +256,4 @@ function diffEdges(ctx, id, lEdges, rEdges) {
         diffEdge(edge, otherEdge, ctx, id, target);
     }
 }
-//# sourceMappingURL=diff.js.map
+//# sourceMappingURL=diff-dataflow-graph.js.map

package/dataflow/graph/graph.d.ts

@@ -2,7 +2,7 @@ import type { DataflowGraphEdge, EdgeType } from './edge';
 import type { DataflowInformation } from '../info';
 import type { DataflowGraphVertexArgument, DataflowGraphVertexFunctionCall, DataflowGraphVertexInfo } from './vertex';
 import { EmptyArgument } from '../../r-bridge/lang-4.x/ast/model/nodes/r-function-call';
-import type { IdentifierDefinition, IdentifierReference } from '../environments/identifier';
+import type { Identifier, IdentifierDefinition, IdentifierReference } from '../environments/identifier';
 import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { AstIdMap } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
 import type { LinkTo } from '../../queries/catalog/call-context-query/call-context-query-format';
@@ -99,7 +99,7 @@ export type UnknownSidEffect = NodeId | {
  * @see {@link DataflowGraph#addEdge|`addEdge`} - to add an edge to the graph
  * @see {@link DataflowGraph#addVertex|`addVertex`} - to add a vertex to the graph
  * @see {@link DataflowGraph#fromJson|`fromJson`} - to construct a dataflow graph object from a deserialized JSON object.
- * @see {@link emptyGraph} - to create an empty graph (useful in tests)
+ * @see {@link emptyGraph|`emptyGraph`} - to create an empty graph (useful in tests)
  */
 export declare class DataflowGraph<Vertex extends DataflowGraphVertexInfo = DataflowGraphVertexInfo, Edge extends DataflowGraphEdge = DataflowGraphEdge> {
     private static DEFAULT_ENVIRONMENT;
@@ -136,6 +136,13 @@ export declare class DataflowGraph<Vertex extends DataflowGraphVertexInfo = Data
     getVertex(id: NodeId, includeDefinedFunctions?: boolean): Vertex | undefined;
     outgoingEdges(id: NodeId): OutgoingEdges | undefined;
     ingoingEdges(id: NodeId): IngoingEdges | undefined;
+    /**
+     * Given a node in the normalized AST this either:
+     * * returns the id if the node directly exists in the DFG
+     * * returns the ids of all vertices in the DFG that are linked to this
+     * * returns undefined if the node is not part of the DFG and not linked to any node
+     */
+    getLinked(nodeId: NodeId): NodeId[] | undefined;
     /** Retrieves the id-map to the normalized AST attached to the dataflow graph */
     get idMap(): AstIdMap | undefined;
     get sourced(): (string | '<inline>')[];
@@ -178,11 +185,12 @@ export declare class DataflowGraph<Vertex extends DataflowGraphVertexInfo = Data
      * @param vertex - The vertex to add
      * @param asRoot - If false, this will only add the vertex but do not add it to the {@link rootIds|root vertices} of the graph.
      *                 This is probably only of use, when you construct dataflow graphs for tests.
+     * @param overwrite - If true, this will overwrite the vertex if it already exists in the graph (based on the id).
      *
      * @see DataflowGraphVertexInfo
      * @see DataflowGraphVertexArgument
      */
-    addVertex(vertex: DataflowGraphVertexArgument & Omit<Vertex, keyof DataflowGraphVertexArgument>, asRoot?: boolean): this;
+    addVertex(vertex: DataflowGraphVertexArgument & Omit<Vertex, keyof DataflowGraphVertexArgument>, asRoot?: boolean, overwrite?: boolean): this;
     /** {@inheritDoc} */
     addEdge(from: NodeId, to: NodeId, type: EdgeType | number): this;
     /** {@inheritDoc} */
@@ -211,7 +219,7 @@ export declare class DataflowGraph<Vertex extends DataflowGraphVertexInfo = Data
     /** If you do not pass the `to` node, this will just mark the node as maybe */
     addControlDependency(from: NodeId, to?: NodeId, when?: boolean): this;
     /** Marks the given node as having unknown side effects */
-    markIdForUnknownSideEffects(id: NodeId, target?: LinkTo<RegExp | string>): this;
+    markIdForUnknownSideEffects(id: NodeId, target?: LinkTo): this;
     /**
      * Constructs a dataflow graph instance from the given JSON data and returns the result.
      * This can be useful for data sent by the flowR server when analyzing it further.
@@ -219,4 +227,9 @@ export declare class DataflowGraph<Vertex extends DataflowGraphVertexInfo = Data
      */
     static fromJson(data: DataflowGraphJson): DataflowGraph;
 }
+export interface IEnvironmentJson {
+    readonly id: number;
+    parent: IEnvironmentJson;
+    memory: Record<Identifier, IdentifierDefinition[]>;
+}
 export {};