first implementation - needs few refinements

Author: 8Rav3n

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

@@ -24,7 +24,10 @@ will look like this:
     "standaloneDatabase": "neo4j",
     "standaloneDashboardName": "My Dashboard",
     "standaloneDashboardDatabase": "dashboards",
-    "standaloneDashboardURL": ""
+    "standaloneDashboardURL": "",
+    "loggingMode": "0",
+    "loggingDatabase": "logging"   
+
 }
 ....
 
@@ -84,6 +87,18 @@ use multiple databases.
 inside Neo4j and would like to run a standalone mode deployment with a
 dashboard from a URL, set this parameter to the complete URL pointing to
 the dashboard JSON.
+
+|loggingMode |string |none |Determines whether neodash should create any
+user activity logs. possible values include: `0` (no log is created), 
+`1` (user login are tracked), `2` (tracks when a specific dashboard is 
+accessed/opened or saved by a user). 
+⚠️ Logs are created in Neo4J DB using the current user credentials 
+(or standaloneUsername if configured); write access to the log database 
+must be granted to enble any user to create logs.
+
+|loggingDatabase |string |neo4j |When loggingMode is set to anything 
+else than '0', the database to use for logging. Log records (nodes)
+will be created in this database.
 |===
 
 == Configuring SSO
@@ -134,3 +149,20 @@ The `standaloneDashboardName` and `standaloneDashboardDatabase` config
 parameters are used to define these.
 ** A standalone deployment that *reads the fixed dashboard from a URL*.
 The `standaloneDashboardURL` config parameter is used to define this.
+
+== Configuring Logging
+
+NeoDash treats log records with an approach similar to dashboards metadata: 
+saving them in a Neo4J database as distinct nodes. Each node has a label 
+"_Neodash_Log" and a standard set of properties such as DateTime (date), 
+UserID (user), Databadse Name (dashboard) Dashboard Name or UUID (dashboard), 
+NeoDash mode (neodash_mmode), Action (action) and a short message (message).
+
+⚠️ Logs are created using the credentials of the current user (either from 
+logon or, if configured, from standaloneUsername), therefore, for it to work,
+administrator must ensure that every neodash user has write access to the 
+__Neodash_Log_ label in the database confugred in the loggingDatabase prameter (which must also be available on the same Neo4J instance where dashboards and data are stored).
+This can be achieved by creating a standard NeoDashUser role in Neo4j with 
+such permissions and assigning this role to every neoDash user. For more 
+details on Neo4J granular access control please refer to the link:https://neo4j.com/docs/operations-manual/current/authentication-authorization/access-control/[product documentation]
+

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

@@ -47,6 +47,7 @@ docker run  -it --rm -p 5005:5005 \
     -e standaloneDatabase="neo4j" \
     -e standaloneDashboardName="My Dashboard" \
     -e standaloneDashboardDatabase="dashboards" \
+    ...
     neo4jlabs/neodash
 ....
 

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

@@ -134,6 +134,8 @@ standalone mode.
     "standaloneDatabase": "neo4j",
     "standaloneDashboardName": "My Dashboard",
     "standaloneDashboardDatabase": "dashboards",
+    "loggingMode": "0",
+    "loggingDatabase": "logging",
     "notificationIsDismissable": null
 }
 ....

public/config.json

@@ -8,5 +8,7 @@
   "standaloneDatabase": "neo4j",
   "standaloneDashboardName": "My Dashboard",
   "standaloneDashboardDatabase": "dashboards",
-  "standaloneDashboardURL": ""
+  "standaloneDashboardURL": "",
+  "loggingMode": "2",
+  "loggingDatabase": "logs"
 }

scripts/config-entrypoint.sh

@@ -15,5 +15,7 @@ echo " \
     \"standalonePassword\": \"${standalonePassword:=}\", \
     \"standaloneDashboardName\": \"${standaloneDashboardName:='My Dashboard'}\", \
     \"standaloneDashboardDatabase\": \"${standaloneDashboardDatabase:='neo4j'}\",  \
-    \"standaloneDashboardURL\": \"${standaloneDashboardURL:=}\"  \
+    \"standaloneDashboardURL\": \"${standaloneDashboardURL:=}\",  \
+    \"loggingMode\": \"${loggingMode:='0'}\",  \
+    \"loggingMode\": \"${loggingDatabase:='logs'}\"  \
     }" > /usr/share/nginx/html/config.json

src/application/ApplicationActions.ts

@@ -172,6 +172,18 @@ export const setStandaloneDashboardDatabase = (dashboardDatabase: string) => ({
   payload: { dashboardDatabase },
 });
 
+export const SET_LOGGING_MODE = 'APPLICATION/SET_LOGGING_MODE';
+export const setLoggingMode = (loggingMode: string) => ({
+  type: SET_LOGGING_MODE,
+  payload: { loggingMode },
+});
+
+export const SET_LOGGING_DATABASE = 'APPLICATION/SET_LOGGING_DATABASE';
+export const setLoggingDatabase = (loggingDatabase: string) => ({
+  type: SET_LOGGING_DATABASE,
+  payload: { loggingDatabase },
+});
+
 export const SET_SSO_ENABLED = 'APPLICATION/SET_SSO_ENABLED';
 export const setSSOEnabled = (enabled: boolean, discoveryUrl: string) => ({
   type: SET_SSO_ENABLED,

src/application/ApplicationReducer.ts

@@ -24,6 +24,8 @@ import {
   SET_STANDALONE_DASHBOARD_DATEBASE,
   SET_STANDALONE_ENABLED,
   SET_STANDALONE_MODE,
+  SET_LOGGING_MODE,
+  SET_LOGGING_DATABASE,
   SET_WAIT_FOR_SSO,
   SET_WELCOME_SCREEN_OPEN,
 } from './ApplicationActions';
@@ -50,6 +52,7 @@ const initialState = {
   dashboardToLoadAfterConnecting: null,
   waitForSSO: false,
   standalone: false,
+  loggingMode: '0',
 };
 export const applicationReducer = (state = initialState, action: { type: any; payload: any }) => {
   const { type, payload } = action;
@@ -107,6 +110,16 @@ export const applicationReducer = (state = initialState, action: { type: any; pa
       state = update(state, { standalone: standalone });
       return state;
     }
+    case SET_LOGGING_MODE: {
+      const { loggingMode } = payload;
+      state = update(state, { loggingMode: loggingMode });
+      return state;
+    }
+    case SET_LOGGING_DATABASE: {
+      const { loggingDatabase } = payload;
+      state = update(state, { loggingDatabase: loggingDatabase });
+      return state;
+    }
     case SET_SSO_ENABLED: {
       const { enabled, discoveryUrl } = payload;
       state = update(state, { ssoEnabled: enabled, ssoDiscoveryUrl: discoveryUrl });

src/application/ApplicationSelectors.ts

@@ -33,6 +33,10 @@ export const applicationGetConnectionDatabase = (state: any) => {
   return state.application.connection.database;
 };
 
+export const applicationGetConnectionUser = (state: any) => {
+  return state.application.connection.username;
+}
+
 export const applicationGetShareDetails = (state: any) => {
   return state.application.shareDetails;
 };
@@ -41,6 +45,10 @@ export const applicationIsStandalone = (state: any) => {
   return state.application.standalone;
 };
 
+export const applicationGetLoggingMode = (state: any) => {
+  return state.application.loggingMode;
+};
+
 export const applicationHasNeo4jDesktopConnection = (state: any) => {
   return state.application.desktopConnection != null;
 };
@@ -84,6 +92,13 @@ export const applicationGetStandaloneSettings = (state: any) => {
   };
 };
 
+export const applicationGetLoggingSettings = (state: any) => {
+  return {
+    loggingMode: state.application.loggingMode,
+    loggingDatabase: state.application.loggingDatabase,
+  };
+};
+
 export const applicationHasWelcomeScreenOpen = (state: any) => {
   return state.application.welcomeScreenOpen;
 };

src/application/ApplicationThunks.ts

@@ -34,11 +34,15 @@ import {
   setAboutModalOpen,
   setStandaloneMode,
   setStandaloneDashboardDatabase,
+  setLoggingMode,
+  setLoggingDatabase,
   setWaitForSSO,
   setParametersToLoadAfterConnecting,
   setReportHelpModalOpen,
 } from './ApplicationActions';
 import { version } from '../modal/AboutModal';
+import { applicationGetLoggingSettings, applicationIsStandalone } from './ApplicationSelectors';
+import { createUUID } from '../utils/uuid';
 
 /**
  * Application Thunks (https://redux.js.org/usage/writing-logic-thunks) handle complex state manipulations.
@@ -56,6 +60,9 @@ import { version } from '../modal/AboutModal';
  */
 export const createConnectionThunk =
   (protocol, url, port, database, username, password) => (dispatch: any, getState: any) => {
+    const loggingState = getState();
+    const loggingSettings = applicationGetLoggingSettings(loggingState)
+    const neodashMode = applicationIsStandalone(loggingState) ? 'Standalone' : 'Editor'
     try {
       const driver = createDriver(protocol, url, port, username, password, { userAgent: `neodash/v${version}` });
       // eslint-disable-next-line no-console
@@ -65,13 +72,41 @@ export const createConnectionThunk =
         console.log('Confirming connection was established...');
         if (records && records[0] && records[0].error) {
           dispatch(createNotificationThunk('Unable to establish connection', records[0].error));
-        } else if (records && records[0] && records[0].keys[0] == 'connected') {
+          if (loggingSettings.loggingMode>'0'){
+            dispatch(
+              createLogThunk(
+                  driver, 
+                  loggingSettings.loggingDatabase,
+                  neodashMode,
+                  username,
+                  'ERR - connect to DB', 
+                  database, 
+                  '',
+                  'Error while trying to establish connection to Neo4j DB in ' +neodashMode+' mode at '+Date.now()  
+                )
+            );  
+          }              
+      } else if (records && records[0] && records[0].keys[0] == 'connected') {
           dispatch(setConnectionProperties(protocol, url, port, database, username, password));
           dispatch(setConnectionModalOpen(false));
           dispatch(setConnected(true));
           dispatch(updateSessionParameterThunk('session_uri', `${protocol}://${url}:${port}`));
           dispatch(updateSessionParameterThunk('session_database', database));
           dispatch(updateSessionParameterThunk('session_username', username));
+          if (loggingSettings.loggingMode>'0'){
+            dispatch(
+              createLogThunk(
+                  driver, 
+                  loggingSettings.loggingDatabase,
+                  neodashMode,
+                  username,
+                  'INF - connect to DB', 
+                  database, 
+                  '',
+                  username +'established connection to Neo4j DB in ' +neodashMode+' mode at '+Date.now()  
+                )
+            );                
+        }
           // If we have remembered to load a specific dashboard after connecting to the database, take care of it here.
           const { application } = getState();
           if (
@@ -349,6 +384,8 @@ export const loadApplicationConfigThunk = () => async (dispatch: any, getState:
     standaloneDashboardName: 'My Dashboard',
     standaloneDashboardDatabase: 'dashboards',
     standaloneDashboardURL: '',
+    loggingMode: '0',
+    loggingDatabase: 'logs',
   };
   try {
     config = await (await fetch('config.json')).json();
@@ -393,6 +430,10 @@ export const loadApplicationConfigThunk = () => async (dispatch: any, getState:
         config.standalonePassword
       )
     );
+
+    dispatch(setLoggingMode(config.loggingMode));
+    dispatch(setLoggingDatabase(config.loggingDatabase));
+
     dispatch(setConnectionModalOpen(false));
 
     // Auto-upgrade the dashboard version if an old version is cached.
@@ -595,3 +636,48 @@ export const initializeApplicationAsStandaloneThunk =
       dispatch(setConnectionModalOpen(true));
     }
   };
+
+    // Thunk to handle log events.
+export const createLogThunk =
+(loggingDriver, loggingDatabase, neodashMode, logUser, logAction, logDatabase, logDashboard = '', logMessage) =>
+(dispatch: any) => {
+  try {
+    alert('entered log ceation with following parameters:\n'+loggingDriver+'\n'+neodashMode+'\n'+logUser+'\n'+logAction+'\n'+logDatabase+'\n'+logDashboard+'\n'+logMessage)
+    const uuid = createUUID();
+
+    // Generate a cypher query to save the log.
+    const query = 'CREATE (n:_Neodash_Log) SET n.uuid = $uuid, n.user = $user, n.date = datetime(), n.neodash_mode = $neodashMode, n.action = $logAction, n.database = $logDatabase, n.dashboard = $logDashboard, n.message = $logMessage RETURN $uuid as uuid'
+      
+    const parameters = {
+      uuid: uuid,
+      user: logUser,
+      logAction: logAction,
+      logDatabase: logDatabase,
+      neodashMode: neodashMode,
+      logDashboard: logDashboard,
+      logMessage: logMessage
+    };
+    runCypherQuery(
+      loggingDriver,
+      loggingDatabase,
+      query,
+      parameters,
+      1,
+      () => {},
+      (records) => {
+        if (records && records[0] && records[0]._fields && records[0]._fields[0] && records[0]._fields[0] == uuid) {
+          dispatch(createNotificationThunk('🎉 Success!', 'log created: '+uuid));
+        } else {
+          dispatch(
+            createNotificationThunk(
+              'Error creating log',
+              `Please check logging configuration with your Neodash administrator`
+            )
+          );
+        }
+      }
+    );
+  } catch (e) {
+    dispatch(createNotificationThunk('Error creating log', e));
+  }
+};