Skip to content

Commit a68df4f

Browse files
Merge pull request #1041 from neo4j-labs/develop
Release 2.4.10
2 parents 86058df + 92b1623 commit a68df4f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+295
-150
lines changed

.github/workflows/master-deployment.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ jobs:
7979
context: .
8080
file: ./Dockerfile
8181
push: true
82-
tags: ${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:2.4.9
82+
tags: ${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_LABS_USERNAME }}/neodash:2.4.10
8383
build-docker-legacy:
8484
needs: build-test
8585
runs-on: neodash-runners
@@ -103,7 +103,7 @@ jobs:
103103
context: .
104104
file: ./Dockerfile
105105
push: true
106-
tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.4.9
106+
tags: ${{ secrets.DOCKER_HUB_USERNAME }}/neodash:latest,${{ secrets.DOCKER_HUB_USERNAME }}/neodash:2.4.10
107107
deploy-gallery:
108108
runs-on: neodash-runners
109109
strategy:

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ USER nginx
4444
EXPOSE $NGINX_PORT
4545

4646
HEALTHCHECK cmd curl --fail "http://localhost:$NGINX_PORT" || exit 1
47-
LABEL version="2.4.9"
47+
LABEL version="2.4.10"

changelog.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
## NeoDash 2.4.10 - Community contributions
2+
This is a minor release containing bug fixes and improvements contributed by the NeoDash community.
3+
- [#1039](https://github.com/neo4j-labs/neodash/pull/1039) - Fix default color scheme for bar charts
4+
- [#1038](https://github.com/neo4j-labs/neodash/pull/1038) - Fix rule-based styling for line charts
5+
- [#1036](https://github.com/neo4j-labs/neodash/pull/1036) - Fix table cell rule-based styling
6+
- [#1029](https://github.com/neo4j-labs/neodash/pull/1029) - Fix rule-based styling for numeric values
7+
- [#1028](https://github.com/neo4j-labs/neodash/pull/1028) - Fix OpenStreetMap leaflet display
8+
- [#1020](https://github.com/neo4j-labs/neodash/pull/1020) - Fix boolean handling in parameter selection
9+
- [#1014](https://github.com/neo4j-labs/neodash/pull/1014) - Remove autoPageSize flag (defaults to 0)
10+
- [#1009](https://github.com/neo4j-labs/neodash/pull/1009) - Fix SSO parameters lost on browser redirect
11+
- [#1008](https://github.com/neo4j-labs/neodash/pull/1008) - Fix existence check for `value.low`
12+
- [#1005](https://github.com/neo4j-labs/neodash/pull/1005) - Replace Neo4j Logo
13+
- [#1002](https://github.com/neo4j-labs/neodash/pull/1002) - Patch FAQ on supportability
14+
- [#999](https://github.com/neo4j-labs/neodash/pull/999) - Fix dark mode table header styling
15+
- [#956](https://github.com/neo4j-labs/neodash/pull/956) - Change default protocol to `neo4j+s`
16+
117
## NeoDash 2.4.9
218
This release adds some minor changes to documentation and implements some community contributions.
319
- Added notice about project evolution: [#967](https://github.com/neo4j-labs/neodash/pull/967)

cypress/Page.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ export class Page {
3131

3232
connectToNeo4j() {
3333
cy.get('#form-dialog-title', { timeout: 20000 }).should('contain', 'Connect to Neo4j');
34+
cy.get('#protocol').type('neo4j{enter}');
3435
cy.get('#url').clear().type(DB_URL);
3536
cy.get('#dbusername').clear().type(DB_USERNAME);
3637
cy.get('#dbpassword').type(DB_PASSWORD);

cypress/e2e/start_page.cy.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ describe('NeoDash E2E Tests', () => {
5959
.should('contain', 'title')
6060
.and('contain', 'released')
6161
.and('not.contain', '__id');
62-
// cy.get('main .react-grid-item:eq(2) .MuiDataGrid-virtualScroller .MuiDataGrid-row').should('have.length', 5);
63-
// cy.get('main .react-grid-item:eq(2) .MuiDataGrid-footerContainer').should('contain', '1–5 of 8');
64-
cy.get('main .react-grid-item:eq(2) .MuiDataGrid-footerContainer button[aria-label="Go to next page"]').click();
65-
cy.get('main .react-grid-item:eq(2) .MuiDataGrid-virtualScroller .MuiDataGrid-row').should('have.length', 3);
66-
cy.get('main .react-grid-item:eq(2) .MuiDataGrid-footerContainer').should('contain', '6–8 of 8');
62+
// cy.get('main .react-grid-item:eq(2) .MuiDataGrid-virtualScroller .MuiDataGrid-row').should('have.length', 8);
63+
// cy.get('main .react-grid-item:eq(2) .MuiDataGrid-footerContainer').should('contain', '1–8 of 8');
64+
// cy.get('main .react-grid-item:eq(2) .MuiDataGrid-footerContainer button[aria-label="Go to next page"]').click();
65+
// cy.get('main .react-grid-item:eq(2) .MuiDataGrid-virtualScroller .MuiDataGrid-row').should('have.length', 3);
66+
// cy.get('main .react-grid-item:eq(2) .MuiDataGrid-footerContainer').should('contain', '6–8 of 8');
6767
});
6868

6969
it('creates a bar chart report', () => {

docs/modules/ROOT/pages/developer-guide/adding-visualizations.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= Adding Visualizations
44

5+
include::../banner.adoc[]
6+
57
You can extend NeoDash with your own visualizations without diving deep
68
into the core application. Likewise, adding a new customization to an
79
existing report requires minimal changes.

docs/modules/ROOT/pages/developer-guide/build-and-run.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= Build & Run
44

5+
include::../banner.adoc[]
6+
57
To start developing the application, you will need to set up the
68
development environment.
79

docs/modules/ROOT/pages/developer-guide/component-overview.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ include::../banner.adoc[]
22

33
= Component Overview
44

5+
include::../banner.adoc[]
56

67
The image below contains a high-level overview of the component
78
hierarchy within the application. The following conceptual building

docs/modules/ROOT/pages/developer-guide/configuration.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= Configuration
44

5+
include::../banner.adoc[]
6+
57
When using a custom NeoDash deployment, there are several settings that
68
can be configured. These mostly relate to
79
link:../standalone-mode[Standalone Mode] and SSO configurations.
@@ -21,7 +23,7 @@ will look like this:
2123
"ssoProviders": [],
2224
"ssoDiscoveryUrl": "https://example.com",
2325
"standalone": false,
24-
"standaloneProtocol": "neo4j",
26+
"standaloneProtocol": "neo4j+s",
2527
"standaloneHost": "localhost",
2628
"standalonePort": "7687",
2729
"standaloneDatabase": "neo4j",
@@ -57,7 +59,7 @@ mode (false), or reader mode (true). The terms ``Reader mode'' and
5759
``Standalone mode'' are used interchangibly.
5860

5961
|standaloneProtocol |string |neo4j |When running in standalone mode, the
60-
protocol to used for the Neo4j driver. This shoudl be set to one of
62+
protocol to used for the Neo4j driver. This should be set to one of
6163
`neo4j`, `neo4j+s`, `neo4j+ssc`, `bolt`, `bolt+s`, or `bolt+ssc`.
6264

6365
|standaloneHost |string |localhost |When running in standalone mode, the

docs/modules/ROOT/pages/developer-guide/contributing.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= Contributing
44

5+
include::../banner.adoc[]
6+
57
Contributions to the project are highly welcomed. Please consider
68
creating a https://github.com/neo4j-labs/neodash/pulls[Pull Request].
79
Ensure you start from the `develop` branch, and set the merge base to

docs/modules/ROOT/pages/developer-guide/deploy-a-build.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
= Deploy a Build
2+
13
include::../banner.adoc[]
24

3-
= Deploy a Build
45
If you have a pre-built NeoDash application, you can easily deploy it on an any webserver.
56
A NeoDash build is "just" a collection of HTML, CSS and JavaScript files, so it can run virtually anywhere.
67

@@ -39,7 +40,7 @@ Depending on the webserver type and version, this could be different directory.
3940
As an example - to copy the files to an nginx webserver using `scp`:
4041

4142
```bash
42-
scp neodash-2.4.9-labs username@host:/usr/share/nginx/html
43+
scp neodash-2.4.10-labs username@host:/usr/share/nginx/html
4344
```
4445

4546
NeoDash should now be visible by visiting your (sub)domain in the browser.

docs/modules/ROOT/pages/developer-guide/design.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@ include::../banner.adoc[]
22

33
= Design
44

5+
include::../banner.adoc[]
6+
7+
8+
include::../banner.adoc[]
9+
10+
511
This page contains some key guidelines for design of the application.
612
This entails code architecture, as well as UX/UI design.
713

docs/modules/ROOT/pages/developer-guide/index.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@ include::../banner.adoc[]
22

33
= Developer Guide
44

5+
include::../banner.adoc[]
6+
7+
8+
include::../banner.adoc[]
9+
10+
511
This guide contains information for developers looking to deploy NeoDash, or extend it for their own needs.
612

713
- link:build-and-run[Build & Run]

docs/modules/ROOT/pages/developer-guide/session-storage.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= Session Storage
44

5+
include::../banner.adoc[]
6+
57
This reducer serves only to store data that we want to reset at each new session.
68
To connect to it, just define a key and use the predefined actions to set a new pair (key,value) inside of it.
79
Inside the actions there is also an action to delete all the keys that match a precise prefix, it can be useful, for example, to wipe the sessionStorage state for a certain extension, if it stores the data inside the sessionStorage using a prefix (for example look at the query-translator extension at getSessionStorageHistoryKey).

docs/modules/ROOT/pages/developer-guide/standalone-mode.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= Standalone Mode
44

5+
include::../banner.adoc[]
6+
57
Next to being a dashboard editor, NeoDash can be deployed in a
68
`standalone mode' - allowing you set up a architecture to publish and
79
read dashboards.
@@ -44,7 +46,7 @@ docker run -it --rm -p 5005:5005 \
4446
-e ssoProviders=[] \
4547
-e ssoDiscoveryUrl="https://example.com" \
4648
-e standalone=true \
47-
-e standaloneProtocol="neo4j" \
49+
-e standaloneProtocol="neo4j+s" \
4850
-e standaloneHost="localhost" \
4951
-e standalonePort="7687" \
5052
-e standaloneDatabase="neo4j" \

docs/modules/ROOT/pages/developer-guide/state-management.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= State Management
44

5+
include::../banner.adoc[]
6+
57
NeoDash is an application with a complex internal state. If you are
68
planning to extend the application state in some way, make sure you are
79
familiar with https://redux.js.org/[Redux] design patterns.
@@ -131,7 +133,7 @@ standalone mode.
131133
"ssoEnabled": false,
132134
"ssoProviders": [],
133135
"ssoDiscoveryUrl": "https://example.com",
134-
"standaloneProtocol": "neo4j",
136+
"standaloneProtocol": "neo4j+s",
135137
"standaloneHost": "localhost",
136138
"standalonePort": "7687",
137139
"standaloneDatabase": "neo4j",

docs/modules/ROOT/pages/developer-guide/style-configuration.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= Style Configuration
44

5+
include::../banner.adoc[]
6+
57
When using a custom NeoDash deployment, there are several theme variables that
68
can be configured. These mostly relate to css tokens for
79
link:https://cdn.jsdelivr.net/npm/@neo4j-ndl/[email protected]/lib/tokens/css/tokens.css[Needle] and some other brand specific options.

docs/modules/ROOT/pages/developer-guide/testing.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= Testing
44

5+
include::../banner.adoc[]
6+
57
NeoDash uses *Cypress* for automated testing. To install Cypress, check
68
out the official
79
https://docs.cypress.io/guides/getting-started/installing-cypress#What-you-ll-learn[installation

docs/modules/ROOT/pages/index.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
include::/banner.adoc[]
22

33
= Introduction
4+
5+
include::/banner.adoc[]
6+
47
This portal contains information on getting started with NeoDash - A Low-Code Dashboard Builder for Neo4j.
58

69
NeoDash is an open source tool for visualizing your Neo4j data. It lets you group visualizations together as dashboards, and allow for interactions between reports.

docs/modules/ROOT/pages/quickstart.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::/banner.adoc[]
22

33
= Quickstart
44

5+
include::/banner.adoc[]
6+
57
There are three easy ways to run NeoDash and start dashboarding your Neo4j data:
68

79
. The latest version is always available online:

docs/modules/ROOT/pages/user-guide/access-control.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= Access Control
44

5+
include::../banner.adoc[]
6+
57
The Access Control feature in NeoDash is a security measure that allows Users with write access or higher privileges to manage who has access to specific dashboards.
68

79

docs/modules/ROOT/pages/user-guide/bloom-integration.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= Bloom Integration
44

5+
include::../banner.adoc[]
6+
57
NeoDash can be linked to Neo4j Bloom perspectives by using
68
https://neo4j.com/docs/bloom-user-guide/current/bloom-tutorial/deep-links/[Bloom
79
Deep Links]. This functionality allows you to combine the power of graph

docs/modules/ROOT/pages/user-guide/dashboards.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= Dashboards
44

5+
include::../banner.adoc[]
6+
57
In NeoDash, a dashboard consists of several pages, each of which can
68
consist of multiple reports.
79

docs/modules/ROOT/pages/user-guide/extensions/access-control-management.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
include::../../banner.adoc[]
21

32
= Access Control Management
43

4+
include::../../banner.adoc[]
5+
56
This extension lets you manage access control for roles and users, letting you assign users to roles as well as controlling which node labels can be read by a user.
67

78
This extension is only visible to users with the role of "Administrator" or "Super User". Enabling this extension will allow the admin user to manage the labels of the roles in the database and then attach them to the users.

docs/modules/ROOT/pages/user-guide/extensions/advanced-visualizations.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
include::../../banner.adoc[]
21

32
= Advanced Visualizations
43

4+
include::../../banner.adoc[]
5+
56
Advanced visualizations let you extend your dashboard with complex, powerful visualizations beyond the standard visualizations.
67
For specific use-cases, these visualizations may convey information that a simple visualization cannot.
78
To use advanced visualizations, enable them in the **Extensions Window**. This makes them selectable inside reports, as well as add examples to the Example window.

docs/modules/ROOT/pages/user-guide/extensions/forms.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
include::../../banner.adoc[]
21

32
= Forms
43

4+
include::../../banner.adoc[]
5+
56
The 'forms' extension lets you combine different parameter selectors to update / modify your graph data.
67
Update queries are predefined by the dashboard builder, and the user is limited to specifying the parameters for the query only.
78

docs/modules/ROOT/pages/user-guide/extensions/index.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
include::../../banner.adoc[]
21

32
= Extensions
43

4+
include::../../banner.adoc[]
5+
56
Extensions provide a way to expand the basic functionality of NeoDash with extra features.
67
To enable an extension, open up the extensions window by clicking the puzzle piece icon in the left-sidebar of the screen.
78
This will open up the **Extensions Window**, which lets you toggle active extensions for the current dashboard.

docs/modules/ROOT/pages/user-guide/extensions/natural-language-queries.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
include::../../banner.adoc[]
21

32
= Text2Cypher - Natural Language Queries
3+
4+
include::../../banner.adoc[]
5+
46
Use natural language to generate Cypher queries in NeoDash. Connect to an LLM through an API, and let NeoDash use your database schema + the report types to generate queries automatically.
57

68
== How it works

docs/modules/ROOT/pages/user-guide/extensions/report-actions.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
include::../../banner.adoc[]
21

32
= Report Actions
43

4+
include::../../banner.adoc[]
5+
56
link:../#_2_pro_extensions[label:Pro Extension[]]
67

78
Report actions let dashboard builders add interactivity into dashboards. Actions can be used to achieve:

docs/modules/ROOT/pages/user-guide/extensions/rule-based-styling.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
include::../../banner.adoc[]
21

32
= Rule-Based Styling
43

4+
include::../../banner.adoc[]
55

66
The rule-based styling extension allows users to dynamically color elements in a visualization based on output values. This can be applied to tables, graphs, bar charts, line charts, and more. To use the extension, click on the 'rule-based styling' icon inside the settings of a report.
77

docs/modules/ROOT/pages/user-guide/extensions/workflows.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
include::../../banner.adoc[]
21

32
= Workflows
43

4+
include::../../banner.adoc[]
5+
56
Introducing an advanced extension for creating, managing, and running workflows with Cypher queries. Simplify ETL flows, execute complex query chains, and run graph data science workloads effortlessly from Neodash.
67

78
== Enable the extension

docs/modules/ROOT/pages/user-guide/faq.adoc

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ include::../banner.adoc[]
22

33
= FAQ
44

5+
include::../banner.adoc[]
6+
57
== 1. How can I learn more about NeoDash?
68

79
To learn more, check out the following list of resources (blogs, videos
@@ -48,17 +50,8 @@ If you need help setting this up, please contact the NeoDash team.
4850

4951
== 4. Is NeoDash Production Ready?
5052

51-
NeoDash is safe to be used in a production environment. As it is a
52-
reporting tool, keep the following things in mind:
53-
54-
- Always use *read-only* Neo4j accounts when connecting to a dashboard.
55-
- Always deploy NeoDash with SSL, so that an encrypted Neo4j connection must be
56-
used.
57-
- As NeoDash accesses Neo4j directly, make sure you only give
58-
access to the right people. As a rule of thumb, you should give NeoDash
59-
access to the people that can also see Bloom.
60-
61-
For other questions regarding setting up your own production deployment, contact the NeoDash team.
53+
NeoDash Labs is an experimental tool without official support.
54+
For production-grade usage with Neo4j Enterprise Edition, we recommend a `NeoDash commercial` license.
6255

6356
== 5. Can I use NeoDash with Neo4j Community Edition?
6457

0 commit comments

Comments
 (0)