Merge pull request #423 from neo4j-labs/develop

BennuFire · web-flow · commit 498e8893e2b4 · 2023-04-24T17:38:42.000+02:00
2.2.5 Release
diff --git a/.github/workflows/master-deployment.yml b/.github/workflows/master-deployment.yml
@@ -79,7 +79,7 @@ jobs:
       context: .
       file: ./Dockerfile
       push: true
-      tags: ${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:2.2.4
+      tags: ${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:2.2.5
  build-docker-legacy:
    needs: build-test
    runs-on: ubuntu-latest
@@ -103,7 +103,7 @@ jobs:
       context: .
       file: ./Dockerfile
       push: true
-      tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.2.4
+      tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.2.5
 #  build-npm:
 #    needs: build-test
 #    runs-on: ubuntu-latest
diff --git a/Dockerfile b/Dockerfile
@@ -38,4 +38,4 @@ RUN chown -R nginx:nginx /usr/share/nginx/html/
 USER nginx
 EXPOSE 5005
 HEALTHCHECK cmd curl --fail http://localhost:5005 || exit 1
-LABEL version="2.2.4"
+LABEL version="2.2.5"
diff --git a/changelog.md b/changelog.md
@@ -1,3 +1,11 @@
+## NeoDash 2.2.5
+This is a minor release with some small bug fixes, directly following the 2.2.4 release.
+- Fixed replacement rules for parameters in iFrames/Markdown reports. [#17](https://github.com/neo4j-labs/neodash/pull/417)
+- Added automatic header text color switch for reports with a dark background [#420](https://github.com/neo4j-labs/neodash/pull/420)
+- Fixed handling right click events (for graph exploration) in Neo4j Desktop [#415](https://github.com/neo4j-labs/neodash/pull/415).
+- Added support for unweighted Sankey charts [#419](https://github.com/neo4j-labs/neodash/pull/419)
+
+
 ## NeoDash 2.2.4
 This release is a feature-rich package with a variety of new features and bug fixes. NeoDash 2.2.4 features new visualizations, as well as new features in existing visualization components. 
 
diff --git a/docs/modules/ROOT/pages/developer-guide/deploy-a-build.adoc b/docs/modules/ROOT/pages/developer-guide/deploy-a-build.adoc
@@ -34,7 +34,7 @@ Depending on the webserver type and version, this could be different directory.
 As an example - to copy the files to an nginx webserver using `scp`:
 
 ```bash
-scp neodash-2.2.4 username@host:/usr/share/nginx/html
+scp neodash-2.2.5 username@host:/usr/share/nginx/html
 ```
 
 NeoDash should now be visible by visiting your (sub)domain in the browser.
diff --git a/docs/modules/ROOT/pages/user-guide/reports/sankey.adoc b/docs/modules/ROOT/pages/user-guide/reports/sankey.adoc
@@ -31,7 +31,8 @@ the visualization.
 user hovers over a node or link.
 
 |Relationship Property |text | value | Name of the property with an integer value that is going
-to be used to determine thickness of links.
+to be used to determine thickness of links. Using 'SANKEY_UNWEIGHTED', this sankey will assume
+every relationship with a weight of 1.
 
 |Color Scheme |List | |The color scheme to use for the slices. Colors
 are assigned automatically (consecutively) to the different categories
diff --git a/gallery/package.json b/gallery/package.json
@@ -9,15 +9,15 @@
     "neo4j-driver": "^5.0.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-scripts": "5.0.1",
+    "react-scripts": "^5.0.1",
     "typescript": "^4.4.2",
     "web-vitals": "^2.1.0"
   },
   "scripts": {
-    "start": "react-scripts start",
-    "build": "react-scripts build",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject"
+    "start": "DISABLE_ESLINT_PLUGIN=true react-scripts start",
+    "build": "DISABLE_ESLINT_PLUGIN=true react-scripts build",
+    "test": "DISABLE_ESLINT_PLUGIN=true react-scripts test",
+    "eject": "DISABLE_ESLINT_PLUGIN=true react-scripts eject"
   },
   "browserslist": {
     "production": [
diff --git a/gallery/yarn.lock b/gallery/yarn.lock
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "neodash",
-  "version": "2.2.4",
+  "version": "2.2.5",
   "description": "NeoDash - Neo4j Dashboard Builder",
   "neo4jDesktop": {
     "apiVersion": "^1.2.0"
diff --git a/public/style.css b/public/style.css
@@ -7,7 +7,7 @@
     color: white !important;
 }
 
-.no-underline .MuiInput-underline::before {
+.no-underline [class*='MuiInput-underline-']::before{
     border-bottom: none;
 }
 
diff --git a/release-notes.md b/release-notes.md
@@ -1,39 +1,6 @@
-## NeoDash 2.2.4
-This release is a feature-rich package with a variety of new features and bug fixes. NeoDash 2.2.4 features new visualizations, as well as new features in existing visualization components. 
-
-
-- Area Map - **New!** 
-  - Added a new advanced chart interactive area map visualization for rendering geo json polygons. ([@alfredorubin96](https://github.com/alfredorubin96), [#401](https://github.com/neo4j-labs/neodash/pull/401))
-  - Assign color scale automatically based on numeric values.
-  - Assign colors to countries based on Alpha-2 and Alpha-3 codes, and area codes by ISO 3166 code.
-  - Interactive drilldown by clicking on regions in a country.
-
-- Graph Visualization
-  - Added **lightweight, ad-hoc graph exploration** by relationship type and direction. ([@nielsdejong](https://github.com/nielsdejong), [#401](https://github.com/neo4j-labs/neodash/pull/401))
-  - Added experimental graph editing: nodes and relationships, plus creating relationships between existing nodes. ([@nielsdejong](https://github.com/nielsdejong), [#401](https://github.com/neo4j-labs/neodash/pull/401))
-  - Fixed incorrect assignment of chip colors in graph visualization footer. ([@BennuFire](https://github.com/bennufire), [#296](https://github.com/neo4j-labs/neodash/issues/296))
-  - Added experimental CSV download button to graph visualizations. ([@JonanOribe](https://github.com/JonanOribe), [#288](https://github.com/neo4j-labs/neodash/issues/288), [#363](https://github.com/neo4j-labs/neodash/issues/363))
-  - Fixed a bug where dashboard parameters were not dynamically injected into drilldown links. ([@nielsdejong](https://github.com/nielsdejong), [#397](https://github.com/neo4j-labs/neodash/pull/397))
-  - Added setting to customize the size of the arrow head on an edge. Set to zero to disable directional rendering. ([@BennuFire](https://github.com/bennufire), [#410](https://github.com/neo4j-labs/neodash/pull/410))
- 
-- Single Value Chart
-  - Added support for outputting dictionaries in YML format, and rendering new lines. ([@nielsdejong](https://github.com/nielsdejong), [#315](https://github.com/neo4j-labs/neodash/issues/315))
-
-- Choropleth Map
-  - Added polygon information for missing countries: France, Kosovo, and others. ([@BennuFire](https://github.com/bennufire), [#357](https://github.com/neo4j-labs/neodash/issues/357))
-
-- Parameter Selector
-  - Fixed bug where the parameter selector was not using the selected database to populate results. ([@BennuFire](https://github.com/bennufire), [#366](https://github.com/neo4j-labs/neodash/issues/366))
-  - Added a date picker parameter selector type for natively specifying dates. ([@alfredorubin96](https://github.com/alfredorubin96), [#401](https://github.com/neo4j-labs/neodash/pull/401))
-  - Added support for injecting custom queries as a populator for parameter selector suggestions. ([@BennuFire](https://github.com/bennufire), [#236](https://github.com/neo4j-labs/neodash/issues/236), [#369](https://github.com/neo4j-labs/neodash/issues/369))
-
-- Table Chart
-  - Added support for customizing the seperator in csv exports. ([@nielsdejong](https://github.com/nielsdejong), [#337](https://github.com/neo4j-labs/neodash/issues/337))
-- Others
-  - Added support for easily configurable branding/color schemes of the editor. ([@nielsdejong](https://github.com/nielsdejong), [#401](https://github.com/neo4j-labs/neodash/pull/401))
-  - Added a new report action to switch pages based on a user interaction. ([@BennuFire](https://github.com/BennuFire), [#324](https://github.com/neo4j-labs/neodash/issues/324))
-  - Added handler for mulitple report actions to be executed on the same event. ([@BennuFire](https://github.com/BennuFire), [#324](https://github.com/neo4j-labs/neodash/issues/324))
-  - Integrated the official released version of the Neo4j Cypher editor component. ([@jharris4](https://github.com/jharris4), [#365](https://github.com/neo4j-labs/neodash/pull/365))
-  - Fixed hot-module replacement inside webpack configuration.  ([@konsalex](https://github.com/konsalex), [#396](https://github.com/neo4j-labs/neodash/pull/396))
-  - Fixed husky pre-commit hook not triggering correctly on Windows environments. ([@bastienhubert](https://github.com/bastienhubert), [#342](https://github.com/neo4j-labs/neodash/issues/342))
-  - Add support for using complex objects in markdown, iframes and report titles. ([@BennuFire](https://github.com/bennufire), [#413](https://github.com/neo4j-labs/neodash/pull/413))
+## NeoDash 2.2.5
+This is a minor release with some small bug fixes, directly following the 2.2.4 release.
+- Fixed replacement rules for parameters in iFrames/Markdown reports. [#417](https://github.com/neo4j-labs/neodash/pull/417)
+- Added automatic header text color switch for reports with a dark background [#420](https://github.com/neo4j-labs/neodash/pull/420)
+- Fixed handling right click events (for graph exploration) in Neo4j Desktop [#415](https://github.com/neo4j-labs/neodash/pull/415).
+- Added support for unweighted Sankey charts [#419](https://github.com/neo4j-labs/neodash/pull/419)
diff --git a/src/application/Application.tsx b/src/application/Application.tsx
@@ -3,6 +3,8 @@ import { hot } from 'react-hot-loader/root';
 import CssBaseline from '@material-ui/core/CssBaseline';
 import NeoNotificationModal from '../modal/NotificationModal';
 import NeoWelcomeScreenModal from '../modal/WelcomeScreenModal';
+import { ThemeProvider } from '@material-ui/styles';
+import { lightTheme } from '../component/theme/Themes';
 import { connect } from 'react-redux';
 import {
   applicationGetConnection,
@@ -89,6 +91,10 @@ const Application = ({
   const [initialized, setInitialized] = React.useState(false);
 
   if (!initialized) {
+    // Tell Neo4j Desktop to disable capturing right clicking
+    window.neo4jDesktopApi &&
+      window.neo4jDesktopApi.showMenuOnRightClick &&
+      window.neo4jDesktopApi.showMenuOnRightClick(false);
     setInitialized(true);
     initializeApplication(initialized);
   }
@@ -97,48 +103,50 @@ const Application = ({
 
   // Only render the dashboard component if we have an active Neo4j connection.
   return (
-    <div ref={ref} style={{ display: 'flex' }}>
-      <CssBaseline />
-      {/* TODO - clean this up. Only draw the placeholder if the connection is not established. */}
-      <NeoDashboardPlaceholder connected={connected}></NeoDashboardPlaceholder>
-      {connected ? <Dashboard onDownloadDashboardAsImage={(_) => downloadComponentAsImage(ref)}></Dashboard> : <></>}
-      {/* TODO - move all models into a pop-ups (or modals) component. */}
-      <NeoAboutModal open={aboutModalOpen} handleClose={onAboutModalClose} getDebugState={getDebugState} />
-      <NeoConnectionModal
-        open={connectionModalOpen}
-        dismissable={connected}
-        connection={connection}
-        ssoSettings={ssoSettings}
-        standalone={standaloneSettings.standalone}
-        standaloneSettings={standaloneSettings}
-        createConnection={createConnection}
-        onSSOAttempt={onSSOAttempt}
-        onConnectionModalClose={onConnectionModalClose}
-      ></NeoConnectionModal>
-      <NeoWelcomeScreenModal
-        welcomeScreenOpen={welcomeScreenOpen}
-        setWelcomeScreenOpen={setWelcomeScreenOpen}
-        hasCachedDashboard={hasCachedDashboard}
-        hasNeo4jDesktopConnection={hasNeo4jDesktopConnection}
-        onConnectionModalOpen={onConnectionModalOpen}
-        createConnectionFromDesktopIntegration={createConnectionFromDesktopIntegration}
-        onAboutModalOpen={onAboutModalOpen}
-        resetDashboard={resetDashboard}
-      ></NeoWelcomeScreenModal>
-      <NeoUpgradeOldDashboardModal
-        open={oldDashboard}
-        text={oldDashboard}
-        loadDashboard={loadDashboard}
-        clearOldDashboard={clearOldDashboard}
-      />
-      <NeoLoadSharedDashboardModal
-        shareDetails={shareDetails}
-        onResetShareDetails={onResetShareDetails}
-        onConfirmLoadSharedDashboard={onConfirmLoadSharedDashboard}
-      />
-      <NeoReportHelpModal open={reportHelpModalOpen} handleClose={onReportHelpModalClose} />
-      <NeoNotificationModal></NeoNotificationModal>
-    </div>
+    <ThemeProvider theme={lightTheme}>
+      <div ref={ref} style={{ display: 'flex' }}>
+        <CssBaseline />
+        {/* TODO - clean this up. Only draw the placeholder if the connection is not established. */}
+        <NeoDashboardPlaceholder connected={connected}></NeoDashboardPlaceholder>
+        {connected ? <Dashboard onDownloadDashboardAsImage={(_) => downloadComponentAsImage(ref)}></Dashboard> : <></>}
+        {/* TODO - move all models into a pop-ups (or modals) component. */}
+        <NeoAboutModal open={aboutModalOpen} handleClose={onAboutModalClose} getDebugState={getDebugState} />
+        <NeoConnectionModal
+          open={connectionModalOpen}
+          dismissable={connected}
+          connection={connection}
+          ssoSettings={ssoSettings}
+          standalone={standaloneSettings.standalone}
+          standaloneSettings={standaloneSettings}
+          createConnection={createConnection}
+          onSSOAttempt={onSSOAttempt}
+          onConnectionModalClose={onConnectionModalClose}
+        ></NeoConnectionModal>
+        <NeoWelcomeScreenModal
+          welcomeScreenOpen={welcomeScreenOpen}
+          setWelcomeScreenOpen={setWelcomeScreenOpen}
+          hasCachedDashboard={hasCachedDashboard}
+          hasNeo4jDesktopConnection={hasNeo4jDesktopConnection}
+          onConnectionModalOpen={onConnectionModalOpen}
+          createConnectionFromDesktopIntegration={createConnectionFromDesktopIntegration}
+          onAboutModalOpen={onAboutModalOpen}
+          resetDashboard={resetDashboard}
+        ></NeoWelcomeScreenModal>
+        <NeoUpgradeOldDashboardModal
+          open={oldDashboard}
+          text={oldDashboard}
+          loadDashboard={loadDashboard}
+          clearOldDashboard={clearOldDashboard}
+        />
+        <NeoLoadSharedDashboardModal
+          shareDetails={shareDetails}
+          onResetShareDetails={onResetShareDetails}
+          onConfirmLoadSharedDashboard={onConfirmLoadSharedDashboard}
+        />
+        <NeoReportHelpModal open={reportHelpModalOpen} handleClose={onReportHelpModalClose} />
+        <NeoNotificationModal></NeoNotificationModal>
+      </div>
+    </ThemeProvider>
   );
 };
 
diff --git a/src/card/view/CardView.tsx b/src/card/view/CardView.tsx
@@ -11,6 +11,8 @@ import { extensionEnabled, getReportTypes } from '../../extensions/ExtensionUtil
 import NeoCodeViewerComponent from '../../component/editor/CodeViewerComponent';
 import { NeoReportWrapper } from '../../report/ReportWrapper';
 import { identifyStyleRuleParameters } from '../../extensions/styling/StyleRuleEvaluator';
+import { ThemeProvider } from '@material-ui/styles';
+import { lightTheme, darkHeaderTheme, luma } from '../../component/theme/Themes';
 
 const NeoCardView = ({
   title,
@@ -70,22 +72,30 @@ const NeoCardView = ({
 
   // @ts-ignore
   const reportHeader = (
-    <NeoCardViewHeader
-      title={title}
-      editable={editable}
-      description={settings.description}
-      fullscreenEnabled={settings.fullscreenEnabled}
-      downloadImageEnabled={settings.downloadImageEnabled}
-      refreshButtonEnabled={settings.refreshButtonEnabled}
-      onTitleUpdate={onTitleUpdate}
-      onToggleCardSettings={onToggleCardSettings}
-      onManualRefreshCard={() => setLastRunTimestamp(Date.now())}
-      settings={settings}
-      onDownloadImage={onDownloadImage}
-      onToggleCardExpand={onToggleCardExpand}
-      expanded={expanded}
-      parameters={getLocalParameters(title)}
-    ></NeoCardViewHeader>
+    <ThemeProvider
+      theme={
+        settings.backgroundColor && luma(settings.backgroundColor) < dashboardSettings.darkLuma
+          ? darkHeaderTheme
+          : lightTheme
+      }
+    >
+      <NeoCardViewHeader
+        title={title}
+        editable={editable}
+        description={settings.description}
+        fullscreenEnabled={settings.fullscreenEnabled}
+        downloadImageEnabled={settings.downloadImageEnabled}
+        refreshButtonEnabled={settings.refreshButtonEnabled}
+        onTitleUpdate={onTitleUpdate}
+        onToggleCardSettings={onToggleCardSettings}
+        onManualRefreshCard={() => setLastRunTimestamp(Date.now())}
+        settings={settings}
+        onDownloadImage={onDownloadImage}
+        onToggleCardExpand={onToggleCardExpand}
+        expanded={expanded}
+        parameters={getLocalParameters(title)}
+      ></NeoCardViewHeader>
+    </ThemeProvider>
   );
 
   // @ts-ignore
@@ -102,7 +112,7 @@ const NeoCardView = ({
   ) : (
     <></>
   );
-  
+
   const localParameters = { ...getLocalParameters(query), ...getLocalParameters(settings.drilldownLink) };
   const reportTypes = getReportTypes(extensions);
   const withoutFooter =
diff --git a/src/chart/ChartUtils.ts b/src/chart/ChartUtils.ts
@@ -182,6 +182,7 @@ export function replaceDashboardParameters(str, parameters) {
   }
   let rx = /`.([^`]*)`/g;
   let regexSquareBrackets = /\[(.*?)\]/g;
+  let rxSimple = /\$neodash_\w*/g;
 
   /**
    * Define function to access elements in an array/object type dashboard parameter.
@@ -205,15 +206,15 @@ export function replaceDashboardParameters(str, parameters) {
     return RenderSubValue(val);
   };
 
-  let newString = str.replace(rx, parameterElementReplacer);
+  const parameterSimpleReplacer = (_) => {
+    let param = _.replace(`$`, '').trim();
+    let val = parameters?.[param] || null;
+    let type = getRecordType(val);
+    let valueRender = type === 'string' ? val : RenderSubValue(val);
+    return valueRender;
+  };
 
-  Object.keys(parameters).forEach((key) => {
-    let valueRender = RenderSubValue(parameters[key]);
-    newString = newString.replaceAll(`$${key} `, `${valueRender} `);
-    newString = newString.replaceAll(`$${key},`, `${valueRender},`);
-    newString = newString.replaceAll(`$${key}.`, `${valueRender}.`);
-    newString = newString.replaceAll(`$${key})`, `${valueRender})`);
-  });
+  let newString = str.replace(rx, parameterElementReplacer).replace(rxSimple, parameterSimpleReplacer);
 
   return newString;
 }
diff --git a/src/chart/graph/util/RecordUtils.ts b/src/chart/graph/util/RecordUtils.ts
@@ -223,7 +223,7 @@ export function injectNewRecordsIntoGraphVisualization(
     props.data.nodeLabels,
     props.data.linkTypes,
     props.style.colorScheme,
-    props.engine.fields,
+    mergedFields,
     props.style.nodeColorProp,
     props.style.defaultNodeColor,
     props.style.nodeSizeProp,
diff --git a/src/component/theme/Themes.tsx b/src/component/theme/Themes.tsx
@@ -0,0 +1,26 @@
+import { createTheme } from '@material-ui/core/styles';
+export const lightTheme = createTheme({
+  palette: {
+    type: 'light',
+  },
+});
+
+export const darkHeaderTheme = createTheme({
+  palette: {
+    text: {
+      primary: '#ffffff',
+    },
+  },
+});
+
+export const luma = (colorString) => {
+  let color = colorString.substring(1); // strip #
+  let rgb = parseInt(color, 16); // convert rrggbb to decimal
+  let r = (rgb >> 16) & 0xff; // extract red
+  let g = (rgb >> 8) & 0xff; // extract green
+  let b = (rgb >> 0) & 0xff; // extract blue
+
+  return 0.2126 * r + 0.7152 * g + 0.0722 * b; // per ITU-R BT.709
+};
+
+export default lightTheme;
diff --git a/src/config/DashboardConfig.ts b/src/config/DashboardConfig.ts
@@ -37,6 +37,12 @@ export const DASHBOARD_SETTINGS = {
     default: 'bottom-right',
     helperText: 'These are the resize handle options shared across all reports. ',
   },
+  darkLuma: {
+    label: 'Luma Threshold',
+    type: SELECTION_TYPES.NUMBER,
+    default: 25,
+    helperText: 'Background colors under this threshold will be considered as dark',
+  },
   pagenumber: {
     label: 'Page Number',
     type: SELECTION_TYPES.NUMBER,
diff --git a/src/config/ReportConfig.tsx b/src/config/ReportConfig.tsx
diff --git a/src/extensions/advancedcharts/chart/sankey/SankeyChart.tsx b/src/extensions/advancedcharts/chart/sankey/SankeyChart.tsx
diff --git a/src/modal/AboutModal.tsx b/src/modal/AboutModal.tsx

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "neodash",`
`3`		`- "version": "2.2.4",`
	`3`	`+ "version": "2.2.5",`
`4`	`4`	`"description": "NeoDash - Neo4j Dashboard Builder",`
`5`	`5`	`"neo4jDesktop": {`
`6`	`6`	`"apiVersion": "^1.2.0"`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`color: white !important;`
`8`	`8`	`}`
`9`	`9`
`10`		`-.no-underline .MuiInput-underline::before {`
	`10`	`+.no-underline [class*='MuiInput-underline-']::before{`
`11`	`11`	`border-bottom: none;`
`12`	`12`	`}`
`13`	`13`