[DDW-656] Log Daedalus state snapshot

CHANGELOG.md

@@ -5,6 +5,7 @@ Changelog
 
 ### Features
 
+- Added Daedalus state snapshot log file "State-snapshot.json" on Download logs action ([PR 1456](https://github.com/input-output-hk/daedalus/pull/1456))
 - Implemented no-wallets case on the Delegation Center screen ([PR 1463](https://github.com/input-output-hk/daedalus/pull/1463))
 - Implemented the animated Daedalus logo on the "Loading" screens ([PR 1457](https://github.com/input-output-hk/daedalus/pull/1457))
 - Implemented "Delegation Setup wizard" steps 3 & 4 UI ([PR 1439](https://github.com/input-output-hk/daedalus/pull/1439))

source/common/ipc/api.js

@@ -18,6 +18,7 @@ import type { RedemptionTypeChoices } from '../../renderer/app/types/redemptionT
 import type { CheckDiskSpaceResponse } from '../types/no-disk-space.types';
 import type { LogFiles } from '../../renderer/app/types/LogTypes';
 import type { GpuStatus } from '../../renderer/app/types/gpuStatus';
+import type { LogStateSnapshotParams } from '../types/logging.types';
 
 /**
  * ======================= IPC CHANNELS API =========================
@@ -77,6 +78,13 @@ export const GET_STATE_DIRECTORY_PATH_CHANNEL = 'GetStateDirectoryPathChannel';
 export type GetStateDirectoryPathRendererRequest = string | any;
 export type GetStateDirectoryPathMainResponse = any;
 
+/**
+ * Channel for setting log state snapshot
+ */
+export const SET_LOG_STATE_SNAPSHOT_CHANNEL = 'SetLogStateSnapshotChannel';
+export type SetLogStateSnapshotRendererRequest = LogStateSnapshotParams | any;
+export type SetLogStateSnapshotMainResponse = LogStateSnapshotParams | any;
+
 /**
  * Channel for loading a base64 encoded asset from within the `source/renderer` folder
  */

source/common/ipc/constants.js

@@ -16,3 +16,7 @@ export const ERRORS = {
 export const NOTIFICATIONS = {
   DOWNLOAD_LOGS: 'DOWNLOAD_LOGS_NOTIFICATION',
 };
+
+export const STATE_SNAPSHOT = {
+  LOG: 'LOG',
+};

source/common/types/logging.types.js

@@ -1,4 +1,6 @@
 // @flow
+import type { CardanoNodeState } from './cardano-node.types';
+
 export type FormatMessageContextParams = {
   appName: string,
   electronProcess: string,
@@ -48,3 +50,44 @@ export type LogSystemInfoParams = {
   ram: string,
   startTime: string,
 };
+
+export type LogStateSnapshotParams = {
+  availableDiskSpace: string,
+  cardanoAPIPort: number,
+  cardanoNetwork: string,
+  cardanoNodeState: CardanoNodeState | any,
+  cardanoProcessID: number,
+  cardanoVersion: string,
+  cpu: string,
+  current: string,
+  currentLocale: string,
+  daedalusVersion: string,
+  daedalusMainProcessID: string,
+  daedalusProcessID: string,
+  daedalusStateDirectoryPath: string,
+  isConnected: boolean,
+  isDev: boolean,
+  isForceCheckingNodeTime: boolean,
+  isInSafeMode: boolean,
+  isMainnet: boolean,
+  isNodeInSync: boolean,
+  isNodeResponding: boolean,
+  isNodeSubscribed: boolean,
+  isNodeSyncing: boolean,
+  isNodeTimeCorrect: boolean,
+  isStaging: boolean,
+  isSynced: boolean,
+  isSystemTimeCorrect: boolean,
+  isSystemTimeIgnored: boolean,
+  isTestnet: boolean,
+  latestLocalBlockTimestamp: number,
+  latestNetworkBlockTimestamp: number,
+  localBlockHeight: number,
+  localTimeDifference: ?number,
+  networkBlockHeight: number,
+  platform: string,
+  platformVersion: string,
+  ram: string,
+  startTime: string,
+  syncPercentage: number,
+};

source/main/config.js

@@ -66,6 +66,7 @@ export const ALLOWED_LOGS = [
   'Daedalus.json',
   'System-info.json',
   'Daedalus-versions.json',
+  'State-snapshot.json',
 ];
 export const ALLOWED_NODE_LOGS = new RegExp(/(node.json-)(\d{14}$)/);
 export const ALLOWED_LAUNCHER_LOGS = new RegExp(/(launcher-)(\d{14}$)/);

source/main/index.js

@@ -4,7 +4,11 @@ import path from 'path';
 import { app, BrowserWindow, shell } from 'electron';
 import { client } from 'electron-connect';
 import { Logger } from './utils/logging';
-import { setupLogging, logSystemInfo } from './utils/setupLogging';
+import {
+  setupLogging,
+  logSystemInfo,
+  logStateSnapshot,
+} from './utils/setupLogging';
 import { getNumberOfEpochsConsolidated } from './utils/getNumberOfEpochsConsolidated';
 import { handleDiskSpace } from './utils/handleDiskSpace';
 import { createMainWindow } from './windows/main';
@@ -31,6 +35,7 @@ import { getStateDirectoryPathChannel } from './ipc/getStateDirectoryPathChannel
 import { CardanoNodeStates } from '../common/types/cardano-node.types';
 import type { CheckDiskSpaceResponse } from '../common/types/no-disk-space.types';
 import { logUsedVersion } from './utils/logUsedVersion';
+import { setLogStateSnapshotChannel } from './ipc/set-log-state-snapshot';
 
 /* eslint-disable consistent-return */
 
@@ -156,6 +161,10 @@ const onAppReady = async () => {
 
   getNumberOfEpochsConsolidated();
 
+  setLogStateSnapshotChannel.onReceive(data => {
+    return Promise.resolve(logStateSnapshot(data));
+  });
+
   getStateDirectoryPathChannel.onRequest(() =>
     Promise.resolve(stateDirectoryPath)
   );

source/main/ipc/set-log-state-snapshot.js

@@ -0,0 +1,14 @@
+// @flow
+import { MainIpcChannel } from './lib/MainIpcChannel';
+import { SET_LOG_STATE_SNAPSHOT_CHANNEL } from '../../common/ipc/api';
+import type {
+  SetLogStateSnapshotRendererRequest,
+  SetLogStateSnapshotMainResponse,
+} from '../../common/ipc/api';
+
+// IpcChannel<Incoming, Outgoing>
+
+export const setLogStateSnapshotChannel: MainIpcChannel<
+  SetLogStateSnapshotMainResponse,
+  SetLogStateSnapshotRendererRequest
+> = new MainIpcChannel(SET_LOG_STATE_SNAPSHOT_CHANNEL);

source/main/menus/osx.js

@@ -6,7 +6,8 @@ import type { MenuActions } from './MenuActions.types';
 import { getTranslation } from '../utils/getTranslation';
 import { environment } from '../environment';
 import { showUiPartChannel } from '../ipc/control-ui-parts';
-import { NOTIFICATIONS } from '../../common/ipc/constants';
+import { NOTIFICATIONS, STATE_SNAPSHOT } from '../../common/ipc/constants';
+import { setLogStateSnapshotChannel } from '../ipc/set-log-state-snapshot';
 import type { SupportRequests } from '../../common/types/support-requests.types';
 
 const id = 'menu';
@@ -180,6 +181,7 @@ export const osxMenu = (
       {
         label: translation('helpSupport.downloadLogs'),
         click() {
+          setLogStateSnapshotChannel.send(STATE_SNAPSHOT.LOG, window);
           showUiPartChannel.send(NOTIFICATIONS.DOWNLOAD_LOGS, window);
         },
       },

source/main/menus/win-linux.js

@@ -5,8 +5,9 @@ import type { App, BrowserWindow } from 'electron';
 import type { MenuActions } from './MenuActions.types';
 import { getTranslation } from '../utils/getTranslation';
 import { environment } from '../environment';
-import { NOTIFICATIONS } from '../../common/ipc/constants';
+import { NOTIFICATIONS, STATE_SNAPSHOT } from '../../common/ipc/constants';
 import { showUiPartChannel } from '../ipc/control-ui-parts';
+import { setLogStateSnapshotChannel } from '../ipc/set-log-state-snapshot';
 import type { SupportRequests } from '../../common/types/support-requests.types';
 
 const id = 'menu';
@@ -187,6 +188,7 @@ export const winLinuxMenu = (
       {
         label: translation('helpSupport.downloadLogs'),
         click() {
+          setLogStateSnapshotChannel.send(STATE_SNAPSHOT.LOG, window);
           showUiPartChannel.send(NOTIFICATIONS.DOWNLOAD_LOGS, window);
         },
       },

source/main/utils/setupLogging.js

@@ -14,6 +14,7 @@ import type {
   ConstructMessageBodyParams,
   MessageBody,
   LogSystemInfoParams,
+  LogStateSnapshotParams,
 } from '../../common/types/logging.types';
 
 const isTest = process.env.NODE_ENV === 'test';
@@ -94,3 +95,34 @@ export const logSystemInfo = (props: LogSystemInfoParams): MessageBody => {
   fs.writeFileSync(systemInfoFilePath, JSON.stringify(messageBody));
   return messageBody;
 };
+
+export const logStateSnapshot = (
+  props: LogStateSnapshotParams
+): MessageBody => {
+  const { current, ...data } = props;
+  const {
+    daedalusVersion,
+    cardanoVersion,
+    cardanoNetwork,
+    platform,
+    startTime: at,
+  } = data;
+  const env = `${cardanoNetwork}:${platform}:${cardanoVersion}:${daedalusVersion}`;
+  const messageBodyParams: ConstructMessageBodyParams = {
+    at,
+    env,
+    ns: ['daedalus', `v${daedalusVersion}`, `*${current}*`],
+    data,
+    msg: 'Updating State-snapshot.json file',
+    pid: '',
+    sev: 'info',
+    thread: '',
+  };
+  const messageBody: MessageBody = constructMessageBody(messageBodyParams);
+  const stateSnapshotFilePath = path.join(
+    pubLogsFolderPath,
+    'State-snapshot.json'
+  );
+  fs.writeFileSync(stateSnapshotFilePath, JSON.stringify(messageBody));
+  return messageBody;
+};

source/renderer/app/actions/network-status-actions.js

@@ -7,4 +7,5 @@ export default class NetworkStatusActions {
   isSyncedAndReady: Action<any> = new Action();
   tlsConfigIsReady: Action<any> = new Action();
   restartNode: Action<any> = new Action();
+  logStateSnapshot: Action<any> = new Action();
 }

source/renderer/app/containers/loading/SyncingConnectingPage.js

@@ -76,7 +76,8 @@ export default class LoadingSyncingConnectingPage extends Component<Props> {
   };
 
   handleDownloadLogs = () => {
-    const { app } = this.props.actions;
+    const { app, networkStatus } = this.props.actions;
+    networkStatus.logStateSnapshot.trigger();
     app.downloadLogs.trigger();
     app.setNotificationVisibility.trigger(true);
   };

source/renderer/app/containers/settings/categories/SupportSettingsPage.js

@@ -39,7 +39,8 @@ export default class SupportSettingsPage extends Component<InjectedProps> {
   };
 
   handleDownloadLogs = () => {
-    const { app } = this.props.actions;
+    const { app, networkStatus } = this.props.actions;
+    networkStatus.logStateSnapshot.trigger();
     app.downloadLogs.trigger();
     app.setNotificationVisibility.trigger(true);
   };

source/renderer/app/ipc/setLogStateSnapshotChannel.js

@@ -0,0 +1,13 @@
+// @flow
+import { RendererIpcChannel } from './lib/RendererIpcChannel';
+import { SET_LOG_STATE_SNAPSHOT_CHANNEL } from '../../../common/ipc/api';
+import type {
+  SetLogStateSnapshotRendererRequest,
+  SetLogStateSnapshotMainResponse,
+} from '../../../common/ipc/api';
+
+export const setLogStateSnapshotChannel: // IpcChannel<Incoming, Outgoing>
+RendererIpcChannel<
+  SetLogStateSnapshotMainResponse,
+  SetLogStateSnapshotRendererRequest
+> = new RendererIpcChannel(SET_LOG_STATE_SNAPSHOT_CHANNEL);

source/renderer/app/stores/NetworkStatusStore.js

@@ -23,6 +23,7 @@ import {
 import { CardanoNodeStates } from '../../../common/types/cardano-node.types';
 import { getDiskSpaceStatusChannel } from '../ipc/getDiskSpaceChannel.js';
 import { getStateDirectoryPathChannel } from '../ipc/getStateDirectoryPathChannel';
+import { setLogStateSnapshotChannel } from '../ipc/setLogStateSnapshotChannel';
 import type { GetNetworkStatusResponse } from '../api/nodes/types';
 import type {
   CardanoNodeState,
@@ -31,6 +32,7 @@ import type {
 } from '../../../common/types/cardano-node.types';
 import type { NodeInfoQueryParams } from '../api/nodes/requests/getNodeInfo';
 import type { CheckDiskSpaceResponse } from '../../../common/types/no-disk-space.types';
+import type { LogStateSnapshotParams } from '../../../common/types/logging.types';
 import { TlsCertificateNotValidError } from '../api/nodes/errors';
 import { openLocalDirectoryChannel } from '../ipc/open-local-directory';
 import { rebuildApplicationMenu } from '../ipc/rebuild-application-menu';
@@ -122,6 +124,8 @@ export default class NetworkStatusStore extends Store {
     // Passively receive state changes of the cardano-node
     cardanoStateChangeChannel.onReceive(this._handleCardanoNodeStateChange);
 
+    setLogStateSnapshotChannel.onReceive(this._handleLogStateSnapshot);
+
     // ========== MOBX REACTIONS =========== //
 
     this.registerReactions([
@@ -145,6 +149,8 @@ export default class NetworkStatusStore extends Store {
     this._checkDiskSpace();
 
     this._getStateDirectoryPath();
+
+    this.actions.networkStatus.logStateSnapshot.listen(this._logStateSnapshot);
   }
 
   // Setup network status polling interval
@@ -304,6 +310,11 @@ export default class NetworkStatusStore extends Store {
     return Promise.resolve();
   };
 
+  _handleLogStateSnapshot = (): Promise<void> => {
+    this._logStateSnapshot();
+    return Promise.resolve();
+  };
+
   _extractNodeStatus = (from: Object & CardanoStatus): CardanoStatus => {
     const {
       isNodeResponding,
@@ -583,6 +594,17 @@ export default class NetworkStatusStore extends Store {
     openLocalDirectoryChannel.send(path);
   }
 
+  convertBytesToSize = (bytes: number): string => {
+    const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB'];
+    if (bytes === 0) return 'n/a';
+    const i = parseInt(
+      Math.floor(Math.log(Math.abs(bytes)) / Math.log(1024)),
+      10
+    );
+    if (i === 0) return `${bytes} ${sizes[i]})`;
+    return `${(bytes / 1024 ** i).toFixed(1)} ${sizes[i]}`;
+  };
+
   @action _onCheckDiskSpace = ({
     isNotEnoughDiskSpace,
     diskSpaceRequired,
@@ -612,6 +634,66 @@ export default class NetworkStatusStore extends Store {
     this.stateDirectoryPath = stateDirectoryPath;
   };
 
+  @action _logStateSnapshot = () => {
+    const {
+      network,
+      buildNumber,
+      cpu,
+      current,
+      version,
+      mainProcessID,
+      rendererProcessID,
+      isInSafeMode,
+      isMainnet,
+      isStaging,
+      isTestnet,
+      os,
+      platformVersion,
+    } = this.environment;
+
+    const stateSnapshotData: LogStateSnapshotParams = {
+      availableDiskSpace: this.diskSpaceAvailable,
+      cardanoAPIPort: this.tlsConfig ? this.tlsConfig.port : 0,
+      cardanoNetwork: network,
+      cardanoNodeState: this.cardanoNodeState,
+      cardanoProcessID: this.cardanoNodeID,
+      cardanoVersion: buildNumber,
+      cpu: Array.isArray(cpu) ? cpu[0].model : '',
+      current,
+      currentLocale: this.stores.profile.currentLocale,
+      daedalusVersion: version,
+      daedalusMainProcessID: mainProcessID,
+      daedalusProcessID: rendererProcessID,
+      daedalusStateDirectoryPath: this.stateDirectoryPath,
+      isConnected: this.isConnected,
+      isDev: this.isConnected,
+      isForceCheckingNodeTime: this.forceCheckTimeDifferenceRequest.isExecuting,
+      isInSafeMode,
+      isMainnet,
+      isNodeInSync: this.isNodeInSync,
+      isNodeResponding: this.isNodeResponding,
+      isNodeSubscribed: this.isNodeSubscribed,
+      isNodeSyncing: this.isNodeSyncing,
+      isNodeTimeCorrect: this.isNodeTimeCorrect,
+      isStaging,
+      isSynced: this.isSynced,
+      isSystemTimeCorrect: this.isSystemTimeCorrect,
+      isSystemTimeIgnored: this.isSystemTimeIgnored,
+      isTestnet,
+      latestLocalBlockTimestamp: this.latestLocalBlockTimestamp,
+      latestNetworkBlockTimestamp: this.latestNetworkBlockTimestamp,
+      localBlockHeight: this.localBlockHeight,
+      localTimeDifference: this.localTimeDifference,
+      networkBlockHeight: this.networkBlockHeight,
+      platform: os,
+      platformVersion,
+      ram: this.convertBytesToSize(this.environment.ram),
+      startTime: new Date().toISOString(),
+      syncPercentage: this.syncPercentage,
+    };
+    setLogStateSnapshotChannel.send(stateSnapshotData);
+  };
+
   // DEFINE COMPUTED VALUES
 
   @computed get isConnected(): boolean {