2.0.12 (#105)

* Stability fixes for 2.0.11

* Added prototype SSO implementation

* Changed dockerfile usage from ENV to ARG (#93)

* Stability fixes for 2.0.11 (#76)

Fix for rendering dictionaries in tables/single value charts.
Added resize handler for fullscreen map views.
Added missing auto-run config to pie charts.
Fixed broken value scale parameter for bar charts.

* Changed dockerfile usage from ENV to ARG

Also using CMD as opposed to ENTRYPOINT

* Updated supporting docker scripts

* Renamed docker run scripts, deleted docker-build.bash

* Changed dockerfile usage from ENV to ARG

Also using CMD as opposed to ENTRYPOINT

* Updated supporting docker scripts

* Renamed docker run scripts, deleted docker-build.bash

* Updated README to match new Docker image setup

Co-authored-by: Niels de Jong <[email protected]>
Co-authored-by: Tobias <[email protected]>

* Added color selector component. Clean up/refactoring of file names

* Tweaking of color picker for advanced settings, added framework for rule-based styling of reports

* Clean up, refactoring of project structure

* Added version number to Dockerfile

* Moved version number in docker file to before RUN command

* Added some more comments to the docker scripts

* Restructured scripts and docker file locations, added conf.d

* Added conf.d directory

* Updated version number and Dockerfile references

* updated path to conf.d

* Updated version number in dockerfile

* First version of rule-based styling is completed

* Fixed handling of nginx configuration file (#98)

* Remedied errors in handling of nginx configs

* Adjusted copy of default.conf

Co-authored-by: Tobias Krøgholt <[email protected]>

* Update Dockerfile

* Update Dockerfile

* Improved handling of null values in tables

* Added support for custom style rules to relevant report types

* Removed standalone password from default configuration

* Fixed default styling for config.json

* Updated release notes, readme and docker push script for 2.0.12

* Updated description of component hierarchy

* Set dockerfile to pull from master by default

Co-authored-by: Tkrogholt <[email protected]>
Co-authored-by: Tobias <[email protected]>

Author: 3 people

tools/Dockerfile renamed to Dockerfile

@@ -12,8 +12,7 @@ FROM nginx:alpine AS neodash
 RUN apk upgrade
 COPY --from=build-stage /usr/local/src/neodash/dist /usr/share/nginx/html
 
-# Set default config options
-ENV standalone=false
+COPY ./conf/default.conf /etc/nginx/conf.d/
 
 RUN chown -R nginx:nginx /var/cache/nginx && \
     chown -R nginx:nginx /var/log/nginx && \
@@ -27,19 +26,22 @@ USER nginx
 EXPOSE 5005
 HEALTHCHECK cmd curl --fail http://localhost:5005 || exit 1
 
-# Set the defaults for the environment variables. These can be changed at runtime by modifying the docker arguments, avoiding container rebuilds.
-ENV standalone=false
-ENV ssoEnabled=false
-ENV ssoDiscoveryUrl='https://example.com'
-ENV standaloneProtocol='neo4j+s'
-ENV standaloneHost='test.databases.neo4j.io'
-ENV standalonePort=7687
-ENV standaloneDatabase='neo4j'
-ENV standaloneDashboardName='My Dashboard'
-ENV standaloneDashboardDatabase='neo4j'
+# Set the defaults for the build arguments. When the image is created, these variables can be changed with --build-arg
+# Such as --build-arg ssoEnabled=true
+ARG standalone=false
+ARG ssoEnabled=false
+ARG ssoDiscoveryUrl='https://example.com'
+ARG standaloneProtocol='neo4j+s'
+ARG standaloneHost='test.databases.neo4j.io'
+ARG standalonePort=7687
+ARG standaloneDatabase='neo4j'
+ARG standaloneDashboardName='My Dashboard'
+ARG standaloneDashboardDatabase='neo4j'
+
+LABEL version="2.0.12"
 
 # Dynamically set app config on container startup.
-ENTRYPOINT echo " \
+RUN echo " \
     { \
     \"ssoEnabled\": ${ssoEnabled}, \
     \"ssoDiscoveryUrl\": \"${ssoDiscoveryUrl}\",  \
@@ -50,7 +52,8 @@ ENTRYPOINT echo " \
     \"standaloneDatabase\": \"${standaloneDatabase}\",  \
     \"standaloneDashboardName\": \"${standaloneDashboardName}\", \
     \"standaloneDashboardDatabase\": \"${standaloneDashboardDatabase}\"  \
-    }" > /usr/share/nginx/html/config.json && \
-    nginx -g 'daemon off;'
+    }" > /usr/share/nginx/html/config.json
+    
+CMD ["nginx", "-g", "daemon off;"]
 
-# neodash will be available at http://localhost:8080 by default.
+# neodash will be available at http://localhost:80 inside the container. See `scripts/docker-build-run-unix.bash` on how to map ports.

README.md

@@ -43,23 +43,24 @@ To build the app for production:
 
 
 ## Build Docker image
-Make sure you have a recent version of `docker` installed.
-On a Unix-like system you can run  `./tools/docker-build.bash` to build the multi-stage NeoDash image.
+A pre-built Docker image is available [on DockerHub](https://hub.docker.com/r/nielsdejong/neodash). 
+This image is built using the default configuration (running in editor mode, without SSO).
+
+### To build the image yourself:
 
-After this, you can run Neo4j in a container. On Unix (Mac/Linux) systems:
+Make sure you have a recent version of `docker` installed to build the multi-stage NeoDash image and run it.
+
+On Unix (Mac/Linux) systems:
 ```
-$ cd tools/
-$ ./docker-run-unix.bash 
+$ ./scripts/docker-build-run-unix.bash 
 ```
 
 If you use Windows, you should have installed WSL. In WSL, you can run the script as follows:
 ```
-$ cd tools/
-$ ./docker-run-windows.bash
+$ ./scripts/docker-build-run-windows.bash
 ```
-Then visit `http://localhost:8080` with the chosen port in your browser.
+Then visit `http://localhost:8080` in your browser.
 
-A pre-built Docker image is available [on DockerHub](https://hub.docker.com/r/nielsdejong/neodash). 
 
 ## Run in standalone mode
 NeoDash can be deployed in a 'standalone mode' for dashboard viewers. This mode will:
@@ -71,7 +72,7 @@ The diagram below illustrates how NeoDash standalone mode can be deployed next t
 
 ![](doc/standalone-architecture.png)
 
-You can configure an instance to run as standalone by changing the variables in `tools/docker-run-unix.bash`, or, if you're not using docker, directly modifying `public/config.json`. Note that the editor mode is determined at runtime by the React app, and *not* at build time. You therefore do not need to (re-)build a docker image.
+You can configure an instance to run as standalone by changing the variables in `scripts/docker-build-run-unix.bash`, or, if you're not using docker, directly modifying `public/config.json`. Note that the editor mode is determined at runtime by the React app, and *not* at build time. You therefore do not need to (re-)build the React application, just the image.
 
  ## Extending NeoDash
 There are two categories of extensions to NeoDash you can build:
@@ -88,22 +89,22 @@ To extend the core functionality of the app, it helps to be familiar with the fo
 - Redux Thunks
 
 The image below contains a high-level overview of the component hierarchy within the application. The following conceptual building blocks are used to create the interface:
-- The Application
-- The Dashboard
-- Modals 
-- Drawer
-- Dashboard Header
-- Pages
-- Cards
-- Card Views
-- Card Settings
-- Card View Header
-- Report
-- Card View Footer
-- Card Settings Header
-- Card Settings Content
-- Card Settings Footer
-- Charts
+- **The Application** - highest level in the component structure. Handles all application-level logic (e.g. initalizing the app).
+- **Modals** - all pop-up windows used by the tool. (Connection modal, save-dashboard modal, errors/warnings, etc.) 
+- **Drawer** - the sidebar on the left side of the screen. Contains buttons to perform application-level actions. 
+- **The Dashboard** - Main dashboard component. Renders components dynamically based on the current state.
+- **Dashboard Header** - the textbox at the top of the screen that lets you set a title for the dashboard, plus the page selector.
+- **Pages** - a dashboard has one or more pages, each of which can have a list of cards.
+- **Cards** - a 'block' inside a dashboard. Each card contains a 'view' window, and a 'settings' window.
+- **Card View** - the front of the card containing the selected report.
+- **Card Settings** - the back of the card, containing the cypher editor and advanced settings for the report.
+- **Card View Header** - the header of the card, containing a text box that acts as the name of the report.
+- **Report** - the component inside the card view that handles query execution and result parsing. Contains a single chart (visualization)
+- **Card View Footer** - The footer of the card view. Depending on the type, contains several 'selectors' that modify the visualization.
+- **Card Settings Header** - Header of the card settings, used for moving/deleting the card.
+- **Card Settings Content** - the component containing the main content of the report. This is most often the Cypher query editor.
+- **Card Settings Footer** - the 'footer' of the card. This contains the 'advanced settings' window for reports.
+- **Charts** - the different visualizations used by the application: bar charts, tables, graphs, etc.
 
 ![](doc/component-hierarchy.png)
 

conf/default.conf

@@ -0,0 +1,16 @@
+server {
+    listen       5005;
+    server_name  localhost;
+    include      mime.types;
+    location / {
+        root   /usr/share/nginx/html;
+        try_files $uri $uri/ /index.html;
+        index  index.html index.htm;
+    }
+    # redirect server error pages to the static page /50x.html
+    # Note: This is optional, depending on the implementation in React
+    error_page   500 502 503 504  /50x.html;
+    location = /50x.html {
+        root   /usr/share/nginx/html;
+    }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "neodash",
-  "version": "2.0.11",
+  "version": "2.0.12",
   "description": "NeoDash - Neo4j Dashboard Builder",
   "neo4jDesktop": {
     "apiVersion": "^1.2.0"
@@ -34,6 +34,7 @@
     "@material-ui/core": "^4.12.3",
     "@material-ui/icons": "^4.11.2",
     "@material-ui/lab": "^4.0.0-alpha.60",
+    "@material-ui/styles": "^4.11.4",
     "@mui/material": "^5.3.0",
     "@mui/x-data-grid": "^5.2.2",
     "@nivo/bar": "^0.79.1",
@@ -46,6 +47,8 @@
     "cypher-codemirror": "github:nielsdejong/cypher-editor#c0eff97fc97f22355e60b57fb6f8dc26b16f9a5f",
     "d3-scale-chromatic": "^3.0.0",
     "leaflet": "^1.7.1",
+    "material-ui-color-picker": "github:nielsdejong/material-ui-color-picker#fd4766cc4e8e38966417fbdbf62ebe628dd699ec",
+    "neo4j-client-sso": "^1.2.2",
     "react": "^17.0.2",
     "react-cool-dimensions": "^2.0.7",
     "react-dom": "^17.0.2",

public/config.json

@@ -1,12 +1,11 @@
 {
-    "ssoEnabled": false, 
-    "ssoDiscoveryUrl": "https://example.com", 
+    "ssoEnabled": false,
+    "ssoDiscoveryUrl": "https://example.com",
     "standalone": false,
     "standaloneProtocol": "neo4j",
     "standaloneHost": "localhost",
-    "standalonePassword":"test123",
     "standalonePort": "7687",
-    "standaloneDatabase": "neo4j", 
+    "standaloneDatabase": "neo4j",
     "standaloneDashboardName": "My Dashboard",
-    "standaloneDashboardDatabase": "dashboards" 
+    "standaloneDashboardDatabase": "dashboards"
 }

public/style.css

@@ -76,6 +76,10 @@
 .MuiTablePagination-root{
     margin-top: -10px;
 } */
+.chrome-picker {
+    margin-top: -285px;
+    margin-left: 10px;
+}
 .MuiTablePagination-root{
     margin-top: -10px;
 }

release-notes.md

@@ -1,3 +1,14 @@
+## NeoDash 2.0.12
+Added **rule-based styling**:
+- Use the card settings to specify styling rules for tables, graphs, bar/pie/line charts and single values.
+- Conditional rules are evaluated on each report render in order of priority.
+- Rules can customize colors in tables, node colors & dynamically set the colors of components in your chart.
+
+Minor improvements:
+- Better handling of null values in tables.
+- Tweaking/reorganization of the Docker file and deployment scripts.
+- Renaming/restructuring of source code.
+
 ## NeoDash 2.0.8 / 2.0.9 / 2.0.10 / 2.0.11
 Stability fixes to supplement 2.0.7:
 - Hotfix for missing config file in Neo4j Desktop causing startup issue.

scripts/docker-build-run-unix.bash

@@ -0,0 +1,26 @@
+# The port to expose NeoDash on.
+port=8080 
+# Set `standalone=true`` to disable the editor, and create a 'fixed' dashboard view.
+standalone=false 
+# If `standalone=true`, the protocol for the hardcoded database connection.
+standaloneProtocol='neo4j+s' 
+# If `standalone=true`, the hostname for the hardcoded database connection.
+standaloneHost='example.databases.neo4j.io' 
+# If `standalone=true`, the port for the hardcoded database connection.
+standalonePort=7687 
+# If `standalone=true`, the database for the hardcoded database connection.
+standaloneDatabase='neo4j'  
+# If `standalone=true`, the name of the dashboard stored in Neo4j to load. This is case-sensitive, and will load the latest version of a dashboard with the exact name.
+standaloneDashboardName='My Dashboard'
+# If `standalone=true`, the database name that the "to be loaded" dashboard is stored in. 
+standaloneDashboardDatabase='neo4j'
+
+# SSO settings. Experimental.
+ssoEnabled=false 
+ssoDiscoveryUrl='https://example.com'
+
+echo "-----------------------------------------------"
+echo "neodash is available at http://localhost:$port."
+echo "-----------------------------------------------"
+docker build --build-arg standalone=$standalone --build-arg ssoEnabled=$ssoEnabled --build-arg ssoDiscoveryUrl=$ssoDiscoveryUrl --build-arg standaloneProtocol=$standaloneProtocol --build-arg standaloneHost=$standaloneHost --build-arg standalonePort=$standalonePort --build-arg standaloneDatabase=$standaloneDatabase --build-arg standaloneDashboardName="${standaloneDashboardName}" --build-arg standaloneDashboardDatabase=$standaloneDashboardDatabase -t neodash .
+docker run -it --rm -p $port:80 neodash 

scripts/docker-build-run-windows.bash

@@ -0,0 +1,26 @@
+# The port to expose NeoDash on.
+port=8080 
+# Set `standalone=true`` to disable the editor, and create a 'fixed' dashboard view.
+standalone=false 
+# If `standalone=true`, the protocol for the hardcoded database connection.
+standaloneProtocol='neo4j+s' 
+# If `standalone=true`, the hostname for the hardcoded database connection.
+standaloneHost='example.databases.neo4j.io' 
+# If `standalone=true`, the port for the hardcoded database connection.
+standalonePort=7687 
+# If `standalone=true`, the database for the hardcoded database connection.
+standaloneDatabase='neo4j'  
+# If `standalone=true`, the name of the dashboard stored in Neo4j to load. This is case-sensitive, and will load the latest version of a dashboard with the exact name.
+standaloneDashboardName='My Dashboard'
+# If `standalone=true`, the database name that the "to be loaded" dashboard is stored in. 
+standaloneDashboardDatabase='neo4j'
+
+# SSO settings. Experimental.
+ssoEnabled=false 
+ssoDiscoveryUrl='https://example.com'
+
+echo "-----------------------------------------------"
+echo "neodash is available at http://localhost:$port."
+echo "-----------------------------------------------"
+winpty docker build --build-arg standalone=$standalone --build-arg ssoEnabled=$ssoEnabled --build-arg ssoDiscoveryUrl=$ssoDiscoveryUrl --build-arg standaloneProtocol=$standaloneProtocol --build-arg standaloneHost=$standaloneHost --build-arg standalonePort=$standalonePort --build-arg standaloneDatabase=$standaloneDatabase --build-arg standaloneDashboardName="${standaloneDashboardName}" --build-arg standaloneDashboardDatabase=$standaloneDashboardDatabase -t neodash .
+winpty docker run -it --rm -p $port:80 neodash