@eagleoutice/flowr 1.4.1 → 1.5.0

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

@@ -1,35 +0,0 @@
-/**
- * Provides the capability of connecting to the repl of flowr via messages.
- *
- * @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';
-/**
- * If you send a message it must *not* contain a newline but the message must be terminated by a newline.
- */
-export interface IdMessageBase {
-    /**
-     * The at this time unknown type
-     */
-    type: string;
-    /**
-     * The id that links a request with its responses, it is up to the calling client to make sure it is unique.
-     * However, the client does not have to pass the id if it does not need to link the request with its response.
-     * The id is always undefined if the message is unprompted (e.g., with hello) or the id unknown.
-     */
-    id: string | undefined;
-}
-export interface MessageDefinition<T extends FlowrMessage | IdMessageBase> {
-    type: T['type'] | undefined;
-    schema: Joi.Schema;
-}
-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 | FlowrErrorMessage;

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

@@ -1,40 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-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"));
-exports.baseMessage = {
-    type: '**base**',
-    schema: Joi.object({
-        type: Joi.string().required(),
-        id: Joi.string().optional()
-    }).unknown(true)
-};
-//# sourceMappingURL=messages.js.map

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

@@ -1,33 +0,0 @@
-import type { IdMessageBase, MessageDefinition } from './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
- */
-export interface ExecuteRequestMessage extends IdMessageBase {
-    type: 'request-repl-execution';
-    /** Should ansi formatting be enabled for the response? Is `false` by default.  */
-    ansi?: boolean;
-    /** The expression to execute */
-    expression: string;
-}
-export declare const requestExecuteReplExpressionMessage: MessageDefinition<ExecuteRequestMessage>;
-/**
- * This message may be sent multiple times, triggered for every "output" performed by the execution.
- * {@link ExecuteEndMessage} marks the end of these messages.
- */
-export interface ExecuteIntermediateResponseMessage extends IdMessageBase {
-    type: 'response-repl-execution';
-    stream: 'stdout' | 'stderr';
-    result: string;
-}
-/**
- * Marks the end of the execution of the respective {@link ExecuteRequestMessage}.
- * The underlying TCP connection should ensure the ordering so that this message is the last.
- */
-export interface ExecuteEndMessage extends IdMessageBase {
-    type: 'end-repl-execution';
-}

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

@@ -1,37 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.requestExecuteReplExpressionMessage = void 0;
-const Joi = __importStar(require("joi"));
-exports.requestExecuteReplExpressionMessage = {
-    type: 'request-repl-execution',
-    schema: Joi.object({
-        type: Joi.string().valid('request-repl-execution').required(),
-        id: Joi.string().optional(),
-        ansi: Joi.boolean().optional(),
-        expression: Joi.string().required(),
-    })
-};
-//# sourceMappingURL=repl.js.map

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

@@ -1,25 +0,0 @@
-import type { SlicingCriteria } from '../../../../slicing';
-import type { LAST_PER_FILE_STEP, LAST_STEP, StepResults } from '../../../../core';
-import type { IdMessageBase, MessageDefinition } from './messages';
-/**
- * Can only be sent after you have sent the {@link FileAnalysisRequestMessage}.
- * Using the same `filetoken` as in the {@link FileAnalysisRequestMessage} you
- * can slice the respective file given the respective criteria.
- */
-export interface SliceRequestMessage extends IdMessageBase {
-    type: 'request-slice';
-    /** The {@link FileAnalysisRequestMessage#filetoken} of the file/data to slice */
-    filetoken: string;
-    /** The slicing criteria to use */
-    criterion: SlicingCriteria;
-}
-export declare const requestSliceMessage: MessageDefinition<SliceRequestMessage>;
-/**
- * Similar to {@link FileAnalysisResponseMessage} this only contains the results of
- * the slice steps.
- */
-export interface SliceResponseMessage extends IdMessageBase {
-    type: 'response-slice';
-    /** only contains the results of the slice steps to not repeat ourselves */
-    results: Omit<StepResults<typeof LAST_STEP>, keyof StepResults<typeof LAST_PER_FILE_STEP>>;
-}

package/cli/repl/server/messages/slice.js

@@ -1,37 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.requestSliceMessage = void 0;
-const Joi = __importStar(require("joi"));
-exports.requestSliceMessage = {
-    type: 'request-slice',
-    schema: Joi.object({
-        type: Joi.string().valid('request-slice').required(),
-        id: Joi.string().optional(),
-        filetoken: Joi.string().required(),
-        criterion: Joi.array().items(Joi.string().regex(/\d+:\d+|\d+@.*|\$\d+/)).min(0).required()
-    })
-};
-//# sourceMappingURL=slice.js.map

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

@@ -1,49 +0,0 @@
-/// <reference types="node" />
-import type WebSocket from 'ws';
-/** Function handler that should be triggered when the respective socket connects */
-export type OnConnect = (c: Socket) => void;
-/**
- * A generic server interface that allows us to mock the server's behavior in tests.
- */
-export interface Server {
-    /**
-     * Register a function to be called when a new socket connects.
-     * This should be only called once per server.
-     */
-    onConnect(handler: OnConnect): void;
-    start(port: number): void;
-}
-export declare class WebSocketServerWrapper implements Server {
-    private server;
-    private connectHandler;
-    onConnect(handler: OnConnect): void;
-    start(port: number): void;
-}
-/**
- * The socket abstraction of *flowR*.
- * Essentially a subset of what the default `net.Socket` of `node` provides.
- */
-export interface Socket {
-    remoteAddress?: string;
-    remotePort?: number;
-    on(event: 'error', listener: (e: unknown) => void): void;
-    on(event: 'close', listener: () => void): void;
-    on(event: 'data', listener: (data: Buffer) => void): void;
-    write(data: string): void;
-    end(): void;
-}
-export declare class WebSocketWrapper implements Socket {
-    private readonly socket;
-    remoteAddress?: string;
-    remotePort?: number;
-    constructor(socket: WebSocket);
-    write(data: string): void;
-    end(): void;
-    on(event: 'data' | 'close' | 'error', listener: (data: Buffer) => void): void;
-}
-export declare class NetServer implements Server {
-    private readonly server;
-    constructor();
-    onConnect(handler: OnConnect): void;
-    start(port: number): void;
-}

package/cli/repl/server/net.js

@@ -1,63 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NetServer = exports.WebSocketWrapper = exports.WebSocketServerWrapper = void 0;
-/**
- * This is just a simple layer to allow me to mock the server's behavior in tests.
- */
-const node_net_1 = __importDefault(require("node:net"));
-const ws_1 = require("ws");
-const server_1 = require("./server");
-class WebSocketServerWrapper {
-    server;
-    connectHandler;
-    onConnect(handler) {
-        this.connectHandler = handler;
-    }
-    start(port) {
-        this.server = new ws_1.WebSocketServer({ port });
-        server_1.serverLog.info('WebSocket-Server wrapper is active!');
-        this.server.on('connection', c => this.connectHandler?.(new WebSocketWrapper(c)));
-    }
-}
-exports.WebSocketServerWrapper = WebSocketServerWrapper;
-class WebSocketWrapper {
-    socket;
-    remoteAddress;
-    remotePort;
-    constructor(socket) {
-        this.socket = socket;
-        this.remoteAddress = socket.url;
-    }
-    write(data) {
-        this.socket.send(data);
-    }
-    end() {
-        this.socket.close();
-    }
-    on(event, listener) {
-        if (event === 'data') {
-            this.socket.on('message', listener);
-        }
-        else {
-            this.socket.on(event, listener);
-        }
-    }
-}
-exports.WebSocketWrapper = WebSocketWrapper;
-class NetServer {
-    server;
-    constructor() {
-        this.server = node_net_1.default.createServer();
-    }
-    onConnect(handler) {
-        this.server.on('connection', handler);
-    }
-    start(port) {
-        this.server.listen(port);
-    }
-}
-exports.NetServer = NetServer;
-//# sourceMappingURL=net.js.map

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

@@ -1,4 +0,0 @@
-import type { IdMessageBase } from './messages/messages';
-import type { Socket } from './net';
-export declare function getUnnamedSocketName(c: Socket): string;
-export declare function sendMessage<T extends IdMessageBase>(c: Socket, message: T): void;

package/cli/repl/server/send.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendMessage = exports.getUnnamedSocketName = void 0;
-const json_1 = require("../../../util/json");
-const server_1 = require("./server");
-function getUnnamedSocketName(c) {
-    return `${c.remoteAddress ?? '?'}@${c.remotePort ?? '?'}`;
-}
-exports.getUnnamedSocketName = getUnnamedSocketName;
-function sendMessage(c, message) {
-    const msg = JSON.stringify(message, json_1.jsonReplacer);
-    if (server_1.serverLog.settings.minLevel >= 2 /* LogLevel.Debug */) {
-        server_1.serverLog.debug(`[${getUnnamedSocketName(c)}] sending message: ${msg}`);
-    }
-    c.write(`${msg}\n`);
-}
-exports.sendMessage = sendMessage;
-//# sourceMappingURL=send.js.map

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

@@ -1,20 +0,0 @@
-import type { RShell } from '../../../r-bridge';
-import type { Server } from './net';
-import { FlowrLogger } from '../../../util/log';
-export declare const serverLog: FlowrLogger;
-/**
- * This class controls the TCP server, which can be started by calling {@link start}.
- * Afterward, each incoming connection will be greeted with {@link helloClient} and from
- * thereon be handled by a {@link FlowRServerConnection}.
- */
-export declare class FlowRServer {
-    private readonly server;
-    private readonly shell;
-    private versionInformation;
-    /** maps names to the respective connection */
-    private connections;
-    private nameCounter;
-    constructor(shell: RShell, server?: Server);
-    start(port: number): Promise<void>;
-    private onConnect;
-}

package/cli/repl/server/server.js

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlowRServer = exports.serverLog = void 0;
-const version_1 = require("../commands/version");
-const connection_1 = require("./connection");
-const send_1 = require("./send");
-const net_1 = require("./net");
-const log_1 = require("../../../util/log");
-// we detach from the main logger so that it can have its own switch
-exports.serverLog = new log_1.FlowrLogger({ name: 'server' });
-/**
- * This class controls the TCP server, which can be started by calling {@link start}.
- * Afterward, each incoming connection will be greeted with {@link helloClient} and from
- * thereon be handled by a {@link FlowRServerConnection}.
- */
-class FlowRServer {
-    server;
-    shell;
-    versionInformation;
-    /** maps names to the respective connection */
-    connections = new Map();
-    nameCounter = 0;
-    constructor(shell, server = new net_1.NetServer()) {
-        this.server = server;
-        this.server.onConnect(c => this.onConnect(c));
-        this.shell = shell;
-    }
-    async start(port) {
-        this.versionInformation = await (0, version_1.retrieveVersionInformation)(this.shell);
-        this.server.start(port);
-        exports.serverLog.info(`Server listening on port ${port}`);
-    }
-    onConnect(c) {
-        if (!this.versionInformation) {
-            notYetInitialized(c, undefined);
-            return;
-        }
-        const name = `client-${this.nameCounter++}`;
-        exports.serverLog.info(`Client connected: ${(0, send_1.getUnnamedSocketName)(c)} as "${name}"`);
-        this.connections.set(name, new connection_1.FlowRServerConnection(c, name, this.shell));
-        helloClient(c, name, this.versionInformation);
-        c.on('close', () => {
-            this.connections.delete(name);
-            exports.serverLog.info(`Client "${name}" disconnected (${(0, send_1.getUnnamedSocketName)(c)})`);
-        });
-    }
-}
-exports.FlowRServer = FlowRServer;
-function notYetInitialized(c, id) {
-    (0, send_1.sendMessage)(c, {
-        id,
-        type: 'error',
-        fatal: true,
-        reason: 'Server not initialized yet (or failed to), please try again later.'
-    });
-    c.end();
-}
-function helloClient(c, name, versionInformation) {
-    (0, send_1.sendMessage)(c, {
-        id: undefined,
-        type: 'hello',
-        clientName: name,
-        versions: versionInformation
-    });
-}
-//# sourceMappingURL=server.js.map

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

@@ -1,15 +0,0 @@
-import type * as Joi from 'joi';
-import type { FlowrMessage, IdMessageBase, MessageDefinition } from './messages/messages';
-import type { Socket } from './net';
-export interface ValidationErrorResult {
-    type: 'error';
-    reason: Joi.ValidationError | Error;
-}
-export interface SuccessValidationResult<T extends IdMessageBase> {
-    type: 'success';
-    message: T;
-}
-export type ValidationResult<T extends IdMessageBase> = SuccessValidationResult<T> | ValidationErrorResult;
-export declare function validateBaseMessageFormat(input: string): ValidationResult<IdMessageBase>;
-export declare function validateMessage<T extends FlowrMessage | IdMessageBase>(input: IdMessageBase, def: MessageDefinition<T>): ValidationResult<T>;
-export declare function answerForValidationError(client: Socket, result: ValidationErrorResult, id?: string): void;

package/cli/repl/server/validate.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.answerForValidationError = exports.validateMessage = exports.validateBaseMessageFormat = void 0;
-const send_1 = require("./send");
-const messages_1 = require("./messages/messages");
-function validateBaseMessageFormat(input) {
-    try {
-        return validateMessage(JSON.parse(input), messages_1.baseMessage);
-    }
-    catch (e) {
-        return { type: 'error', reason: e };
-    }
-}
-exports.validateBaseMessageFormat = validateBaseMessageFormat;
-function validateMessage(input, def) {
-    try {
-        const result = def.schema.validate(input);
-        return result.error ? { type: 'error', reason: result.error } : { type: 'success', message: input };
-    }
-    catch (e) {
-        return { type: 'error', reason: e };
-    }
-}
-exports.validateMessage = validateMessage;
-function answerForValidationError(client, result, id) {
-    (0, send_1.sendMessage)(client, {
-        type: 'error',
-        fatal: false,
-        id: id,
-        reason: `Invalid message format: ${result.reason.message}`
-    });
-}
-exports.answerForValidationError = answerForValidationError;
-//# sourceMappingURL=validate.js.map

package/cli/slicer-app.d.ts

@@ -1,11 +0,0 @@
-export interface SlicerCliOptions {
-    verbose: boolean;
-    help: boolean;
-    input: string | undefined;
-    criterion: string | undefined;
-    output: string | undefined;
-    diff: boolean;
-    'input-is-text': boolean;
-    stats: boolean;
-    api: boolean;
-}

package/cli/slicer-app.js

@@ -1,81 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const log_1 = require("../util/log");
-const fs_1 = __importDefault(require("fs"));
-const assert_1 = require("../util/assert");
-const benchmark_1 = require("../benchmark");
-const common_1 = require("./common");
-const json_1 = require("../util/json");
-const slice_diff_ansi_1 = require("../core/print/slice-diff-ansi");
-const options = (0, common_1.processCommandLineArgs)('slicer', ['input', 'criterion'], {
-    subtitle: 'Slice R code based on a given slicing criterion',
-    examples: [
-        '{bold -c} {italic "12@product"} {italic test/testfiles/example.R}',
-        // why double escaped :C
-        '{bold -c} {italic "3@a"} {bold -r} {italic "a <- 3\\\\nb <- 4\\\\nprint(a)"} {bold --diff}',
-        '{bold -i} {italic example.R} {bold --stats} {bold --criterion} {italic "8:3;3:1;12@product"}',
-        '{bold --help}'
-    ]
-});
-async function getSlice() {
-    const slicer = new benchmark_1.BenchmarkSlicer();
-    (0, assert_1.guard)(options.input !== undefined, 'input must be given');
-    (0, assert_1.guard)(options.criterion !== undefined, 'a slicing criterion must be given');
-    await slicer.init(options['input-is-text'] ? { request: 'text', content: options.input } : { request: 'file', content: options.input });
-    let mappedSlices = [];
-    let reconstruct = undefined;
-    const doSlicing = options.criterion.trim() !== '';
-    let slice = undefined;
-    if (doSlicing) {
-        const slices = options.criterion.split(';').map(c => c.trim());
-        try {
-            const { stats: { reconstructedCode, slicingCriteria }, slice: sliced } = await slicer.slice(...slices);
-            slice = sliced;
-            mappedSlices = slicingCriteria;
-            reconstruct = reconstructedCode;
-            if (options.output) {
-                console.log('Written reconstructed code to', options.output);
-                console.log(`Automatically selected ${reconstructedCode.autoSelected} statements`);
-                fs_1.default.writeFileSync(options.output, reconstructedCode.code);
-            }
-            else if (!options.api && !options.diff) {
-                console.log(reconstructedCode.code);
-            }
-        }
-        catch (e) {
-            log_1.log.error(`[Skipped] Error while processing ${options.input}: ${e.message} (${e.stack ?? ''})`);
-        }
-    }
-    const { stats, normalize, parse, tokenMap, dataflow } = slicer.finish();
-    const mappedCriteria = mappedSlices.map(c => `    ${c.criterion} => ${c.id} (${JSON.stringify(normalize.idMap.get(c.id)?.location)})`).join('\n');
-    log_1.log.info(`Mapped criteria:\n${mappedCriteria}`);
-    const sliceStatsAsString = (0, benchmark_1.stats2string)(await (0, benchmark_1.summarizeSlicerStats)(stats));
-    if (options.api) {
-        const output = {
-            tokenMap,
-            parse,
-            normalize,
-            dataflow,
-            ...(options.stats ? { stats } : {}),
-            ...(doSlicing ? { slice: mappedSlices, reconstruct } : {})
-        };
-        console.log(JSON.stringify(output, json_1.jsonReplacer));
-    }
-    else {
-        if (doSlicing && options.diff) {
-            const originalCode = options['input-is-text'] ? options.input : fs_1.default.readFileSync(options.input).toString();
-            console.log((0, slice_diff_ansi_1.sliceDiffAnsi)(slice.result, normalize, new Set(mappedSlices.map(({ id }) => id)), originalCode));
-        }
-        if (options.stats) {
-            console.log(sliceStatsAsString);
-            const filename = `${options.input}.stats`;
-            console.log(`Writing stats for ${options.input} to "${filename}"`);
-            fs_1.default.writeFileSync(filename, sliceStatsAsString);
-        }
-    }
-}
-void getSlice();
-//# sourceMappingURL=slicer-app.js.map

package/cli/statistics-app.d.ts

@@ -1,11 +0,0 @@
-export interface StatsCliOptions {
-    readonly verbose: boolean;
-    readonly help: boolean;
-    readonly limit: number | undefined;
-    readonly input: string[];
-    readonly 'dump-json': boolean;
-    readonly 'output-dir': string;
-    readonly 'no-ansi': boolean;
-    readonly parallel: number;
-    readonly features: string[];
-}