@eagleoutice/flowr 1.4.2 → 1.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eagleoutice/flowr",
-  "version": "1.4.2",
+  "version": "1.5.1",
   "description": "Static Dataflow Analyzer and Program Slicer for the R Programming Language",
   "types": "dist/src/index.d.ts",
   "repository": {
@@ -13,15 +13,7 @@
   },
   "scripts": {
     "publish-library": "cp .npmignore package.json README.md LICENSE dist/src/ && cd dist/src && npm publish --access public",
-    "main": "ts-node src/flowr.ts",
-    "stats": "ts-node src/cli/statistics-app.ts",
-    "stats-helper": "ts-node src/cli/statistics-helper-app.ts",
-    "slicer": "ts-node src/cli/slicer-app.ts",
     "release": "release-it --ci",
-    "benchmark-helper": "ts-node src/cli/benchmark-helper-app.ts",
-    "benchmark": "npm run build && node dist/src/cli/benchmark-app.js",
-    "summarizer": "ts-node src/cli/summarizer-app.ts",
-    "export-quads": "ts-node src/cli/export-quads-app.ts",
     "build": "tsc --project .",
     "lint-local": "eslint src/ test/ --rule \"no-warning-comments: off\"",
     "lint": "npm run license-compat -- --summary && eslint src/ test/",
@@ -63,6 +55,69 @@
       "cobertura"
     ]
   },
+  "eslintConfig": {
+    "settings": {
+      "import/resolver": {
+        "node": {
+          "extensions": [
+            ".ts"
+          ]
+        }
+      }
+    },
+    "extends": [
+      "@eagleoutice/eslint-config-flowr"
+    ],
+    "rules": {
+      "import/no-restricted-paths": [
+        "error",
+        {
+          "zones": [
+            {
+              "target": "modules/benchmark",
+              "from": [
+                "modules/cli",
+                "src",
+                "modules/statistics"
+              ]
+            },
+            {
+              "target": "modules/cli",
+              "from": [
+                "modules/benchmark",
+                "src",
+                "modules/statistics"
+              ]
+            },
+            {
+              "target": "modules/statistics",
+              "from": [
+                "modules/benchmark",
+                "modules/cli",
+                "src"
+              ]
+            },
+            {
+              "target": "src",
+              "from": [
+                "modules/benchmark",
+                "modules/cli",
+                "modules/statistics"
+              ]
+            },
+            {
+              "target": "test",
+              "from": [
+                "modules/benchmark",
+                "modules/cli",
+                "modules/statistics"
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  },
   "typedocOptions": {
     "includeVersion": true,
     "plugin": [
@@ -114,209 +169,6 @@
     },
     "treatValidationWarningsAsErrors": false
   },
-  "eslintConfig": {
-    "root": true,
-    "env": {
-      "browser": false,
-      "node": true,
-      "es2022": true
-    },
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/recommended-requiring-type-checking",
-      "plugin:@typescript-eslint/strict",
-      "plugin:@typescript-eslint/recommended"
-    ],
-    "overrides": [],
-    "parserOptions": {
-      "ecmaVersion": "latest",
-      "sourceType": "module",
-      "project": "./tsconfig.json"
-    },
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-      "@typescript-eslint",
-      "eslint-plugin-tsdoc",
-      "check-file",
-      "@stylistic",
-      "@stylistic/js",
-      "@stylistic/ts",
-      "import"
-    ],
-    "rules": {
-      "@stylistic/js/object-curly-spacing": [
-        "error",
-        "always"
-      ],
-      "@stylistic/js/indent": [
-        "error",
-        "tab",
-        {
-          "FunctionDeclaration": {
-            "parameters": "first"
-          },
-          "ObjectExpression": 1,
-          "SwitchCase": 1
-        }
-      ],
-      "@stylistic/js/quotes": [
-        "error",
-        "single",
-        {
-          "avoidEscape": true
-        }
-      ],
-      "@stylistic/no-mixed-spaces-and-tabs": [
-        "error",
-        "smart-tabs"
-      ],
-      "no-warning-comments": [
-        "error",
-        {
-          "terms": [
-            "todo",
-            "fixme",
-            "xxx"
-          ],
-          "location": "anywhere"
-        }
-      ],
-      "@typescript-eslint/non-nullable-type-assertion-style": "off",
-      "@typescript-eslint/no-unsafe-enum-comparison": "off",
-      "@typescript-eslint/no-redundant-type-constituents": "off",
-      "@typescript-eslint/consistent-type-assertions": [
-        "error",
-        {
-          "assertionStyle": "as"
-        }
-      ],
-      "@stylistic/ts/key-spacing": [
-        "error",
-        {
-          "align": "value"
-        }
-      ],
-      "@stylistic/js/semi": [
-        "error",
-        "never"
-      ],
-      "@stylistic/js/space-before-function-paren": [
-        "error",
-        "never"
-      ],
-      "@stylistic/js/keyword-spacing": "off",
-      "check-file/filename-naming-convention": [
-        "error",
-        {
-          "**/*.ts": "?([A-Z])+([a-z])*((-|.)?([A-Z])+([a-z]))"
-        }
-      ],
-      "check-file/folder-match-with-fex": [
-        "error",
-        {
-          "*.spec.{js,jsx,ts,tsx}": "test/**"
-        }
-      ],
-      "@stylistic/ts/keyword-spacing": [
-        "error",
-        {
-          "before": true,
-          "after": true,
-          "overrides": {
-            "if": {
-              "after": false
-            },
-            "for": {
-              "after": false
-            },
-            "while": {
-              "after": false
-            },
-            "do": {
-              "after": false
-            },
-            "catch": {
-              "after": false
-            },
-            "switch": {
-              "after": false
-            },
-            "default": {
-              "after": false
-            },
-            "throw": {
-              "after": false
-            }
-          }
-        }
-      ],
-      "@stylistic/ts/space-before-function-paren": [
-        "error",
-        "never"
-      ],
-      "@typescript-eslint/no-unused-vars": [
-        "error",
-        {
-          "argsIgnorePattern": "^_",
-          "destructuredArrayIgnorePattern": "^_",
-          "varsIgnorePattern": "^_"
-        }
-      ],
-      "tsdoc/syntax": "error",
-      "@typescript-eslint/naming-convention": [
-        "error",
-        {
-          "selector": "variable",
-          "modifiers": [
-            "const",
-            "global",
-            "exported"
-          ],
-          "format": [
-            "camelCase",
-            "PascalCase",
-            "UPPER_CASE"
-          ],
-          "leadingUnderscore": "allow",
-          "trailingUnderscore": "allow"
-        },
-        {
-          "selector": "variable",
-          "modifiers": [
-            "const"
-          ],
-          "format": [
-            "camelCase",
-            "PascalCase"
-          ],
-          "leadingUnderscore": "allow",
-          "trailingUnderscore": "allow"
-        },
-        {
-          "selector": "enumMember",
-          "format": [
-            "StrictPascalCase"
-          ],
-          "leadingUnderscore": "forbid",
-          "trailingUnderscore": "forbid"
-        },
-        {
-          "selector": "typeLike",
-          "format": [
-            "PascalCase"
-          ]
-        }
-      ],
-      "@typescript-eslint/consistent-type-imports": "error",
-      "curly": "error",
-      "@stylistic/js/brace-style": [
-        "error",
-        "1tbs"
-      ],
-      "@stylistic/js/new-parens": "error",
-      "import/no-duplicates": "error"
-    }
-  },
   "release-it": {
     "git": {
       "commitMessage": "[skip ci] Release v${version}",
@@ -349,14 +201,21 @@
       "after:bump": "npm run build",
       "after:git:release": "echo After git push, before github release",
       "after:release": "echo Successfully released ${name} v${version} to ${repo.repository}."
+    },
+    "plugins": {
+      "@j-ulrich/release-it-regex-bumper": {
+        "out": {
+          "file": "src/util/version.ts",
+          "search": "const version = '[\\d.]+'",
+          "replace": "const version = '{{version}}'"
+        }
+      }
     }
   },
-  "engines": {
-    "node": ">=16.0.0"
-  },
   "devDependencies": {
     "@commitlint/cli": "^18.4.3",
     "@commitlint/config-angular": "^18.4.3",
+    "@eagleoutice/eslint-config-flowr": "^1.0.2",
     "@stylistic/eslint-plugin": "^1.6.2",
     "@stylistic/eslint-plugin-plus": "^1.6.2",
     "@stylistic/eslint-plugin-ts": "^1.6.2",
@@ -389,7 +248,8 @@
     "typedoc-plugin-missing-exports": "^2.1.0",
     "typedoc-theme-hierarchy": "^4.1.2",
     "typedoc-umlclass": "^0.8.0",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "@j-ulrich/release-it-regex-bumper": "^5.1.0"
   },
   "dependencies": {
     "@types/semver": "^7.5.6",

package/util/{summarizer/summarizer.d.ts → summarizer.d.ts}

@@ -1,4 +1,4 @@
-import type { MergeableRecord } from '../objects';
+import type { MergeableRecord } from './objects';
 export declare const enum SummarizerType {
     Benchmark = "benchmark",
     Statistics = "statistics"
@@ -6,6 +6,17 @@ export declare const enum SummarizerType {
 export interface CommonSummarizerConfiguration extends MergeableRecord {
     logger: (message: string) => void;
 }
+export interface SummarizedMeasurement<T = number> {
+    min: T;
+    max: T;
+    median: T;
+    /** total may be useless for some measurements, especially if they are weighted before (it is just the sum...)*/
+    total: T;
+    /** average */
+    mean: number;
+    /** standard deviation */
+    std: number;
+}
 export declare abstract class Summarizer<Output, Configuration extends CommonSummarizerConfiguration> {
     protected readonly config: Configuration;
     protected readonly log: CommonSummarizerConfiguration['logger'];
@@ -23,3 +34,6 @@ export declare abstract class Summarizer<Output, Configuration extends CommonSum
      */
     abstract summarizePhase(): Promise<Output>;
 }
+export declare function summarizedMeasurement2Csv(a: SummarizedMeasurement): string;
+export declare function summarizedMeasurement2CsvHeader(prefix?: string): string;
+export declare function summarizeMeasurement(data: number[], totalNumberOfDataPoints?: number): SummarizedMeasurement;

package/util/summarizer.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.summarizeMeasurement = exports.summarizedMeasurement2CsvHeader = exports.summarizedMeasurement2Csv = exports.Summarizer = void 0;
+const arrays_1 = require("./arrays");
+class Summarizer {
+    config;
+    log;
+    constructor(config) {
+        this.config = config;
+        this.log = this.config.logger;
+    }
+}
+exports.Summarizer = Summarizer;
+function summarizedMeasurement2Csv(a) {
+    return `${a.min},${a.max},${a.median},${a.mean},${a.std},${a.total}`;
+}
+exports.summarizedMeasurement2Csv = summarizedMeasurement2Csv;
+const summarizedKeys = ['min', 'max', 'median', 'mean', 'std', 'total'];
+function summarizedMeasurement2CsvHeader(prefix) {
+    return summarizedKeys.map(k => prefix ? `${prefix}-${k}` : k).join(',');
+}
+exports.summarizedMeasurement2CsvHeader = summarizedMeasurement2CsvHeader;
+function summarizeMeasurement(data, totalNumberOfDataPoints) {
+    // just to avoid in-place modification
+    const sorted = [...data].sort((a, b) => a - b);
+    const min = sorted[0];
+    const max = sorted[sorted.length - 1];
+    const median = sorted[Math.floor(sorted.length / 2)];
+    const total = (0, arrays_1.sum)(sorted);
+    const length = totalNumberOfDataPoints ?? sorted.length;
+    const mean = total / length;
+    // sqrt(sum(x-mean)^2 / n)
+    const std = Math.sqrt(sorted.map(x => (x - mean) ** 2).reduce((a, b) => a + b, 0) / length);
+    return { min, max, median, mean, std, total };
+}
+exports.summarizeMeasurement = summarizeMeasurement;
+//# sourceMappingURL=summarizer.js.map

package/util/version.d.ts

@@ -0,0 +1,2 @@
+import { SemVer } from 'semver';
+export declare function flowrVersion(): SemVer;

package/util/version.js

@@ -0,0 +1,11 @@
+"use strict";
+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 = '1.5.1';
+function flowrVersion() {
+    return new semver_1.SemVer(version);
+}
+exports.flowrVersion = flowrVersion;
+//# sourceMappingURL=version.js.map

package/benchmark/index.d.ts

@@ -1,3 +0,0 @@
-export * from './stats';
-export * from './slicer';
-export * from './stopwatch';

package/benchmark/index.js

@@ -1,20 +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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./stats"), exports);
-__exportStar(require("./slicer"), exports);
-__exportStar(require("./stopwatch"), exports);
-//# sourceMappingURL=index.js.map

package/benchmark/slicer.d.ts

@@ -1,98 +0,0 @@
-/**
- * Provides a top-level slicer that can be used to slice code *and* retrieve stats.
- * @module
- */
-import type { NormalizedAst, RParseRequestFromFile, RParseRequestFromText } from '../r-bridge';
-import type { DataflowInformation } from '../dataflow/internal/info';
-import type { SlicingCriteria, SlicingCriteriaFilter, SliceResult, ReconstructionResult } from '../slicing';
-import type { PerSliceStats, SlicerStats } from './stats';
-import type { MergeableRecord } from '../util/objects';
-export declare const benchmarkLogger: import("tslog").Logger<import("tslog").ILogObj>;
-/**
- * Returns the stats but also the result of all setup steps (parsing, normalization, and the dataflow analysis) during the slicing.
- * This is useful for debugging and visualizing the slicing process.
- */
-export interface BenchmarkSlicerStats extends MergeableRecord {
-    /** the measurements obtained during the benchmark */
-    stats: SlicerStats;
-    /** the initial and unmodified AST produced by the R side/the 'parse' step */
-    parse: string;
-    /** the normalized AST produced by the 'normalization' step, including its parent decoration */
-    normalize: NormalizedAst;
-    /** the dataflow graph produced by the 'dataflow' step */
-    dataflow: DataflowInformation;
-}
-/**
- * Additionally to {@link BenchmarkSlicerStats}, this contains the results of a *single* slice.
- * In other words, it holds the results of the slice and reconstruct steps.
- */
-export interface BenchmarkSingleSliceStats extends MergeableRecord {
-    /** the measurements obtained during the single slice */
-    stats: PerSliceStats;
-    /** the result of the 'slice' step */
-    slice: SliceResult;
-    /** the final code, as the result of the 'reconstruct' step */
-    code: ReconstructionResult;
-}
-/**
- * A slicer that can be used to slice exactly one file (multiple times).
- * It holds its own {@link RShell} instance, maintains a cached dataflow and keeps measurements.
- *
- * Make sure to call {@link init} to initialize the slicer, before calling {@link slice}.
- * After slicing, call {@link finish} to close the R session and retrieve the stats.
- *
- * @note Under the hood, the benchmark slicer maintains a {@link SteppingSlicer}.
- */
-export declare class BenchmarkSlicer {
-    /** Measures all data that is recorded *once* per slicer (complete setup up to the dataflow graph creation) */
-    private readonly commonMeasurements;
-    private readonly perSliceMeasurements;
-    private readonly shell;
-    private stats;
-    private loadedXml;
-    private dataflow;
-    private ai;
-    private normalizedAst;
-    private totalStopwatch;
-    private finished;
-    private stepper;
-    constructor();
-    /**
-     * Initialize the slicer on the given request.
-     * Can only be called once for each instance.
-     */
-    init(request: RParseRequestFromFile | RParseRequestFromText): Promise<void>;
-    private calculateStatsAfterInit;
-    /**
-   * Slice for the given {@link SlicingCriteria}.
-   * @see SingleSlicingCriterion
-   *
-   * @returns The per slice stats retrieved for this slicing criteria
-   */
-    slice(...slicingCriteria: SlicingCriteria): Promise<BenchmarkSingleSliceStats>;
-    /** Bridging the gap between the new internal and the old names for the benchmarking */
-    private measureCommonStep;
-    private measureSliceStep;
-    private guardActive;
-    /**
-   * Call {@link slice} for all slicing criteria that match the given filter.
-   * See {@link collectAllSlicingCriteria} for details.
-   * <p>
-   * the `report` function will be called *before* each individual slice is performed.
-   *
-   * @returns The number of slices that were produced
-   *
-   * @see collectAllSlicingCriteria
-   * @see SlicingCriteriaFilter
-   */
-    sliceForAll(filter: SlicingCriteriaFilter, report?: (current: number, total: number, allCriteria: SlicingCriteria[]) => void): Promise<number>;
-    /**
-   * Retrieves the final stats and closes the shell session.
-   * Can be called multiple times to retrieve the stored stats, but will only close the session once (the first time).
-   */
-    finish(): BenchmarkSlicerStats;
-    /**
-   * Only call in case of an error - if the session must be closed and the benchmark itself is to be considered failed/dead.
-   */
-    ensureSessionClosed(): void;
-}