Add URL param support for populating editor with Cypher and parameters

src/shared/modules/editor/editorDuck.js

@@ -28,6 +28,15 @@ export const SET_CONTENT = NAME + '/SET_CONTENT'
 export const EDIT_CONTENT = NAME + '/EDIT_CONTENT'
 export const FOCUS = `${NAME}/FOCUS`
 export const EXPAND = `${NAME}/EXPAND`
+export const NOT_SUPPORTED_URL_PARAM_COMMAND = `${NAME}/NOT_SUPPORTED_URL_PARAM_COMMAND`
+
+// Supported commands
+const validCommandTypes = {
+  play: (cmdchar, args) => `${cmdchar}play ${args.join(' ')}`,
+  edit: (_, args) => args.join('\n'),
+  param: (cmdchar, args) => `${cmdchar}param ${args.join(' ')}`,
+  params: (cmdchar, args) => `${cmdchar}params ${args.join(' ')}`
+}
 
 export const setContent = newContent => ({
   type: SET_CONTENT,
@@ -45,13 +54,30 @@ export const populateEditorFromUrlEpic = (some$, store) => {
     .merge(some$.ofType(URL_ARGUMENTS_CHANGE))
     .delay(1) // Timing issue. Needs to be detached like this
     .mergeMap(action => {
-      if (!action.url) return Rx.Observable.never()
+      if (!action.url) {
+        return Rx.Observable.never()
+      }
       const cmdParam = getUrlParamValue('cmd', action.url)
-      if (!cmdParam || cmdParam[0] !== 'play') return Rx.Observable.never()
-      const cmdCommand = getSettings(store.getState()).cmdchar + cmdParam[0]
+
+      // No URL command param found
+      if (!cmdParam || !cmdParam[0]) {
+        return Rx.Observable.never()
+      }
+
+      // Not supported URL param command
+      if (!Object.keys(validCommandTypes).includes(cmdParam[0])) {
+        return Rx.Observable.of({
+          type: NOT_SUPPORTED_URL_PARAM_COMMAND,
+          command: cmdParam[0]
+        })
+      }
+
+      const commandType = cmdParam[0]
+      const cmdchar = getSettings(store.getState()).cmdchar
       const cmdArgs =
         getUrlParamValue('arg', decodeURIComponent(action.url)) || []
-      const fullCommand = `${cmdCommand} ${cmdArgs.join(' ')}`
+      const fullCommand = validCommandTypes[commandType](cmdchar, cmdArgs)
+
       return Rx.Observable.of({ type: SET_CONTENT, ...setContent(fullCommand) })
     })
 }

src/shared/modules/editor/editorDuck.test.js

@@ -21,7 +21,11 @@
 import configureMockStore from 'redux-mock-store'
 import { createEpicMiddleware } from 'redux-observable'
 import { createBus, createReduxMiddleware } from 'suber'
-import { populateEditorFromUrlEpic, SET_CONTENT } from './editorDuck'
+import {
+  populateEditorFromUrlEpic,
+  SET_CONTENT,
+  NOT_SUPPORTED_URL_PARAM_COMMAND
+} from './editorDuck'
 import { APP_START, URL_ARGUMENTS_CHANGE } from '../app/appDuck'
 
 describe('editorDuck Epics', () => {
@@ -80,6 +84,91 @@ describe('editorDuck Epics', () => {
       done()
     })
 
+    // When
+    store.dispatch(action)
+  })
+  test('Handles the param command', done => {
+    const cmd = 'param'
+    const arg = 'x => 1'
+    const action = {
+      type: APP_START,
+      url: `?cmd=${cmd}&arg=${encodeURIComponent(arg)}`
+    }
+
+    bus.take(SET_CONTENT, currentAction => {
+      // Then
+      expect(store.getActions()).toEqual([
+        action,
+        { type: SET_CONTENT, message: `:${cmd} ${arg}` }
+      ])
+      done()
+    })
+
+    // When
+    store.dispatch(action)
+  })
+  test('Handles the params command', done => {
+    const cmd = 'params'
+    const arg = '{x: 1, y: "hello"}'
+    const action = {
+      type: APP_START,
+      url: `?cmd=${cmd}&arg=${encodeURIComponent(arg)}`
+    }
+
+    bus.take(SET_CONTENT, currentAction => {
+      // Then
+      expect(store.getActions()).toEqual([
+        action,
+        { type: SET_CONTENT, message: `:${cmd} ${arg}` }
+      ])
+      done()
+    })
+
+    // When
+    store.dispatch(action)
+  })
+  test('Accepts one or more Cypher queries from URL params and populates the editor', done => {
+    const cmd = 'edit'
+    const args = ['RETURN 1;', 'RETURN rand();']
+    const action = {
+      type: APP_START,
+      url:
+        `http://url.com?cmd=${cmd}` +
+        args.map(arg => `&arg=${encodeURIComponent(arg)}`).join('')
+    }
+
+    bus.take(SET_CONTENT, () => {
+      // Then
+      expect(store.getActions()).toEqual([
+        action,
+        {
+          type: SET_CONTENT,
+          message: args.join('\n')
+        }
+      ])
+      done()
+    })
+
+    // When
+    store.dispatch(action)
+  })
+  test('Does not accept arbitrary URL params and populate the editor', done => {
+    const cmd = 'not-supported'
+    const arg = 'evil'
+    const action = {
+      type: APP_START,
+      url: `http://url.com?cmd=${cmd}&arg=${arg}`
+    }
+
+    bus.take(NOT_SUPPORTED_URL_PARAM_COMMAND, () => {
+      // Then
+      expect(store.getActions()).toEqual([
+        action,
+        { type: NOT_SUPPORTED_URL_PARAM_COMMAND, command: cmd }
+      ])
+      done()
+    })
+
     // When
     store.dispatch(action)
   })