feat: Show release notes when there's update available

Author: ashchan

packages/neuron-ui/src/components/GeneralSetting/index.tsx

@@ -5,25 +5,37 @@ import { NeuronWalletContext } from 'states/stateProvider'
 import { StateWithDispatch } from 'states/stateProvider/reducer'
 import { addPopup } from 'states/stateProvider/actionCreators'
 import { checkForUpdates, downloadUpdate, installUpdate, clearCellCache } from 'services/remote'
+import { releaseNotesStyle } from './style.module.scss'
 
 const UpdateDownloadStatus = ({
   progress = 0,
   newVersion = '',
-}: React.PropsWithoutRef<{ progress: number; newVersion: string }>) => {
+  releaseNotes = '',
+}: React.PropsWithoutRef<{ progress: number; newVersion: string; releaseNotes: string }>) => {
   const [t] = useTranslation()
-  const available = newVersion !== '' && progress <= 0
+  const available = newVersion !== '' && progress < 0
   const downloaded = progress >= 1
 
   if (available) {
     const download = () => {
       downloadUpdate()
     }
 
+    const releaseNotesHtml = () => {
+      return { __html: releaseNotes }
+    }
+
+    /* eslint-disable react/no-danger */
+
     return (
       <Stack>
         <Text as="p" variant="medium">
           {t('updates.updates-found-do-you-want-to-update', { version: newVersion })}
         </Text>
+        <h3>{t('updates.release-notes')}</h3>
+        <div className={releaseNotesStyle}>
+          <div dangerouslySetInnerHTML={releaseNotesHtml()} />
+        </div>
         <Stack horizontal horizontalAlign="start">
           <PrimaryButton
             onClick={download}
@@ -101,7 +113,11 @@ const GeneralSetting = ({ dispatch }: React.PropsWithoutRef<StateWithDispatch>)
       <Stack>
         <Stack horizontal horizontalAlign="start">
           {updater.version !== '' || updater.downloadProgress >= 0 ? (
-            <UpdateDownloadStatus progress={updater.downloadProgress} newVersion={updater.version} />
+            <UpdateDownloadStatus
+              progress={updater.downloadProgress}
+              newVersion={updater.version}
+              releaseNotes={updater.releaseNotes}
+            />
           ) : (
             <PrimaryButton
               onClick={checkUpdates}

packages/neuron-ui/src/components/GeneralSetting/style.module.scss

@@ -0,0 +1,21 @@
+.releaseNotesStyle {
+  overflow: scroll;
+  height: 200px;
+  margin-bottom: 20px;
+  padding: 10px 15px 15px 15px;
+  border: solid 1px #ccc;
+
+  ul {
+    list-style-type: disc;
+    padding-left: 30px;
+
+    li {
+      margin: 5px 0;
+    }
+  }
+
+  a {
+    text-decoration: none;
+    pointer-events: none;
+  }
+}

packages/neuron-ui/src/locales/en.json

@@ -348,6 +348,7 @@
       "check-updates": "Check for Updates",
       "downloading-update": "Downloading update...",
       "update-not-available": "There are currently no updates available.",
+      "release-notes": "Release Notes:",
       "updates-found-do-you-want-to-update": "An update ({{version}}) is available, do you want to download and update now?",
       "download-update": "Download Update",
       "updates-downloaded-about-to-quit-and-install": "Update downloaded. Please quit to install the update.",

packages/neuron-ui/src/locales/zh.json

@@ -348,6 +348,7 @@
       "check-updates": "检查更新",
       "downloading-update": "正在下载更新...",
       "update-not-available": "没有可供升级的新版本。",
+      "release-notes": "Release Notes:",
       "updates-found-do-you-want-to-update": "有可供升级的新版本({{version}})。现在进行下载和升级吗？",
       "download-update": "下载更新以升级",
       "updates-downloaded-about-to-quit-and-install": "下载完成。请退出并安装新版本。",

packages/neuron-wallet/src/controllers/update.ts

@@ -31,6 +31,7 @@ export default class UpdateController {
   }
 
   public downloadUpdate() {
+    this.notify(0)
     autoUpdater.downloadUpdate()
   }
 
@@ -46,7 +47,7 @@ export default class UpdateController {
 
     autoUpdater.on('update-available', (info: UpdateInfo) => {
       UpdateController.isChecking = false
-      this.notify(-1, info.version, 'todo')
+      this.notify(-1, info.version, info.releaseNotes as string)
     })
 
     autoUpdater.on('update-not-available', () => {