@eagleoutice/flowr 2.2.12 → 2.2.14

package/queries/catalog/dependencies-query/dependencies-query-format.d.ts

@@ -39,7 +39,7 @@ export type WriteInfo = (DependencyInfo & {
 });
 export declare const DependenciesQueryDefinition: {
     readonly executor: typeof executeDependenciesQuery;
-    readonly asciiSummarizer: (formatter: import("../../../util/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
         readonly name: "parse";
         readonly humanReadableName: "parse with R shell";
         readonly description: "Parse the given R code into an AST";
@@ -94,4 +94,5 @@ export declare const DependenciesQueryDefinition: {
         readonly dependencies: readonly ["normalize"];
     }>>, queryResults: BaseQueryResult, result: string[]) => true;
     readonly schema: Joi.ObjectSchema<any>;
+    readonly flattenInvolvedNodes: (queryResults: BaseQueryResult) => NodeId[];
 };

package/queries/catalog/dependencies-query/dependencies-query-format.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DependenciesQueryDefinition = exports.Unknown = void 0;
-const ansi_1 = require("../../../util/ansi");
-const time_1 = require("../../../util/time");
+const ansi_1 = require("../../../util/text/ansi");
+const time_1 = require("../../../util/text/time");
 const joi_1 = __importDefault(require("joi"));
 const dependencies_query_executor_1 = require("./dependencies-query-executor");
 exports.Unknown = 'unknown';
@@ -53,6 +53,15 @@ exports.DependenciesQueryDefinition = {
         sourceFunctions: functionInfoSchema.description('The set of source functions to search for.'),
         readFunctions: functionInfoSchema.description('The set of data reading functions to search for.'),
         writeFunctions: functionInfoSchema.description('The set of data writing functions to search for.'),
-    }).description('The dependencies query retrieves and returns the set of all dependencies in the dataflow graph, which includes libraries, sourced files, read data, and written data.')
+    }).description('The dependencies query retrieves and returns the set of all dependencies in the dataflow graph, which includes libraries, sourced files, read data, and written data.'),
+    flattenInvolvedNodes: (queryResults) => {
+        const out = queryResults;
+        return [
+            ...out.libraries.map(library => library.nodeId),
+            ...out.sourcedFiles.map(sourced => sourced.nodeId),
+            ...out.readData.map(read => read.nodeId),
+            ...out.writtenData.map(write => write.nodeId)
+        ];
+    }
 };
 //# sourceMappingURL=dependencies-query-format.js.map

package/queries/catalog/happens-before-query/happens-before-query-executor.d.ts

@@ -1,3 +1,3 @@
 import type { BasicQueryData } from '../../base-query-format';
 import type { HappensBeforeQuery, HappensBeforeQueryResult } from './happens-before-query-format';
-export declare function executeHappensBefore({ ast, dataflow }: BasicQueryData, queries: readonly HappensBeforeQuery[]): HappensBeforeQueryResult;
+export declare function executeHappensBefore({ ast }: BasicQueryData, queries: readonly HappensBeforeQuery[]): HappensBeforeQueryResult;

package/queries/catalog/happens-before-query/happens-before-query-executor.js

@@ -3,13 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeHappensBefore = executeHappensBefore;
 const logic_1 = require("../../../util/logic");
 const log_1 = require("../../../util/log");
-const cfg_1 = require("../../../util/cfg/cfg");
-const happens_before_1 = require("../../../util/cfg/happens-before");
+const extract_cfg_1 = require("../../../control-flow/extract-cfg");
+const happens_before_1 = require("../../../control-flow/happens-before");
 const parse_1 = require("../../../slicing/criterion/parse");
-function executeHappensBefore({ ast, dataflow }, queries) {
+function executeHappensBefore({ ast }, queries) {
     const start = Date.now();
     const results = {};
-    const cfg = (0, cfg_1.extractCFG)(ast, dataflow.graph);
+    const cfg = (0, extract_cfg_1.extractSimpleCfg)(ast);
     for (const query of queries) {
         const { a, b } = query;
         const fingerprint = `${a}<${b}`;

package/queries/catalog/happens-before-query/happens-before-query-format.d.ts

@@ -13,7 +13,7 @@ export interface HappensBeforeQueryResult extends BaseQueryResult {
 }
 export declare const HappensBeforeQueryDefinition: {
     readonly executor: typeof executeHappensBefore;
-    readonly asciiSummarizer: (formatter: import("../../../util/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
         readonly name: "parse";
         readonly humanReadableName: "parse with R shell";
         readonly description: "Parse the given R code into an AST";
@@ -68,4 +68,5 @@ export declare const HappensBeforeQueryDefinition: {
         readonly dependencies: readonly ["normalize"];
     }>>, queryResults: BaseQueryResult, result: string[]) => true;
     readonly schema: Joi.ObjectSchema<any>;
+    readonly flattenInvolvedNodes: () => never[];
 };

package/queries/catalog/happens-before-query/happens-before-query-format.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HappensBeforeQueryDefinition = void 0;
-const ansi_1 = require("../../../util/ansi");
-const time_1 = require("../../../util/time");
+const ansi_1 = require("../../../util/text/ansi");
+const time_1 = require("../../../util/text/time");
 const joi_1 = __importDefault(require("joi"));
 const happens_before_query_executor_1 = require("./happens-before-query-executor");
 exports.HappensBeforeQueryDefinition = {
@@ -22,6 +22,7 @@ exports.HappensBeforeQueryDefinition = {
         type: joi_1.default.string().valid('happens-before').required().description('The type of the query.'),
         a: joi_1.default.string().required().description('The first slicing criterion.'),
         b: joi_1.default.string().required().description('The second slicing criterion.')
-    }).description('Happens-Before tracks whether a always happens before b.')
+    }).description('Happens-Before tracks whether a always happens before b.'),
+    flattenInvolvedNodes: () => []
 };
 //# sourceMappingURL=happens-before-query-format.js.map

package/queries/catalog/id-map-query/id-map-query-format.d.ts

@@ -10,7 +10,7 @@ export interface IdMapQueryResult extends BaseQueryResult {
 }
 export declare const IdMapQueryDefinition: {
     readonly executor: typeof executeIdMapQuery;
-    readonly asciiSummarizer: (formatter: import("../../../util/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
         readonly name: "parse";
         readonly humanReadableName: "parse with R shell";
         readonly description: "Parse the given R code into an AST";
@@ -65,4 +65,5 @@ export declare const IdMapQueryDefinition: {
         readonly dependencies: readonly ["normalize"];
     }>>, queryResults: BaseQueryResult, result: string[]) => true;
     readonly schema: Joi.ObjectSchema<any>;
+    readonly flattenInvolvedNodes: () => never[];
 };

package/queries/catalog/id-map-query/id-map-query-format.js

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IdMapQueryDefinition = void 0;
 const id_map_query_executor_1 = require("./id-map-query-executor");
-const ansi_1 = require("../../../util/ansi");
-const time_1 = require("../../../util/time");
+const ansi_1 = require("../../../util/text/ansi");
+const time_1 = require("../../../util/text/time");
 const joi_1 = __importDefault(require("joi"));
 const query_print_1 = require("../../query-print");
 exports.IdMapQueryDefinition = {
@@ -19,6 +19,7 @@ exports.IdMapQueryDefinition = {
     },
     schema: joi_1.default.object({
         type: joi_1.default.string().valid('id-map').required().description('The type of the query.'),
-    }).description('The id map query retrieves the id map from the normalized AST.')
+    }).description('The id map query retrieves the id map from the normalized AST.'),
+    flattenInvolvedNodes: () => []
 };
 //# sourceMappingURL=id-map-query-format.js.map

package/queries/catalog/lineage-query/lineage-query-format.d.ts

@@ -16,7 +16,7 @@ export interface LineageQueryResult extends BaseQueryResult {
 }
 export declare const LineageQueryDefinition: {
     readonly executor: typeof executeLineageQuery;
-    readonly asciiSummarizer: (formatter: import("../../../util/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
         readonly name: "parse";
         readonly humanReadableName: "parse with R shell";
         readonly description: "Parse the given R code into an AST";
@@ -71,4 +71,5 @@ export declare const LineageQueryDefinition: {
         readonly dependencies: readonly ["normalize"];
     }>>, queryResults: BaseQueryResult, result: string[]) => true;
     readonly schema: Joi.ObjectSchema<any>;
+    readonly flattenInvolvedNodes: (queryResults: BaseQueryResult) => NodeId[];
 };

package/queries/catalog/lineage-query/lineage-query-format.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LineageQueryDefinition = void 0;
-const ansi_1 = require("../../../util/ansi");
-const time_1 = require("../../../util/time");
+const ansi_1 = require("../../../util/text/ansi");
+const time_1 = require("../../../util/text/time");
 const joi_1 = __importDefault(require("joi"));
 const lineage_query_executor_1 = require("./lineage-query-executor");
 const query_print_1 = require("../../query-print");
@@ -22,6 +22,10 @@ exports.LineageQueryDefinition = {
     schema: joi_1.default.object({
         type: joi_1.default.string().valid('lineage').required().description('The type of the query.'),
         criterion: joi_1.default.string().required().description('The slicing criterion of the node to get the lineage of.')
-    }).description('Lineage query used to find the lineage of a node in the dataflow graph')
+    }).description('Lineage query used to find the lineage of a node in the dataflow graph'),
+    flattenInvolvedNodes: (queryResults) => {
+        const out = queryResults;
+        return Object.values(out.lineages).flatMap(lineage => [...lineage]);
+    }
 };
 //# sourceMappingURL=lineage-query-format.js.map

package/queries/catalog/linter-query/linter-query-executor.d.ts

@@ -0,0 +1,3 @@
+import type { BasicQueryData } from '../../base-query-format';
+import type { LinterQuery, LinterQueryResult } from './linter-query-format';
+export declare function executeLinterQuery({ ast, dataflow }: BasicQueryData, queries: readonly LinterQuery[]): LinterQueryResult;

package/queries/catalog/linter-query/linter-query-executor.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeLinterQuery = executeLinterQuery;
+const linter_rules_1 = require("../../../linter/linter-rules");
+const log_1 = require("../../../util/log");
+const linter_executor_1 = require("../../../linter/linter-executor");
+function executeLinterQuery({ ast, dataflow }, queries) {
+    const flattened = queries.flatMap(q => q.rules ?? Object.keys(linter_rules_1.LintingRules));
+    const distinct = new Set(flattened);
+    if (distinct.size !== flattened.length) {
+        const pretty = [...distinct].filter(r => flattened.indexOf(r) !== flattened.lastIndexOf(r)).map(r => typeof r === 'string' ? r : r.name).join(', ');
+        log_1.log.warn(`Linter query collection contains duplicate rules ${pretty}, only linting for each rule once`);
+    }
+    const results = { results: {} };
+    const start = Date.now();
+    const input = { normalize: ast, dataflow };
+    for (const entry of distinct) {
+        const ruleName = typeof entry === 'string' ? entry : entry.name;
+        results.results[ruleName] = (0, linter_executor_1.executeLintingRule)(ruleName, input, entry?.config);
+    }
+    return {
+        ...results,
+        '.meta': {
+            timing: Date.now() - start
+        }
+    };
+}
+//# sourceMappingURL=linter-query-executor.js.map

package/queries/catalog/linter-query/linter-query-format.d.ts

@@ -0,0 +1,80 @@
+import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
+import Joi from 'joi';
+import { executeLinterQuery } from './linter-query-executor';
+import type { LintingRuleNames } from '../../../linter/linter-rules';
+import type { ConfiguredLintingRule, LintingResults } from '../../../linter/linter-format';
+export interface LinterQuery extends BaseQueryFormat {
+    readonly type: 'linter';
+    /**
+     * The rules to lint for. If unset, all rules will be included.
+     * Optionally, a {@link ConfiguredLintingRule} can be provided, which additionally includes custom user-supplied values for the linting rules' configurations.
+     */
+    readonly rules?: (LintingRuleNames | ConfiguredLintingRule)[];
+}
+export interface LinterQueryResult extends BaseQueryResult {
+    /**
+     * The results of the linter query, which returns a set of linting results for each rule that was executed.
+     */
+    readonly results: {
+        [L in LintingRuleNames]?: LintingResults<L>;
+    };
+}
+export declare const LinterQueryDefinition: {
+    readonly executor: typeof executeLinterQuery;
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
+        readonly name: "parse";
+        readonly humanReadableName: "parse with R shell";
+        readonly description: "Parse the given R code into an AST";
+        readonly processor: (_results: unknown, input: Partial<import("../../../r-bridge/parser").ParseRequiredInput<string>>) => Promise<import("../../../r-bridge/parser").ParseStepOutput<string>>;
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: {
+                (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
+                (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
+            };
+            readonly 5: ({ parsed }: import("../../../r-bridge/parser").ParseStepOutput<string>, config: import("../../../util/quads").QuadSerializationConfiguration) => string;
+        };
+        readonly dependencies: readonly [];
+        readonly requiredInput: import("../../../r-bridge/parser").ParseRequiredInput<string>;
+    } | {
+        readonly name: "normalize";
+        readonly humanReadableName: "normalize";
+        readonly description: "Normalize the AST to flowR's AST";
+        readonly processor: (results: {
+            parse?: import("../../../r-bridge/parser").ParseStepOutput<string>;
+        }, input: Partial<import("../../../core/steps/all/core/10-normalize").NormalizeRequiredInput>) => import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst<import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, import("../../../r-bridge/lang-4.x/ast/model/model").RNode<import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>>;
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: typeof import("../../../core/print/normalize-printer").normalizedAstToJson;
+            readonly 5: typeof import("../../../core/print/normalize-printer").normalizedAstToQuads;
+            readonly 3: typeof import("../../../core/print/normalize-printer").printNormalizedAstToMermaid;
+            readonly 4: typeof import("../../../core/print/normalize-printer").printNormalizedAstToMermaidUrl;
+        };
+        readonly dependencies: readonly ["parse"];
+        readonly requiredInput: import("../../../core/steps/all/core/10-normalize").NormalizeRequiredInput;
+    } | {
+        readonly humanReadableName: "dataflow";
+        readonly processor: (results: {
+            normalize?: import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
+        }, input: {
+            request?: import("../../../r-bridge/retriever").RParseRequests;
+            parser?: import("../../../r-bridge/parser").Parser<import("../../../r-bridge/parser").KnownParserType>;
+        }) => import("../../../dataflow/info").DataflowInformation;
+        readonly requiredInput: {};
+        readonly name: "dataflow";
+        readonly description: "Construct the dataflow graph";
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: typeof import("../../../core/print/dataflow-printer").dataflowGraphToJson;
+            readonly 5: typeof import("../../../core/print/dataflow-printer").dataflowGraphToQuads;
+            readonly 3: typeof import("../../../core/print/dataflow-printer").dataflowGraphToMermaid;
+            readonly 4: typeof import("../../../core/print/dataflow-printer").dataflowGraphToMermaidUrl;
+        };
+        readonly dependencies: readonly ["normalize"];
+    }>>, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly schema: Joi.ObjectSchema<any>;
+    readonly flattenInvolvedNodes: () => never[];
+};

package/queries/catalog/linter-query/linter-query-format.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinterQueryDefinition = void 0;
+const joi_1 = __importDefault(require("joi"));
+const linter_query_executor_1 = require("./linter-query-executor");
+const linter_rules_1 = require("../../../linter/linter-rules");
+const linter_format_1 = require("../../../linter/linter-format");
+const ansi_1 = require("../../../util/text/ansi");
+const time_1 = require("../../../util/text/time");
+exports.LinterQueryDefinition = {
+    executor: linter_query_executor_1.executeLinterQuery,
+    asciiSummarizer: (formatter, _processed, queryResults, result) => {
+        const out = queryResults;
+        result.push(`Query: ${(0, ansi_1.bold)('linter', formatter)} (${(0, time_1.printAsMs)(out['.meta'].timing, 0)})`);
+        for (const [ruleName, results] of Object.entries(out.results)) {
+            const rule = linter_rules_1.LintingRules[ruleName];
+            result.push(`   ╰ ${ruleName}:`);
+            for (const certainty of [linter_format_1.LintingCertainty.Definitely, linter_format_1.LintingCertainty.Maybe]) {
+                const certaintyResults = results.results.filter(r => r.certainty === certainty);
+                if (certaintyResults.length) {
+                    result.push(`       ╰ ${certainty}:`);
+                    for (const res of certaintyResults) {
+                        result.push(`           ╰ ${rule.prettyPrint(res)}`);
+                    }
+                }
+            }
+            result.push(`       ╰ Metadata: ${JSON.stringify(results['.meta'])}`);
+        }
+        return true;
+    },
+    schema: joi_1.default.object({
+        type: joi_1.default.string().valid('linter').required().description('The type of the query.'),
+        rules: joi_1.default.array().items(joi_1.default.string().valid(...Object.keys(linter_rules_1.LintingRules)), joi_1.default.object({
+            name: joi_1.default.string().valid(...Object.keys(linter_rules_1.LintingRules)).required(),
+            config: joi_1.default.object()
+        })).description('The rules to lint for. If unset, all rules will be included.')
+    }).description('The linter query lints for the given set of rules and returns the result.'),
+    flattenInvolvedNodes: () => []
+};
+//# sourceMappingURL=linter-query-format.js.map

package/queries/catalog/location-map-query/location-map-query-format.d.ts

@@ -1,6 +1,6 @@
 import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
 import { executeLocationMapQuery } from './location-map-query-executor';
-import { type OutputFormatter } from '../../../util/ansi';
+import { type OutputFormatter } from '../../../util/text/ansi';
 import Joi from 'joi';
 import type { NodeId } from '../../../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { SourceRange } from '../../../util/range';
@@ -23,4 +23,5 @@ export declare const LocationMapQueryDefinition: {
     readonly executor: typeof executeLocationMapQuery;
     readonly asciiSummarizer: (formatter: OutputFormatter, _processed: unknown, queryResults: BaseQueryResult, result: string[]) => boolean;
     readonly schema: Joi.ObjectSchema<any>;
+    readonly flattenInvolvedNodes: () => never[];
 };

package/queries/catalog/location-map-query/location-map-query-format.js

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocationMapQueryDefinition = void 0;
 const location_map_query_executor_1 = require("./location-map-query-executor");
-const ansi_1 = require("../../../util/ansi");
-const time_1 = require("../../../util/time");
+const ansi_1 = require("../../../util/text/ansi");
+const time_1 = require("../../../util/text/time");
 const joi_1 = __importDefault(require("joi"));
 const query_print_1 = require("../../query-print");
 exports.LocationMapQueryDefinition = {
@@ -23,6 +23,7 @@ exports.LocationMapQueryDefinition = {
     },
     schema: joi_1.default.object({
         type: joi_1.default.string().valid('location-map').required().description('The type of the query.'),
-    }).description('The location map query retrieves the location of every id in the ast.')
+    }).description('The location map query retrieves the location of every id in the ast.'),
+    flattenInvolvedNodes: () => []
 };
 //# sourceMappingURL=location-map-query-format.js.map

package/queries/catalog/normalized-ast-query/normalized-ast-query-format.d.ts

@@ -13,7 +13,7 @@ export interface NormalizedAstQueryResult extends BaseQueryResult {
 }
 export declare const NormalizedAstQueryDefinition: {
     readonly executor: typeof executeNormalizedAstQuery;
-    readonly asciiSummarizer: (formatter: import("../../../util/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
         readonly name: "parse";
         readonly humanReadableName: "parse with R shell";
         readonly description: "Parse the given R code into an AST";
@@ -68,4 +68,5 @@ export declare const NormalizedAstQueryDefinition: {
         readonly dependencies: readonly ["normalize"];
     }>>, queryResults: BaseQueryResult, result: string[]) => true;
     readonly schema: Joi.ObjectSchema<any>;
+    readonly flattenInvolvedNodes: () => never[];
 };

package/queries/catalog/normalized-ast-query/normalized-ast-query-format.js

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NormalizedAstQueryDefinition = void 0;
 const normalized_ast_query_executor_1 = require("./normalized-ast-query-executor");
-const ansi_1 = require("../../../util/ansi");
-const time_1 = require("../../../util/time");
+const ansi_1 = require("../../../util/text/ansi");
+const time_1 = require("../../../util/text/time");
 const ast_1 = require("../../../util/mermaid/ast");
 const joi_1 = __importDefault(require("joi"));
 exports.NormalizedAstQueryDefinition = {
@@ -19,6 +19,7 @@ exports.NormalizedAstQueryDefinition = {
     },
     schema: joi_1.default.object({
         type: joi_1.default.string().valid('normalized-ast').required().description('The type of the query.'),
-    }).description('The normalized AST query simply returns the normalized AST, there is no need to pass it multiple times!')
+    }).description('The normalized AST query simply returns the normalized AST, there is no need to pass it multiple times!'),
+    flattenInvolvedNodes: () => []
 };
 //# sourceMappingURL=normalized-ast-query-format.js.map

package/queries/catalog/origin-query/origin-query-executor.d.ts

@@ -0,0 +1,5 @@
+import type { BasicQueryData } from '../../base-query-format';
+import type { SingleSlicingCriterion } from '../../../slicing/criterion/parse';
+import type { OriginQueryResult, OriginQuery } from './origin-query-format';
+export declare function fingerPrintOfQuery(query: OriginQuery): SingleSlicingCriterion;
+export declare function executeResolveValueQuery({ dataflow: { graph }, ast }: BasicQueryData, queries: readonly OriginQuery[]): OriginQueryResult;

package/queries/catalog/origin-query/origin-query-executor.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fingerPrintOfQuery = fingerPrintOfQuery;
+exports.executeResolveValueQuery = executeResolveValueQuery;
+const log_1 = require("../../../util/log");
+const parse_1 = require("../../../slicing/criterion/parse");
+const dfg_get_origin_1 = require("../../../dataflow/origin/dfg-get-origin");
+function fingerPrintOfQuery(query) {
+    return query.criterion;
+}
+function executeResolveValueQuery({ dataflow: { graph }, ast }, queries) {
+    const start = Date.now();
+    const results = {};
+    for (const query of queries) {
+        const key = fingerPrintOfQuery(query);
+        if (results[key]) {
+            log_1.log.warn(`Duplicate Key for origin-query: ${key}, skipping...`);
+        }
+        const astId = (0, parse_1.slicingCriterionToId)(key, ast.idMap);
+        if (astId === undefined) {
+            log_1.log.warn(`Could not resolve id for ${key}, skipping...`);
+            continue;
+        }
+        results[key] = (0, dfg_get_origin_1.getOriginInDfg)(graph, astId);
+    }
+    return {
+        '.meta': {
+            timing: Date.now() - start
+        },
+        results
+    };
+}
+//# sourceMappingURL=origin-query-executor.js.map

package/queries/catalog/origin-query/origin-query-format.d.ts

@@ -0,0 +1,73 @@
+import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
+import type { SingleSlicingCriterion } from '../../../slicing/criterion/parse';
+import Joi from 'joi';
+import { executeResolveValueQuery } from './origin-query-executor';
+import type { Origin } from '../../../dataflow/origin/dfg-get-origin';
+import type { NodeId } from '../../../r-bridge/lang-4.x/ast/model/processing/node-id';
+export interface OriginQuery extends BaseQueryFormat {
+    readonly type: 'origin';
+    /** The slicing criteria to use */
+    readonly criterion: SingleSlicingCriterion;
+}
+export interface OriginQueryResult extends BaseQueryResult {
+    results: Record<SingleSlicingCriterion, Origin[] | undefined>;
+}
+export declare const OriginQueryDefinition: {
+    readonly executor: typeof executeResolveValueQuery;
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
+        readonly name: "parse";
+        readonly humanReadableName: "parse with R shell";
+        readonly description: "Parse the given R code into an AST";
+        readonly processor: (_results: unknown, input: Partial<import("../../../r-bridge/parser").ParseRequiredInput<string>>) => Promise<import("../../../r-bridge/parser").ParseStepOutput<string>>;
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: {
+                (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
+                (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
+            };
+            readonly 5: ({ parsed }: import("../../../r-bridge/parser").ParseStepOutput<string>, config: import("../../../util/quads").QuadSerializationConfiguration) => string;
+        };
+        readonly dependencies: readonly [];
+        readonly requiredInput: import("../../../r-bridge/parser").ParseRequiredInput<string>;
+    } | {
+        readonly name: "normalize";
+        readonly humanReadableName: "normalize";
+        readonly description: "Normalize the AST to flowR's AST";
+        readonly processor: (results: {
+            parse?: import("../../../r-bridge/parser").ParseStepOutput<string>;
+        }, input: Partial<import("../../../core/steps/all/core/10-normalize").NormalizeRequiredInput>) => import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst<import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, import("../../../r-bridge/lang-4.x/ast/model/model").RNode<import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>>;
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: typeof import("../../../core/print/normalize-printer").normalizedAstToJson;
+            readonly 5: typeof import("../../../core/print/normalize-printer").normalizedAstToQuads;
+            readonly 3: typeof import("../../../core/print/normalize-printer").printNormalizedAstToMermaid;
+            readonly 4: typeof import("../../../core/print/normalize-printer").printNormalizedAstToMermaidUrl;
+        };
+        readonly dependencies: readonly ["parse"];
+        readonly requiredInput: import("../../../core/steps/all/core/10-normalize").NormalizeRequiredInput;
+    } | {
+        readonly humanReadableName: "dataflow";
+        readonly processor: (results: {
+            normalize?: import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
+        }, input: {
+            request?: import("../../../r-bridge/retriever").RParseRequests;
+            parser?: import("../../../r-bridge/parser").Parser<import("../../../r-bridge/parser").KnownParserType>;
+        }) => import("../../../dataflow/info").DataflowInformation;
+        readonly requiredInput: {};
+        readonly name: "dataflow";
+        readonly description: "Construct the dataflow graph";
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: typeof import("../../../core/print/dataflow-printer").dataflowGraphToJson;
+            readonly 5: typeof import("../../../core/print/dataflow-printer").dataflowGraphToQuads;
+            readonly 3: typeof import("../../../core/print/dataflow-printer").dataflowGraphToMermaid;
+            readonly 4: typeof import("../../../core/print/dataflow-printer").dataflowGraphToMermaidUrl;
+        };
+        readonly dependencies: readonly ["normalize"];
+    }>>, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly schema: Joi.ObjectSchema<any>;
+    readonly flattenInvolvedNodes: (queryResults: BaseQueryResult) => NodeId[];
+};

package/queries/catalog/origin-query/origin-query-format.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OriginQueryDefinition = void 0;
+const ansi_1 = require("../../../util/text/ansi");
+const time_1 = require("../../../util/text/time");
+const joi_1 = __importDefault(require("joi"));
+const origin_query_executor_1 = require("./origin-query-executor");
+exports.OriginQueryDefinition = {
+    executor: origin_query_executor_1.executeResolveValueQuery,
+    asciiSummarizer: (formatter, _processed, queryResults, result) => {
+        const out = queryResults;
+        result.push(`Query: ${(0, ansi_1.bold)('origin', formatter)} (${(0, time_1.printAsMs)(out['.meta'].timing, 0)})`);
+        for (const [criteria, obj] of Object.entries(out.results)) {
+            result.push(`   ╰ Origins for {${criteria}}`);
+            result.push(`   	╰ ${obj?.map(o => JSON.stringify(o)).join(', ')}`);
+        }
+        return true;
+    },
+    schema: joi_1.default.object({
+        type: joi_1.default.string().valid('origin').required().description('The type of the query.'),
+        criterion: joi_1.default.string().required().description('The slicing criteria to use'),
+    }).description('The resolve value query used to get definitions of an identifier'),
+    flattenInvolvedNodes: (queryResults) => {
+        const out = queryResults;
+        return Object.entries(out.results).flatMap(([_, obj]) => obj?.map(origin => origin.id) ?? []);
+    }
+};
+//# sourceMappingURL=origin-query-format.js.map

package/queries/catalog/project-query/project-query-executor.js

@@ -4,7 +4,7 @@ exports.executeProjectQuery = executeProjectQuery;
 const log_1 = require("../../../util/log");
 function executeProjectQuery({ dataflow }, queries) {
     if (queries.length !== 1) {
-        log_1.log.warn('Id-Map query expects only up to one query, but got', queries.length);
+        log_1.log.warn('Project query expects only up to one query, but got', queries.length);
     }
     return {
         '.meta': {

package/queries/catalog/project-query/project-query-format.d.ts

@@ -9,7 +9,7 @@ export interface ProjectQueryResult extends BaseQueryResult {
 }
 export declare const ProjectQueryDefinition: {
     readonly executor: typeof executeProjectQuery;
-    readonly asciiSummarizer: (formatter: import("../../../util/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
         readonly name: "parse";
         readonly humanReadableName: "parse with R shell";
         readonly description: "Parse the given R code into an AST";
@@ -64,4 +64,5 @@ export declare const ProjectQueryDefinition: {
         readonly dependencies: readonly ["normalize"];
     }>>, queryResults: BaseQueryResult, result: string[]) => true;
     readonly schema: Joi.ObjectSchema<any>;
+    readonly flattenInvolvedNodes: () => never[];
 };

package/queries/catalog/project-query/project-query-format.js

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProjectQueryDefinition = void 0;
 const project_query_executor_1 = require("./project-query-executor");
-const ansi_1 = require("../../../util/ansi");
-const time_1 = require("../../../util/time");
+const ansi_1 = require("../../../util/text/ansi");
+const time_1 = require("../../../util/text/time");
 const joi_1 = __importDefault(require("joi"));
 exports.ProjectQueryDefinition = {
     executor: project_query_executor_1.executeProjectQuery,
@@ -21,6 +21,7 @@ exports.ProjectQueryDefinition = {
     },
     schema: joi_1.default.object({
         type: joi_1.default.string().valid('project').required().description('The type of the query.'),
-    }).description('The project query provides information on the analyzed project.')
+    }).description('The project query provides information on the analyzed project.'),
+    flattenInvolvedNodes: () => []
 };
 //# sourceMappingURL=project-query-format.js.map