refactor: path-references refactoring and using 'import' instead of 'require' (#1752)

* refactor references to 'userData' and 'appData' directories to move hardcoding into single location
* convert to es6 for lower memory usage as per https://codesource.io/the-difference-between-import-and-require-in-javascript/

6 files changed, 36 insertions, 33 deletions

diff --git a/src/electron/Settings.js b/src/electron/Settings.js
index 2f3f8261a..4dd9f8245 100644
--- a/src/electron/Settings.js
+++ b/src/electron/Settings.js
@@ -1,8 +1,6 @@
 import { observable, toJS } from 'mobx';
 import { pathExistsSync, outputJsonSync, readJsonSync } from 'fs-extra';
-import path from 'path';
-
-import { SETTINGS_PATH } from '../environment';
+import { userDataPath } from '../environment';
 
 const debug = require('debug')('Ferdi:Settings');
 
@@ -58,6 +56,6 @@ export default class Settings {
   }
 
   get settingsFile() {
-    return path.join(SETTINGS_PATH, `${this.type === 'app' ? 'settings' : this.type}.json`);
+    return userDataPath('config', `${this.type === 'app' ? 'settings' : this.type}.json`);
   }
 }
diff --git a/src/electron/ipc-api/appIndicator.js b/src/electron/ipc-api/appIndicator.js
index 0691e5170..c6c261d0f 100644
--- a/src/electron/ipc-api/appIndicator.js
+++ b/src/electron/ipc-api/appIndicator.js
@@ -1,5 +1,5 @@
 import { app, ipcMain } from 'electron';
-import path from 'path';
+import { join } from 'path';
 import { autorun } from 'mobx';
 import { isMac, isWindows, isLinux } from '../../environment';
 
@@ -9,7 +9,7 @@ const FILE_EXTENSION = isWindows ? 'ico' : 'png';
 let isTrayIconEnabled;
 
 function getAsset(type, asset) {
-  return path.join(
+  return join(
     __dirname, '..', '..', 'assets', 'images', type, process.platform, `${asset}.${FILE_EXTENSION}`,
   );
 }
diff --git a/src/electron/ipc-api/download.js b/src/electron/ipc-api/download.js
index 7f8718924..ba261ba1e 100644
--- a/src/electron/ipc-api/download.js
+++ b/src/electron/ipc-api/download.js
@@ -1,7 +1,7 @@
 import { ipcMain, dialog, BrowserWindow } from 'electron';
 import { download } from 'electron-dl';
 import mime from 'mime-types';
-import fs from 'fs-extra';
+import { writeFileSync } from 'fs-extra';
 
 const debug = require('debug')('Ferdi:ipcApi:download');
 
@@ -37,7 +37,7 @@ export default (params) => {
           if (saveDialog.canceled) return;
 
           const binaryImage = decodeBase64Image(content);
-          fs.writeFileSync(saveDialog.filePath, binaryImage, 'binary');
+          writeFileSync(saveDialog.filePath, binaryImage, 'binary');
 
           debug('File blob saved to', saveDialog.filePath);
         } catch (err) {
diff --git a/src/electron/ipc-api/localServer.js b/src/electron/ipc-api/localServer.js
index 493253e17..1ed4b7167 100644
--- a/src/electron/ipc-api/localServer.js
+++ b/src/electron/ipc-api/localServer.js
@@ -1,6 +1,7 @@
-import { ipcMain, app } from 'electron';
+import { ipcMain } from 'electron';
 import net from 'net';
 import { LOCAL_HOSTNAME } from '../../config';
+import { userDataPath } from '../../environment';
 import startServer from '../../internal-server/start';
 
 const DEFAULT_PORT = 45569;
@@ -37,7 +38,7 @@ export default (params) => {
         }
         console.log('Starting local server on port', port);
 
-        startServer(app.getPath('userData'), port);
+        startServer(userDataPath(), port);
 
         params.mainWindow.webContents.send('localServerPort', {
           port,
diff --git a/src/electron/macOSPermissions.js b/src/electron/macOSPermissions.js
index c114f4843..887af2903 100644
--- a/src/electron/macOSPermissions.js
+++ b/src/electron/macOSPermissions.js
@@ -1,45 +1,43 @@
-import { app, systemPreferences, dialog } from 'electron';
-import fs from 'fs';
+import { systemPreferences, dialog } from 'electron';
+import { pathExistsSync, mkdirSync, writeFileSync } from 'fs-extra';
 import macosVersion from 'macos-version';
-import path from 'path';
+import { dirname } from 'path';
 import { askForScreenCaptureAccess } from 'node-mac-permissions';
+import { userDataPath } from '../environment';
 
 const debug = require('debug')('Ferdi:macOSPermissions');
 
-const permissionExists = macosVersion.isGreaterThanOrEqualTo('10.15');
-const filePath = path.join(
-  app.getPath('userData'),
-  '.has-app-requested-screen-capture-permissions',
-);
+const isExplicitScreenCapturePermissionReqd = macosVersion.isGreaterThanOrEqualTo('10.15');
+debug(`Should check explicitly for screen-capture permissions: ${isExplicitScreenCapturePermissionReqd}`);
 
-function hasPromptedForPermission() {
-  if (!permissionExists) {
-    return false;
-  }
+const filePath = userDataPath('.has-app-requested-screen-capture-permissions');
 
-  if (filePath && fs.existsSync(filePath)) {
-    return true;
+function hasPromptedForScreenCapturePermission() {
+  if (!isExplicitScreenCapturePermissionReqd) {
+    return false;
   }
 
-  return false;
+  debug('Checking if status file exists');
+  return filePath && pathExistsSync(filePath);
 }
 
-function hasScreenCapturePermission() {
-  if (!permissionExists) {
+function hasScreenCapturePermissionAlreadyBeenGranted() {
+  if (!isExplicitScreenCapturePermissionReqd) {
     return true;
   }
 
   const screenCaptureStatus = systemPreferences.getMediaAccessStatus('screen');
+  debug(`screen-capture permissions status: ${screenCaptureStatus}`);
   return screenCaptureStatus === 'granted';
 }
 
 function createStatusFile() {
   try {
-    fs.writeFileSync(filePath, '');
+    writeFileSync(filePath, '');
   } catch (error) {
     if (error.code === 'ENOENT') {
-      fs.mkdirSync(path.dirname(filePath));
-      fs.writeFileSync(filePath, '');
+      mkdirSync(dirname(filePath));
+      writeFileSync(filePath, '');
     }
 
     throw error;
@@ -51,7 +49,13 @@ export const askFormacOSPermissions = async mainWindow => {
   systemPreferences.askForMediaAccess('camera');
   systemPreferences.askForMediaAccess('microphone');
 
-  if (!hasPromptedForPermission() && !hasScreenCapturePermission()) {
+  if (hasScreenCapturePermissionAlreadyBeenGranted()) {
+    debug('Already obtained screen-capture permissions - writing status file');
+    createStatusFile();
+    return;
+  }
+
+  if (!hasPromptedForScreenCapturePermission()) {
     debug('Checking screen capture permissions');
 
     const { response } = await dialog.showMessageBox(mainWindow, {
diff --git a/src/electron/webview-ime-focus.js b/src/electron/webview-ime-focus.js
index b9421eb06..e187ee0b4 100644
--- a/src/electron/webview-ime-focus.js
+++ b/src/electron/webview-ime-focus.js
@@ -1,5 +1,5 @@
-const { webContents } = require('@electron/remote');
-const { releaseDocumentFocus } = require('./webview-ime-focus-helpers');
+import { webContents } from '@electron/remote';
+import { releaseDocumentFocus } from './webview-ime-focus-helpers';
 
 function giveWebviewDocumentFocus(element) {
   releaseDocumentFocus();