refactor: split 'environment' into 'environment-remote' with only the remote module dependency

(might be a pre-requisite for the electron v14 upgrade)

25 files changed, 125 insertions, 126 deletions

diff --git a/src/api/apiBase.ts b/src/api/apiBase.ts
index 510ccb619..a30793848 100644
--- a/src/api/apiBase.ts
+++ b/src/api/apiBase.ts
@@ -1,7 +1,7 @@
 /**
  * Get API base URL from store
  */
-import { API_VERSION } from '../environment';
+import { API_VERSION } from '../environment-remote';
 import {
   DEV_API_FRANZ_WEBSITE,
   LIVE_FRANZ_API,
diff --git a/src/api/server/ServerApi.js b/src/api/server/ServerApi.js
index fb0d64dc3..e321f9372 100644
--- a/src/api/server/ServerApi.js
+++ b/src/api/server/ServerApi.js
@@ -22,13 +22,8 @@ import UserModel from '../../models/User';
 import { sleep } from '../../helpers/async-helpers';
 
 import { SERVER_NOT_LOADED } from '../../config';
-import {
-  osArch,
-  osPlatform,
-  userDataRecipesPath,
-  userDataPath,
-  ferdiVersion,
-} from '../../environment';
+import { osArch, osPlatform } from '../../environment';
+import { userDataRecipesPath, userDataPath, ferdiVersion } from '../../environment-remote';
 import { asarRecipesPath } from '../../helpers/asar-helpers';
 import apiBase from '../apiBase';
 import { prepareAuthRequest, sendAuthRequest } from '../utils/auth';
diff --git a/src/api/utils/auth.js b/src/api/utils/auth.js
index 527c68840..07b0c096b 100644
--- a/src/api/utils/auth.js
+++ b/src/api/utils/auth.js
@@ -1,5 +1,5 @@
 import localStorage from 'mobx-localstorage';
-import { ferdiLocale, ferdiVersion } from '../../environment';
+import { ferdiLocale, ferdiVersion } from '../../environment-remote';
 
 export const prepareAuthRequest = (
   // eslint-disable-next-line unicorn/no-object-as-default-parameter
diff --git a/src/components/auth/Login.js b/src/components/auth/Login.js
index 286d2dec8..2f9986858 100644
--- a/src/components/auth/Login.js
+++ b/src/components/auth/Login.js
@@ -5,7 +5,7 @@ import { observer, inject } from 'mobx-react';
 import { defineMessages, injectIntl } from 'react-intl';
 
 import { LIVE_FRANZ_API } from '../../config';
-import { API_VERSION, isDevMode, useLiveAPI } from '../../environment';
+import { API_VERSION, isDevMode, useLiveAPI } from '../../environment-remote';
 import Form from '../../lib/Form';
 import { required, email } from '../../helpers/validation-helpers';
 import serverlessLogin from '../../helpers/serverless-helpers';
diff --git a/src/components/settings/settings/EditSettingsForm.js b/src/components/settings/settings/EditSettingsForm.js
index 59aa0190e..819d0a9e6 100644
--- a/src/components/settings/settings/EditSettingsForm.js
+++ b/src/components/settings/settings/EditSettingsForm.js
@@ -15,13 +15,11 @@ import Input from '../../ui/Input';
 import { FRANZ_TRANSLATION, GITHUB_FRANZ_URL } from '../../../config';
 import {
   DEFAULT_APP_SETTINGS,
-  ferdiVersion,
   isMac,
   isWindows,
   lockFerdiShortcutKey,
-  userDataPath,
-  userDataRecipesPath,
 } from '../../../environment';
+import { ferdiVersion, userDataPath, userDataRecipesPath } from '../../../environment-remote';
 import { openPath } from '../../../helpers/url-helpers';
 import globalMessages from '../../../i18n/globalMessages';
 
diff --git a/src/containers/settings/AccountScreen.js b/src/containers/settings/AccountScreen.js
index 0f9457fd0..1515fc22b 100644
--- a/src/containers/settings/AccountScreen.js
+++ b/src/containers/settings/AccountScreen.js
@@ -10,7 +10,7 @@ import SettingsStore from '../../stores/SettingsStore';
 import AccountDashboard from '../../components/settings/account/AccountDashboard';
 import ErrorBoundary from '../../components/util/ErrorBoundary';
 import { LIVE_FRANZ_API } from '../../config';
-import { WEBSITE } from '../../environment';
+import { WEBSITE } from '../../environment-remote';
 
 @inject('stores', 'actions')
 @observer
diff --git a/src/containers/settings/RecipesScreen.js b/src/containers/settings/RecipesScreen.js
index 162390d57..2e60ceefa 100644
--- a/src/containers/settings/RecipesScreen.js
+++ b/src/containers/settings/RecipesScreen.js
@@ -12,7 +12,7 @@ import UserStore from '../../stores/UserStore';
 import RecipesDashboard from '../../components/settings/recipes/RecipesDashboard';
 import ErrorBoundary from '../../components/util/ErrorBoundary';
 import { CUSTOM_WEBSITE_RECIPE_ID, FRANZ_DEV_DOCS } from '../../config';
-import { userDataRecipesPath } from '../../environment';
+import { userDataRecipesPath } from '../../environment-remote';
 import { asarRecipesPath } from '../../helpers/asar-helpers';
 import { communityRecipesStore } from '../../features/communityRecipes';
 import RecipePreview from '../../models/RecipePreview';
diff --git a/src/electron/Settings.ts b/src/electron/Settings.ts
index a1344aa97..98acfa1d5 100644
--- a/src/electron/Settings.ts
+++ b/src/electron/Settings.ts
@@ -1,6 +1,6 @@
 import { observable, toJS } from 'mobx';
 import { pathExistsSync, outputJsonSync, readJsonSync } from 'fs-extra';
-import { userDataPath } from '../environment';
+import { userDataPath } from '../environment-remote';
 
 const debug = require('debug')('Ferdi:Settings');
 
diff --git a/src/electron/ipc-api/localServer.ts b/src/electron/ipc-api/localServer.ts
index 61e56c777..7ee642101 100644
--- a/src/electron/ipc-api/localServer.ts
+++ b/src/electron/ipc-api/localServer.ts
@@ -1,7 +1,7 @@
 import { ipcMain, BrowserWindow } from 'electron';
 import net from 'net';
 import { LOCAL_HOSTNAME, LOCAL_PORT } from '../../config';
-import { userDataPath } from '../../environment';
+import { userDataPath } from '../../environment-remote';
 import { server } from '../../internal-server/start';
 
 const portInUse = (port: number): Promise<boolean> =>
diff --git a/src/electron/macOSPermissions.ts b/src/electron/macOSPermissions.ts
index aef3ac30b..bcd5b5931 100644
--- a/src/electron/macOSPermissions.ts
+++ b/src/electron/macOSPermissions.ts
@@ -3,7 +3,7 @@ import { pathExistsSync, mkdirSync, writeFileSync } from 'fs-extra';
 import macosVersion from 'macos-version';
 import { dirname } from 'path';
 import { askForScreenCaptureAccess } from 'node-mac-permissions';
-import { userDataPath } from '../environment';
+import { userDataPath } from '../environment-remote';
 
 const debug = require('debug')('Ferdi:macOSPermissions');
 
diff --git a/src/environment-remote.ts b/src/environment-remote.ts
new file mode 100644
index 000000000..1ff019c5f
--- /dev/null
+++ b/src/environment-remote.ts
@@ -0,0 +1,93 @@
+import { join } from 'path';
+import osName from 'os-name';
+import { api as electronApi } from 'electron-util';
+import {
+  LIVE_FERDI_API,
+  DEV_FRANZ_API,
+  LOCAL_API,
+  LOCAL_API_WEBSITE,
+  DEV_API_FRANZ_WEBSITE,
+  LIVE_API_FERDI_WEBSITE,
+  LIVE_WS_API,
+  LOCAL_WS_API,
+  DEV_WS_API,
+  LOCAL_TODOS_FRONTEND_URL,
+  PRODUCTION_TODOS_FRONTEND_URL,
+} from './config';
+import { chromeVersion, electronVersion, isWindows, nodeVersion, osArch } from './environment';
+
+// @ts-expect-error Cannot find module './buildInfo.json' or its corresponding type declarations.
+import * as buildInfo from './buildInfo.json';
+
+export const { app } = electronApi;
+export const ferdiVersion = app.getVersion();
+export const ferdiLocale = app.getLocale();
+
+// Set app directory before loading user modules
+if (process.env.FERDI_APPDATA_DIR != null) {
+  app.setPath('appData', process.env.FERDI_APPDATA_DIR);
+  app.setPath('userData', app.getPath('appData'));
+} else if (process.env.PORTABLE_EXECUTABLE_DIR != null) {
+  app.setPath('appData', join(process.env.PORTABLE_EXECUTABLE_DIR, `${app.name}AppData`));
+  app.setPath('userData', join(app.getPath('appData'), `${app.name}AppData`));
+} else if (isWindows && process.env.APPDATA != null) {
+  app.setPath('appData', process.env.APPDATA);
+  app.setPath('userData', join(app.getPath('appData'), app.name));
+}
+
+export const isDevMode = process.env.ELECTRON_IS_DEV !== undefined ? Number.parseInt(process.env.ELECTRON_IS_DEV, 10) === 1 : !app.isPackaged;
+if (isDevMode) {
+  app.setPath('userData', join(app.getPath('appData'), `${app.name}Dev`));
+}
+
+export function userDataPath(...segments: string[]) {
+  return join(app.getPath('userData'), ...[segments].flat());
+}
+
+export function userDataRecipesPath(...segments: any[]) {
+  return userDataPath('recipes', ...[segments].flat());
+}
+
+const useLocalAPI = process.env.USE_LOCAL_API;
+export const useLiveAPI = process.env.USE_LIVE_API;
+
+let api: string;
+let wsApi: string;
+let web: string;
+let todos: string;
+if (!isDevMode || (isDevMode && useLiveAPI)) {
+  api = LIVE_FERDI_API;
+  wsApi = LIVE_WS_API;
+  web = LIVE_API_FERDI_WEBSITE;
+  todos = PRODUCTION_TODOS_FRONTEND_URL;
+} else if (isDevMode && useLocalAPI) {
+  api = LOCAL_API;
+  wsApi = LOCAL_WS_API;
+  web = LOCAL_API_WEBSITE;
+  todos = LOCAL_TODOS_FRONTEND_URL;
+} else {
+  api = DEV_FRANZ_API;
+  wsApi = DEV_WS_API;
+  web = DEV_API_FRANZ_WEBSITE;
+  todos = PRODUCTION_TODOS_FRONTEND_URL;
+}
+
+export const API = api;
+export const API_VERSION = 'v1';
+export const WS_API = wsApi;
+export const WEBSITE = web;
+export const TODOS_FRONTEND = todos;
+
+export function aboutAppDetails() {
+  return [
+    `Version: ${ferdiVersion}`,
+    `Electron: ${electronVersion}`,
+    `Chrome: ${chromeVersion}`,
+    `Node.js: ${nodeVersion}`,
+    `Platform: ${osName()}`,
+    `Arch: ${osArch}`,
+    `Build date: ${new Date(Number(buildInfo.timestamp))}`,
+    `Git SHA: ${buildInfo.gitHashShort}`,
+    `Git branch: ${buildInfo.gitBranch}`,
+  ].join('\n');
+}
diff --git a/src/environment.ts b/src/environment.ts
index 9478f803c..99002367f 100644
--- a/src/environment.ts
+++ b/src/environment.ts
@@ -1,69 +1,21 @@
 import os from 'os';
-import { join } from 'path';
-
-import { api as electronApi } from 'electron-util';
 
 import { DEFAULT_ACCENT_COLOR } from '@meetfranz/theme';
 
-import osName from 'os-name';
 import {
   LIVE_FERDI_API,
-  DEV_FRANZ_API,
-  LOCAL_API,
-  LOCAL_API_WEBSITE,
-  DEV_API_FRANZ_WEBSITE,
-  LIVE_API_FERDI_WEBSITE,
-  LIVE_WS_API,
-  LOCAL_WS_API,
-  DEV_WS_API,
-  LOCAL_TODOS_FRONTEND_URL,
-  PRODUCTION_TODOS_FRONTEND_URL,
   DEFAULT_TODO_SERVICE,
   SEARCH_ENGINE_DDG,
   iconSizeBias,
 } from './config';
 
-// @ts-expect-error Cannot find module './buildInfo.json' or its corresponding type declarations.
-import * as buildInfo from './buildInfo.json';
-
 export const isMac = process.platform === 'darwin';
 export const isWindows = process.platform === 'win32';
 export const isLinux = process.platform === 'linux';
 
-export const { app } = electronApi;
-export const ferdiVersion = app.getVersion();
 export const electronVersion = process.versions.electron;
 export const chromeVersion = process.versions.chrome;
 export const nodeVersion = process.versions.node;
-export const ferdiLocale = app.getLocale();
-
-// Set app directory before loading user modules
-if (process.env.FERDI_APPDATA_DIR != null) {
-  app.setPath('appData', process.env.FERDI_APPDATA_DIR);
-  app.setPath('userData', app.getPath('appData'));
-} else if (process.env.PORTABLE_EXECUTABLE_DIR != null) {
-  app.setPath('appData', join(process.env.PORTABLE_EXECUTABLE_DIR, `${app.name}AppData`));
-  app.setPath('userData', join(app.getPath('appData'), `${app.name}AppData`));
-} else if (isWindows && process.env.APPDATA != null) {
-  app.setPath('appData', process.env.APPDATA);
-  app.setPath('userData', join(app.getPath('appData'), app.name));
-}
-
-export const isDevMode = process.env.ELECTRON_IS_DEV !== undefined ? Number.parseInt(process.env.ELECTRON_IS_DEV, 10) === 1 : !app.isPackaged;
-if (isDevMode) {
-  app.setPath('userData', join(app.getPath('appData'), `${app.name}Dev`));
-}
-
-export function userDataPath(...segments: string[]) {
-  return join(app.getPath('userData'), ...[segments].flat());
-}
-
-export function userDataRecipesPath(...segments: any[]) {
-  return userDataPath('recipes', ...[segments].flat());
-}
-
-export const useLiveAPI = process.env.USE_LIVE_API;
-const useLocalAPI = process.env.USE_LOCAL_API;
 
 export const osPlatform = os.platform();
 export const osArch = os.arch();
@@ -96,33 +48,6 @@ export const addNewServiceShortcutKey = (isAccelerator = true) =>
 export const settingsShortcutKey = (isAccelerator = true) =>
   `${cmdOrCtrlShortcutKey(isAccelerator)}+${isMac ? ',' : 'P'}`;
 
-let api: string;
-let wsApi: string;
-let web: string;
-let todos: string;
-if (!isDevMode || (isDevMode && useLiveAPI)) {
-  api = LIVE_FERDI_API;
-  wsApi = LIVE_WS_API;
-  web = LIVE_API_FERDI_WEBSITE;
-  todos = PRODUCTION_TODOS_FRONTEND_URL;
-} else if (isDevMode && useLocalAPI) {
-  api = LOCAL_API;
-  wsApi = LOCAL_WS_API;
-  web = LOCAL_API_WEBSITE;
-  todos = LOCAL_TODOS_FRONTEND_URL;
-} else {
-  api = DEV_FRANZ_API;
-  wsApi = DEV_WS_API;
-  web = DEV_API_FRANZ_WEBSITE;
-  todos = PRODUCTION_TODOS_FRONTEND_URL;
-}
-
-export const API = api;
-export const API_VERSION = 'v1';
-export const WS_API = wsApi;
-export const WEBSITE = web;
-export const TODOS_FRONTEND = todos;
-
 export const DEFAULT_APP_SETTINGS = {
   autoLaunchInBackground: false,
   runInBackground: true,
@@ -140,7 +65,7 @@ export const DEFAULT_APP_SETTINGS = {
   showDragArea: false,
   enableSpellchecking: true,
   spellcheckerLanguage: 'en-us',
-  darkMode: isMac && electronApi.nativeTheme.shouldUseDarkColors,
+  darkMode: false,
   splitMode: false,
   locale: '',
   fallbackLocale: 'en-US',
@@ -178,17 +103,3 @@ export const DEFAULT_APP_SETTINGS = {
   alwaysShowWorkspaces: false,
   liftSingleInstanceLock: false,
 };
-
-export function aboutAppDetails() {
-  return [
-    `Version: ${ferdiVersion}`,
-    `Electron: ${electronVersion}`,
-    `Chrome: ${chromeVersion}`,
-    `Node.js: ${nodeVersion}`,
-    `Platform: ${osName()}`,
-    `Arch: ${osArch}`,
-    `Build date: ${new Date(Number(buildInfo.timestamp))}`,
-    `Git SHA: ${buildInfo.gitHashShort}`,
-    `Git branch: ${buildInfo.gitBranch}`,
-  ].join('\n');
-}
diff --git a/src/features/settingsWS/store.js b/src/features/settingsWS/store.js
index e36ccee72..3b9e10825 100755
--- a/src/features/settingsWS/store.js
+++ b/src/features/settingsWS/store.js
@@ -4,7 +4,7 @@ import ms from 'ms';
 
 import { FeatureStore } from '../utils/FeatureStore';
 import { createReactions } from '../../stores/lib/Reaction';
-import { WS_API } from '../../environment';
+import { WS_API } from '../../environment-remote';
 
 const debug = require('debug')('Ferdi:feature:settingsWS:store');
 
diff --git a/src/helpers/recipe-helpers.ts b/src/helpers/recipe-helpers.ts
index 65ef04088..d482dffab 100644
--- a/src/helpers/recipe-helpers.ts
+++ b/src/helpers/recipe-helpers.ts
@@ -1,6 +1,6 @@
 /* eslint-disable global-require */
 import { parse } from 'path';
-import { userDataRecipesPath } from '../environment';
+import { userDataRecipesPath } from '../environment-remote';
 
 export function getRecipeDirectory(id: string = ''): string {
   return userDataRecipesPath(id);
diff --git a/src/helpers/service-helpers.ts b/src/helpers/service-helpers.ts
index 13c921f88..678d5024f 100644
--- a/src/helpers/service-helpers.ts
+++ b/src/helpers/service-helpers.ts
@@ -1,5 +1,5 @@
 import { readdirSync, removeSync } from 'fs-extra';
-import { userDataPath } from '../environment';
+import { userDataPath } from '../environment-remote';
 
 export function getServicePartitionsDirectory(...segments) {
   return userDataPath('Partitions', ...[segments].flat());
diff --git a/src/index.html b/src/index.html
index 929aec3ad..fea2ec387 100644
--- a/src/index.html
+++ b/src/index.html
@@ -26,7 +26,7 @@
         );
 
       require('./sentry');
-      const { isDevMode } = require('./environment');
+      const { isDevMode } = require('./environment-remote');
       if (isDevMode) {
         const debugging = require('debug');
         debugging.enable(process.env.DEBUG);
diff --git a/src/index.js b/src/index.js
index 97a4f0379..6035d08a4 100644
--- a/src/index.js
+++ b/src/index.js
@@ -14,14 +14,16 @@ import { DEFAULT_WINDOW_OPTIONS } from './config';
 
 import {
   DEFAULT_APP_SETTINGS,
-  isDevMode,
   isMac,
   isWindows,
   isLinux,
+} from './environment';
+import {
+  isDevMode,
   aboutAppDetails,
   userDataRecipesPath,
   userDataPath,
-} from './environment';
+} from './environment-remote';
 import { ifUndefinedBoolean } from './jsUtils';
 
 import { mainIpcHandler as basicAuthHandler } from './features/basicAuth';
diff --git a/src/internal-server/app/Controllers/Http/RecipeController.js b/src/internal-server/app/Controllers/Http/RecipeController.js
index 2c7baf2a4..d44839db1 100644
--- a/src/internal-server/app/Controllers/Http/RecipeController.js
+++ b/src/internal-server/app/Controllers/Http/RecipeController.js
@@ -6,7 +6,7 @@ const Env = use('Env');
 const fetch = require('node-fetch');
 const debug = require('debug')('Ferdi:internalServer:RecipeController');
 const { LIVE_FERDI_API } = require('../../../../config');
-const { API_VERSION } = require('../../../../environment');
+const { API_VERSION } = require('../../../../environment-remote');
 
 const RECIPES_URL = `${LIVE_FERDI_API}/${API_VERSION}/recipes`;
 
diff --git a/src/internal-server/app/Controllers/Http/UserController.js b/src/internal-server/app/Controllers/Http/UserController.js
index 747606da7..9bbd2ff6e 100644
--- a/src/internal-server/app/Controllers/Http/UserController.js
+++ b/src/internal-server/app/Controllers/Http/UserController.js
@@ -7,10 +7,8 @@ const btoa = require('btoa');
 const fetch = require('node-fetch');
 const { v4: uuid } = require('uuid');
 const crypto = require('crypto');
-const {
-  DEFAULT_APP_SETTINGS,
-  API_VERSION,
-} = require('../../../../environment');
+const { DEFAULT_APP_SETTINGS } = require('../../../../environment');
+const { API_VERSION } = require('../../../../environment-remote');
 const { default: userAgent } = require('../../../../helpers/userAgent-helpers');
 
 const apiRequest = (url, route, method, auth) =>
diff --git a/src/internal-server/start/migrate.js b/src/internal-server/start/migrate.js
index 0f25240cc..97cefcc54 100644
--- a/src/internal-server/start/migrate.js
+++ b/src/internal-server/start/migrate.js
@@ -1,4 +1,4 @@
-const { ferdiVersion } = require('../../environment');
+const { ferdiVersion } = require('../../environment-remote');
 
 /**
  * Migrate server database to work with current Ferdi version
diff --git a/src/internal-server/start/routes.js b/src/internal-server/start/routes.js
index e75380ccd..db74479c9 100644
--- a/src/internal-server/start/routes.js
+++ b/src/internal-server/start/routes.js
@@ -8,7 +8,7 @@
 /** @type {typeof import('@adonisjs/framework/src/Route/Manager')} */
 const Route = use('Route');
 
-const { API_VERSION } = require('../../environment');
+const { API_VERSION } = require('../../environment-remote');
 // Run latest database migration
 const migrate = require('./migrate');
 
diff --git a/src/lib/Menu.js b/src/lib/Menu.js
index 349748506..56d14ebee 100644
--- a/src/lib/Menu.js
+++ b/src/lib/Menu.js
@@ -14,13 +14,13 @@ import {
   settingsShortcutKey,
   isLinux,
   isMac,
-  aboutAppDetails,
   lockFerdiShortcutKey,
   todosToggleShortcutKey,
   workspaceToggleShortcutKey,
   addNewServiceShortcutKey,
   muteFerdiShortcutKey,
 } from '../environment';
+import { aboutAppDetails } from '../environment-remote';
 import { todosStore } from '../features/todos';
 import { todoActions } from '../features/todos/actions';
 import { workspaceActions } from '../features/workspaces/actions';
diff --git a/src/stores/AppStore.js b/src/stores/AppStore.js
index cb17447c0..83e6a899b 100644
--- a/src/stores/AppStore.js
+++ b/src/stores/AppStore.js
@@ -20,12 +20,14 @@ import { CHECK_INTERVAL } from '../config';
 import {
   DEFAULT_APP_SETTINGS,
   isMac,
-  ferdiVersion,
   electronVersion,
   osRelease,
+} from '../environment';
+import {
+  ferdiVersion,
   userDataPath,
   ferdiLocale,
-} from '../environment';
+} from '../environment-remote';
 import locales from '../i18n/translations';
 import { getLocale } from '../helpers/i18n-helpers';
 
diff --git a/src/stores/ServicesStore.js b/src/stores/ServicesStore.js
index 2a4b0511c..ce6675866 100644
--- a/src/stores/ServicesStore.js
+++ b/src/stores/ServicesStore.js
@@ -17,7 +17,7 @@ import {
 import { workspaceStore } from '../features/workspaces';
 import { KEEP_WS_LOADED_USID } from '../config';
 import { SPELLCHECKER_LOCALES } from '../i18n/languages';
-import { ferdiVersion } from '../environment';
+import { ferdiVersion } from '../environment-remote';
 
 const debug = require('debug')('Ferdi:ServiceStore');
 
diff --git a/src/stores/UserStore.js b/src/stores/UserStore.js
index 77dd28d7c..9f222d2d3 100644
--- a/src/stores/UserStore.js
+++ b/src/stores/UserStore.js
@@ -5,7 +5,7 @@ import localStorage from 'mobx-localstorage';
 import { ipcRenderer } from 'electron';
 
 import { TODOS_PARTITION_ID } from '../config';
-import { isDevMode } from '../environment';
+import { isDevMode } from '../environment-remote';
 import Store from './lib/Store';
 import Request from './lib/Request';
 import CachedRequest from './lib/CachedRequest';