insights-desktop

packages/insights-desktop/bin/insights-desktop

@@ -0,0 +1,16 @@
+#!/usr/bin/env electron
+
+const path = require('path')
+const program = require('commander')
+const root = path.join(__dirname, '..')
+const pkg = require(path.join(root, 'package.json'))
+
+const startInsightsDesktop = require('../src/insights-desktop')
+
+program.version(pkg.version)
+  .usage('<command> [options]')
+  .description('Start Insights in desktop mode via Electron')
+
+program.parse(process.argv)
+
+startInsightsDesktop()

packages/insights-desktop/main.js

@@ -0,0 +1,2 @@
+const startInsightsDesktop = require('./src/insights-desktop')
+startInsightsDesktop()

packages/insights-desktop/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "insights-desktop",
+  "description": "insights electron app",
+  "version": "0.0.32",
+  "author": "Marius Andra <[email protected]>",
+  "main": "main.js",
+  "dependencies": {
+    "get-port": "^5.1.1"
+  },
+  "scripts": {
+    "start": "electron ."
+  },
+  "devDependencies": {
+  },
+  "bin": {
+    "electron": "^8.0.3",
+    "insights-desktop": "./bin/insights-desktop"
+  },
+  "files": [
+    "bin",
+    "src",
+    "main.js"
+  ]
+}

packages/insights-desktop/src/insights-desktop.js

@@ -0,0 +1,90 @@
+const electron = require('electron')
+// Module to control application life.
+const app = electron.app
+// Module to create native browser window.
+const BrowserWindow = electron.BrowserWindow
+
+const fs = require('fs')
+const path = require('path')
+const getPort = require('get-port')
+
+// Keep a global reference of the window object, if you don't, the window will
+// be closed automatically when the JavaScript object is garbage collected.
+let mainWindow
+
+const configFolder = path.join((app || electron.remote.app).getPath('userData'), 'Insights Config');
+
+function createWindow (url) {
+  // Create the browser window.
+  mainWindow = new BrowserWindow({width: 1200, height: 800})
+
+  // and load the index.html of the app.
+  mainWindow.loadURL(url)
+
+  // Open the DevTools.
+  // mainWindow.webContents.openDevTools()
+
+  // Emitted when the window is closed.
+  mainWindow.on('closed', function () {
+    // Dereference the window object, usually you would store windows
+    // in an array if your app supports multi windows, this is the time
+    // when you should delete the corresponding element.
+    mainWindow = null
+  })
+}
+
+function startElectron (url) {
+  // This method will be called when Electron has finished
+  // initialization and is ready to create browser windows.
+  // Some APIs can only be used after this event occurs.
+
+  // Quit when all windows are closed.
+  app.on('window-all-closed', function () {
+    // On OS X it is common for applications and their menu bar
+    // to stay active until the user quits explicitly with Cmd + Q
+    if (process.platform !== 'darwin') {
+      app.quit()
+    }
+  })
+
+  app.on('activate', function () {
+    // On OS X it's common to re-create a window in the app when the
+    // dock icon is clicked and there are no other windows open.
+    if (mainWindow === null) {
+      createWindow(url)
+    }
+  })
+
+  app.on('ready', () => createWindow(url))
+}
+
+function startInsightsAndElectron () {
+  const startInsights = require('insights/app/start')
+
+  startInsights({
+    host: process.env.INSIGHTS_HOST,
+    port: process.env.INSIGHTS_PORT,
+    onListening: (app, server) => {
+      startElectron(process.env.INSIGHTS_PUBLIC_URL)
+    }
+  })
+}
+
+async function startInsightsDesktop () {
+  console.log(`Config in ${configFolder}`)
+  process.env.NODE_ENV = 'production'
+  process.env.NODE_CONFIG_DIR = configFolder;
+
+  if (!fs.existsSync(configFolder)) {
+    const initInsights = require('insights/app/init')
+    await initInsights({ dev: false, login: false, configFolder, exitWhenDone: false })
+  }
+
+  process.env.INSIGHTS_HOST = '127.0.0.1'
+  process.env.INSIGHTS_PORT = await getPort()
+  process.env.INSIGHTS_PUBLIC_URL = `http://${process.env.INSIGHTS_HOST}:${process.env.INSIGHTS_PORT}`
+
+  startInsightsAndElectron()
+}
+
+module.exports = startInsightsDesktop

packages/insights/app/init.js

@@ -10,12 +10,15 @@ const createFolder = require('./lib/create-folder')
 const { promisify } = require('util');
 const exec = promisify(require('child_process').exec)
 
-async function initInsights ({ dev = false, login = undefined }) {
+async function initInsights ({
+  dev = false,
+  login = undefined,
+  configFolder = path.join(process.cwd(), '.insights'),
+  exitWhenDone = true
+}) {
   console.log(`Welcome to Insights v${pkg.version}!`)
   console.log('')
 
-  const configFolder = path.join(process.cwd(), '.insights')
-
   if (fs.existsSync(configFolder)) {
     console.error('!! Fatal Error! The folder ".insights" already exists. ')
     console.error('   Could not complete init.')
@@ -89,7 +92,9 @@ async function initInsights ({ dev = false, login = undefined }) {
   console.log('')
   console.log('Success! Run "insights start" to start the server!')
 
-  process.exit(0)
+  if (exitWhenDone) {
+    process.exit(0)
+  }
 }
 
 module.exports = initInsights

packages/insights/app/start.js

@@ -15,7 +15,8 @@ module.exports = function startInsights({
 
   apiPath = process.env.INSIGHTS_API_PATH || `/api`,
   // TODO: no way to configure socketPath yet, must stay at "/socket.io"
-  socketPath = process.env.INSIGHTS_SOCKET_PATH || '/socket.io'
+  socketPath = process.env.INSIGHTS_SOCKET_PATH || '/socket.io',
+  onListening = undefined
 } = {}) {
   console.log({
     host,
@@ -62,6 +63,7 @@ module.exports = function startInsights({
 
   server.on('listening', () => {
     console.info(`--> ${publicUrl}`)
+    onListening && onListening(app, server)
   })
 
   return app

packages/insights/bin/insights

@@ -14,5 +14,6 @@ program
   .command('start', 'start insights on port 8000')
   .command('createsecret', 'create a new authentication secret')
   .command('createsuperuser', 'create a new admin user')
+  .command('desktop', 'start desktop app (run `npm install -g insights-desktop` first)')
 
 program.parse(process.argv)