@eagleoutice/flowr 2.0.4 → 2.0.6

package/README.md

@@ -2,7 +2,7 @@
 [![QA (and potentially deploy)](https://github.com/Code-Inspect/flowr/actions/workflows/qa.yaml/badge.svg)](https://github.com/Code-Inspect/flowr/actions/workflows/qa.yaml) [![codecov](https://codecov.io/gh/Code-Inspect/flowr/graph/badge.svg)](https://codecov.io/gh/Code-Inspect/flowr) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/eagleoutice/flowr?logo=docker&logoColor=white&label=dockerhub)](https://hub.docker.com/r/eagleoutice/flowr) [![latest tag](https://badgen.net/github/tag/Code-Inspect/flowr?label=latest&color=purple)](https://github.com/Code-Inspect/flowr/releases/latest) [![Marketplace](https://badgen.net/vs-marketplace/v/code-inspect.vscode-flowr)](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr)
 
 
-*flowR* is a static [dataflow analyzer](https://en.wikipedia.org/wiki/Data-flow_analysis) and [program slicer](https://github.com/Code-Inspect/flowr/wiki/Terminology#program-slice) for the [*R*](https://www.r-project.org/) programming language (currently tested for versions `4.x`). It is available as a [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr) and as a [docker image](https://hub.docker.com/r/eagleoutice/flowr).
+*flowR* is a static [dataflow analyzer](https://en.wikipedia.org/wiki/Data-flow_analysis) and [program slicer](https://github.com/Code-Inspect/flowr/wiki/Terminology#program-slice) for the [*R*](https://www.r-project.org/) programming language (currently tested for versions `4.x` and `3.6.x`). It is available as a [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr) and as a [docker image](https://hub.docker.com/r/eagleoutice/flowr).
 
 ## ⭐ Getting Started
 

package/dataflow/internal/linker.js

@@ -55,7 +55,7 @@ function linkArgumentsOnCall(args, params, graph) {
                 graph.addEdge(arg.nodeId, specialDotParameter.name.info.id, { type: 16 /* EdgeType.DefinesOnCall */ });
             }
             else {
-                logger_1.dataflowLogger.error(`skipping argument ${i} as there is no corresponding parameter - R should block that`);
+                logger_1.dataflowLogger.warn(`skipping argument ${i} as there is no corresponding parameter - R should block that`);
             }
             continue;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eagleoutice/flowr",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "description": "Static Dataflow Analyzer and Program Slicer for the R Programming Language",
   "types": "dist/src/index.d.ts",
   "repository": {

package/r-bridge/init.js

@@ -7,8 +7,9 @@ exports.ErrorMarker = 'err';
 function initCommand(eol) {
     /* define the get function complete wrapped in a try so that we can handle failures gracefully on stdout
      * furthermore, we compile for performance reasons
+     * Please note that we add a `flowr_output` assignment before to avoid issues with earlier R versions
      */
-    return 'flowr_get_ast<-compiler::cmpfun(function(...){tryCatch({'
+    return 'flowr_output<-NULL;flowr_get_ast<-compiler::cmpfun(function(...){tryCatch({'
         /* the actual code to parse the R code, ... allows us to keep the old 'file=path' and 'text=content' semantics. we define flowr_output using the super assignment to persist it in the env! */
         + 'flowr_output<<-getParseData(parse(...,keep.source=TRUE),includeText=TRUE);'
         /* json conversion of the output, dataframe="values" allows us to receive a list of lists (which is more compact)!

package/r-bridge/lang-4.x/ast/model/type.d.ts

@@ -138,6 +138,12 @@ export declare const enum RawRType {
      * https://github.com/REditorSupport/languageserver/pull/328
      */
     ExprOfAssignOrHelp = "expr_or_assign_or_help",
+    /**
+     * Pre-4.0 version of expr_or_assign_or_help, which was seemingly silently renamed here:
+     * https://github.com/wch/r-source/commit/84bbf385f909c0223924c310af6c7c77aa810234
+     * (Also see {@link ExprOfAssignOrHelp} documentation for more context.)
+     */
+    LegacyEqualAssign = "equal_assign",
     /** T65 */
     ExpressionList = "exprlist"
 }

package/r-bridge/lang-4.x/ast/parser/json/format.js

@@ -8,7 +8,13 @@ exports.RootId = 0;
  * Parses the given data and sets child relationship, return the list of root entries (with a parent of {@link RootId}).
  */
 function prepareParsedData(data) {
-    const json = JSON.parse(`[${data}]`);
+    let json;
+    try {
+        json = JSON.parse(`[${data}]`);
+    }
+    catch (e) {
+        throw new Error(`Failed to parse data ${data}: ${e?.message}`);
+    }
     (0, assert_1.guard)(Array.isArray(json), () => `Expected ${data} to be an array but was not`);
     const ret = new Map(json.map(([line1, col1, line2, col2, id, parent, token, terminal, text]) => {
         return [id, { line1, col1, line2, col2, id, parent, token: (0, retriever_1.removeRQuotes)(token), terminal, text }];

package/r-bridge/lang-4.x/ast/parser/xml/internal/functions/normalize-call.js

@@ -22,7 +22,7 @@ const normalize_symbol_1 = require("../values/normalize-symbol");
  */
 function tryNormalizeFunctionCall(data, mappedWithName) {
     const fnBase = mappedWithName[0];
-    if (fnBase.name !== "expr" /* RawRType.Expression */ && fnBase.name !== "expr_or_assign_or_help" /* RawRType.ExprOfAssignOrHelp */) {
+    if (fnBase.name !== "expr" /* RawRType.Expression */ && fnBase.name !== "expr_or_assign_or_help" /* RawRType.ExprOfAssignOrHelp */ && fnBase.name !== "equal_assign" /* RawRType.LegacyEqualAssign */) {
         parser_1.parseLog.trace(`expected function call name to be wrapped an expression, yet received ${fnBase.name}`);
         return undefined;
     }

package/r-bridge/lang-4.x/ast/parser/xml/internal/loops/normalize-for.js

@@ -18,7 +18,7 @@ function tryNormalizeFor(data, [forToken, head, body]) {
     else if (head.name !== "forcond" /* RawRType.ForCondition */) {
         throw new input_format_1.XmlParseError(`expected condition for for-loop but found ${JSON.stringify(head)}`);
     }
-    else if (body.name !== "expr" /* RawRType.Expression */ && body.name !== "expr_or_assign_or_help" /* RawRType.ExprOfAssignOrHelp */) {
+    else if (body.name !== "expr" /* RawRType.Expression */ && body.name !== "expr_or_assign_or_help" /* RawRType.ExprOfAssignOrHelp */ && body.name !== "equal_assign" /* RawRType.LegacyEqualAssign */) {
         throw new input_format_1.XmlParseError(`expected expr body for for-loop but found ${JSON.stringify(body)}`);
     }
     parser_1.parseLog.debug('trying to parse for-loop');

package/r-bridge/lang-4.x/ast/parser/xml/internal/normalize-access.js

@@ -72,7 +72,7 @@ function tryNormalizeAccess(data, mappedWithName) {
             return undefined;
     }
     const accessed = mappedWithName[0];
-    if (accessed.name !== "expr" /* RawRType.Expression */ && accessed.name !== "expr_or_assign_or_help" /* RawRType.ExprOfAssignOrHelp */) {
+    if (accessed.name !== "expr" /* RawRType.Expression */ && accessed.name !== "expr_or_assign_or_help" /* RawRType.ExprOfAssignOrHelp */ && accessed.name !== "equal_assign" /* RawRType.LegacyEqualAssign */) {
         parser_1.parseLog.trace(`expected accessed element to be wrapped an expression, yet received ${accessed.name}`);
         return undefined;
     }

package/r-bridge/lang-4.x/ast/parser/xml/internal/operators/normalize-binary.js

@@ -33,7 +33,9 @@ function parseBinaryOp(data, lhs, operator, rhs) {
     const operationName = (0, normalize_meta_1.retrieveOpName)(operator);
     const { location, content } = (0, normalize_meta_1.retrieveMetaStructure)(operator.content);
     if ((0, strings_1.startAndEndsWith)(operationName, '%')) {
-        (0, assert_1.guard)(parsedLhs.location !== undefined && parsedLhs.lexeme !== undefined && parsedRhs.location !== undefined && parsedRhs.lexeme !== undefined, () => `special op lhs and rhs must have a locations and lexemes, but ${JSON.stringify(parsedLhs)} and ${JSON.stringify(parsedRhs)})`);
+        const lhsLoc = parsedLhs.type === "RExpressionList" /* RType.ExpressionList */ ? parsedLhs.grouping?.[0].location : parsedLhs.location;
+        const rhsLoc = parsedRhs.type === "RExpressionList" /* RType.ExpressionList */ ? parsedRhs.grouping?.[0].location : parsedRhs.location;
+        (0, assert_1.guard)(lhsLoc !== undefined && rhsLoc !== undefined, () => `special op lhs and rhs must have a locations, but ${JSON.stringify(parsedLhs)} || ${JSON.stringify(lhsLoc)} and ${JSON.stringify(parsedRhs)} ||  || ${JSON.stringify(rhsLoc)})`);
         // parse as infix function call!
         return {
             type: "RFunctionCall" /* RType.FunctionCall */,
@@ -52,18 +54,18 @@ function parseBinaryOp(data, lhs, operator, rhs) {
             arguments: [
                 {
                     type: "RArgument" /* RType.Argument */,
-                    location: parsedLhs.location,
+                    location: lhsLoc,
                     value: parsedLhs,
                     name: undefined,
-                    lexeme: parsedLhs.lexeme,
+                    lexeme: parsedLhs.lexeme ?? '',
                     info: {}
                 },
                 {
                     type: "RArgument" /* RType.Argument */,
-                    location: parsedRhs.location,
+                    location: rhsLoc,
                     value: parsedRhs,
                     name: undefined,
-                    lexeme: parsedRhs.lexeme,
+                    lexeme: parsedRhs.lexeme ?? '',
                     info: {}
                 }
             ],

package/r-bridge/lang-4.x/ast/parser/xml/internal/structure/normalize-expressions.d.ts

@@ -7,4 +7,4 @@ export declare function splitComments(tokens: readonly NamedXmlBasedJson[]): {
     others: NamedXmlBasedJson[];
 };
 export declare function normalizeExpressions(data: NormalizerData, tokens: readonly XmlBasedJson[] | readonly NamedXmlBasedJson[]): (RNode | RDelimiter)[];
-export declare function parseNodesWithUnknownType(data: NormalizerData, mappedWithName: readonly NamedXmlBasedJson[]): (RNode | RDelimiter)[];
+export declare function parseNodesWithUnknownType(data: NormalizerData, mappedWithName: readonly NamedXmlBasedJson[] | undefined): (RNode | RDelimiter)[];

package/r-bridge/lang-4.x/ast/parser/xml/internal/structure/normalize-expressions.js

@@ -18,7 +18,7 @@ const normalize_if_then_else_1 = require("../control/normalize-if-then-else");
 const normalize_comment_1 = require("../other/normalize-comment");
 function normalizeMappedWithoutSemicolonBasedOnType(mappedWithName, data) {
     let result = undefined;
-    switch (mappedWithName.length) {
+    switch (mappedWithName?.length) {
         case 1:
             result = (0, normalize_single_node_1.normalizeSingleNode)(data, mappedWithName[0]);
             break;
@@ -67,7 +67,7 @@ function splitExprs(tokens) {
             last = i + 1;
         }
         else {
-            const thisExpr = token.name === "expr" /* RawRType.Expression */ || token.name === "expr_or_assign_or_help" /* RawRType.ExprOfAssignOrHelp */;
+            const thisExpr = token.name === "expr" /* RawRType.Expression */ || token.name === "expr_or_assign_or_help" /* RawRType.ExprOfAssignOrHelp */ || token.name === "equal_assign" /* RawRType.LegacyEqualAssign */;
             if (thisExpr && lastExpr) {
                 if (i > last) {
                     segments.push(tokens.slice(last, i));
@@ -93,7 +93,7 @@ function handleExpressionList(raw) {
         return { segments: [], comments: [], braces: undefined };
     }
     const { comments, others: tokens } = splitComments(raw);
-    const first = tokens[0].name;
+    const first = tokens[0]?.name;
     if (first === "{" /* RawRType.BraceLeft */) {
         const endType = tokens[tokens.length - 1].name;
         (0, assert_1.guard)(endType === "}" /* RawRType.BraceRight */, () => `expected a brace at the end of the expression list as well, but ${endType} :: ${JSON.stringify(tokens[tokens.length - 1], json_1.jsonReplacer)}`);
@@ -172,7 +172,7 @@ exports.normalizeExpressions = normalizeExpressions;
 function parseNodesWithUnknownType(data, mappedWithName) {
     const parsedNodes = [];
     // used to indicate the new root node of this set of nodes
-    for (const elem of mappedWithName) {
+    for (const elem of mappedWithName ?? []) {
         const retrieved = (0, normalize_single_node_1.normalizeSingleNode)(data, elem);
         parsedNodes.push(retrieved);
     }

package/r-bridge/lang-4.x/ast/parser/xml/internal/structure/normalize-single-node.js

@@ -35,6 +35,7 @@ function normalizeSingleNode(data, elem) {
         case "exprlist" /* RawRType.ExpressionList */:
         case "expr" /* RawRType.Expression */:
         case "expr_or_assign_or_help" /* RawRType.ExprOfAssignOrHelp */:
+        case "equal_assign" /* RawRType.LegacyEqualAssign */:
             return (0, normalize_expression_1.normalizeExpression)(data, elem.content);
         case "NUM_CONST" /* RawRType.NumericConst */:
             return (0, normalize_number_1.normalizeNumber)(data, elem.content);

package/r-bridge/lang-4.x/ast/parser/xml/normalize-meta.d.ts

@@ -32,7 +32,7 @@ export declare function assureTokenType(obj: XmlBasedJson, expectedName: RawRTyp
  * @param content  - the json object to extract the token-type from
  */
 export declare function getTokenType(content: XmlBasedJson): RawRType;
-export declare function getWithTokenType(obj: XmlBasedJson[]): {
+export declare function getWithTokenType(obj: readonly XmlBasedJson[]): {
     name: RawRType;
     content: XmlBasedJson;
 }[];

package/r-bridge/lang-4.x/ast/parser/xml/normalize-meta.js

@@ -66,7 +66,7 @@ function getTokenType(content) {
 }
 exports.getTokenType = getTokenType;
 function getWithTokenType(obj) {
-    return obj.map((content) => ({
+    return obj.map(content => ({
         name: getTokenType(content),
         content
     }));

package/r-bridge/shell.js

@@ -51,7 +51,9 @@ exports.DEFAULT_OUTPUT_COLLECTOR_CONFIGURATION = {
 exports.DEFAULT_R_PATH = (0, os_1.getPlatform)() === 'windows' ? 'R.exe' : 'R';
 exports.DEFAULT_R_SHELL_EXEC_OPTIONS = {
     pathToRExecutable: (0, config_1.getConfig)().rPath ?? exports.DEFAULT_R_PATH,
-    commandLineOptions: ['--vanilla', '--quiet', '--no-echo', '--no-save', '--slave'],
+    // -s is a short form of --no-echo (and the old version --slave), but this one works in R 3 and 4
+    // (see https://github.com/wch/r-source/commit/f1ff49e74593341c74c20de9517f31a22c8bcb04)
+    commandLineOptions: ['--vanilla', '--quiet', '--no-save', '-s'],
     cwd: process.cwd(),
     env: undefined,
     eol: '\n',

package/util/version.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.flowrVersion = void 0;
 const semver_1 = require("semver");
 // this is automatically replaced with the current version by release-it
-const version = '2.0.4';
+const version = '2.0.6';
 function flowrVersion() {
     return new semver_1.SemVer(version);
 }