place errors behind feature flag

Author: daveajrussell

src/browser/modules/Stream/CypherFrame/CypherFrame.test.tsx

@@ -28,6 +28,8 @@ import {
   BrowserRequestResult
 } from 'shared/modules/requests/requestsDuck'
 
+import { initialState as initialExperimentalFeatureState } from 'shared/modules/experimentalFeatures/experimentalFeaturesDuck'
+
 const createProps = (
   status: string,
   result: BrowserRequestResult
@@ -63,7 +65,8 @@ describe('CypherFrame', () => {
         maxFieldItems: 1000
       },
       app: {},
-      connections: {}
+      connections: {},
+      experimentalFeatures: initialExperimentalFeatureState
     })
   }
   test('renders accordingly from pending to success to error to success', () => {

src/browser/modules/Stream/CypherFrame/ErrorsView/ErrorsView.test.tsx

@@ -25,40 +25,44 @@ import { ErrorsView, ErrorsViewProps } from './ErrorsView'
 import { BrowserError } from 'services/exceptions'
 import { Provider } from 'react-redux'
 import { initialState as initialConnectionsState } from 'shared/modules/connections/connectionsDuck'
+import { initialState as initialExperimentalFeatureState } from 'shared/modules/experimentalFeatures/experimentalFeaturesDuck'
 
 const withProvider = (store: any, children: any) => {
   return <Provider store={store}>{children}</Provider>
 }
 
-const mount = (partOfProps: Partial<ErrorsViewProps>, state?: any) => {
+const mount = (props: Partial<ErrorsViewProps>, state?: any) => {
   const defaultProps: ErrorsViewProps = {
     result: null,
     bus: createBus(),
     params: {},
     executeCmd: jest.fn(),
     setEditorContent: jest.fn(),
     neo4jVersion: null,
-    protocolVersion: null
+    gqlErrorsEnabled: true
   }
 
-  const props = {
+  const combinedProps = {
     ...defaultProps,
-    ...partOfProps
+    ...props
   }
 
-  state = state ?? {
-    connections: initialConnectionsState
+  const initialState = {
+    connections: initialConnectionsState,
+    experimentalFeatures: initialExperimentalFeatureState
   }
 
+  const combinedState = { ...initialState, ...state }
+
   const store = {
     subscribe: () => {},
     dispatch: () => {},
     getState: () => ({
-      ...state
+      ...combinedState
     })
   }
 
-  return render(withProvider(store, <ErrorsView {...props} />))
+  return render(withProvider(store, <ErrorsView {...combinedProps} />))
 }
 
 describe('ErrorsView', () => {
@@ -117,6 +121,11 @@ describe('ErrorsView', () => {
             protocolVersion: 5.7
           }
         }
+      },
+      experimentalFeatures: {
+        enableGqlErrors: {
+          on: true
+        }
       }
     }
 
@@ -160,6 +169,11 @@ describe('ErrorsView', () => {
             protocolVersion: 5.7
           }
         }
+      },
+      experimentalFeatures: {
+        enableGqlErrors: {
+          on: true
+        }
       }
     }
 

src/browser/modules/Stream/CypherFrame/ErrorsView/ErrorsView.tsx

@@ -59,17 +59,25 @@ import { deepEquals } from 'neo4j-arc/common'
 import { getSemanticVersion } from 'shared/modules/dbMeta/dbMetaDuck'
 import { SemVer } from 'semver'
 import { getProtocolVersion } from 'shared/modules/connections/connectionsDuck'
-import { formatError } from '../errorUtils'
+import {
+  formatError,
+  formatErrorGqlStatusObject,
+  hasPopulatedGqlFields
+} from '../errorUtils'
+import {
+  enableGqlErrors,
+  showFeature
+} from 'shared/modules/experimentalFeatures/experimentalFeaturesDuck'
 
 export type ErrorsViewProps = {
   result: BrowserRequestResult
   bus: Bus
   neo4jVersion: SemVer | null
-  protocolVersion: number | null
   params: Record<string, unknown>
   executeCmd: (cmd: string) => void
   setEditorContent: (cmd: string) => void
   depth?: number
+  gqlErrorsEnabled: boolean
 }
 
 class ErrorsViewComponent extends Component<ErrorsViewProps> {
@@ -87,16 +95,19 @@ class ErrorsViewComponent extends Component<ErrorsViewProps> {
       executeCmd,
       setEditorContent,
       neo4jVersion,
-      protocolVersion,
-      depth = 0
+      depth = 0,
+      gqlErrorsEnabled
     } = this.props
 
     const error = this.props.result as BrowserError
     if (!error) {
       return null
     }
 
-    const formattedError = formatError(protocolVersion, error)
+    const formattedError =
+      gqlErrorsEnabled && hasPopulatedGqlFields(error)
+        ? formatErrorGqlStatusObject(error)
+        : formatError(error)
 
     if (!formattedError?.title) {
       return null
@@ -168,13 +179,20 @@ class ErrorsViewComponent extends Component<ErrorsViewProps> {
   }
 }
 
-const mapStateToProps = (state: GlobalState) => {
-  return {
-    params: getParams(state),
-    neo4jVersion: getSemanticVersion(state),
-    protocolVersion: getProtocolVersion(state)
-  }
+const gqlErrorsEnabled = (state: GlobalState): boolean => {
+  const featureEnabled = showFeature(state, enableGqlErrors)
+  const protocolVersion = getProtocolVersion(state)
+  const protocolVersionSupported =
+    protocolVersion !== null && protocolVersion >= 5.7
+  return featureEnabled && protocolVersionSupported
 }
+
+const mapStateToProps = (state: GlobalState) => ({
+  params: getParams(state),
+  neo4jVersion: getSemanticVersion(state),
+  gqlErrorsEnabled: gqlErrorsEnabled(state)
+})
+
 const mapDispatchToProps = (
   _dispatch: Dispatch<Action>,
   ownProps: ErrorsViewProps