[DDW-269] Automatic Daedalus updates

CHANGELOG.md

@@ -91,6 +91,10 @@ Changelog
 
 ## 2.0.0-RC1
 
+### Features
+
+- Implemented Daedalus app automatic update ([PR 2056](https://github.com/input-output-hk/daedalus/pull/2056))
+
 ### Fixes
 
 - Fixed the epoch duration copy ([PR 2107](https://github.com/input-output-hk/daedalus/pull/2107))

default.nix

@@ -333,12 +333,7 @@ let
       runLint = self.callPackage ./tests/lint.nix {};
       runShellcheck = self.callPackage ./tests/shellcheck.nix { src = ./.;};
     };
-    nix-bundle = import (pkgs.fetchFromGitHub {
-      owner = "matthewbauer";
-      repo = "nix-bundle";
-      rev = "7f12322399fd87d937355d0fc263d37d798496fc";
-      sha256 = "07wnmdadchf73p03wk51abzgd3zm2xz5khwadz1ypbvv3cqlzp5m";
-    }) { nixpkgs = pkgs; };
+    nix-bundle = import sources.nix-bundle { nixpkgs = pkgs; };
     iconPath = self.launcherConfigs.installerConfig.iconPath;
     # used for name of profile, binary and the desktop shortcut
     linuxClusterBinName = cluster;

installers/nix/nix-installer.nix

@@ -8,6 +8,8 @@ let
     target = "${installer}";
     run = "/bin/installer";
     nixUserChrootFlags = "-c -m /home:/home -p HOME";
+    rmStyle = "-rm_";
+    shared = false;
   };
   utils = pkgs.writeText "utils.sh" ''
     function rmrf {
@@ -29,24 +31,38 @@ let
     pwd
     id
     UNPACK=$(mktemp -d)
-    cd $UNPACK
-    echo "$@"
-    bash "$1" --extract
-    ls -ltrh dat/nix/store/*-tarball/tarball/tarball.tar.xz
-    UNPACK2=$(mktemp -d)
-    tar --delay-directory-restore -C $UNPACK2 -xf dat/nix/store/*-tarball/tarball/tarball.tar.xz
-    cd
+    pushd $UNPACK
+      echo "$@"
+      echo STATUS decompressing
+      echo PROG 1/6
+      bash "$1" --extract
+      ls -ltrh dat/nix/store/*-tarball/tarball/tarball.tar.xz
+      UNPACK2=$(mktemp -d)
+      echo STATUS unpacking
+      echo PROG 2/6
+      tar --delay-directory-restore -C $UNPACK2 -xf dat/nix/store/*-tarball/tarball/tarball.tar.xz
+    popd
+    echo STATUS removing temp files
+    echo PROG 3/6
     rmrf $UNPACK
     ls -ltrh $UNPACK2
+    echo STATUS copying files
+    echo PROG 3/6
     NIX_REMOTE=local?root=$UNPACK2 nix-store --load-db < $UNPACK2/nix-path-registration
     NIX_REMOTE=local?root=$UNPACK2 nix-store --verify --check-contents
     nix copy --no-check-sigs --from local?root=$UNPACK2 $(readlink $UNPACK2/firstGeneration)
     export NIX_PROFILE=/nix/var/nix/profiles/profile
     nix-env --set $(readlink $UNPACK2/firstGeneration)
     nix-env -p /nix/var/nix/profiles/profile-${linuxClusterBinName} --set $(readlink $UNPACK2/firstGeneration)
+    echo STATUS cleaning up
+    echo PROG 4/6
     rmrf $UNPACK2
 
+    echo STATUS post-install
+    echo PROG 5/6
     post-install || true
+    echo STATUS done
+    echo PROG 6/6
   '';
   enter = pkgs.writeScriptBin "enter-chroot" ''
     #!/usr/bin/env bash
@@ -86,6 +102,7 @@ let
     ln -svf ${pkgs.cacert}/etc/ssl/certs/ca-bundle.crt /etc/ssl/certs/ca-certificates.crt
     ln -svf ${pkgs.cacert}/etc/ssl/certs/ca-bundle.crt /etc/ssl/certs/ca-bundle.crt
     unset NIX_SSL_CERT_FILE
+    export USER=daedalus
 
     if [ -z "$@" ]; then
       exec bash

nix/launcher-config.nix

@@ -151,6 +151,7 @@ let
     inherit logsPrefix launcherLogsPrefix tlsConfig;
     walletLogging = false;
     daedalusBin = mkBinPath "frontend";
+    updateRunnerBin = mkBinPath "update-runner";
     # TODO: set when update system is complete
     updaterArgs = [];
     updaterPath = "";

nix/sources.json

@@ -96,6 +96,18 @@
         "url": "https://github.com/input-output-hk/niv/archive/4229fbcf62997467c34283a2f353702359e78e5a.tar.gz",
         "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
     },
+    "nix-bundle": {
+        "branch": "rm-style",
+        "description": "Bundle Nix derivations to run anywhere!",
+        "homepage": "",
+        "owner": "input-output-hk",
+        "repo": "nix-bundle",
+        "rev": "acf3b142c1fa332d4f9050e7cdfb3c3f8091e78b",
+        "sha256": "0pcc8bh1x3shr6k2h8zw05n0apm5ppx6nk07xp89ljldah4mmc6c",
+        "type": "tarball",
+        "url": "https://github.com/input-output-hk/nix-bundle/archive/acf3b142c1fa332d4f9050e7cdfb3c3f8091e78b.tar.gz",
+        "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"
+    },
     "nixpkgs-nsis": {
         "branch": "nsis",
         "description": "A read-only mirror of NixOS/nixpkgs tracking the released channels. Send issues and PRs to",

package.json

@@ -229,6 +229,7 @@
     "rust-cardano-crypto": "0.2.0",
     "safe-buffer": "5.2.0",
     "semver": "7.1.3",
+    "shasum": "1.0.2",
     "source-map-support": "0.5.16",
     "spectron-fake-dialog": "0.0.1",
     "unorm": "1.6.0",

source/common/config/appupdateConfig.js

@@ -0,0 +1,12 @@
+// @flow
+import type { UpdateInstallationStatus } from '../types/app-update.types';
+
+export const APP_UPDATE_DOWNLOAD_ID = 'appUpdate';
+
+export const UPDATE_INSTALLATION_STATUSES: {
+  [key: string]: UpdateInstallationStatus,
+} = {
+  PROGRESS: 'progress',
+  ERROR: 'error',
+  SUCCESS: 'success',
+};

source/common/config/downloadManagerConfig.js

@@ -38,6 +38,8 @@ export const DOWNLOAD_EVENT_TYPES: {
   PROGRESS: 'progress',
   END: 'end',
   TIMEOUT: 'timeout',
+  STOP: 'stop',
+  PAUSE: 'pause',
   ERROR: 'error',
 };
 
@@ -49,7 +51,7 @@ export const TEMPORARY_FILENAME = {
   extension: 'crdownload',
 };
 
-export const DOWNLOAD_PROGRESS_DEFAULT = {
+export const DOWNLOAD_DATA_DEFAULT = {
   state: DOWNLOAD_STATES.IDLE,
   remainingSize: 0,
   serverFileSize: 0,
@@ -60,3 +62,5 @@ export const DOWNLOAD_PROGRESS_DEFAULT = {
   incomplete: false,
   isResumed: false,
 };
+
+export const ERROR_TIME_AFTER_NO_END_EVENT = 10 * 1000; // 10 seconds | unit: milliseconds

source/common/config/electron-store.config.js

@@ -26,4 +26,6 @@ export const STORAGE_KEYS: {
   WALLETS: 'WALLETS',
   WALLET_MIGRATION_STATUS: 'WALLET-MIGRATION-STATUS',
   DOWNLOAD_MANAGER: 'DOWNLOAD-MANAGER',
+  APP_AUTOMATIC_UPDATE_FAILED: 'APP-AUTOMATIC-UPDATE-FAILED',
+  APP_UPDATE_COMPLETED: 'APP-UPDATE-COMPLETED',
 };

source/common/ipc/api.js

@@ -36,6 +36,11 @@ import type {
   DownloadResponse,
   ResumeDownloadRequest,
   ResumeDownloadResponse,
+  ClearDownloadLocalDataRequest,
+  ClearDownloadLocalDataResponse,
+  DeleteDownloadedFileRequest,
+  DeleteDownloadedFileResponse,
+  CheckFileExistsRequest,
 } from '../types/downloadManager.types';
 import type { StoreMessage } from '../types/electron-store.types';
 import type {
@@ -297,6 +302,27 @@ export type ShowSaveDialogMainResponse = SaveFileDialogResponseParams;
 export const ELECTRON_STORE_CHANNEL = 'ELECTRON_STORE_CHANNEL';
 export type ElectronStoreMessage = StoreMessage;
 
+/**
+ * Channel for requesting a new download
+ */
+export const REQUEST_DOWNLOAD = 'REQUEST_DOWNLOAD';
+export type DownloadRendererRequest = DownloadRequest;
+export type DownloadMainResponse = DownloadResponse;
+
+/**
+ * Channel for resuming an existing download
+ */
+export const RESUME_DOWNLOAD = 'RESUME_DOWNLOAD';
+export type ResumeDownloadRendererRequest = ResumeDownloadRequest;
+export type ResumeDownloadMainResponse = ResumeDownloadResponse | void;
+
+/**
+ * Channel for resuming an existing download
+ */
+export const DELETE_DOWNLOADED_FILE = 'DELETE_DOWNLOADED_FILE';
+export type DeleteDownloadedFileRendererRequest = DeleteDownloadedFileRequest;
+export type DeleteDownloadedFileMainResponse = DeleteDownloadedFileResponse | void;
+
 /**
  * Channel for initiating the download manager
  */
@@ -312,18 +338,37 @@ export type DownloadsLocalDataRendererRequest = DownloadsLocalDataRequest | void
 export type DownloadsLocalDataMainResponse = DownloadsLocalDataResponse | void;
 
 /**
- * Channel for requesting a new download
+ * Channel for initiating the download manager
  */
-export const REQUEST_DOWNLOAD = 'REQUEST_DOWNLOAD';
-export type DownloadRendererRequest = DownloadRequest;
-export type DownloadMainResponse = DownloadResponse;
+export const CLEAR_DOWNLOAD_LOCAL_DATA = 'CLEAR_DOWNLOAD_LOCAL_DATA';
+export type ClearDownloadLocalDataRendererRequest = ClearDownloadLocalDataRequest;
+export type ClearDownloadLocalDataMainResponse = ClearDownloadLocalDataResponse;
 
 /**
- * Channel for requesting a new download
+ * Channel for checking if the downloaded file still exists
  */
-export const RESUME_DOWNLOAD = 'RESUME_DOWNLOAD';
-export type ResumeDownloadRendererRequest = ResumeDownloadRequest;
-export type ResumeDownloadMainResponse = ResumeDownloadResponse | void;
+export const CHECK_FILE_EXISTS = 'CHECK_FILE_EXISTS';
+export type CheckFileExistsRendererRequest = CheckFileExistsRequest;
+export type CheckFileExistsMainResponse = boolean;
+
+/**
+ * Channel for quitting Daedalus and installing update
+ */
+export const MANAGE_APP_UPDATE = 'MANAGE_APP_UPDATE';
+export type ManageAppUpdateRendererRequest = {
+  filePath: string,
+  hash: string,
+};
+export type ManageAppUpdateMainResponse = {
+  status: 'progress' | 'success' | 'error',
+  data: {
+    message?: string,
+    progress?: number,
+    code?: number,
+    error?: Error,
+    info?: Object,
+  },
+};
 
 /**
  * Channel for introspecting an address

source/common/types/app-update.types.js

@@ -0,0 +1,3 @@
+// @flow
+
+export type UpdateInstallationStatus = 'progress' | 'error' | 'success';

source/common/types/downloadManager.types.js

@@ -34,6 +34,8 @@ export type DownloadRequestOptions = {
   override?: boolean, // if true it will override the file, otherwise will append '(number)' to the end of file
   httpRequestOptions?: Object, // Override the http request options
   httpsRequestOptions?: Object, // Override the https request options, ex: to add SSL Certs
+  progressIsThrottled?: boolean, // by default, the progress is sent every second. if `false` it will be sent every milisecond
+  persistLocalData?: boolean, // by default, the localdata information is deleted after the end of the download
 };
 
 // https://www.npmjs.com/package/node-downloader-helper
@@ -55,26 +57,28 @@ export type DownloadEventType =
   | 'progress'
   | 'end'
   | 'timeout'
+  | 'stop'
+  | 'pause'
   | 'error';
 
 export type DownloadResponse = {
   eventType: DownloadEventType,
+  info: DownloadInfo,
   data: DownloadData,
-  progress: DownloadProgress,
+  error?: string,
 };
 
-export type DownloadData = {
+export type DownloadInfo = {
   downloadId: string,
   fileUrl: string,
   originalFilename: string,
   temporaryFilename: string,
   destinationDirectoryName: AllowedDownloadDirectories,
   destinationPath: string,
   options: DownloadRequestOptions,
-  persistLocalData?: boolean,
 };
 
-export type DownloadProgress = {
+export type DownloadData = {
   state: DownloadState,
   remainingSize: number,
   serverFileSize: number,
@@ -87,7 +91,7 @@ export type DownloadProgress = {
   error?: string,
 };
 
-export type DownloadProgressUpdate = {
+export type DownloadDataUpdate = {
   state?: DownloadState,
   remainingSize?: number,
   serverFileSize?: number,
@@ -104,7 +108,7 @@ export type DownloadProgressUpdate = {
  *
  * Each event has a different response
  * which is formatted and so the Main IPC
- * response has always the DownloadProgress shape
+ * response has always the DownloadData shape
  *
  */
 
@@ -133,31 +137,37 @@ export type DownloadInfoEnd = {
 };
 export type DownloadInfoError = {
   message: string, // Error message
-  status: string, // Http status response if available
-  body: string, // Http body response if available
+  status?: string, // Http status response if available
+  body?: string, // Http body response if available
 };
 
 export type DownloadLocalDataRequest = {
   fileName?: string,
   id?: string,
 };
-
 export type DownloadLocalDataResponse = {
-  data: DownloadData,
-  progress: DownloadProgress,
+  info?: DownloadInfo,
+  data?: DownloadData,
 };
 
 export type DownloadsLocalDataRequest = {
   state: DownloadState,
 };
-
 export type DownloadsLocalDataResponse = {
-  [key: string]: DownloadsLocalDataResponse,
+  [key: string]: DownloadLocalDataResponse,
 };
 
-export type ResumeDownloadRequest = {
-  fileName?: string,
+export type ResumeDownloadRequest = DownloadLocalDataRequest;
+export type ResumeDownloadResponse = DownloadResponse | void;
+
+export type ClearDownloadLocalDataRequest = DownloadLocalDataRequest;
+export type ClearDownloadLocalDataResponse = void;
+
+export type DeleteDownloadedFileRequest = {
   id?: string,
 };
+export type DeleteDownloadedFileResponse = void;
 
-export type ResumeDownloadResponse = DownloadResponse | void;
+export type CheckFileExistsRequest = {
+  id?: string,
+};

source/common/types/electron-store.types.js

@@ -15,7 +15,9 @@ export type StorageKey =
   | 'READ-NEWS'
   | 'WALLETS'
   | 'WALLET-MIGRATION-STATUS'
-  | 'DOWNLOAD-MANAGER';
+  | 'DOWNLOAD-MANAGER'
+  | 'APP-AUTOMATIC-UPDATE-FAILED'
+  | 'APP-UPDATE-COMPLETED';
 
 export type StoreMessage = {
   type: StorageType,

source/common/types/environment.types.js

@@ -67,6 +67,8 @@ export const OS_NAMES = {
   [LINUX]: 'Linux',
 };
 
+export type Platform = 'darwin' | 'win32' | 'linux';
+
 export type Network =
   | 'mainnet'
   | 'mainnet_flight'

source/common/types/locales.types.js

@@ -13,3 +13,10 @@ export const humanizedDurationLanguages = {
   'en-US': 'en',
   'ja-JP': 'ja',
 };
+
+export const momentLocales: {
+  [key: Locale]: string,
+} = {
+  'en-US': 'en-us',
+  'ja-JP': 'ja',
+};