@eagleoutice/flowr 2.0.25 → 2.1.0

package/cli/repl/commands/repl-query.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.queryStarCommand = exports.queryCommand = void 0;
+exports.asciiSummaryOfQueryResult = asciiSummaryOfQueryResult;
+const pipeline_executor_1 = require("../../../core/pipeline-executor");
+const default_pipelines_1 = require("../../../core/steps/pipeline/default-pipelines");
+const retriever_1 = require("../../../r-bridge/retriever");
+const args_1 = require("../../../util/args");
+const ansi_1 = require("../../../util/ansi");
+const schema_1 = require("../../../util/schema");
+const query_1 = require("../../../queries/query");
+const json_1 = require("../../../util/json");
+const query_schema_1 = require("../../../queries/query-schema");
+const built_in_1 = require("../../../dataflow/environments/built-in");
+async function getDataflow(shell, remainingLine) {
+    return await new pipeline_executor_1.PipelineExecutor(default_pipelines_1.DEFAULT_DATAFLOW_PIPELINE, {
+        shell,
+        request: (0, retriever_1.requestFromInput)(remainingLine.trim())
+    }).allRemainingSteps();
+}
+function printHelp(output) {
+    output.stderr(`Format: ${(0, ansi_1.italic)(':query "<query>" <code>', output.formatter)}`);
+    output.stdout('The query is an array of query objects to represent multiple queries. Each query object may have the following properties:');
+    output.stdout((0, schema_1.describeSchema)(query_schema_1.AnyQuerySchema, output.formatter));
+    output.stdout(`\n\nThe example ${(0, ansi_1.italic)(':query "[{\\"type\\": \\"call-context\\", \\"callName\\": \\"mean\\" }]" mean(1:10)', output.formatter)} would return the call context of the mean function.`);
+    output.stdout('As a convenience, we interpret any (non-help) string not starting with \'[\' as a regex for the simple call-context query.');
+    output.stdout(`Hence, ${(0, ansi_1.italic)(':query "mean" mean(1:10)', output.formatter)} is equivalent to the above example.`);
+}
+async function processQueryArgs(line, shell, output) {
+    const args = (0, args_1.splitAtEscapeSensitive)(line);
+    const query = args.shift();
+    if (!query) {
+        output.stderr(`No query provided, use ':query help' to get more information.`);
+        return;
+    }
+    if (query === 'help') {
+        printHelp(output);
+        return;
+    }
+    let parsedQuery = [];
+    if (query.startsWith('[')) {
+        parsedQuery = JSON.parse(query);
+        const validationResult = query_schema_1.QueriesSchema.validate(parsedQuery);
+        if (validationResult.error) {
+            output.stderr(`Invalid query: ${validationResult.error.message}`);
+            printHelp(output);
+            return;
+        }
+    }
+    else {
+        parsedQuery = [{ type: 'call-context', callName: query }];
+    }
+    const processed = await getDataflow(shell, args.join(' '));
+    return {
+        query: (0, query_1.executeQueries)({ graph: processed.dataflow.graph, ast: processed.normalize }, parsedQuery),
+        processed
+    };
+}
+function nodeString(id, formatter, processed) {
+    if (id === built_in_1.BuiltIn) {
+        return (0, ansi_1.italic)('built-in', formatter);
+    }
+    const node = processed.normalize.idMap.get(id);
+    if (node === undefined) {
+        return `UNKNOWN: ${id}`;
+    }
+    return `${(0, ansi_1.italic)('`' + (node.lexeme ?? node.info.fullLexeme ?? 'UNKNOWN') + '`', formatter)} (L.${node.location?.[0]})`;
+}
+function asciiCallContextSubHit(formatter, results, processed) {
+    const result = [];
+    for (const { id, calls = [], linkedIds = [], aliasRoots = [] } of results) {
+        const node = processed.normalize.idMap.get(id);
+        if (node === undefined) {
+            result.push(` ${(0, ansi_1.bold)('UNKNOWN: ' + JSON.stringify({ calls, linkedIds }))}`);
+            continue;
+        }
+        let line = nodeString(id, formatter, processed);
+        if (calls.length > 0) {
+            line += ` with ${calls.length} call${calls.length > 1 ? 's' : ''} (${calls.map(c => nodeString(c, formatter, processed)).join(', ')})`;
+        }
+        if (linkedIds.length > 0) {
+            line += ` with ${linkedIds.length} link${linkedIds.length > 1 ? 's' : ''} (${linkedIds.map(c => nodeString(c, formatter, processed)).join(', ')})`;
+        }
+        if (aliasRoots.length > 0) {
+            line += ` with ${aliasRoots.length} alias root${aliasRoots.length > 1 ? 's' : ''} (${aliasRoots.map(c => nodeString(c, formatter, processed)).join(', ')})`;
+        }
+        result.push(line);
+    }
+    return result.join(', ');
+}
+function asciiCallContext(formatter, results, processed) {
+    /* traverse over 'kinds' and within them 'subkinds' */
+    const result = [];
+    for (const [kind, { subkinds }] of Object.entries(results['kinds'])) {
+        result.push(`   ╰ ${(0, ansi_1.bold)(kind, formatter)}`);
+        for (const [subkind, values] of Object.entries(subkinds)) {
+            result.push(`     ╰ ${(0, ansi_1.bold)(subkind, formatter)}: ${asciiCallContextSubHit(formatter, values, processed)}`);
+        }
+    }
+    return result.join('\n');
+}
+function asciiSummaryOfQueryResult(formatter, totalInMs, results, processed) {
+    const result = [];
+    for (const [query, queryResults] of Object.entries(results)) {
+        if (query === '.meta') {
+            continue;
+        }
+        if (query === 'call-context') {
+            const out = queryResults;
+            result.push(`Query: ${(0, ansi_1.bold)(query, formatter)} (${out['.meta'].timing.toFixed(0)}ms)`);
+            result.push(asciiCallContext(formatter, out, processed));
+            continue;
+        }
+        result.push(`Query: ${(0, ansi_1.bold)(query, formatter)}`);
+        let timing = -1;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        for (const [key, value] of Object.entries(queryResults)) {
+            if (key === '.meta') {
+                timing = value.timing;
+                continue;
+            }
+            result.push(` ╰ ${key}: ${JSON.stringify(value)}`);
+        }
+        result.push(`  - Took ${timing.toFixed(0)}ms`);
+    }
+    result.push((0, ansi_1.italic)(`All queries together required ≈${results['.meta'].timing.toFixed(0)}ms (1ms accuracy, total ${totalInMs.toFixed(0)}ms)`, formatter));
+    return formatter.format(result.join('\n'));
+}
+exports.queryCommand = {
+    description: `Query the given R code, start with '${retriever_1.fileProtocol}' to indicate a file. The query is to be a valid query in json format (use 'help' to get more information).`,
+    usageExample: ':query "<query>" <code>',
+    aliases: [],
+    script: false,
+    fn: async (output, shell, remainingLine) => {
+        const totalStart = Date.now();
+        const results = await processQueryArgs(remainingLine, shell, output);
+        const totalEnd = Date.now();
+        if (results) {
+            output.stdout(asciiSummaryOfQueryResult(output.formatter, totalEnd - totalStart, results.query, results.processed));
+        }
+    }
+};
+exports.queryStarCommand = {
+    description: 'Similar to query, but returns the output in json format.',
+    usageExample: ':query* <query> <code>',
+    aliases: [],
+    script: false,
+    fn: async (output, shell, remainingLine) => {
+        const results = await processQueryArgs(remainingLine, shell, output);
+        if (results) {
+            output.stdout(JSON.stringify(results.query, json_1.jsonReplacer));
+        }
+    }
+};
+//# sourceMappingURL=repl-query.js.map

package/cli/repl/commands/repl-quit.d.ts

@@ -0,0 +1,2 @@
+import type { ReplCommand } from './repl-main';
+export declare const quitCommand: ReplCommand;

package/cli/repl/commands/{quit.js → repl-quit.js}

@@ -12,4 +12,4 @@ exports.quitCommand = {
         process.exit(0);
     }
 };
-//# sourceMappingURL=quit.js.map
+//# sourceMappingURL=repl-quit.js.map

package/cli/repl/commands/{version.d.ts → repl-version.d.ts}

@@ -1,4 +1,4 @@
-import type { ReplCommand, ReplOutput } from './main';
+import type { ReplCommand, ReplOutput } from './repl-main';
 import type { RShell } from '../../../r-bridge/shell';
 type Version = `${number}.${number}.${number}`;
 /**

package/cli/repl/commands/{version.js → repl-version.js}

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.versionCommand = exports.printVersionInformation = exports.retrieveVersionInformation = void 0;
+exports.versionCommand = void 0;
+exports.retrieveVersionInformation = retrieveVersionInformation;
+exports.printVersionInformation = printVersionInformation;
 const version_1 = require("../../../util/version");
 const assert_1 = require("../../../util/assert");
 const versionRegex = /^\d+\.\d+\.\d+/m;
@@ -11,13 +13,11 @@ async function retrieveVersionInformation(shell) {
     (0, assert_1.guard)(r === 'unknown' || versionRegex.test(r), `R version ${r} does not match the expected format!`);
     return { flowr: flowr, r: r };
 }
-exports.retrieveVersionInformation = retrieveVersionInformation;
 async function printVersionInformation(output, shell) {
     const { flowr, r } = await retrieveVersionInformation(shell);
     output.stdout(`flowR: ${flowr}`);
     output.stdout(`R: ${r}`);
 }
-exports.printVersionInformation = printVersionInformation;
 exports.versionCommand = {
     description: 'Prints the version of flowR as well as the current version of R',
     aliases: [],
@@ -25,4 +25,4 @@ exports.versionCommand = {
     script: false,
     fn: (output, shell) => printVersionInformation(output, shell)
 };
-//# sourceMappingURL=version.js.map
+//# sourceMappingURL=repl-version.js.map

package/cli/repl/core.d.ts

@@ -1,6 +1,5 @@
-/// <reference types="node" />
 import * as readline from 'readline';
-import type { ReplOutput } from './commands/main';
+import type { ReplOutput } from './commands/repl-main';
 import { RShell } from '../../r-bridge/shell';
 import type { MergeableRecord } from '../../util/objects';
 /**

package/cli/repl/core.js

@@ -26,7 +26,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadReplHistory = exports.repl = exports.replProcessAnswer = exports.DEFAULT_REPL_READLINE_CONFIGURATION = exports.replCompleter = void 0;
+exports.DEFAULT_REPL_READLINE_CONFIGURATION = void 0;
+exports.replCompleter = replCompleter;
+exports.replProcessAnswer = replProcessAnswer;
+exports.repl = repl;
+exports.loadReplHistory = loadReplHistory;
 /**
  * Basically a helper file to allow the main 'flowr' script (located in the source root) to provide its repl
  *
@@ -34,21 +38,21 @@ exports.loadReplHistory = exports.repl = exports.replProcessAnswer = exports.DEF
  */
 const prompt_1 = require("./prompt");
 const readline = __importStar(require("readline"));
-const execute_1 = require("./commands/execute");
+const repl_execute_1 = require("./commands/repl-execute");
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const args_1 = require("../../util/args");
 const ansi_1 = require("../../util/ansi");
-const commands_1 = require("./commands/commands");
+const repl_commands_1 = require("./commands/repl-commands");
 const scripts_info_1 = require("../common/scripts-info");
 const retriever_1 = require("../../r-bridge/retriever");
-const main_1 = require("./commands/main");
+const repl_main_1 = require("./commands/repl-main");
 const shell_1 = require("../../r-bridge/shell");
 let _replCompleterKeywords = undefined;
 function replCompleterKeywords() {
     if (_replCompleterKeywords === undefined) {
-        _replCompleterKeywords = Array.from((0, commands_1.getCommandNames)(), s => `:${s}`);
+        _replCompleterKeywords = Array.from((0, repl_commands_1.getCommandNames)(), s => `:${s}`);
     }
     return _replCompleterKeywords;
 }
@@ -66,7 +70,7 @@ function replCompleter(line) {
         if (commandNameColon) {
             const completions = [];
             const commandName = commandNameColon.slice(1);
-            if ((0, commands_1.getCommand)(commandName)?.script === true) {
+            if ((0, repl_commands_1.getCommand)(commandName)?.script === true) {
                 // autocomplete script arguments
                 const options = scripts_info_1.scripts[commandName].options;
                 completions.push(...(0, scripts_info_1.getValidOptionsForCompletion)(options, splitLine).map(o => `${o} `));
@@ -84,7 +88,6 @@ function replCompleter(line) {
     // if no command is already typed, just return all commands that match
     return [replCompleterKeywords().filter(k => k.startsWith(line)).map(k => `${k} `), line];
 }
-exports.replCompleter = replCompleter;
 exports.DEFAULT_REPL_READLINE_CONFIGURATION = {
     input: process.stdin,
     output: process.stdout,
@@ -97,7 +100,7 @@ exports.DEFAULT_REPL_READLINE_CONFIGURATION = {
 async function replProcessStatement(output, statement, shell, allowRSessionAccess) {
     if (statement.startsWith(':')) {
         const command = statement.slice(1).split(' ')[0].toLowerCase();
-        const processor = (0, commands_1.getCommand)(command);
+        const processor = (0, repl_commands_1.getCommand)(command);
         const bold = (s) => output.formatter.format(s, { style: 1 /* FontStyles.Bold */ });
         if (processor) {
             try {
@@ -112,7 +115,7 @@ async function replProcessStatement(output, statement, shell, allowRSessionAcces
         }
     }
     else if (allowRSessionAccess) {
-        await (0, execute_1.executeRShellCommand)(output, shell, statement);
+        await (0, repl_execute_1.executeRShellCommand)(output, shell, statement);
     }
     else {
         output.stderr(`${output.formatter.format('You are not allowed to execute arbitrary R code.', { style: 1 /* FontStyles.Bold */, color: 1 /* Colors.Red */, effect: ansi_1.ColorEffect.Foreground })}\nIf you want to do so, please restart flowR with the ${output.formatter.format('--r-session-access', { style: 1 /* FontStyles.Bold */ })} flag. Please be careful of the security implications of this action.`);
@@ -132,7 +135,6 @@ async function replProcessAnswer(output, expr, shell, allowRSessionAccess) {
         await replProcessStatement(output, statement, shell, allowRSessionAccess);
     }
 }
-exports.replProcessAnswer = replProcessAnswer;
 /**
  * Provides a never-ending repl (read-evaluate-print loop) processor that can be used to interact with a {@link RShell} as well as all flowR scripts.
  *
@@ -145,7 +147,7 @@ exports.replProcessAnswer = replProcessAnswer;
  * For the execution, this function makes use of {@link replProcessAnswer}.
  *
  */
-async function repl({ shell = new shell_1.RShell({ revive: 2 /* RShellReviveOptions.Always */ }), rl = readline.createInterface(exports.DEFAULT_REPL_READLINE_CONFIGURATION), output = main_1.standardReplOutput, historyFile = defaultHistoryFile, allowRSessionAccess = false }) {
+async function repl({ shell = new shell_1.RShell({ revive: 2 /* RShellReviveOptions.Always */ }), rl = readline.createInterface(exports.DEFAULT_REPL_READLINE_CONFIGURATION), output = repl_main_1.standardReplOutput, historyFile = defaultHistoryFile, allowRSessionAccess = false }) {
     if (historyFile) {
         rl.on('history', h => fs_1.default.writeFileSync(historyFile, h.join('\n'), { encoding: 'utf-8' }));
     }
@@ -163,12 +165,10 @@ async function repl({ shell = new shell_1.RShell({ revive: 2 /* RShellReviveOpti
         });
     }
 }
-exports.repl = repl;
 function loadReplHistory(historyFile) {
     if (!fs_1.default.existsSync(historyFile)) {
         return undefined;
     }
     return fs_1.default.readFileSync(historyFile, { encoding: 'utf-8' }).split('\n');
 }
-exports.loadReplHistory = loadReplHistory;
 //# sourceMappingURL=core.js.map

package/cli/repl/execute.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { Readable, Writable } from 'stream';
 type Stdio = [stdin: Writable | null, stdout: Readable | null, stderr: Readable | null, extra: Writable | Readable | null | undefined, extra: Writable | Readable | null | undefined];
 export type StdioProcessor = (stdio: Stdio) => void;
@@ -24,5 +23,5 @@ export declare function stdioCaptureProcessor(stdio: Stdio, onStdOutLine: (msg:
  *                      the output of the script, see {@link stdioCaptureProcessor}.
  * @param exitOnError - If set to `true`, the process will exit with the exit code of the script.
  */
-export declare function waitOnScript(module: string, args: string[], io?: StdioProcessor, exitOnError?: boolean): Promise<void>;
+export declare function waitOnScript(module: string, args: readonly string[], io?: StdioProcessor, exitOnError?: boolean): Promise<void>;
 export {};

package/cli/repl/execute.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitOnScript = exports.stdioCaptureProcessor = void 0;
+exports.stdioCaptureProcessor = stdioCaptureProcessor;
+exports.waitOnScript = waitOnScript;
 const child_process_1 = __importDefault(require("child_process"));
 const readline_1 = __importDefault(require("readline"));
 const assert_1 = require("../../util/assert");
@@ -29,7 +30,6 @@ function stdioCaptureProcessor(stdio, onStdOutLine, onStdErrLine) {
     outRl.on('line', onStdOutLine);
     errRl.on('line', onStdErrLine);
 }
-exports.stdioCaptureProcessor = stdioCaptureProcessor;
 /**
  * Run the given module with the presented arguments, and wait for it to exit.
  *
@@ -75,5 +75,4 @@ async function waitOnScript(module, args, io, exitOnError = false) {
         }
     }));
 }
-exports.waitOnScript = waitOnScript;
 //# sourceMappingURL=execute.js.map

package/cli/repl/print-version.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.printVersionRepl = void 0;
-const version_1 = require("./commands/version");
+exports.printVersionRepl = printVersionRepl;
+const repl_version_1 = require("./commands/repl-version");
 async function printVersionRepl(shell) {
-    const version = await (0, version_1.retrieveVersionInformation)(shell);
+    const version = await (0, repl_version_1.retrieveVersionInformation)(shell);
     console.log(`flowR repl using flowR ${version.flowr}, R ${version.r}`);
 }
-exports.printVersionRepl = printVersionRepl;
 //# sourceMappingURL=print-version.js.map

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

@@ -23,5 +23,6 @@ export declare class FlowRServerConnection {
     private handleSliceRequest;
     private handleRepl;
     private handleLineageRequest;
+    private handleQueryRequest;
 }
 export declare function sanitizeAnalysisResults(results: Partial<PipelineOutput<typeof DEFAULT_SLICING_PIPELINE>>): DeepPartial<PipelineOutput<typeof DEFAULT_SLICING_PIPELINE>>;

package/cli/repl/server/connection.js

@@ -26,13 +26,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitizeAnalysisResults = exports.FlowRServerConnection = void 0;
+exports.FlowRServerConnection = void 0;
+exports.sanitizeAnalysisResults = sanitizeAnalysisResults;
 const send_1 = require("./send");
 const validate_1 = require("./validate");
-const analysis_1 = require("./messages/analysis");
-const slice_1 = require("./messages/slice");
+const message_analysis_1 = require("./messages/message-analysis");
+const message_slice_1 = require("./messages/message-slice");
 const server_1 = require("./server");
-const repl_1 = require("./messages/repl");
+const message_repl_1 = require("./messages/message-repl");
 const core_1 = require("../core");
 const pipeline_executor_1 = require("../../../core/pipeline-executor");
 const cfg_1 = require("../../../util/cfg/cfg");
@@ -47,10 +48,12 @@ const graph_1 = require("../../../dataflow/graph/graph");
 const tmp = __importStar(require("tmp"));
 const fs_1 = __importDefault(require("fs"));
 const magic_comments_1 = require("../../../reconstruct/auto-select/magic-comments");
-const lineage_1 = require("./messages/lineage");
-const lineage_2 = require("../commands/lineage");
+const message_lineage_1 = require("./messages/message-lineage");
+const repl_lineage_1 = require("../commands/repl-lineage");
 const assert_1 = require("../../../util/assert");
 const auto_select_defaults_1 = require("../../../reconstruct/auto-select/auto-select-defaults");
+const message_query_1 = require("./messages/message-query");
+const query_1 = require("../../../queries/query");
 /**
  * Each connection handles a single client, answering to its requests.
  * There is no need to construct this class manually, {@link FlowRServer} will do it for you.
@@ -103,6 +106,9 @@ class FlowRServerConnection {
             case 'request-lineage':
                 this.handleLineageRequest(request.message);
                 break;
+            case 'request-query':
+                this.handleQueryRequest(request.message);
+                break;
             default:
                 (0, send_1.sendMessage)(this.socket, {
                     id: request.message.id,
@@ -114,7 +120,7 @@ class FlowRServerConnection {
         }
     }
     async handleFileAnalysisRequest(base) {
-        const requestResult = (0, validate_1.validateMessage)(base, analysis_1.requestAnalysisMessage);
+        const requestResult = (0, validate_1.validateMessage)(base, message_analysis_1.requestAnalysisMessage);
         if (requestResult.type === 'error') {
             (0, validate_1.answerForValidationError)(this.socket, requestResult, base.id);
             return;
@@ -202,7 +208,7 @@ class FlowRServerConnection {
         return slicer;
     }
     handleSliceRequest(base) {
-        const requestResult = (0, validate_1.validateMessage)(base, slice_1.requestSliceMessage);
+        const requestResult = (0, validate_1.validateMessage)(base, message_slice_1.requestSliceMessage);
         if (requestResult.type === 'error') {
             (0, validate_1.answerForValidationError)(this.socket, requestResult, base.id);
             return;
@@ -241,7 +247,7 @@ class FlowRServerConnection {
         });
     }
     handleRepl(base) {
-        const requestResult = (0, validate_1.validateMessage)(base, repl_1.requestExecuteReplExpressionMessage);
+        const requestResult = (0, validate_1.validateMessage)(base, message_repl_1.requestExecuteReplExpressionMessage);
         if (requestResult.type === 'error') {
             (0, validate_1.answerForValidationError)(this.socket, requestResult, base.id);
             return;
@@ -267,7 +273,7 @@ class FlowRServerConnection {
         });
     }
     handleLineageRequest(base) {
-        const requestResult = (0, validate_1.validateMessage)(base, lineage_1.requestLineageMessage);
+        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;
@@ -287,13 +293,41 @@ class FlowRServerConnection {
         const { dataflow: dfg, normalize: ast } = fileInformation.pipeline.getResults(true);
         (0, assert_1.guard)(dfg !== undefined, `Dataflow graph must be present (request: ${request.filetoken})`);
         (0, assert_1.guard)(ast !== undefined, `AST must be present (request: ${request.filetoken})`);
-        const lineageIds = (0, lineage_2.getLineage)(request.criterion, ast, dfg);
+        const lineageIds = (0, repl_lineage_1.getLineage)(request.criterion, dfg.graph, ast.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') {
+            (0, validate_1.answerForValidationError)(this.socket, requestResult, base.id);
+            return;
+        }
+        const request = requestResult.message;
+        this.logger.info(`[${this.name}] Received query request for query ${JSON.stringify(request.query)}`);
+        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 { dataflow: dfg, normalize: ast } = fileInformation.pipeline.getResults(true);
+        (0, assert_1.guard)(dfg !== undefined, `Dataflow graph must be present (request: ${request.filetoken})`);
+        (0, assert_1.guard)(ast !== undefined, `AST must be present (request: ${request.filetoken})`);
+        const results = (0, query_1.executeQueries)({ graph: dfg.graph, ast }, request.query);
+        (0, send_1.sendMessage)(this.socket, {
+            type: 'response-query',
+            id: request.id,
+            results
+        });
+    }
 }
 exports.FlowRServerConnection = FlowRServerConnection;
 function sanitizeAnalysisResults(results) {
@@ -310,5 +344,4 @@ function sanitizeAnalysisResults(results) {
         }
     };
 }
-exports.sanitizeAnalysisResults = sanitizeAnalysisResults;
 //# sourceMappingURL=connection.js.map

package/cli/repl/server/messages/{messages.d.ts → all-messages.d.ts}

@@ -4,12 +4,13 @@
  * @module
  */
 import * as Joi from 'joi';
-import type { FlowrHelloResponseMessage } from './hello';
-import type { FileAnalysisRequestMessage, FileAnalysisResponseMessageJson } from './analysis';
-import type { ExecuteEndMessage, ExecuteIntermediateResponseMessage, ExecuteRequestMessage } from './repl';
-import type { SliceRequestMessage, SliceResponseMessage } from './slice';
-import type { FlowrErrorMessage } from './error';
-import type { LineageRequestMessage, LineageResponseMessage } from './lineage';
+import type { FlowrHelloResponseMessage } from './message-hello';
+import type { FileAnalysisRequestMessage, FileAnalysisResponseMessageJson } from './message-analysis';
+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.
  */
@@ -33,4 +34,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 | FlowrErrorMessage;
+export type FlowrMessage = FlowrHelloResponseMessage | FileAnalysisRequestMessage | FileAnalysisResponseMessageJson | ExecuteRequestMessage | ExecuteIntermediateResponseMessage | ExecuteEndMessage | SliceRequestMessage | SliceResponseMessage | LineageRequestMessage | LineageResponseMessage | QueryRequestMessage | QueryResponseMessage | FlowrErrorMessage;

package/cli/repl/server/messages/{messages.js → all-messages.js}

@@ -37,4 +37,4 @@ exports.baseMessage = {
         id: Joi.string().optional()
     }).unknown(true)
 };
-//# sourceMappingURL=messages.js.map
+//# sourceMappingURL=all-messages.js.map

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

@@ -1,4 +1,4 @@
-import type { IdMessageBase, MessageDefinition } from './messages';
+import type { IdMessageBase, MessageDefinition } from './all-messages';
 import type { ControlFlowInformation } from '../../../../util/cfg/cfg';
 import type { DEFAULT_DATAFLOW_PIPELINE, DEFAULT_SLICING_PIPELINE } from '../../../../core/steps/pipeline/default-pipelines';
 import type { PipelineOutput } from '../../../../core/steps/pipeline/pipeline';
@@ -76,3 +76,4 @@ export interface FileAnalysisResponseMessageNQuads extends IdMessageBase {
      */
     cfg?: string;
 }
+export declare const analysisResponseMessage: MessageDefinition<FileAnalysisResponseMessageJson | FileAnalysisResponseMessageNQuads>;

package/cli/repl/server/messages/message-analysis.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.analysisResponseMessage = exports.requestAnalysisMessage = void 0;
+const joi_1 = __importDefault(require("joi"));
+exports.requestAnalysisMessage = {
+    type: 'request-file-analysis',
+    schema: joi_1.default.object({
+        type: joi_1.default.string().valid('request-file-analysis').required().description('The type of the message.'),
+        id: joi_1.default.string().optional().description('You may pass an id to link requests with responses (they get the same id).'),
+        filetoken: joi_1.default.string().optional().description('A unique token to identify the file for subsequent requests. Only use this if you plan to send more queries!'),
+        filename: joi_1.default.string().optional().description('A human-readable name of the file, only for debugging purposes.'),
+        content: joi_1.default.string().optional().description('The content of the file or an R expression (either give this or the filepath).'),
+        filepath: joi_1.default.alternatives(joi_1.default.string(), joi_1.default.array().items(joi_1.default.string())).optional().description('The path to the file(s) on the local machine (either give this or the content).'),
+        cfg: joi_1.default.boolean().optional().description('If you want to extract the control flow information of the file.'),
+        format: joi_1.default.string().valid('json', 'n-quads').optional().description('The format of the results, if missing we assume json.')
+    }).xor('content', 'filepath')
+};
+const jsonSchema = joi_1.default.object({
+    type: joi_1.default.string().valid('response-file-analysis').required().description('The type of the message.'),
+    id: joi_1.default.string().optional().description('The id of the message, if you passed one in the request.'),
+    format: joi_1.default.string().valid('json').required().description('The format of the results in json format.'),
+    results: joi_1.default.object().required().description('The results of the analysis (one field per step).'),
+    cfg: joi_1.default.object().optional().description('The control flow information of the file, only present if requested.')
+}).description('The response in JSON format.');
+const nquadsSchema = joi_1.default.object({
+    type: joi_1.default.string().valid('response-file-analysis').required().description('The type of the message.'),
+    id: joi_1.default.string().optional().description('The id of the message, if you passed one in the request.'),
+    format: joi_1.default.string().valid('n-quads').required().description('The format of the results in n-quads format.'),
+    results: joi_1.default.object().required().description('The results of the analysis (one field per step). Quads are presented as string.'),
+    cfg: joi_1.default.string().optional().description('The control flow information of the file, only present if requested.')
+}).description('The response as n-quads.');
+exports.analysisResponseMessage = {
+    type: 'response-file-analysis',
+    schema: joi_1.default.alternatives(jsonSchema, nquadsSchema).required().description('The response to a file analysis request (based on the `format` field).')
+};
+//# sourceMappingURL=message-analysis.js.map

package/cli/repl/server/messages/{error.d.ts → message-error.d.ts}

@@ -1,4 +1,4 @@
-import type { IdMessageBase } from './messages';
+import type { IdMessageBase } from './all-messages';
 /**
  * Sent in case of any error (e.g., if the analysis fails, or the message contains syntax errors).
  */

package/cli/repl/server/messages/{error.js → message-error.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=error.js.map
+//# sourceMappingURL=message-error.js.map

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

@@ -1,7 +1,7 @@
-import type { VersionInformation } from '../../commands/version';
-import type { IdMessageBase } from './messages';
+import type { VersionInformation } from '../../commands/repl-version';
+import type { IdMessageBase, MessageDefinition } from './all-messages';
 /**
- * The hello message is automatically send by the sever upon connection.
+ * The hello message is automatically sent by the sever upon connection.
  */
 export interface FlowrHelloResponseMessage extends IdMessageBase {
     type: 'hello';
@@ -18,3 +18,4 @@ export interface FlowrHelloResponseMessage extends IdMessageBase {
      */
     versions: VersionInformation;
 }
+export declare const helloMessageDefinition: MessageDefinition<FlowrHelloResponseMessage>;

package/cli/repl/server/messages/message-hello.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.helloMessageDefinition = void 0;
+const joi_1 = __importDefault(require("joi"));
+exports.helloMessageDefinition = {
+    type: 'hello',
+    schema: joi_1.default.object({
+        type: joi_1.default.string().required().valid('hello').description('The type of the hello message.'),
+        id: joi_1.default.any().forbidden().description('The id of the message is always undefined (as it is the initial message and not requested).'),
+        clientName: joi_1.default.string().required().description('A unique name that is assigned to each client. It has no semantic meaning and is only used/useful for debugging.'),
+        versions: joi_1.default.object({
+            flowr: joi_1.default.string().required().description('The version of the flowr server running in semver format.'),
+            r: joi_1.default.string().required().description('The version of the underlying R shell running in semver format.')
+        }).required()
+    }).required()
+};
+//# sourceMappingURL=message-hello.js.map