[DDW-1186] Shows 'To be defined' if date of the next fund is in the p…

…ast (input-output-hk#3105)

* [DDW-1216] Use new Catalyst API

* [DDW-1216] Add changelog entry

* [DDW-1186] Now showing 'To be defined' if date of the next fund coming from API is in the past

* [DDW-1186] Changed JP translation

* [DDW-1186] Apply the latest requirements on showing "To be defined"

* [DDW-1186] Implement Catalyst testing utilities

* [DDW-1186] Fix handling of URL override for Catalyst

* [DDW-1186] Implement time machine for Catalyst voting testing

* [DDW-1186] Fix time machine

---------

Co-authored-by: Marcin Mazurek <marcin.mazurek@iohk.io>

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Features
 
+- Show "To be defined" if date of the next Catalyst fund is in the past ([PR 3105](https://github.com/input-output-hk/daedalus/pull/3105))
 - Switched to the new Catalyst API ([PR 3129](https://github.com/input-output-hk/daedalus/pull/3129))
 
 ### Fixes

source/common/types/environment.types.ts

@@ -35,6 +35,8 @@ export type Environment = {
   isBlankScreenFixActive: boolean;
   keepLocalClusterRunning: boolean;
   analyticsFeatureEnabled: boolean;
+  catalystApiUrlOverride?: string;
+  votingVisibleOverride: boolean;
 };
 // constants
 export const PRODUCTION = 'production';

source/main/environment.ts

@@ -112,6 +112,8 @@ export const environment: Environment = Object.assign(
     keepLocalClusterRunning,
     hasMetHardwareRequirements,
     analyticsFeatureEnabled,
+    catalystApiUrlOverride: process.env.CATALYST_API_URL_OVERRIDE,
+    votingVisibleOverride: process.env.VOTING_VISIBLE_OVERRIDE === 'true',
   },
   process.env
 );

source/renderer/app/api/voting/requests/getCatalystFund.ts

@@ -2,10 +2,16 @@ import { externalRequest } from '../../utils/externalRequest';
 import { CATALYST_API_URL } from '../../../config/urlsConfig';
 import { GetCatalystFundResponse } from '../types';
 
-export const getCatalystFund = (): Promise<GetCatalystFundResponse> =>
-  externalRequest({
-    hostname: CATALYST_API_URL,
+export const getCatalystFund = (): Promise<GetCatalystFundResponse> => {
+  const urlOverride: URL | undefined = environment.catalystApiUrlOverride
+    ? new URL(environment.catalystApiUrlOverride)
+    : undefined;
+
+  return externalRequest({
+    hostname: urlOverride ? urlOverride.hostname : CATALYST_API_URL,
     path: '/api/v0/fund',
     method: 'GET',
-    protocol: 'https',
+    port: urlOverride ? Number(urlOverride.port) : undefined,
+    protocol: urlOverride ? urlOverride.protocol.replace(':', '') : 'https',
   });
+};

source/renderer/app/components/voting/voting-info/RegisterToVote.messages.ts

@@ -27,4 +27,10 @@ export const messages = defineMessages({
     defaultMessage: '!!!Register to vote',
     description: 'Button Label for voting registration steps',
   },
+  toBeDefined: {
+    id: 'voting.resultsPhase.toBeDefined',
+    defaultMessage: '!!!To be defined',
+    description:
+      'Text to show when Catalyst API is returning a past date value',
+  },
 });

source/renderer/app/components/voting/voting-info/RegisterToVote.tsx

@@ -1,5 +1,6 @@
 import React, { useState } from 'react';
 import { injectIntl } from 'react-intl';
+import moment from 'moment';
 import { Button } from 'react-polymorph/lib/components/Button';
 import { Checkbox } from 'react-polymorph/lib/components/Checkbox';
 import {
@@ -13,6 +14,7 @@ import { messages as votingMessages } from './VotingInfo.messages';
 import styles from './RegisterToVote.scss';
 import votingStyles from './VotingInfo.scss';
 import type { CatalystFund } from '../../../api/voting/types';
+import { logger } from '../../../utils/logging';
 
 type Props = {
   currentLocale: Locale;
@@ -23,6 +25,17 @@ type Props = {
   onRegisterToVoteClick: (...args: Array<any>) => any;
 };
 
+const isFutureDate = (date: Date): boolean => {
+  try {
+    return moment().diff(date) < 0;
+  } catch (error) {
+    logger.error('Voting::NextFund::Invalid date', {
+      error,
+    });
+  }
+  return false;
+};
+
 function RegisterToVote({
   currentLocale,
   currentDateFormat,
@@ -34,17 +47,19 @@ function RegisterToVote({
   const [step1, setStep1] = useState(false);
   const [step2, setStep2] = useState(false);
   const canRegister = step1 && step2;
-  const snapshotDate = formattedDateTime(
-    fundInfo.next.registrationSnapshotTime,
-    {
-      currentLocale,
-      ...mapToLongDateTimeFormat({
+  const nextSnapshotDateTime = fundInfo.next.registrationSnapshotTime;
+
+  const snapshotDate = isFutureDate(nextSnapshotDateTime)
+    ? formattedDateTime(nextSnapshotDateTime, {
         currentLocale,
-        currentDateFormat,
-        currentTimeFormat,
-      }),
-    }
-  );
+        ...mapToLongDateTimeFormat({
+          currentLocale,
+          currentDateFormat,
+          currentTimeFormat,
+        }),
+      })
+    : intl.formatMessage(messages.toBeDefined);
+
   return (
     <div className={styles.root}>
       <span className={styles.title}>

source/renderer/app/config/urlsConfig.ts

@@ -25,5 +25,7 @@ export const ALLOWED_EXTERNAL_HOSTNAMES = [
   TESTNET_NEWS_HASH_URL,
   STAGING_NEWS_HASH_URL,
   coingeckoConfig.hostname,
-  CATALYST_API_URL,
+  environment.catalystApiUrlOverride
+    ? new URL(environment.catalystApiUrlOverride).hostname
+    : CATALYST_API_URL,
 ];

source/renderer/app/containers/voting/VotingRegistrationPage.tsx

@@ -1,5 +1,5 @@
 import React, { Component } from 'react';
-import { observer, inject } from 'mobx-react';
+import { inject, observer } from 'mobx-react';
 import Layout from '../MainLayout';
 import { VOTING_REGISTRATION_MIN_WALLET_FUNDS } from '../../config/votingConfig';
 import VerticalFlexContainer from '../../components/layout/VerticalFlexContainer';

source/renderer/app/i18n/locales/defaultMessages.json

@@ -4475,6 +4475,11 @@
         "defaultMessage": "!!!Register to vote",
         "description": "Button Label for voting registration steps",
         "id": "voting.registerToVote.registerToVoteButtonLabel"
+      },
+      {
+        "defaultMessage": "!!!To be defined",
+        "description": "Text to show when Catalyst API is returning a past date value",
+        "id": "voting.resultsPhase.toBeDefined"
       }
     ],
     "path": "source/renderer/app/components/voting/voting-info/RegisterToVote.messages.ts"

source/renderer/app/i18n/locales/en-US.json

@@ -731,6 +731,7 @@
   "voting.registerToVote.step2CheckBoxLabel": "Ensure that you register and hold the necessary 500 ADA at the time of the snapshot.",
   "voting.registerToVote.stepsTitle": "Follow these steps to vote:",
   "voting.resultsPhase.endDateLabel": "End of voting:",
+  "voting.resultsPhase.toBeDefined": "To be defined",
   "voting.resultsPhase.viewResultsLinkLabel": "View results",
   "voting.resultsPhase.viewResultsLinkURL": "https://cardano.ideascale.com/a/pages/results",
   "voting.snapshotPhase.snapshotDateLabel": "Snapshot date:",

source/renderer/app/i18n/locales/ja-JP.json

@@ -731,6 +731,7 @@
   "voting.registerToVote.step2CheckBoxLabel": "スナップショット実施の時点で、登録を済ませ、500ADAを保有していてください",
   "voting.registerToVote.stepsTitle": "投票方法:",
   "voting.resultsPhase.endDateLabel": "投票締め切り:",
+  "voting.resultsPhase.toBeDefined": "未定",
   "voting.resultsPhase.viewResultsLinkLabel": "結果を見る",
   "voting.resultsPhase.viewResultsLinkURL": "https://cardano.ideascale.com/a/pages/results",
   "voting.snapshotPhase.snapshotDateLabel": "スナップショット日:",

source/renderer/app/stores/SidebarStore.ts

@@ -130,7 +130,8 @@ export default class SidebarStore extends Store {
       [categories.STAKING_DELEGATION_COUNTDOWN.name]: false,
       [categories.STAKING.name]: true,
       [categories.SETTINGS.name]: true,
-      [categories.VOTING.name]: isMainnet || isDev,
+      [categories.VOTING.name]:
+        isMainnet || isDev || environment.votingVisibleOverride,
       [categories.NETWORK_INFO.name]: isFlight,
     };
     const categoriesFilteredList: Array<SidebarCategoryInfo> = list.filter(

source/renderer/app/utils/PersistentTimeMachine.ts

@@ -0,0 +1,42 @@
+import timeMachine from 'timemachine';
+
+// https://github.com/schickling/timemachine/issues/8
+timeMachine.reset();
+
+const TIME_MACHINE_SESSION_STORAGE_KEY = 'time_machine_date';
+
+export class PersistentTimeMachine {
+  private _isInitialized = false;
+
+  init() {
+    const dateString = sessionStorage.getItem(TIME_MACHINE_SESSION_STORAGE_KEY);
+    if (dateString !== null) {
+      timeMachine.config({
+        dateString,
+      });
+    }
+    this._isInitialized = true;
+  }
+
+  enable(dateString: string) {
+    this._ensureIsInitialized();
+    timeMachine.config({
+      dateString,
+    });
+    sessionStorage.setItem(TIME_MACHINE_SESSION_STORAGE_KEY, dateString);
+    window.location.reload();
+  }
+
+  disable() {
+    this._ensureIsInitialized();
+    timeMachine.reset();
+    sessionStorage.removeItem(TIME_MACHINE_SESSION_STORAGE_KEY);
+    window.location.reload();
+  }
+
+  private _ensureIsInitialized() {
+    if (!this._isInitialized) {
+      throw new Error('Time machine must be initialized before use');
+    }
+  }
+}

source/renderer/app/utils/index.ts

@@ -1,7 +1,12 @@
 import { generateMnemonic } from './crypto';
+import { PersistentTimeMachine } from './PersistentTimeMachine';
+
+const timeMachine = new PersistentTimeMachine();
+timeMachine.init();
 
 export default {
   crypto: {
     generateMnemonic,
   },
+  timeMachine,
 };

translations/messages.json

@@ -4475,6 +4475,11 @@
         "defaultMessage": "!!!Register to vote",
         "description": "Button Label for voting registration steps",
         "id": "voting.registerToVote.registerToVoteButtonLabel"
+      },
+      {
+        "defaultMessage": "!!!To be defined",
+        "description": "Text to show when Catalyst API is returning a past date value",
+        "id": "voting.resultsPhase.toBeDefined"
       }
     ],
     "path": "source/renderer/app/components/voting/voting-info/RegisterToVote.messages.ts"