Dumping session state and logs to a file

Author: toddtarsi

packages/selenium-ide/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seleniumhq/selenium-ide",
-  "version": "4.0.0-alpha.53",
+  "version": "4.0.0-alpha.54",
   "private": true,
   "description": "Selenium IDE electron app",
   "author": "Todd <[email protected]>",

packages/selenium-ide/src/main/session/controllers/Menu/menus/application.ts

@@ -5,6 +5,7 @@ import { projectEditorCommands } from './projectEditor'
 import { testEditorCommands } from './testEditor'
 import { projectViewCommands } from './projectView'
 import { platform } from 'os'
+import helpMenu from './help'
 
 const applicationMenu = (session: Session) => async () =>
   Menu.buildFromTemplate([
@@ -43,6 +44,10 @@ const applicationMenu = (session: Session) => async () =>
       label: '&View',
       submenu: await projectViewCommands(session)(),
     },
+    {
+      label: '&Help',
+      submenu: await helpMenu(session)(),
+    },
   ])
 
 export default applicationMenu

packages/selenium-ide/src/main/session/controllers/Menu/menus/help.ts

@@ -0,0 +1,20 @@
+import { Menu } from 'electron'
+import { MenuComponent, Session } from 'main/types'
+
+export const HelpCommands: MenuComponent = (session) => async () =>
+  [
+    {
+      accelerator: 'CommandOrControl+Shift+D',
+      click: async () => {
+        await session.system.dumpSession()
+      },
+      label: 'Dump Session To File',
+    },
+  ]
+
+const helpMenu = (session: Session) => async () => {
+  const menuItems = await HelpCommands(session)()
+  return Menu.buildFromTemplate(menuItems)
+}
+
+export default helpMenu

packages/selenium-ide/src/main/session/controllers/System/index.ts

@@ -1,15 +1,49 @@
 import { dialog } from 'electron'
 import BaseController from '../Base'
 import { isAutomated } from 'main/util'
+import { inspect } from 'util'
+import { writeFile } from 'fs/promises'
 
 let firstTime = true
 export default class SystemController extends BaseController {
+  constructor(session: any) {
+    super(session)
+    this.writeToLog = this.writeToLog.bind(this)
+  }
   isDown = true
   shuttingDown = false
+  logs = ''
+
+  async dumpSession() {
+    const response = await this.session.dialogs.openSave()
+    if (response.canceled) return
+    const filePath = response.filePath as string
+    await writeFile(
+      filePath,
+      JSON.stringify(
+        {
+          project: this.session.projects.project,
+          state: this.session.state.state,
+          logs: this.logs,
+        },
+        undefined,
+        2
+      )
+    )
+  }
 
   async getLogPath() {
     return this.session.app.getPath('logs')
   }
+
+  async getLogs() {
+    return this.logs
+  }
+
+  async writeToLog(...args: any[]) {
+    this.logs += args.map((arg) => inspect(arg)).join(' ') + '\n'
+  }
+
   async startup() {
     if (this.isDown) {
       await this.session.windows.open('logger')
@@ -23,6 +57,7 @@ export default class SystemController extends BaseController {
         }
       }
       await this.session.projects.select(firstTime)
+      await this.session.api.system.onLog.addListener(this.writeToLog)
       this.isDown = false
       firstTime = false
     }
@@ -39,6 +74,9 @@ export default class SystemController extends BaseController {
         }
         this.shuttingDown = false
       }
+      try {
+        await this.session.api.system.onLog.removeListener(this.writeToLog)
+      } catch (e) {}
     }
   }