refactor ide updater dialog: clean-up code and rename events

Author: Alberto Iannaccone

arduino-ide-extension/src/browser/dialogs/ide-updater/ide-updater-component.tsx

@@ -6,17 +6,17 @@ import ReactMarkdown from 'react-markdown';
 import { ProgressInfo, UpdateInfo } from '../../../common/protocol/ide-updater';
 import ProgressBar from '../../components/ProgressBar';
 
-export type UpdateProgress = {
+export interface UpdateProgress {
   progressInfo?: ProgressInfo | undefined;
   downloadFinished?: boolean;
   downloadStarted?: boolean;
   error?: Error;
-};
+}
 
-export type IDEUpdaterComponentProps = {
+export interface IDEUpdaterComponentProps {
   updateInfo: UpdateInfo;
   updateProgress: UpdateProgress;
-};
+}
 
 export const IDEUpdaterComponent = ({
   updateInfo,

arduino-ide-extension/src/browser/dialogs/ide-updater/ide-updater-dialog.tsx

@@ -1,11 +1,15 @@
 import * as React from '@theia/core/shared/react';
-import { inject, injectable } from '@theia/core/shared/inversify';
+import {
+  inject,
+  injectable,
+  postConstruct,
+} from '@theia/core/shared/inversify';
 import { DialogProps } from '@theia/core/lib/browser/dialogs';
 import { AbstractDialog } from '../../theia/dialogs/dialogs';
 import { Widget } from '@theia/core/shared/@phosphor/widgets';
 import { Message } from '@theia/core/shared/@phosphor/messaging';
 import { ReactWidget } from '@theia/core/lib/browser/widgets/react-widget';
-import { Disposable, nls } from '@theia/core';
+import { nls } from '@theia/core';
 import { IDEUpdaterComponent, UpdateProgress } from './ide-updater-component';
 import {
   IDEUpdater,
@@ -29,7 +33,7 @@ export class IDEUpdaterDialogWidget extends ReactWidget {
     this.update();
   }
 
-  setUpdateProgress(updateProgress: UpdateProgress): void {
+  mergeUpdateProgress(updateProgress: UpdateProgress): void {
     this._updateProgress = { ...this._updateProgress, ...updateProgress };
     this.update();
   }
@@ -57,9 +61,6 @@ export class IDEUpdaterDialogProps extends DialogProps {}
 
 @injectable()
 export class IDEUpdaterDialog extends AbstractDialog<UpdateInfo> {
-  private onError: Disposable;
-  private onDownloadProgressChanged: Disposable;
-  onDownloadFinished: Disposable;
   @inject(IDEUpdaterDialogWidget)
   private readonly widget: IDEUpdaterDialogWidget;
 
@@ -90,32 +91,19 @@ export class IDEUpdaterDialog extends AbstractDialog<UpdateInfo> {
     this.acceptButton = undefined;
   }
 
-  private init(): void {
-    this.widget.setUpdateProgress({
-      progressInfo: undefined,
-      downloadStarted: false,
-      downloadFinished: false,
-      error: undefined,
+  @postConstruct()
+  protected init(): void {
+    this.updaterClient.onUpdaterDidFail((error) => {
+      this.appendErrorButtons();
+      this.widget.mergeUpdateProgress({ error });
+    });
+    this.updaterClient.onDownloadProgressDidChange((progressInfo) => {
+      this.widget.mergeUpdateProgress({ progressInfo });
+    });
+    this.updaterClient.onDownloadDidFinish(() => {
+      this.appendInstallButtons();
+      this.widget.mergeUpdateProgress({ downloadFinished: true });
     });
-    if (!this.onError) {
-      this.onError = this.updaterClient.onError((error) => {
-        this.appendErrorButtons();
-        this.widget.setUpdateProgress({ error });
-      });
-    }
-    if (!this.onDownloadProgressChanged) {
-      this.onDownloadProgressChanged =
-        this.updaterClient.onDownloadProgressChanged((progressInfo) => {
-          this.widget.setUpdateProgress({ progressInfo });
-        });
-    }
-    if (!this.onDownloadFinished) {
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      this.onDownloadFinished = this.updaterClient.onDownloadFinished((_) => {
-        this.appendInstallButtons();
-        this.widget.setUpdateProgress({ downloadFinished: true });
-      });
-    }
   }
 
   get value(): UpdateInfo {
@@ -217,7 +205,7 @@ export class IDEUpdaterDialog extends AbstractDialog<UpdateInfo> {
   }
 
   private startDownload(): void {
-    this.widget.setUpdateProgress({
+    this.widget.mergeUpdateProgress({
       downloadStarted: true,
     });
     this.clearButtons();
@@ -233,7 +221,12 @@ export class IDEUpdaterDialog extends AbstractDialog<UpdateInfo> {
     data: UpdateInfo | undefined = undefined
   ): Promise<UpdateInfo | undefined> {
     if (data && data.version) {
-      this.init();
+      this.widget.mergeUpdateProgress({
+        progressInfo: undefined,
+        downloadStarted: false,
+        downloadFinished: false,
+        error: undefined,
+      });
       this.widget.setUpdateInfo(data);
       return super.open();
     }

arduino-ide-extension/src/browser/ide-updater/ide-updater-client-impl.ts

@@ -5,36 +5,43 @@ import { IDEUpdaterClient } from '../../common/protocol/ide-updater';
 
 @injectable()
 export class IDEUpdaterClientImpl implements IDEUpdaterClient {
-  protected readonly onErrorEmitter = new Emitter<Error>();
-  protected readonly onCheckingForUpdateEmitter = new Emitter<void>();
-  protected readonly onUpdateAvailableEmitter = new Emitter<UpdateInfo>();
-  protected readonly onUpdateNotAvailableEmitter = new Emitter<UpdateInfo>();
-  protected readonly onDownloadProgressEmitter = new Emitter<ProgressInfo>();
-  protected readonly onDownloadFinishedEmitter = new Emitter<UpdateInfo>();
+  protected readonly onUpdaterDidFailEmitter = new Emitter<Error>();
+  protected readonly onUpdaterDidCheckForUpdateEmitter = new Emitter<void>();
+  protected readonly onUpdaterDidFindUpdateAvailableEmitter =
+    new Emitter<UpdateInfo>();
+  protected readonly onUpdaterDidNotFindUpdateAvailableEmitter =
+    new Emitter<UpdateInfo>();
+  protected readonly onDownloadProgressDidChangeEmitter =
+    new Emitter<ProgressInfo>();
+  protected readonly onDownloadDidFinishEmitter = new Emitter<UpdateInfo>();
 
-  readonly onError = this.onErrorEmitter.event;
-  readonly onCheckingForUpdate = this.onCheckingForUpdateEmitter.event;
-  readonly onUpdateAvailable = this.onUpdateAvailableEmitter.event;
-  readonly onUpdateNotAvailable = this.onUpdateNotAvailableEmitter.event;
-  readonly onDownloadProgressChanged = this.onDownloadProgressEmitter.event;
-  readonly onDownloadFinished = this.onDownloadFinishedEmitter.event;
+  readonly onUpdaterDidFail = this.onUpdaterDidFailEmitter.event;
+  readonly onUpdaterDidCheckForUpdate =
+    this.onUpdaterDidCheckForUpdateEmitter.event;
+  readonly onUpdaterDidFindUpdateAvailable =
+    this.onUpdaterDidFindUpdateAvailableEmitter.event;
+  readonly onUpdaterDidNotFindUpdateAvailable =
+    this.onUpdaterDidNotFindUpdateAvailableEmitter.event;
+  readonly onDownloadProgressDidChange =
+    this.onDownloadProgressDidChangeEmitter.event;
+  readonly onDownloadDidFinish = this.onDownloadDidFinishEmitter.event;
 
-  notifyError(message: Error): void {
-    this.onErrorEmitter.fire(message);
+  notifyUpdaterFailed(message: Error): void {
+    this.onUpdaterDidFailEmitter.fire(message);
   }
-  notifyCheckingForUpdate(message: void): void {
-    this.onCheckingForUpdateEmitter.fire(message);
+  notifyCheckedForUpdate(message: void): void {
+    this.onUpdaterDidCheckForUpdateEmitter.fire(message);
   }
-  notifyUpdateAvailable(message: UpdateInfo): void {
-    this.onUpdateAvailableEmitter.fire(message);
+  notifyUpdateAvailableFound(message: UpdateInfo): void {
+    this.onUpdaterDidFindUpdateAvailableEmitter.fire(message);
   }
-  notifyUpdateNotAvailable(message: UpdateInfo): void {
-    this.onUpdateNotAvailableEmitter.fire(message);
+  notifyUpdateAvailableNotFound(message: UpdateInfo): void {
+    this.onUpdaterDidNotFindUpdateAvailableEmitter.fire(message);
   }
   notifyDownloadProgressChanged(message: ProgressInfo): void {
-    this.onDownloadProgressEmitter.fire(message);
+    this.onDownloadProgressDidChangeEmitter.fire(message);
   }
   notifyDownloadFinished(message: UpdateInfo): void {
-    this.onDownloadFinishedEmitter.fire(message);
+    this.onDownloadDidFinishEmitter.fire(message);
   }
 }

arduino-ide-extension/src/common/protocol/ide-updater.ts

@@ -56,16 +56,16 @@ export interface IDEUpdater extends JsonRpcServer<IDEUpdaterClient> {
 
 export const IDEUpdaterClient = Symbol('IDEUpdaterClient');
 export interface IDEUpdaterClient {
-  onError: Event<Error>;
-  onCheckingForUpdate: Event<void>;
-  onUpdateAvailable: Event<UpdateInfo>;
-  onUpdateNotAvailable: Event<UpdateInfo>;
-  onDownloadProgressChanged: Event<ProgressInfo>;
-  onDownloadFinished: Event<UpdateInfo>;
-  notifyError(message: Error): void;
-  notifyCheckingForUpdate(message: void): void;
-  notifyUpdateAvailable(message: UpdateInfo): void;
-  notifyUpdateNotAvailable(message: UpdateInfo): void;
+  onUpdaterDidFail: Event<Error>;
+  onUpdaterDidCheckForUpdate: Event<void>;
+  onUpdaterDidFindUpdateAvailable: Event<UpdateInfo>;
+  onUpdaterDidNotFindUpdateAvailable: Event<UpdateInfo>;
+  onDownloadProgressDidChange: Event<ProgressInfo>;
+  onDownloadDidFinish: Event<UpdateInfo>;
+  notifyUpdaterFailed(message: Error): void;
+  notifyCheckedForUpdate(message: void): void;
+  notifyUpdateAvailableFound(message: UpdateInfo): void;
+  notifyUpdateAvailableNotFound(message: UpdateInfo): void;
   notifyDownloadProgressChanged(message: ProgressInfo): void;
   notifyDownloadFinished(message: UpdateInfo): void;
 }

arduino-ide-extension/src/electron-main/ide-updater/ide-updater-impl.ts

@@ -19,13 +19,13 @@ export class IDEUpdaterImpl implements IDEUpdater {
 
   constructor() {
     this.updater.on('checking-for-update', (e) => {
-      this.clients.forEach((c) => c.notifyCheckingForUpdate(e));
+      this.clients.forEach((c) => c.notifyCheckedForUpdate(e));
     });
     this.updater.on('update-available', (e) => {
-      this.clients.forEach((c) => c.notifyUpdateAvailable(e));
+      this.clients.forEach((c) => c.notifyUpdateAvailableFound(e));
     });
     this.updater.on('update-not-available', (e) => {
-      this.clients.forEach((c) => c.notifyUpdateNotAvailable(e));
+      this.clients.forEach((c) => c.notifyUpdateAvailableNotFound(e));
     });
     this.updater.on('download-progress', (e) => {
       this.clients.forEach((c) => c.notifyDownloadProgressChanged(e));
@@ -34,7 +34,7 @@ export class IDEUpdaterImpl implements IDEUpdater {
       this.clients.forEach((c) => c.notifyDownloadFinished(e));
     });
     this.updater.on('error', (e) => {
-      this.clients.forEach((c) => c.notifyError(e));
+      this.clients.forEach((c) => c.notifyUpdaterFailed(e));
     });
   }
 
@@ -58,10 +58,8 @@ export class IDEUpdaterImpl implements IDEUpdater {
       this.isAlreadyChecked = true;
     }
 
-    const {
-      updateInfo,
-      cancellationToken,
-    } = await this.updater.checkForUpdates();
+    const { updateInfo, cancellationToken } =
+      await this.updater.checkForUpdates();
 
     this.cancellationToken = cancellationToken;
     if (this.updater.currentVersion.compare(updateInfo.version) === -1) {
@@ -104,7 +102,7 @@ export class IDEUpdaterImpl implements IDEUpdater {
       await this.updater.downloadUpdate(this.cancellationToken);
     } catch (e) {
       if (e.message === 'cancelled') return;
-      this.clients.forEach((c) => c.notifyError(e));
+      this.clients.forEach((c) => c.notifyUpdaterFailed(e));
     }
   }