enable navigation bar to be toggled via URL / electron menu via rendererApi.

BUG: ZAPP-450

src-electron/ui/browser-api.js

@@ -89,6 +89,18 @@ async function progressStart(browserWindow, message) {
   )
 }
 
+async function debugNavBarOn(browserWindow) {
+  await browserWindow.webContents.executeJavaScript(
+    `window.global_renderer_api_execute('${restApi.rendererApiId.debugNavBarOn}')`
+  )
+}
+
+async function debugNavBarOff(browserWindow) {
+  await browserWindow.webContents.executeJavaScript(
+    `window.global_renderer_api_execute('${restApi.rendererApiId.debugNavBarOff}')`
+  )
+}
+
 async function getFileLocation(browserWindow, key) {
   return null
 }
@@ -185,6 +197,8 @@ exports.executeLoad = executeLoad
 exports.executeSave = executeSave
 exports.progressEnd = progressEnd
 exports.progressStart = progressStart
+exports.debugNavBarOn = debugNavBarOn
+exports.debugNavBarOff = debugNavBarOff
 exports.reportFiles = reportFiles
 exports.processRendererNotify = processRendererNotify
 exports.getFileLocation = getFileLocation

src-electron/ui/menu.js

@@ -144,6 +144,18 @@ const template = (httpPort) => [
           browserApi.progressEnd(browserWindow)
         },
       },
+      {
+        label: 'Show debug navigation bar',
+        click(menuItem, browserWindow) {
+          browserApi.debugNavBarOn(browserWindow)
+        },
+      },
+      {
+        label: 'Hide debug navigation bar',
+        click(menuItem, browserWindow) {
+          browserApi.debugNavBarOff(browserWindow)
+        },
+      },
       {
         label: 'About',
         httpPort: httpPort,

src-electron/ui/ui-util.js

@@ -53,7 +53,7 @@ function openFileConfiguration(filePath, httpPort) {
  * Creates a new window with a blank configuration.
  *
  * @param {*} httpPort
- * @param {*} options: uiMode, embeddedMode
+ * @param {*} options: uiMode, debugNavBar
  */
 async function openNewConfiguration(httpPort, options = {}) {
   windowJs.windowCreate(httpPort, options)

src-electron/ui/window.js

@@ -46,7 +46,7 @@ function windowCreateIfNotThere(port) {
   }
 }
 
-function createQueryString(uiMode = null, embeddedMode = null) {
+function createQueryString(uiMode = null) {
   let queryString = ''
   if (uiMode) {
     if (queryString.length == 0) {
@@ -55,13 +55,6 @@ function createQueryString(uiMode = null, embeddedMode = null) {
       queryString += `&uiMode=${uiMode}`
     }
   }
-  if (embeddedMode) {
-    if (queryString.length == 0) {
-      queryString = `?embeddedMode=${embeddedMode}`
-    } else {
-      queryString += `&embeddedMode=${embeddedMode}`
-    }
-  }
   return queryString
 }
 
@@ -72,7 +65,6 @@ function createQueryString(uiMode = null, embeddedMode = null) {
  * @param {*} port
  * @param {*} [filePath=null]
  * @param {*} [uiMode=null]
- * @param {*} [embeddedMode=null]
  * @returns BrowserWindow that got created
  */
 function windowCreate(port, args = {}) {
@@ -94,13 +86,19 @@ function windowCreate(port, args = {}) {
     webPreferences: webPreferences,
   })
 
-  let queryString = createQueryString(args.uiMode, args.embeddedMode)
+  let queryString = createQueryString(args.uiMode)
 
   w.isDirty = false
   w.loadURL(`http://localhost:${port}/` + queryString).then(async () => {
     if (args.filePath != null) {
       browserApi.executeLoad(w, args.filePath)
     }
+
+    if (args.debugNavBar) {
+      browserApi.debugNavBarOn(w)
+    } else {
+      browserApi.debugNavBarOff(w)
+    }
   })
 
   w.on('page-title-updated', (e) => {

src-electron/util/args.js

@@ -92,12 +92,12 @@ function processCommandLineArguments(argv) {
       type: 'string',
       default: restApi.uiMode.ZIGBEE,
     })
-    .option('embeddedMode', {
+    .option('debugNavBar', {
       desc:
         'Boolean for when you want to embed purely the ZCL parts of the ZAP tool',
       alias: 'embed',
       type: 'boolean',
-      default: false,
+      default: exports.debugNavBar,
     })
     .option('noUi', {
       desc: "Don't show the main window when starting.",

src-shared/rest-api.js

@@ -100,6 +100,8 @@ exports.rendererApiId = {
   progressStart: 'progressStart',
   progressEnd: 'progressEnd',
   reportFiles: 'reportFiles',
+  debugNavBarOn: 'debugNavBarOn',
+  debugNavBarOff: 'debugNavBarOff',
 }
 
 exports.rendererApiNotifyKey = {
@@ -109,6 +111,7 @@ exports.rendererApiNotifyKey = {
 
 exports.progress_attribute = 'progress-message'
 exports.reported_files = 'reported-files'
+exports.debugNavBar = 'debugNavBar'
 
 exports.uri = uri
 exports.httpCode = httpCode

src/App.vue

@@ -98,8 +98,8 @@ export default {
       this.$store.dispatch('zap/setDefaultUiMode', query[`uiMode`])
     }
 
-    if (`embeddedMode` in query) {
-      this.$store.dispatch('zap/setEmbeddedMode', query[`embeddedMode`])
+    if (`debugNavBar` in query) {
+      this.$store.dispatch('zap/setDebugNavBar', query[`debugNavBar`])
     }
 
     this.zclDialogTitle = 'ZCL tab!'

src/api/renderer_api.js

@@ -59,6 +59,14 @@ function renderer_api_info() {
         id: restApi.rendererApiId.progressEnd,
         description: 'End progress indicator.',
       },
+      {
+        id: restApi.rendererApiId.debugNavBarOn,
+        description: 'Show debug navigation bar',
+      },
+      {
+        id: restApi.rendererApiId.debugNavBarOff,
+        description: 'Hide debug navigation bar',
+      },
     ],
   }
 }
@@ -103,6 +111,12 @@ function renderer_api_execute(id, ...args) {
         JSON.parse(args[0])
       )
       break
+    case restApi.rendererApiId.debugNavBarOn:
+      observable.setObservableAttribute(restApi.debugNavBar, true)
+      break
+    case restApi.rendererApiId.debugNavBarOff:
+      observable.setObservableAttribute(restApi.debugNavBar, false)
+      break
   }
   return ret
 }

src/layouts/ZclLayout.vue

@@ -29,7 +29,7 @@ limitations under the License.
     <div class="q-gutter-y-md height: 10vh">
       <q-toolbar
         class="shadow-2"
-        v-if="!this.$store.state.zap.calledArgs['embeddedMode']"
+        v-if="this.$store.state.zap.debugNavBar"
       >
         <q-tabs flat v-model="tab">
           <q-tab name="general" label="General" />
@@ -244,6 +244,10 @@ export default {
         this.doGeneration(this.generationDirectory)
       }
     })
+
+    observable.observeAttribute(restApi.debugNavBar, (value) => {
+      this.$store.dispatch('zap/setDebugNavBar', value)
+    })
   },
 }
 </script>

src/store/zap/actions.js

@@ -589,8 +589,8 @@ export function setDefaultUiMode(context, uiMode) {
   context.commit(`setDefaultUiMode`, uiMode)
 }
 
-export function setEmbeddedMode(context, embeddedMode) {
-  context.commit('setEmbeddedMode', embeddedMode)
+export function setDebugNavBar(context, debugNavBar) {
+  context.commit('setDebugNavBar', debugNavBar)
 }
 
 export function setAttributeEditting(context, editContext) {

src/store/zap/mutations.js

@@ -375,8 +375,8 @@ export function setDefaultUiMode(state, uiMode) {
   Vue.set(state.calledArgs, `defaultUiMode`, uiMode)
 }
 
-export function setEmbeddedMode(state, embeddedMode) {
-  Vue.set(state.calledArgs, 'embeddedMode', embeddedMode)
+export function setDebugNavBar(state, debugNavBar) {
+  state.debugNavBar = debugNavBar
 }
 
 export function setAttributeEditting(state, context) {

src/store/zap/state.js

@@ -114,8 +114,8 @@ export default function () {
     },
     calledArgs: {
       defaultUiMode: restApi.uiMode.ZIGBEE,
-      embeddedMode: false,
     },
+    debugNavBar: false, // default visibility mode for debug navigation bar
     studio: {
       projectInfoJson: [], // HTTP response from Studio jetty server
       ucComponents: [],

test/electron.test.js

@@ -27,7 +27,7 @@ test('Make sure electron main process loads', () => {
 
 test('Test constructing queries for the window', () => {
   let query = window.createQueryString('um', 'em')
-  expect(query).toBe(`?uiMode=um&embeddedMode=em`)
+  expect(query).toBe(`?uiMode=um`)
   query = window.createQueryString()
   expect(query).toBe(``)
 })