Merge pull request #413 from neo4j-labs/fixNodeValHandling

Added support for handling nodes as dashboard parameters

Author: BennuFire

changelog.md

@@ -36,6 +36,8 @@ This release is a feature-rich package with a variety of new features and bug fi
   - 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.3
 This releases fixes a small set of bugs that slipped through the 2.2.3 release, and adds some minor features:

docs/modules/ROOT/pages/user-guide/reports/markdown.adoc

@@ -6,6 +6,15 @@ text, to be renderer as rich HTML. This lets you turn your dashboards
 into a storybook with textual descriptions, hyperlinks, images and
 videos.
 
+To use dashboard parameters in Markdown, turn on the `Replace global parameters in Markdown` setting.
+Then, include a variable surrounded by backticks inside the markdown string. For example:
+
+```
+== This is a title
+My variable is equal to `$neodash_person_object['name']`
+```
+
+
 == Examples
 
 === Basic Markdown

release-notes.md

@@ -35,4 +35,5 @@ This release is a feature-rich package with a variety of new features and bug fi
   - 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))
+  - 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))

src/card/view/CardViewHeader.tsx

@@ -15,6 +15,7 @@ import ImageIcon from '@material-ui/icons/Image';
 import CloseIcon from '@material-ui/icons/Close';
 import ReactMarkdown from 'react-markdown';
 import gfm from 'remark-gfm';
+import { replaceDashboardParameters } from '../../chart/ChartUtils';
 
 const NeoCardViewHeader = ({
   title,
@@ -37,13 +38,8 @@ const NeoCardViewHeader = ({
   const [descriptionModalOpen, setDescriptionModalOpen] = React.useState(false);
 
   function replaceParamsOnString(s, p) {
-    let parsed = `${s} `;
-    for (const [key, value] of Object.entries(p)) {
-      // TODO: make this a regex.
-      parsed = parsed.replace(`$${key} `, `${value} `);
-      parsed = parsed.replace(`$${key},`, `${value},`);
-      parsed = parsed.replace(`$${key}.`, `${value}.`);
-    }
+    let parsed: string;
+    parsed = replaceDashboardParameters(s, p);
     return parsed;
   }
 

src/chart/ChartUtils.ts

@@ -208,7 +208,11 @@ export function replaceDashboardParameters(str, parameters) {
   let newString = str.replace(rx, parameterElementReplacer);
 
   Object.keys(parameters).forEach((key) => {
-    newString = newString.replaceAll(`$${key}`, parameters[key] !== null ? parameters[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})`);
   });
 
   return newString;

src/settings/SettingsThunks.ts

@@ -1,6 +1,6 @@
 import { setSessionParameters } from '../application/ApplicationActions';
 import { hardResetCardSettings } from '../card/CardActions';
-import { castToNeo4jDate, isCastableToNeo4jDate } from '../chart/ChartUtils';
+import { castToNeo4jDate, isCastableToNeo4jDate, valueIsNode } from '../chart/ChartUtils';
 import { createNotificationThunk } from '../page/PageThunks';
 import { updateDashboardSetting } from './SettingsActions';
 
@@ -29,7 +29,8 @@ export const updateGlobalParameterThunk = (key, value) => (dispatch: any, getSta
     const { settings } = getState().dashboard;
     const parameters = settings.parameters ? settings.parameters : {};
     if (value !== undefined) {
-      parameters[key] = value;
+      let valueFinal = valueIsNode(value) ? Object.assign({}, value) : value;
+      parameters[key] = valueFinal;
     } else {
       delete parameters[key];
     }