Merge pull request #2967 from input-output-hk/fix/ddw-1088-no-progress-on-win-splash-screen

Author: danielmain

CHANGELOG.md

@@ -13,6 +13,7 @@
 
 ### Fixes
 
+- Fixed no progress shown on loading screen on Windows ([PR 2967](https://github.com/input-output-hk/daedalus/pull/2967))
 - Fixes hardware wallet issues on Windows ([PR 2900](https://github.com/input-output-hk/daedalus/pull/2900))
 - Fixed stake pool list styling ([PR 2920](https://github.com/input-output-hk/daedalus/pull/2920))
 - Fixed PopOver overlap ([PR 2954](https://github.com/input-output-hk/daedalus/pull/2954))

source/common/ipc/api.ts

@@ -14,6 +14,7 @@ import type { GenerateVotingPDFParams } from '../types/voting-pdf-request.types'
 import type { GenerateCsvParams } from '../types/csv-request.types';
 import type { GenerateQRCodeParams } from '../types/save-qrCode.types';
 import type {
+  BlockSyncProgress,
   BlockSyncType,
   CardanoNodeState,
   CardanoStatus,
@@ -458,10 +459,7 @@ export type IntrospectAddressMainResponse = IntrospectAddressResponse;
 export const GET_BLOCK_SYNC_PROGRESS_CHANNEL = 'GetBlockSyncProgressChannel';
 export type GetBlockSyncProgressType = BlockSyncType;
 export type GetBlockSyncProgressRendererRequest = void;
-export type GetBlockSyncProgressMainResponse = {
-  progress: number;
-  type: GetBlockSyncProgressType;
-};
+export type GetBlockSyncProgressMainResponse = BlockSyncProgress;
 
 /**
  * Channels for connecting / interacting with Hardware Wallet devices

source/common/types/cardano-node.types.ts

@@ -6,6 +6,7 @@ import {
   ALONZO_PURPLE,
   SELFNODE,
 } from './environment.types';
+import { GetBlockSyncProgressType } from '../ipc/api';
 
 export type TlsConfig = {
   hostname: string;
@@ -159,8 +160,11 @@ export const NetworkMagics: {
   // Cardano Selfnode network magic
   [SELFNODE]: [1, null],
 };
+
 export enum BlockSyncType {
   pushingLedger = 'pushingLedger',
   replayedBlock = 'replayedBlock',
   validatingChunk = 'validatingChunk',
 }
+
+export type BlockSyncProgress = Record<GetBlockSyncProgressType, number>;

source/main/utils/handleCheckBlockReplayProgress.ts

@@ -4,9 +4,13 @@ import moment from 'moment';
 import path from 'path';
 import { Tail } from 'tail';
 import { getBlockSyncProgressChannel } from '../ipc/get-block-sync-progress';
-import type { GetBlockSyncProgressType } from '../../common/ipc/api';
-import { BlockSyncType } from '../../common/types/cardano-node.types';
+import {
+  BlockSyncProgress,
+  BlockSyncType,
+} from '../../common/types/cardano-node.types';
 import { isItFreshLog } from './blockSyncProgressHelpers';
+import { environment } from '../environment';
+import { logger } from './logging';
 
 const blockKeyword = 'Replayed block';
 const validatingChunkKeyword = 'Validating chunk';
@@ -20,7 +24,7 @@ const progressKeywords = [
   ledgerKeyword,
 ];
 
-const keywordTypeMap: Record<string, GetBlockSyncProgressType> = {
+const keywordTypeMap: Record<string, BlockSyncType> = {
   [blockKeyword]: BlockSyncType.replayedBlock,
   [validatingChunkKeyword]: BlockSyncType.validatingChunk,
   [validatedChunkKeyword]: BlockSyncType.validatingChunk,
@@ -31,7 +35,7 @@ function containProgressKeywords(line: string) {
   return progressKeywords.some((keyword) => line.includes(keyword));
 }
 
-function getProgressType(line: string): GetBlockSyncProgressType | null {
+function getProgressType(line: string): BlockSyncType | null {
   const key = progressKeywords.find((k) => line.includes(k));
 
   if (!key) {
@@ -43,35 +47,94 @@ function getProgressType(line: string): GetBlockSyncProgressType | null {
 
 const applicationStartDate = moment.utc();
 
-export const handleCheckBlockReplayProgress = (
-  mainWindow: BrowserWindow,
-  logsDirectoryPath: string
-) => {
-  const filename = 'node.log';
-  const logFilePath = `${logsDirectoryPath}/pub/`;
-  const filePath = path.join(logFilePath, filename);
-  if (!fs.existsSync(filePath)) return;
-
-  const tail = new Tail(filePath);
+const createHandleNewLogLine = (mainWindow: BrowserWindow) => {
+  const progressReport: BlockSyncProgress = {
+    [BlockSyncType.validatingChunk]: 0,
+    [BlockSyncType.replayedBlock]: 0,
+    [BlockSyncType.pushingLedger]: 0,
+  };
 
-  tail.on('line', (line) => {
+  return (line: string) => {
     if (
       !isItFreshLog(applicationStartDate, line) ||
       !containProgressKeywords(line)
     ) {
       return;
     }
 
-    const percentage = line.match(/Progress:([\s\d.,]+)%/)?.[1];
-    const progressType = getProgressType(line);
-    if (!percentage || !progressType) {
+    const unparsedProgress = line.match(/Progress:([\s\d.,]+)%/)?.[1];
+    const type = getProgressType(line);
+    if (!unparsedProgress || !type) {
       return;
     }
-    const finalProgressPercentage = parseFloat(percentage);
-    // Send result to renderer process (NetworkStatusStore)
-    getBlockSyncProgressChannel.send(
-      { progress: finalProgressPercentage, type: progressType },
-      mainWindow.webContents
-    );
+
+    const progress = Math.floor(parseFloat(unparsedProgress));
+
+    if (progressReport[type] !== progress) {
+      progressReport[type] = progress;
+      getBlockSyncProgressChannel.send(progressReport, mainWindow.webContents);
+    }
+  };
+};
+
+const watchLogFile = ({
+  logFilePath,
+  mainWindow,
+}: {
+  logFilePath: string;
+  mainWindow: BrowserWindow;
+}) => {
+  const tail = new Tail(logFilePath, {
+    // using fs.watchFile instead of fs.watch on Windows because of Node API issues:
+    // https://github.com/nodejs/node/issues/36888
+    // https://github.com/lucagrulla/node-tail/issues/137
+    // https://nodejs.org/dist/latest-v14.x/docs/api/fs.html#fs_caveats
+    useWatchFile: environment.isWindows,
+    fromBeginning: true,
   });
+
+  const handleNewLogLine = createHandleNewLogLine(mainWindow);
+  tail.on('line', handleNewLogLine);
+};
+
+const waitForLogFileToBeCreatedAndWatchIt = ({
+  logFileName,
+  logFileDirPath,
+  mainWindow,
+}: {
+  logFileName: string;
+  logFileDirPath: string;
+  mainWindow: BrowserWindow;
+}) => {
+  const watcher = fs.watch(logFileDirPath, {}, (eventName, file) => {
+    if (eventName === 'rename' && logFileName === file) {
+      watchLogFile({
+        logFilePath: path.join(logFileDirPath, logFileName),
+        mainWindow,
+      });
+      watcher.close();
+    }
+  });
+};
+
+export const handleCheckBlockReplayProgress = (
+  mainWindow: BrowserWindow,
+  logsDirectoryPath: string
+) => {
+  const logFileName = 'node.log';
+  const logFileDirPath = `${logsDirectoryPath}/pub/`;
+  const logFilePath = path.join(logFileDirPath, logFileName);
+
+  if (!fs.existsSync(logFilePath)) {
+    waitForLogFileToBeCreatedAndWatchIt({
+      logFileDirPath,
+      logFileName,
+      mainWindow,
+    });
+  } else {
+    watchLogFile({
+      logFilePath,
+      mainWindow,
+    });
+  }
 };

source/renderer/app/components/loading/syncing-connecting/SyncingProgress/SyncingProgress.tsx

@@ -79,7 +79,7 @@ const SyncingProgress: FC<Props> = (props, { intl }: Context) => (
           key={type}
           className={makePercentageCellStyles(props[type] === 100)}
         >
-          {Math.floor(props[type])}%
+          {props[type]}%
         </div>
       ))}
     </div>

source/renderer/app/stores/NetworkStatusStore.ts

@@ -805,14 +805,10 @@ export default class NetworkStatusStore extends Store {
     return Promise.resolve();
   };
 
-  @action _onBlockSyncProgressUpdate = async ({
-    progress,
-    type,
-  }: GetBlockSyncProgressMainResponse) => {
-    this.blockSyncProgress = {
-      ...this.blockSyncProgress,
-      [type]: progress,
-    };
+  @action _onBlockSyncProgressUpdate = async (
+    blockSyncProgress: GetBlockSyncProgressMainResponse
+  ) => {
+    this.blockSyncProgress = blockSyncProgress;
   };
 
   @action

storybook/stories/nodes/syncing/SyncingConnecting.stories.tsx

@@ -13,7 +13,7 @@ const makeProgressValueKnob = ({ name, value }) =>
     range: true,
     min: 0,
     max: 100,
-    step: 0.01,
+    step: 1,
   });
 
 const makeBlockSyncProgress = () => ({
@@ -23,7 +23,7 @@ const makeBlockSyncProgress = () => ({
   }),
   [BlockSyncType.replayedBlock]: makeProgressValueKnob({
     name: 'Replaying ledger from on-disk blockchain',
-    value: 99.9,
+    value: 99,
   }),
   [BlockSyncType.pushingLedger]: makeProgressValueKnob({
     name: 'Syncing blockchain',