Comparison View without R (#141)

.github/workflows/ci.yml

@@ -81,6 +81,16 @@ jobs:
       - name: Run Tests
         run: |
           npm test
+      
+      - name: Upload image difference, if there are any
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: Image Differences of charts.test.ts
+          path: |
+            diff-*.png
+            *.svg
+          if-no-files-found: ignore
 
       - name: Lint and Formatting
         run: |

.gitignore

@@ -1,16 +1,29 @@
-dist
-node_modules
-.vscode
-resources/reports
-resources/*.js
-tmp/knit
-tmp/interm
-/tests/large-payload.json
-.Rhistory
-.Rproj.user
 *.Rproj
+*.qs
+*.swp
+/.Rhistory
+/.Rproj.user
+/.vscode
+/coverage
+/dist
+/logo
+/node_modules
+/resources/*.js
 /resources/exp-data
+/resources/reports
+/resources/uPlot.min.css
 /src/views/somns.html
 /src/views/test.html
+/tests/data/actual-results
+/tests/data/large-payload.json
+/tmp
 test.figures
 test.html
+
+# ignore most generated plots to make it easier to handle
+/tests/data/expected-results/stats-data-prep/jssom/inline-[0-9].svg
+/tests/data/expected-results/stats-data-prep/jssom/inline-[1-2][0-9].svg
+/tests/data/expected-results/stats-data-prep/tsom/inline-[0-9].svg
+/tests/data/expected-results/stats-data-prep/tsom/inline-[0-9][0-9].svg
+/tests/data/expected-results/stats-data-prep/tsom/inline-1[0-9][0-9].svg
+/tests/data/expected-results/stats-data-prep/tsom/inline-exe-*.svg

Dockerfile

@@ -29,14 +29,13 @@ COPY ./src/stats/install.R /project/src/stats/
 # Installing R libraries
 RUN Rscript /project/src/stats/install.R
 
-
 # Copy only package.json to enable caching
 COPY ./package.json ./package-lock.json /project/
 
 # Set the working dir to the project & install and compile all dependency
 WORKDIR /project/
 
-RUN npm ci --ignore-scripts .
+RUN SKIP_COMPILE=true npm ci --ignore-scripts=false --foreground-scripts
 
 ENV POSTGRES_PASSWORD=docker
 ENV POSTGRES_USER=docker

README.md

@@ -16,14 +16,25 @@ runner to record data for ReBenchDB.
 
 ReBenchDB is designed to
 
-- [x] record benchmark measurements
-- [-] information about the environment in which the benchmarks were executed
-- [-] enable performance tracking over time
-- [x] enable performance comparison of experiments
-- [-] supports custom reports and performance analyses
-- [-] enables data export
-
-(Things marked with [x] are already finished, or partially finished [-])
+- record and store benchmark measurements
+- track information about the environment in which the benchmarks were executed
+- enable performance tracking over time
+- enable performance comparison of experiments
+
+### Features
+
+ - compare performance between specific commits
+   - show aggregated results on an overview plot
+   - give summary statistics
+   - show per-benchmark details
+     - a plot that allows to judge noise
+     - a plot with per-iteration data
+     - a plot of previous results
+     - various metrics and the command line
+     - profiling information
+   - compare performance across different executors
+ - per-project timeline view
+ - per-project data inventory and data export
 
 ## Non-Goals
 
@@ -43,7 +54,7 @@ Data is stored in a PostgreSQL database.
 Custom reports are executed via a shell script, though, we use R to create
 reports.
 
-To ensure that the SVG for plots is generated using a font available in most browers,
+To ensure that the SVG for plots is generated using a font available in most browsers,
 the server needs them when generating plots. We currently use Arial as default font.
 
 On Ubuntu, these fonts can be installed with: