Treat composite dbs as system database (#1856)

* treat composite dbs as system database

* fix unit tests

Author: OskarDamkjaer

src/shared/modules/commands/helpers/params.test.ts

@@ -34,7 +34,7 @@ describe('commandsDuck params helper', () => {
 
     // When
     return params
-      .handleParamsCommand(action, put)
+      .handleParamsCommand(action, put, false)
       .then(() => {
         throw Error('THIS SHOULD NEVER HAPPEN')
       })
@@ -49,7 +49,7 @@ describe('commandsDuck params helper', () => {
     const put = jest.fn()
 
     // When
-    const p = params.handleParamsCommand(action, put)
+    const p = params.handleParamsCommand(action, put, false)
 
     // Then
     return p.then(res => {
@@ -63,7 +63,7 @@ describe('commandsDuck params helper', () => {
     const put = jest.fn()
 
     // When
-    const p = params.handleParamsCommand(action, put)
+    const p = params.handleParamsCommand(action, put, false)
 
     // Then
     return p.then(res => {
@@ -77,7 +77,7 @@ describe('commandsDuck params helper', () => {
     const put = jest.fn()
 
     // When
-    const p = params.handleParamsCommand(action, put)
+    const p = params.handleParamsCommand(action, put, false)
 
     // Then
     return p.then(res => {
@@ -91,7 +91,7 @@ describe('commandsDuck params helper', () => {
     const put = jest.fn()
 
     // When
-    const p = params.handleParamsCommand(action, put)
+    const p = params.handleParamsCommand(action, put, false)
 
     // Then
     return p.then(res => {
@@ -105,7 +105,7 @@ describe('commandsDuck params helper', () => {
     const put = jest.fn()
 
     // When
-    const p = params.handleParamsCommand(action, put)
+    const p = params.handleParamsCommand(action, put, false)
 
     // Then
     return p.then(res => {

src/shared/modules/commands/helpers/params.ts

@@ -22,7 +22,6 @@ import jsonic from 'jsonic'
 import { collectLambdaValues, parseLambdaStatement } from './lambdas'
 import { splitStringOnFirst } from 'services/commandUtils'
 import { replace, update } from 'shared/modules/params/paramsDuck'
-import { SYSTEM_DB } from 'shared/modules/dbMeta/dbMetaDuck'
 
 export const extractParams = (param: string) => {
   // early bail, now handled by parser
@@ -79,13 +78,15 @@ export const getParamName = (input: any) => {
 export const handleParamsCommand = async (
   action: any,
   put: any,
-  targetDb?: string | null
+  onUnsupportedDatabase: boolean
 ): Promise<{
   result: any
   type: string
 }> => {
-  if (targetDb === SYSTEM_DB) {
-    throw new Error('Parameters cannot be declared when using system database.')
+  if (onUnsupportedDatabase) {
+    throw new Error(
+      'Parameters cannot be declared when using system or composite database.'
+    )
   }
   const strippedCmd = action.cmd.substr(1)
   const parts = splitStringOnFirst(strippedCmd, /\s/)

src/shared/modules/dbMeta/dbMetaDuck.ts

@@ -175,6 +175,7 @@ export type Database = {
   default: boolean
   home?: boolean // introduced in neo4j 4.3
   aliases?: string[] // introduced in neo4j 4.4
+  type?: 'system' | 'composite' | 'standard' // introduced in neo4j 5
   status: string
 }
 

src/shared/modules/dbMeta/dbMetaEpics.ts

@@ -86,6 +86,10 @@ import {
 import { isInt, Record } from 'neo4j-driver'
 import semver, { gte, SemVer } from 'semver'
 import { triggerCredentialsTimeout } from '../credentialsPolicy/credentialsPolicyDuck'
+import {
+  isSystemOrCompositeDb,
+  getCurrentDatabase
+} from 'shared/utils/selectors'
 getCountAutomaticRefreshEnabled
 async function databaseList(store: any) {
   try {
@@ -120,10 +124,10 @@ async function databaseList(store: any) {
 }
 
 async function getLabelsAndTypes(store: any) {
-  const db = getUseDb(store.getState())
+  const db = getCurrentDatabase(store.getState())
 
-  // System db, do nothing
-  if (db === SYSTEM_DB) {
+  // System or composite db, do nothing
+  if (db && isSystemOrCompositeDb(db)) {
     return
   }
 
@@ -159,10 +163,10 @@ async function getLabelsAndTypes(store: any) {
 }
 
 async function getNodeAndRelationshipCounts(store: any) {
-  const db = getUseDb(store.getState())
+  const db = getCurrentDatabase(store.getState())
 
-  // System db, do nothing
-  if (db === SYSTEM_DB) {
+  // System or composite db, do nothing
+  if (db && isSystemOrCompositeDb(db)) {
     return
   }
 

src/shared/services/commandInterpreterHelper.ts

@@ -75,8 +75,7 @@ import {
   findDatabaseByNameOrAlias,
   getAvailableSettings,
   getDatabases,
-  getRemoteContentHostnameAllowlist,
-  SYSTEM_DB
+  getRemoteContentHostnameAllowlist
 } from 'shared/modules/dbMeta/dbMetaDuck'
 import { getUserCapabilities } from 'shared/modules/features/featuresDuck'
 import * as frames from 'shared/modules/frames/framesDuck'
@@ -102,6 +101,10 @@ import {
 } from 'shared/services/bolt/txMetadata'
 import { objToCss, parseGrass } from 'shared/services/grassUtils'
 import { URL } from 'whatwg-url'
+import {
+  getCurrentDatabase,
+  isSystemOrCompositeDb
+} from 'shared/utils/selectors'
 
 const PLAY_FRAME_TYPES = ['play', 'play-remote']
 
@@ -150,7 +153,9 @@ const availableCommands = [
     name: 'set-params',
     match: (cmd: any) => /^params?\s/.test(cmd),
     exec(action: any, put: any, store: any) {
-      return handleParamsCommand(action, put, getUseDb(store.getState()))
+      const currDb = getCurrentDatabase(store.getState())
+      const onUnsupportedDb = Boolean(currDb && isSystemOrCompositeDb(currDb))
+      return handleParamsCommand(action, put, onUnsupportedDb)
         .then(res => {
           const params =
             res.type === 'param' ? res.result : getParams(store.getState())
@@ -350,15 +355,15 @@ const availableCommands = [
     name: 'sysinfo',
     match: (cmd: any) => /^sysinfo$/.test(cmd),
     exec(action: any, put: any, store: any) {
-      const useDb = getUseDb(store.getState())
-      if (useDb === SYSTEM_DB) {
+      const db = getCurrentDatabase(store.getState())
+      if (db && isSystemOrCompositeDb(db)) {
         put(
           frames.add({
             useDb,
             ...action,
             type: 'error',
             error: UnsupportedError(
-              'The :sysinfo command is not supported while using the system database.'
+              'The :sysinfo command is not supported while using the system or a composite database.'
             )
           })
         )

src/shared/utils/selectors.ts

@@ -1,16 +1,19 @@
-import semver from 'semver'
-
 import { GlobalState } from 'shared/globalState'
 import { inDesktop } from 'shared/modules/app/appDuck'
 import {
+  getUseDb,
   isConnected,
-  isConnectedAuraHost
+  isConnectedAuraHost,
+  useDb
 } from 'shared/modules/connections/connectionsDuck'
 import {
+  Database,
+  findDatabaseByNameOrAlias,
   getAllowOutgoingConnections,
   getClientsAllowTelemetry,
   isServerConfigDone,
-  shouldAllowOutgoingConnections
+  shouldAllowOutgoingConnections,
+  SYSTEM_DB
 } from 'shared/modules/dbMeta/dbMetaDuck'
 import {
   getAllowCrashReports,
@@ -22,6 +25,19 @@ import {
   getAllowUserStatsInDesktop
 } from 'shared/modules/udc/udcDuck'
 
+export function getCurrentDatabase(state: GlobalState): Database | null {
+  const dbName = getUseDb(state)
+  if (dbName) {
+    return findDatabaseByNameOrAlias(state, dbName) ?? null
+  }
+
+  return null
+}
+
+export function isSystemOrCompositeDb(db: Database): boolean {
+  return db?.name === SYSTEM_DB || db?.type === 'composite'
+}
+
 export type TelemetrySettingSource =
   | 'AURA'
   | 'BROWSER_SETTING'