Allow for users to enabled release mode debugging (#481)

* Allow for users to enabled release mode debugging by setting the env var `DEBUG` to "true"

* Adds file logging so that in production logs can still be
  obtained. Those log files are limited the size and number and are rotated automatically

Signed-off-by: Sebastian Malton <smalton@mirantis.com>

Co-authored-by: Sebastian Malton <smalton@mirantis.com>

.gitignore

@@ -9,3 +9,4 @@ static/build/**
 binaries/client/
 binaries/server/
 locales/**/**.js
+lens.log

src/main/index.ts

@@ -21,7 +21,7 @@ import logger from "./logger"
 
 const workingDir = path.join(app.getPath("appData"), appName);
 app.setName(appName);
-if(!process.env.CICD) {
+if (!process.env.CICD) {
   app.setPath("userData", workingDir);
 }
 
@@ -49,7 +49,8 @@ async function main() {
   try {
     proxyPort = await getFreePort()
   } catch (error) {
-    await dialog.showErrorBox("Lens Error", "Could not find a free port for the cluster proxy")
+    logger.error(error)
+    dialog.showErrorBox("Lens Error", "Could not find a free port for the cluster proxy")
     app.quit();
   }
 
@@ -68,7 +69,7 @@ async function main() {
     proxyServer = LensProxy.create(proxyPort, clusterManager);
   } catch (error) {
     logger.error(`Could not start proxy (127.0.0:${proxyPort}): ${error.message}`)
-    await dialog.showErrorBox("Lens Error", `Could not start proxy (127.0.0:${proxyPort}): ${error.message || "unknown error"}`)
+    dialog.showErrorBox("Lens Error", `Could not start proxy (127.0.0:${proxyPort}): ${error.message || "unknown error"}`)
     app.quit();
   }
 

src/main/logger.ts

@@ -1,20 +1,30 @@
+import { app, remote } from "electron";
 import winston from "winston"
 import { isDebugging } from "../common/vars";
 
-const options = {
-  colorize: true,
+const consoleOptions: winston.transports.ConsoleTransportOptions = {
   handleExceptions: false,
-  json: false,
   level: isDebugging ? "debug" : "info",
 }
 
+const fileOptions: winston.transports.FileTransportOptions = {
+  handleExceptions: false,
+  level: isDebugging ? "debug" : "info",
+  filename: "lens.log",
+  dirname: (app || remote.app).getPath("logs"),
+  maxsize: 16 * 1024,
+  maxFiles: 16,
+  tailable: true,
+}
+
 const logger = winston.createLogger({
   format: winston.format.combine(
     winston.format.colorize(),
     winston.format.simple(),
   ),
   transports: [
-    new winston.transports.Console(options),
+    new winston.transports.Console(consoleOptions),
+    new winston.transports.File(fileOptions),
   ],
 });