[DDW-964] Showing progress of all three sync types at once on loading screen (#2877)

Co-authored-by: Daniel Main <[email protected]>
Co-authored-by: Renan Ferreira <[email protected]>

Author: 3 people

.eslintrc

@@ -69,7 +69,7 @@
     "react/no-array-index-key": "warn",
     "react/no-unused-prop-types": "warn",
     "react/prefer-stateless-function": 0,
-    "react/prop-types": "warn",
+    "react/prop-types": 0,
     "react/require-default-props": 0,
     "react/jsx-first-prop-new-line": [1, "multiline-multiprop"],
     "@typescript-eslint/ban-ts-comment": 1,

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Features
 
+- Improve the syncing screen by showing syncing progress split into three stages ([PR 2877](https://github.com/input-output-hk/daedalus/pull/2877))
 - Improved stake pool searchbar ([PR 2847](https://github.com/input-output-hk/daedalus/pull/2847))
 - Implemented catalyst dynamic content ([PR 2856](https://github.com/input-output-hk/daedalus/pull/2856))
 

source/common/ipc/api.ts

@@ -183,6 +183,7 @@ export enum WalletSettingsStateEnum {
   disabled = 'disabled',
   enabled = 'enabled',
 }
+
 export const REBUILD_APP_MENU_CHANNEL = 'REBUILD_APP_MENU_CHANNEL';
 export type RebuildAppMenuRendererRequest = {
   isNavigationEnabled: boolean;
@@ -451,7 +452,7 @@ export type IntrospectAddressMainResponse = IntrospectAddressResponse;
 /**
  * Channel for checking block replay progress
  */
-export const GET_BLOCK_SYNC_STATUS_CHANNEL = 'GetBlockSyncProgressChannel';
+export const GET_BLOCK_SYNC_PROGRESS_CHANNEL = 'GetBlockSyncProgressChannel';
 export type GetBlockSyncProgressType = BlockSyncType;
 export type GetBlockSyncProgressRendererRequest = void;
 export type GetBlockSyncProgressMainResponse = {

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

@@ -159,7 +159,8 @@ export const NetworkMagics: {
   // Cardano Selfnode network magic
   [SELFNODE]: [1, null],
 };
-export type BlockSyncType =
-  | 'validatingChunk'
-  | 'pushingLedger'
-  | 'replayedBlock';
+export enum BlockSyncType {
+  pushingLedger = 'pushingLedger',
+  replayedBlock = 'replayedBlock',
+  validatingChunk = 'validatingChunk',
+}

source/main/ipc/get-block-sync-progress.ts

@@ -1,5 +1,5 @@
 import { MainIpcChannel } from './lib/MainIpcChannel';
-import { GET_BLOCK_SYNC_STATUS_CHANNEL } from '../../common/ipc/api';
+import { GET_BLOCK_SYNC_PROGRESS_CHANNEL } from '../../common/ipc/api';
 import type {
   GetBlockSyncProgressRendererRequest,
   GetBlockSyncProgressMainResponse,
@@ -10,4 +10,4 @@ import type {
 export const getBlockSyncProgressChannel: MainIpcChannel<
   GetBlockSyncProgressRendererRequest,
   GetBlockSyncProgressMainResponse
-> = new MainIpcChannel(GET_BLOCK_SYNC_STATUS_CHANNEL);
+> = new MainIpcChannel(GET_BLOCK_SYNC_PROGRESS_CHANNEL);

source/main/utils/blockSyncProgressHelpers.spec.ts

@@ -0,0 +1,28 @@
+import moment from 'moment';
+import { isItFreshLog } from './blockSyncProgressHelpers';
+
+describe('blockSyncProgressHelpers', () => {
+  it('should return true for newer logs', () => {
+    const time = '2022-02-18 13:18:47.66';
+    const applicationStartDate = moment.utc(time).add(-1, 'minute');
+    const line = `[34m[XX-M:cardano.node.ChainDB:Info:30][0m [${time} UTC] Validating chunk no. 2256 out of 2256. Progress: 99.96%`;
+
+    expect(isItFreshLog(applicationStartDate, line)).toBe(true);
+  });
+
+  it('should return false for logs of same time', () => {
+    const time = '2022-02-18 13:18:47.66';
+    const applicationStartDate = moment.utc(time);
+    const line = `[34m[XX-M:cardano.node.ChainDB:Info:30][0m [${time} UTC] Validating chunk no. 2256 out of 2256. Progress: 99.96%`;
+
+    expect(isItFreshLog(applicationStartDate, line)).toBe(false);
+  });
+
+  it('should return false for older logs', () => {
+    const time = '2022-02-18 13:18:47.66';
+    const applicationStartDate = moment.utc(time).add(1, 'minute');
+    const line = `[34m[XX-M:cardano.node.ChainDB:Info:30][0m [${time} UTC] Validating chunk no. 2256 out of 2256. Progress: 99.96%`;
+
+    expect(isItFreshLog(applicationStartDate, line)).toBe(false);
+  });
+});

source/main/utils/blockSyncProgressHelpers.ts

@@ -0,0 +1,8 @@
+import moment, { Moment } from 'moment';
+
+export function isItFreshLog(applicationStartDate: Moment, line: string) {
+  const [, logDate] = line.match(
+    /\[(\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2}\.\d+) UTC]/
+  );
+  return applicationStartDate.isBefore(moment.utc(logDate));
+}

source/main/utils/handleCheckBlockReplayProgress.ts

@@ -1,10 +1,13 @@
 import { BrowserWindow } from 'electron';
 import fs from 'fs';
+import moment, { Moment } from 'moment';
 import readline from 'readline';
 import path from 'path';
 import { getBlockSyncProgressChannel } from '../ipc/get-block-sync-progress';
 import type { GetBlockSyncProgressType } from '../../common/ipc/api';
 import { BLOCK_REPLAY_PROGRESS_CHECK_INTERVAL } from '../config';
+import { BlockSyncType } from '../../common/types/cardano-node.types';
+import { isItFreshLog } from './blockSyncProgressHelpers';
 
 const blockKeyword = 'Replayed block';
 const validatingChunkKeyword = 'Validating chunk';
@@ -18,15 +21,11 @@ const progressKeywords = [
   ledgerKeyword,
 ];
 
-type KeywordTypeMap = {
-  [name: string]: GetBlockSyncProgressType;
-};
-
-const keywordTypeMap: KeywordTypeMap = {
-  [blockKeyword]: 'replayedBlock',
-  [validatingChunkKeyword]: 'validatingChunk',
-  [validatedChunkKeyword]: 'validatingChunk',
-  [ledgerKeyword]: 'pushingLedger',
+const keywordTypeMap: Record<string, GetBlockSyncProgressType> = {
+  [blockKeyword]: BlockSyncType.replayedBlock,
+  [validatingChunkKeyword]: BlockSyncType.validatingChunk,
+  [validatedChunkKeyword]: BlockSyncType.validatingChunk,
+  [ledgerKeyword]: BlockSyncType.pushingLedger,
 };
 
 function containProgressKeywords(line: string) {
@@ -43,6 +42,8 @@ function getProgressType(line: string): GetBlockSyncProgressType | null {
   return keywordTypeMap[key];
 }
 
+const applicationStartDate = moment.utc();
+
 export const handleCheckBlockReplayProgress = (
   mainWindow: BrowserWindow,
   logsDirectoryPath: string
@@ -59,7 +60,10 @@ export const handleCheckBlockReplayProgress = (
     const progress = [];
 
     for await (const line of rl) {
-      if (containProgressKeywords(line)) {
+      if (
+        containProgressKeywords(line) &&
+        isItFreshLog(applicationStartDate, line)
+      ) {
         progress.push(line);
       }
     }