[DDW-256] No disk space overlay

CHANGELOG.md

@@ -35,6 +35,7 @@ Changelog
 - Improved the transaction details text selection ([PR 1073](https://github.com/input-output-hk/daedalus/pull/1073), [PR 1095](https://github.com/input-output-hk/daedalus/pull/1095))
 - Integrated Cardano V1 API endpoints ([PR 1018](https://github.com/input-output-hk/daedalus/pull/1018), [PR 1031](https://github.com/input-output-hk/daedalus/pull/1031), [PR 1037](https://github.com/input-output-hk/daedalus/pull/1037), [PR 1042](https://github.com/input-output-hk/daedalus/pull/1042), [PR 1045](https://github.com/input-output-hk/daedalus/pull/1045), [PR 1070](https://github.com/input-output-hk/daedalus/pull/1070), [PR 1078](https://github.com/input-output-hk/daedalus/pull/1078), [PR 1079](https://github.com/input-output-hk/daedalus/pull/1079), [PR 1080](https://github.com/input-output-hk/daedalus/pull/1080), [PR 1088](https://github.com/input-output-hk/daedalus/pull/1088))
 - Refactored and improved `NetworkStatus` store to use V1 API data ([PR 1081](https://github.com/input-output-hk/daedalus/pull/1081))
+- Implemented a better handling for no disk space error ([PR 1157](https://github.com/input-output-hk/daedalus/pull/1157))
 
 ### Fixes
 

package.json

@@ -99,6 +99,7 @@
     "postcss": "6.0.14",
     "postcss-modules": "1.1.0",
     "postcss-modules-values": "1.3.0",
+    "prettysize": "1.1.0",
     "raw-loader": "0.5.1",
     "react-intl-translations-manager": "5.0.1",
     "resolve-url": "0.2.1",
@@ -122,6 +123,7 @@
     "bip39": "2.3.0",
     "blakejs": "1.1.0",
     "bs58": "4.0.1",
+    "check-disk-space": "1.5.0",
     "classnames": "2.2.5",
     "electron-debug": "1.4.0",
     "electron-log": "2.2.14",

source/common/ipc/check-disk-space.js

@@ -0,0 +1,9 @@
+// @flow
+export const DISK_SPACE_STATUS_CHANNEL = 'disk-space-status';
+
+export type CheckDiskSpaceResponse = {
+  diskSpaceAvailable: number,
+  diskSpaceRequired: number,
+  diskSpaceMissing: number,
+  notEnoughSpace: boolean,
+};

source/main/cardano/setup.js

@@ -17,8 +17,9 @@ import { safeExitWithCode } from '../utils/safeExitWithCode';
 import type {
   TlsConfig,
   CardanoNodeState,
-  CardanoStatus
+  CardanoStatus,
 } from '../../common/types/cardanoNode.types';
+import { CardanoNodeStates } from '../../common/types/cardanoNode.types';
 import type { LauncherConfig } from '../config';
 import {
   NODE_KILL_TIMEOUT,
@@ -45,7 +46,11 @@ const startCardanoNode = (node: CardanoNode, launcherConfig: Object) => {
   return node.start(config);
 };
 
-const restartCardanoNode = async (node: CardanoNode) => {
+export const restartCardanoNode = async (node: CardanoNode) => {
+  if (
+    node.state === CardanoNodeStates.STARTING ||
+    node.state === CardanoNodeStates.RUNNING
+  ) return false;
   try {
     await node.restart();
   } catch (error) {

source/main/index.js

@@ -6,6 +6,7 @@ import { includes } from 'lodash';
 import { Logger } from '../common/logging';
 import { setupLogging } from './utils/setupLogging';
 import { makeEnvironmentGlobal } from './utils/makeEnvironmentGlobal';
+import HandleDiskSpace from './utils/HandleDiskSpace';
 import { createMainWindow } from './windows/main';
 import { winLinuxMenu } from './menus/win-linux';
 import { osxMenu } from './menus/osx';
@@ -16,12 +17,13 @@ import { GO_TO_ADA_REDEMPTION_SCREEN_CHANNEL } from '../common/ipc/go-to-ada-red
 import { GO_TO_NETWORK_STATUS_SCREEN_CHANNEL } from '../common/ipc/go-to-network-status-screen';
 import mainErrorHandler from './utils/mainErrorHandler';
 import { launcherConfig } from './config';
-import { setupCardano } from './cardano/setup';
+import { setupCardano, restartCardanoNode } from './cardano/setup';
 import { CardanoNode } from './cardano/CardanoNode';
 import { safeExitWithCode } from './utils/safeExitWithCode';
 import { ensureXDGDataIsSet } from './cardano/config';
 import { acquireDaedalusInstanceLock } from './utils/lockFiles';
 import { CardanoNodeStates } from '../common/types/cardanoNode.types';
+import type { CheckDiskSpaceResponse } from '../common/ipc/check-disk-space';
 
 // Global references to windows to prevent them from being garbage collected
 let mainWindow: BrowserWindow;
@@ -86,7 +88,30 @@ app.on('ready', async () => {
   }
 
   setupLogging();
-  mainErrorHandler();
+
+  // Detect safe mode
+  const isInSafeMode = includes(process.argv.slice(1), '--safe-mode');
+
+  mainWindow = createMainWindow(isInSafeMode);
+
+  const onCheckDiskSpace = ({ notEnoughSpace }: CheckDiskSpaceResponse) => {
+    if (notEnoughSpace) {
+      cardanoNode.stop();
+    } else {
+      restartCardanoNode(cardanoNode);
+    }
+  };
+
+  const handleCheckDiskSpace = HandleDiskSpace(mainWindow, onCheckDiskSpace);
+
+  const onMainError = (error: string) => {
+    if (error.indexOf('ENOSPC') > -1) {
+      handleCheckDiskSpace();
+      return false;
+    }
+  };
+
+  mainErrorHandler(onMainError);
 
   Logger.info(`========== Daedalus is starting at ${new Date().toString()} ==========`);
 
@@ -98,10 +123,6 @@ app.on('ready', async () => {
   makeEnvironmentGlobal(process.env);
   await installChromeExtensions(environment.isDev());
 
-  // Detect safe mode
-  const isInSafeMode = includes(process.argv.slice(1), '--safe-mode');
-
-  mainWindow = createMainWindow(isInSafeMode);
   cardanoNode = setupCardano(launcherConfig, mainWindow);
 
   if (environment.isWatchMode()) {

source/main/utils/HandleDiskSpace.js

@@ -0,0 +1,69 @@
+// @flow
+import { BrowserWindow } from 'electron';
+import checkDiskSpace from 'check-disk-space';
+import { DISK_SPACE_STATUS_CHANNEL } from '../../common/ipc/check-disk-space';
+import environment from '../../common/environment';
+import { Logger } from '../../common/logging';
+
+export default (
+  mainWindow: BrowserWindow,
+  onCheckDiskSpace?: Function,
+) => {
+
+  const DISK_SPACE_REQUIRED = 2147483648; // 2Gb
+  const DISK_SPACE_REQUIRED_MARGIN =
+    DISK_SPACE_REQUIRED - (DISK_SPACE_REQUIRED * 10 / 100); // 2Gb - 10%
+  const DISK_SPACE_CHECK_LONG_INTERVAL = 600000; // 10 minutes
+  const DISK_SPACE_CHECK_SHORT_INTERVAL = 10000; // 10 seconds
+
+  const path = environment.isWindows() ? 'C:' : '/';
+  let diskSpaceCheckInterval;
+  let notEnoughSpace = false;
+
+  const handleCheckDiskSpace = async () => {
+
+    const { free: diskSpaceAvailable } = await checkDiskSpace(path);
+    let diskSpaceMissing = DISK_SPACE_REQUIRED - diskSpaceAvailable;
+    diskSpaceMissing = diskSpaceMissing > -1 ? diskSpaceMissing : 0;
+
+    if (diskSpaceAvailable <= DISK_SPACE_REQUIRED_MARGIN) {
+      if (!notEnoughSpace) {
+        setDiskSpaceIntervalChecking(DISK_SPACE_CHECK_SHORT_INTERVAL);
+      }
+      notEnoughSpace = true;
+    } else if (diskSpaceAvailable >= DISK_SPACE_REQUIRED) {
+      if (notEnoughSpace) {
+        setDiskSpaceIntervalChecking(DISK_SPACE_CHECK_LONG_INTERVAL);
+      }
+      notEnoughSpace = false;
+    }
+    const response = {
+      diskSpaceAvailable,
+      diskSpaceRequired: DISK_SPACE_REQUIRED,
+      notEnoughSpace,
+      diskSpaceMissing,
+    };
+
+    Logger.info(JSON.stringify(response, null, 2));
+
+    if (typeof onCheckDiskSpace === 'function') {
+      onCheckDiskSpace(response);
+    }
+    mainWindow.webContents.send(DISK_SPACE_STATUS_CHANNEL, response);
+  };
+
+  const setDiskSpaceIntervalChecking = (interval) => {
+    clearInterval(diskSpaceCheckInterval);
+    diskSpaceCheckInterval =
+      setInterval(async () => {
+        handleCheckDiskSpace();
+      }, interval);
+  };
+  setDiskSpaceIntervalChecking(DISK_SPACE_CHECK_LONG_INTERVAL);
+
+  // Initial checking
+  handleCheckDiskSpace();
+
+  return handleCheckDiskSpace;
+
+};

source/main/utils/mainErrorHandler.js

@@ -3,14 +3,25 @@ import { app } from 'electron';
 import unhandled from 'electron-unhandled';
 import { Logger, stringifyError } from '../../common/logging';
 
-export default () => {
+export default (onError?: Function) => {
+
+  Logger.info('mainErrorHandler.js started ==========--------=====');
+
   unhandled({
     logger: (error: any) => Logger.error(`unhandledException::main: ${stringifyError(error)}`),
     showDialog: false
   });
 
   process.on('uncaughtException', (error: any) => {
-    Logger.error(`uncaughtException: ${stringifyError(error)}`);
+
+    const err = `${stringifyError(error)}`;
+
+    Logger.error(`uncaughtException: ${err}`);
+
+    if (typeof onError === 'function') {
+      onError.trigger(this, err);
+    }
+
   });
 
   app.on('gpu-process-crashed', (event: any, killed: boolean) => {

source/renderer/app/components/loading/Loading.js

@@ -8,6 +8,7 @@ import classNames from 'classnames';
 import { Button } from 'react-polymorph/lib/components/Button';
 import { ButtonSkin } from 'react-polymorph/lib/skins/simple/ButtonSkin';
 import SystemTimeErrorOverlay from './SystemTimeErrorOverlay';
+import NoDiskSpaceOverlay from './NoDiskSpaceOverlay';
 import LoadingSpinner from '../widgets/LoadingSpinner';
 import daedalusLogo from '../../assets/images/daedalus-logo-loading-grey.inline.svg';
 import { CardanoNodeStates } from '../../../../common/types/cardanoNode.types';
@@ -100,6 +101,10 @@ type Props = {
   hasBeenConnected: boolean,
   isConnected: boolean,
   isSynced: boolean,
+  diskSpaceAvailable: number,
+  diskSpaceRequired: number,
+  diskSpaceMissing: number,
+  notEnoughSpace: boolean,
   syncPercentage: number,
   loadingDataForNextScreenMessage: ReactIntlMessage,
   hasLoadedCurrentLocale: boolean,
@@ -317,6 +322,10 @@ export default class Loading extends Component<Props, State> {
       apiIcon,
       isConnected,
       isSynced,
+      diskSpaceAvailable,
+      diskSpaceRequired,
+      diskSpaceMissing,
+      notEnoughSpace,
       hasLoadedCurrentLocale,
       hasLoadedCurrentTheme,
       handleReportIssue,
@@ -365,6 +374,17 @@ export default class Loading extends Component<Props, State> {
 
     return (
       <div className={componentStyles}>
+        {
+          notEnoughSpace &&
+          (
+            <NoDiskSpaceOverlay
+              diskSpaceAvailable={diskSpaceAvailable}
+              diskSpaceRequired={diskSpaceRequired}
+              diskSpaceMissing={diskSpaceMissing}
+              notEnoughSpace={notEnoughSpace}
+            />
+          )
+        }
         {showReportIssue && (
           <div className={styles.reportIssue}>
             <h1 className={styles.reportIssueText}>

source/renderer/app/components/loading/NoDiskSpaceErrorOverlay.scss

@@ -0,0 +1,59 @@
+@import "../../themes/mixins/animations";
+
+.component {
+  align-items: center;
+  background-color: var(--theme-loading-no-disk-space-background-color);
+  bottom: 0;
+  box-shadow: 0 5px 20px 0 rgba(0, 0, 0, 0.25);
+  color: var(--theme-loading-no-disk-space-text-color);
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  left: 0;
+  padding: 50px;
+  position: absolute;
+  right: 0;
+  text-align: center;
+  top: 0;
+  z-index: 1;
+
+  .icon {
+    margin-bottom: 36px;
+    object-fit: contain;
+    & > svg {
+      height: 110px;
+      width: 110px;
+      path {
+        fill: var(--theme-loading-no-disk-space-attention-icon-color);
+      }
+      path:nth-child(1) {
+        opacity: 0.2;
+      }
+      path:nth-child(2) {
+        opacity: 0.6;
+      }
+    }
+  }
+
+  h1, p, button {
+    font-family: var(--font-regular);
+  }
+
+  h1 {
+    font-size: 20px;
+    line-height: 1.2;
+    margin-bottom: 8.5px;
+  }
+
+  p {
+    font-size: 16px;
+    line-height: 1.38;
+    margin-bottom: 20px;
+    opacity: 0.8;
+  }
+
+  b {
+    font-weight: bold;
+  }
+
+}

source/renderer/app/components/loading/NoDiskSpaceOverlay.js

@@ -0,0 +1,63 @@
+// @flow
+import React, { Component } from 'react';
+import SVGInline from 'react-svg-inline';
+import { observer } from 'mobx-react';
+import { defineMessages, intlShape, FormattedHTMLMessage } from 'react-intl';
+import prettysize from 'prettysize';
+import attentionIcon from '../../assets/images/attention-big-light.inline.svg';
+import styles from './NoDiskSpaceErrorOverlay.scss';
+
+const messages = defineMessages({
+  overlayContent: {
+    id: 'noDiskSpace.error.overlayContent',
+    defaultMessage: '!!!<b>There is not enough disk space left on your device.</b><br />Daedalus requires at least {diskSpaceRequired} to operate. Please free up some disk space to continue.',
+    description: 'Content of No disk space overlay'
+  },
+  overlayTitle: {
+    id: 'noDiskSpace.error.overlayTitle',
+    defaultMessage: '!!!Not enough disk space',
+    description: 'Title of No disk space overlay'
+  },
+});
+
+type Props = {
+  diskSpaceAvailable: number,
+  diskSpaceRequired: number,
+  diskSpaceMissing: number,
+};
+
+@observer
+export default class NoDiskSpaceErrorOverlay extends Component<Props> {
+
+  static contextTypes = {
+    intl: intlShape.isRequired,
+  };
+
+  render() {
+    const { intl } = this.context;
+    const {
+      /* diskSpaceAvailable, */ diskSpaceRequired/* , diskSpaceMissing */
+    } = this.props;
+
+    return (
+      <div className={styles.component}>
+
+        <SVGInline svg={attentionIcon} className={styles.icon} />
+
+        <div>
+          <h1>{intl.formatMessage(messages.overlayTitle)}</h1>
+
+          <p>
+            <FormattedHTMLMessage
+              {...messages.overlayContent}
+              values={{ diskSpaceRequired: prettysize(diskSpaceRequired) }}
+            />
+          </p>
+
+        </div>
+
+      </div>
+    );
+  }
+
+}