@eagleoutice/flowr 2.6.0 → 2.6.2

package/cli/repl/server/compact.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Compacts an object into a UTF-16 compressed string.
+ * @see {@link uncompact}
+ */
 export declare function compact(obj: unknown): string;
+/**
+ * Uncompacts a UTF-16 compressed string into an object.
+ * @see {@link compact}
+ */
 export declare function uncompact(buf: string): unknown;

package/cli/repl/server/compact.js

@@ -4,9 +4,17 @@ exports.compact = compact;
 exports.uncompact = uncompact;
 const json_1 = require("../../../util/json");
 const lz_string_1 = require("lz-string");
+/**
+ * Compacts an object into a UTF-16 compressed string.
+ * @see {@link uncompact}
+ */
 function compact(obj) {
     return (0, lz_string_1.compressToUTF16)(JSON.stringify(obj, json_1.jsonReplacer));
 }
+/**
+ * Uncompacts a UTF-16 compressed string into an object.
+ * @see {@link compact}
+ */
 function uncompact(buf) {
     return JSON.parse((0, lz_string_1.decompressFromUTF16)(buf));
 }

package/cli/repl/server/connection.d.ts

@@ -1,6 +1,5 @@
 import type { Socket } from './net';
-import type { TREE_SITTER_DATAFLOW_PIPELINE } from '../../../core/steps/pipeline/default-pipelines';
-import { DEFAULT_SLICING_PIPELINE } from '../../../core/steps/pipeline/default-pipelines';
+import { type TREE_SITTER_DATAFLOW_PIPELINE, DEFAULT_SLICING_PIPELINE } from '../../../core/steps/pipeline/default-pipelines';
 import type { PipelineOutput } from '../../../core/steps/pipeline/pipeline';
 import type { DeepPartial } from 'ts-essentials';
 import type { KnownParser, ParseStepOutput } from '../../../r-bridge/parser';
@@ -28,7 +27,9 @@ export declare class FlowRServerConnection {
     private createAnalyzerForRequest;
     private handleSliceRequest;
     private handleRepl;
-    private handleLineageRequest;
     private handleQueryRequest;
 }
+/**
+ * Sanitizes analysis results by removing any potentially sensitive information like id maps.
+ */
 export declare function sanitizeAnalysisResults(parse: ParseStepOutput<string | Tree>, normalize: NormalizedAst, dataflow: DataflowInformation): DeepPartial<PipelineOutput<typeof DEFAULT_SLICING_PIPELINE | typeof TREE_SITTER_DATAFLOW_PIPELINE>>;

package/cli/repl/server/connection.js

@@ -56,8 +56,6 @@ const default_pipelines_1 = require("../../../core/steps/pipeline/default-pipeli
 const graph_1 = require("../../../dataflow/graph/graph");
 const tmp = __importStar(require("tmp"));
 const fs_1 = __importDefault(require("fs"));
-const message_lineage_1 = require("./messages/message-lineage");
-const repl_lineage_1 = require("../commands/repl-lineage");
 const message_query_1 = require("./messages/message-query");
 const compact_1 = require("./compact");
 const _00_slice_1 = require("../../../core/steps/all/static-slicing/00-slice");
@@ -116,9 +114,6 @@ class FlowRServerConnection {
             case 'request-repl-execution':
                 this.handleRepl(request.message);
                 break;
-            case 'request-lineage':
-                void this.handleLineageRequest(request.message);
-                break;
             case 'request-query':
                 this.handleQueryRequest(request.message);
                 break;
@@ -287,43 +282,21 @@ class FlowRServerConnection {
                 stream
             });
         };
-        void (0, core_1.replProcessAnswer)(this.config, {
+        const analyzer = new flowr_analyzer_builder_1.FlowrAnalyzerBuilder()
+            .setConfig(this.config)
+            .setParser(this.parser)
+            .buildSync();
+        void (0, core_1.replProcessAnswer)(analyzer, {
             formatter: request.ansi ? ansi_1.ansiFormatter : ansi_1.voidFormatter,
             stdout: msg => out('stdout', msg),
             stderr: msg => out('stderr', msg)
-        }, request.expression, this.parser, this.allowRSessionAccess).then(() => {
+        }, request.expression, this.allowRSessionAccess).then(() => {
             (0, send_1.sendMessage)(this.socket, {
                 type: 'end-repl-execution',
                 id: request.id
             });
         });
     }
-    async handleLineageRequest(base) {
-        const requestResult = (0, validate_1.validateMessage)(base, message_lineage_1.requestLineageMessage);
-        if (requestResult.type === 'error') {
-            (0, validate_1.answerForValidationError)(this.socket, requestResult, base.id);
-            return;
-        }
-        const request = requestResult.message;
-        this.logger.info(`[${this.name}] Received lineage request for criterion ${request.criterion}`);
-        const fileInformation = this.fileMap.get(request.filetoken);
-        if (!fileInformation) {
-            (0, send_1.sendMessage)(this.socket, {
-                id: request.id,
-                type: 'error',
-                fatal: false,
-                reason: `The file token ${request.filetoken} has never been analyzed.`
-            });
-            return;
-        }
-        const analyzer = fileInformation.analyzer;
-        const lineageIds = (0, repl_lineage_1.getLineage)(request.criterion, (await analyzer.dataflow()).graph, (await analyzer.normalize()).idMap);
-        (0, send_1.sendMessage)(this.socket, {
-            type: 'response-lineage',
-            id: request.id,
-            lineage: [...lineageIds]
-        });
-    }
     handleQueryRequest(base) {
         const requestResult = (0, validate_1.validateMessage)(base, message_query_1.requestQueryMessage);
         if (requestResult.type === 'error') {
@@ -360,6 +333,9 @@ class FlowRServerConnection {
     }
 }
 exports.FlowRServerConnection = FlowRServerConnection;
+/**
+ * Sanitizes analysis results by removing any potentially sensitive information like id maps.
+ */
 function sanitizeAnalysisResults(parse, normalize, dataflow) {
     return {
         parse: parse,

package/cli/repl/server/messages/all-messages.d.ts

@@ -1,6 +1,5 @@
 /**
  * Provides the capability of connecting to the repl of flowr via messages.
- *
  * @module
  */
 import * as Joi from 'joi';
@@ -9,7 +8,6 @@ import type { FileAnalysisRequestMessage, FileAnalysisResponseMessageJson } from
 import type { ExecuteEndMessage, ExecuteIntermediateResponseMessage, ExecuteRequestMessage } from './message-repl';
 import type { SliceRequestMessage, SliceResponseMessage } from './message-slice';
 import type { FlowrErrorMessage } from './message-error';
-import type { LineageRequestMessage, LineageResponseMessage } from './message-lineage';
 import type { QueryRequestMessage, QueryResponseMessage } from './message-query';
 /**
  * If you send a message it must *not* contain a newline but the message must be terminated by a newline.
@@ -34,4 +32,4 @@ export declare const baseMessage: MessageDefinition<IdMessageBase>;
 /**
  * This is the main message type that should be used to represent a message in *flowR*
  */
-export type FlowrMessage = FlowrHelloResponseMessage | FileAnalysisRequestMessage | FileAnalysisResponseMessageJson | ExecuteRequestMessage | ExecuteIntermediateResponseMessage | ExecuteEndMessage | SliceRequestMessage | SliceResponseMessage | LineageRequestMessage | LineageResponseMessage | QueryRequestMessage | QueryResponseMessage | FlowrErrorMessage;
+export type FlowrMessage = FlowrHelloResponseMessage | FileAnalysisRequestMessage | FileAnalysisResponseMessageJson | ExecuteRequestMessage | ExecuteIntermediateResponseMessage | ExecuteEndMessage | SliceRequestMessage | SliceResponseMessage | QueryRequestMessage | QueryResponseMessage | FlowrErrorMessage;

package/cli/repl/server/messages/all-messages.js

@@ -36,7 +36,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.baseMessage = void 0;
 /**
  * Provides the capability of connecting to the repl of flowr via messages.
- *
  * @module
  */
 const Joi = __importStar(require("joi"));

package/cli/repl/server/messages/message-analysis.d.ts

@@ -42,9 +42,7 @@ export declare const requestAnalysisMessage: MessageDefinition<FileAnalysisReque
  *
  * The `idMap` of the normalization step (see {@link NormalizedAst}) is not serialized as it would essentially
  * repeat the complete normalized AST, you have to re-create it yourself if you require it.
- *
  * @note The serialization of maps and sets is controlled by the {@link jsonReplacer} as part of {@link sendMessage}.
- *
  * @see {@link FileAnalysisResponseMessageNQuads}
  * @see {@link FileAnalysisResponseMessageCompact}
  */

package/cli/repl/server/messages/message-hello.d.ts

@@ -1,5 +1,5 @@
-import type { VersionInformation } from '../../commands/repl-version';
 import type { IdMessageBase, MessageDefinition } from './all-messages';
+import type { VersionInformation } from '../../../../util/version';
 /**
  * The hello message is automatically sent by the sever upon connection.
  */

package/cli/repl/server/messages/message-query.d.ts

@@ -1,5 +1,5 @@
 import type { IdMessageBase, MessageDefinition } from './all-messages';
-import type { Queries, QueryResults, SupportedQueryTypes } from '../../../../queries/query';
+import { type Queries, type QueryResults, type SupportedQueryTypes } from '../../../../queries/query';
 export interface QueryRequestMessage extends IdMessageBase {
     type: 'request-query';
     /** The {@link FileAnalysisRequestMessage#filetoken} of the file/data */

package/cli/repl/server/messages/message-repl.d.ts

@@ -3,7 +3,6 @@ import type { IdMessageBase, MessageDefinition } from './all-messages';
  * Request the execution of the given expression as a REPL statement.
  * We strongly recommend that you make use of a unique {@link IdMessageBase#id}
  * in case the message responses happen in parallel.
- *
  * @see ExecuteIntermediateResponseMessage
  * @see ExecuteEndMessage
  */

package/cli/repl/server/send.d.ts

@@ -1,4 +1,10 @@
 import type { IdMessageBase } from './messages/all-messages';
 import type { Socket } from './net';
+/**
+ * Produce a new name for an unnamed socket connection
+ */
 export declare function getUnnamedSocketName(c: Socket): string;
+/**
+ * Sends a message to the given socket
+ */
 export declare function sendMessage<T extends IdMessageBase>(c: Socket, message: T): void;

package/cli/repl/server/send.js

@@ -3,9 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUnnamedSocketName = getUnnamedSocketName;
 exports.sendMessage = sendMessage;
 const json_1 = require("../../../util/json");
+/**
+ * Produce a new name for an unnamed socket connection
+ */
 function getUnnamedSocketName(c) {
     return `${c.remoteAddress ?? '?'}@${c.remotePort ?? '?'}`;
 }
+/**
+ * Sends a message to the given socket
+ */
 function sendMessage(c, message) {
     return (0, json_1.superBigJsonStringify)(message, '\n', msg => {
         c.write(msg);

package/cli/repl/server/server.d.ts

@@ -1,4 +1,4 @@
-import type { Server } from './net';
+import { type Server } from './net';
 import { FlowrLogger } from '../../../util/log';
 import type { FlowrConfigOptions, KnownEngines } from '../../../config';
 export declare const serverLog: FlowrLogger;

package/cli/repl/server/server.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowRServer = exports.serverLog = void 0;
-const repl_version_1 = require("../commands/repl-version");
 const connection_1 = require("./connection");
 const send_1 = require("./send");
 const net_1 = require("./net");
 const log_1 = require("../../../util/log");
+const version_1 = require("../../../util/version");
 // we detach from the main logger so that it can have its own switch
 exports.serverLog = new log_1.FlowrLogger({ name: 'server' });
 /**
@@ -32,7 +32,7 @@ class FlowRServer {
         this.config = config;
     }
     async start(port) {
-        this.versionInformation = await (0, repl_version_1.retrieveVersionInformation)(this.engines[this.defaultEngine]);
+        this.versionInformation = await (0, version_1.retrieveVersionInformation)(this.engines[this.defaultEngine]);
         this.server.start(port);
         exports.serverLog.info(`Server listening on port ${port}`);
     }

package/cli/repl/server/validate.d.ts

@@ -1,5 +1,5 @@
 import type * as Joi from 'joi';
-import type { FlowrMessage, IdMessageBase, MessageDefinition } from './messages/all-messages';
+import { type FlowrMessage, type IdMessageBase, type MessageDefinition } from './messages/all-messages';
 import type { Socket } from './net';
 export interface ValidationErrorResult {
     type: 'error';
@@ -10,6 +10,15 @@ export interface SuccessValidationResult<T extends IdMessageBase> {
     message: T;
 }
 export type ValidationResult<T extends IdMessageBase> = SuccessValidationResult<T> | ValidationErrorResult;
+/**
+ * Check that the serialized input is a valid base message.
+ */
 export declare function validateBaseMessageFormat(input: string): ValidationResult<IdMessageBase>;
+/**
+ * Validates that the given input matches the given message definition.
+ */
 export declare function validateMessage<T extends FlowrMessage | IdMessageBase>(input: IdMessageBase, def: MessageDefinition<T>): ValidationResult<T>;
+/**
+ * Sends an error message to the given client indicating a validation error.
+ */
 export declare function answerForValidationError(client: Socket, result: ValidationErrorResult, id?: string): void;

package/cli/repl/server/validate.js

@@ -5,6 +5,9 @@ exports.validateMessage = validateMessage;
 exports.answerForValidationError = answerForValidationError;
 const send_1 = require("./send");
 const all_messages_1 = require("./messages/all-messages");
+/**
+ * Check that the serialized input is a valid base message.
+ */
 function validateBaseMessageFormat(input) {
     try {
         return validateMessage(JSON.parse(input), all_messages_1.baseMessage);
@@ -13,6 +16,9 @@ function validateBaseMessageFormat(input) {
         return { type: 'error', reason: e };
     }
 }
+/**
+ * Validates that the given input matches the given message definition.
+ */
 function validateMessage(input, def) {
     try {
         const result = def.schema.validate(input);
@@ -22,6 +28,9 @@ function validateMessage(input, def) {
         return { type: 'error', reason: e };
     }
 }
+/**
+ * Sends an error message to the given client indicating a validation error.
+ */
 function answerForValidationError(client, result, id) {
     (0, send_1.sendMessage)(client, {
         type: 'error',

package/cli/run-script.d.ts

@@ -1,8 +1,7 @@
-import type { StdioProcessor } from './repl/execute';
+import { type StdioProcessor } from './repl/execute';
 import { scripts } from './common/scripts-info';
 /**
  * Path-safe helper of {@link waitOnScript} for other flowR scripts.
- *
  * @see waitOnScript
  */
 export declare function runScript(name: keyof typeof scripts, args: readonly string[], io?: StdioProcessor, exitOnError?: boolean): Promise<void>;

package/cli/run-script.js

@@ -9,7 +9,6 @@ const scripts_info_1 = require("./common/scripts-info");
 const path_1 = __importDefault(require("path"));
 /**
  * Path-safe helper of {@link waitOnScript} for other flowR scripts.
- *
  * @see waitOnScript
  */
 async function runScript(name, args, io, exitOnError = false) {

package/cli/script-core/statistics-core.d.ts

@@ -1,3 +1,6 @@
 import type { StatsCliOptions } from '../statistics-app';
 import type { FlowrConfigOptions } from '../../config';
+/**
+ * The core function for the 'flowr stats' script.
+ */
 export declare function flowrScriptGetStats(options: StatsCliOptions, config: FlowrConfigOptions): Promise<void>;

package/cli/script-core/statistics-core.js

@@ -57,6 +57,9 @@ async function collectFileArguments(options, verboseAdd, dumpJson, features) {
     console.log(`Total: ${counter} files (${skipped} skipped with archive existing)`);
     return files;
 }
+/**
+ * The core function for the 'flowr stats' script.
+ */
 async function flowrScriptGetStats(options, config) {
     if (options.input.length === 0) {
         console.error('No input files given. Nothing to do. See \'--help\' if this is an error.');

package/cli/script-core/statistics-helper-core.d.ts

@@ -1,3 +1,6 @@
 import type { StatsHelperCliOptions } from '../statistics-helper-app';
-import type { FlowrConfigOptions } from '../../config';
+import { type FlowrConfigOptions } from '../../config';
+/**
+ * Get statistics for a single file
+ */
 export declare function getStatsForSingleFile(options: StatsHelperCliOptions, config: FlowrConfigOptions): Promise<void>;

package/cli/script-core/statistics-helper-core.js

@@ -36,6 +36,9 @@ function compressFolder(folder, target) {
         console.error('Error during compression:', e);
     });
 }
+/**
+ * Get statistics for a single file
+ */
 async function getStatsForSingleFile(options, config) {
     if (options['no-ansi']) {
         log_1.log.info('disabling ansi colors');

package/cli/script-core/summarizer-core.d.ts

@@ -1,2 +1,5 @@
 import type { SummarizerCliOptions } from '../summarizer-app';
+/**
+ * The core function for the 'flowr summarize' script.
+ */
 export declare function flowrScriptSummarizer(options: SummarizerCliOptions): Promise<void>;

package/cli/script-core/summarizer-core.js

@@ -39,6 +39,9 @@ async function retrieveSummarizer(options, outputBase) {
         process.exit(1);
     }
 }
+/**
+ * The core function for the 'flowr summarize' script.
+ */
 async function flowrScriptSummarizer(options) {
     const outputBase = (options.output ?? options.input).replace(/\.json$|\/$/, '-summary');
     console.log(`Writing outputs to base ${outputBase}`);

package/cli/summarizer-app.d.ts

@@ -1,8 +1,7 @@
 /**
  * The summarizer intends to post-process and summarize the results of
- * * the benchmark tool, and
- * * the statistics extraction.
- *
+ * the benchmark tool, and
+ * the statistics extraction.
  * @module
  */
 export interface SummarizerCliOptions {

package/cli/summarizer-app.js

@@ -1,9 +1,8 @@
 "use strict";
 /**
  * The summarizer intends to post-process and summarize the results of
- * * the benchmark tool, and
- * * the statistics extraction.
- *
+ * the benchmark tool, and
+ * the statistics extraction.
  * @module
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/config.d.ts

@@ -1,4 +1,4 @@
-import type { MergeableRecord } from './util/objects';
+import { type MergeableRecord } from './util/objects';
 import Joi from 'joi';
 import type { BuiltInDefinitions } from './dataflow/environments/built-in-config';
 import type { KnownParser } from './r-bridge/parser';
@@ -59,10 +59,9 @@ export interface FlowrLaxSourcingOptions extends MergeableRecord {
      */
     readonly repeatedSourceLimit?: number;
     /**
-     * sometimes files may have a different name in the source call	(e.g., due to later replacements),
+     * sometimes files may have a different name in the source call (e.g., due to later replacements),
      * with this setting you can provide a list of replacements to apply for each sourced file.
      * Every replacement consists of a record that maps a regex to a replacement string.
-     *
      * @example
      * ```ts
      * [
@@ -205,14 +204,29 @@ export type KnownEngines = {
 };
 export declare const defaultConfigOptions: FlowrConfigOptions;
 export declare const flowrConfigFileSchema: Joi.ObjectSchema<any>;
+/**
+ * Parses the given JSON string as a flowR config file.
+ */
 export declare function parseConfig(jsonString: string): FlowrConfigOptions | undefined;
 /**
  * Creates a new flowr config that has the updated values.
  */
 export declare function amendConfig(config: FlowrConfigOptions, amendmentFunc: (config: DeepWritable<FlowrConfigOptions>) => FlowrConfigOptions | void): FlowrConfigOptions;
+/**
+ * Clones the given flowr config object.
+ */
 export declare function cloneConfig(config: FlowrConfigOptions): FlowrConfigOptions;
+/**
+ * Loads the flowr config from the given file or the default locations.
+ */
 export declare function getConfig(configFile?: string, configWorkingDirectory?: string): FlowrConfigOptions;
+/**
+ * Gets the configuration for the given engine type from the config.
+ */
 export declare function getEngineConfig<T extends EngineConfig['type']>(config: FlowrConfigOptions, engine: T): EngineConfig & {
     type: T;
 } | undefined;
+/**
+ * Checks whether the given count is over the pointer analysis threshold configured in the config.
+ */
 export declare function isOverPointerAnalysisThreshold(config: FlowrConfigOptions, count: number): boolean;

package/config.js

@@ -142,6 +142,9 @@ exports.flowrConfigFileSchema = joi_1.default.object({
         }).description('The configuration of the shape inference for data frames.')
     }).description('The configuration options for abstract interpretation.')
 }).description('The configuration file format for flowR.');
+/**
+ * Parses the given JSON string as a flowR config file.
+ */
 function parseConfig(jsonString) {
     try {
         const parsed = JSON.parse(jsonString);
@@ -168,9 +171,15 @@ function amendConfig(config, amendmentFunc) {
     amendmentFunc(newConfig);
     return newConfig;
 }
+/**
+ * Clones the given flowr config object.
+ */
 function cloneConfig(config) {
     return JSON.parse(JSON.stringify(config));
 }
+/**
+ * Loads the flowr config from the given file or the default locations.
+ */
 function getConfig(configFile, configWorkingDirectory = process.cwd()) {
     try {
         return loadConfigFromFile(configFile, configWorkingDirectory);
@@ -180,6 +189,9 @@ function getConfig(configFile, configWorkingDirectory = process.cwd()) {
         return exports.defaultConfigOptions;
     }
 }
+/**
+ * Gets the configuration for the given engine type from the config.
+ */
 function getEngineConfig(config, engine) {
     const engines = config.engines;
     if (!engines.length) {
@@ -198,6 +210,9 @@ function getPointerAnalysisThreshold(config) {
         return pointerTracking ? 'unlimited' : 'disabled';
     }
 }
+/**
+ * Checks whether the given count is over the pointer analysis threshold configured in the config.
+ */
 function isOverPointerAnalysisThreshold(config, count) {
     const threshold = getPointerAnalysisThreshold(config);
     return threshold !== 'unlimited' && (threshold === 'disabled' || count > threshold);

package/control-flow/basic-cfg-guided-visitor.d.ts

@@ -1,4 +1,4 @@
-import type { CfgBasicBlockVertex, CfgEndMarkerVertex, CfgExpressionVertex, CfgSimpleVertex, CfgStatementVertex, ControlFlowInformation } from './control-flow-graph';
+import { type CfgBasicBlockVertex, type CfgEndMarkerVertex, type CfgExpressionVertex, type CfgSimpleVertex, type CfgStatementVertex, type ControlFlowInformation } from './control-flow-graph';
 import type { NodeId } from '../r-bridge/lang-4.x/ast/model/processing/node-id';
 export interface BasicCfgGuidedVisitorConfiguration<ControlFlow extends ControlFlowInformation = ControlFlowInformation> {
     readonly controlFlow: ControlFlow;
@@ -17,7 +17,6 @@ export declare class BasicCfgGuidedVisitor<ControlFlow extends ControlFlowInform
     constructor(config: Config);
     /**
      * call this function to indicate that a node is to be considered visited.
-     *
      * @returns `true` if the node was not visited before, `false` otherwise
      */
     protected visitNode(node: NodeId): boolean;

package/control-flow/basic-cfg-guided-visitor.js

@@ -19,7 +19,6 @@ class BasicCfgGuidedVisitor {
     }
     /**
      * call this function to indicate that a node is to be considered visited.
-     *
      * @returns `true` if the node was not visited before, `false` otherwise
      */
     visitNode(node) {

package/control-flow/cfg-to-basic-blocks.d.ts

@@ -1,4 +1,4 @@
-import type { ControlFlowInformation } from './control-flow-graph';
+import { type ControlFlowInformation } from './control-flow-graph';
 /**
  * Take a control flow information of a graph without any basic blocks and convert it to a graph with basic blocks.
  */