move ide updater on backend

Author: Alberto Iannaccone

arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts

@@ -262,6 +262,13 @@ import {
   UserFieldsDialogWidget,
 } from './dialogs/user-fields/user-fields-dialog';
 import { nls } from '@theia/core/lib/common';
+import { IDEUpdaterCommands } from './ide-updater/ide-updater-commands';
+import {
+  IDEUpdaterService,
+  IDEUpdaterServiceClient,
+  IDEUpdaterServicePath,
+} from '../common/protocol/ide-updater-service';
+import { IDEUpdaterServiceClientImpl } from './ide-updater/ide-updater-service-client-impl';
 
 const ElementQueries = require('css-element-queries/src/ElementQueries');
 
@@ -761,4 +768,21 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   bind(UserFieldsDialogProps).toConstantValue({
     title: 'UserFields',
   });
+
+  bind(IDEUpdaterCommands).toSelf().inSingletonScope();
+  bind(CommandContribution).toService(IDEUpdaterCommands);
+
+  // Frontend binding for the IDE Updater service
+  bind(IDEUpdaterService)
+    .toDynamicValue((context) => {
+      const connection = context.container.get(WebSocketConnectionProvider);
+      const client = context.container.get<IDEUpdaterServiceClient>(
+        IDEUpdaterServiceClient
+      );
+      return connection.createProxy(IDEUpdaterServicePath, client);
+    })
+    .inSingletonScope();
+  bind(IDEUpdaterServiceClient)
+    .to(IDEUpdaterServiceClientImpl)
+    .inSingletonScope();
 });

arduino-ide-extension/src/browser/ide-updater/ide-updater-commands.ts

@@ -1,44 +1,39 @@
-import { Command, CommandContribution, CommandRegistry } from "@theia/core";
-import { injectable, inject } from "inversify";
-import { CancellationToken } from "electron-updater";
-import { IDEUpdater } from "./ide-updater";
+import { Command, CommandContribution, CommandRegistry } from '@theia/core';
+import { injectable, inject } from 'inversify';
+import { IDEUpdaterService } from '../../common/protocol/ide-updater-service';
 
-// IDEUpdaterCommands register commands used to verify if there
-// are new IDE updates, download them, and install them.
 @injectable()
 export class IDEUpdaterCommands implements CommandContribution {
-  private readonly cancellationToken = new CancellationToken();
-
   constructor(
-    @inject(IDEUpdater) private readonly updater: IDEUpdater
-  ) {
-  }
+    @inject(IDEUpdaterService)
+    private readonly updater: IDEUpdaterService
+  ) {}
 
   registerCommands(registry: CommandRegistry): void {
     registry.registerCommand(IDEUpdaterCommands.CHECK_FOR_UPDATES, {
-      execute: this.checkForUpdates,
+      execute: this.checkForUpdates.bind(this),
     });
     registry.registerCommand(IDEUpdaterCommands.DOWNLOAD_UPDATE, {
-      execute: this.downloadUpdate,
-    })
+      execute: this.downloadUpdate.bind(this),
+    });
     registry.registerCommand(IDEUpdaterCommands.STOP_DOWNLOAD, {
-      execute: this.stopDownload,
-    })
+      execute: this.stopDownload.bind(this),
+    });
     registry.registerCommand(IDEUpdaterCommands.INSTALL_UPDATE, {
-      execute: this.quitAndInstall,
-    })
+      execute: this.quitAndInstall.bind(this),
+    });
   }
 
   checkForUpdates() {
     this.updater.checkForUpdates();
   }
 
   downloadUpdate() {
-    this.updater.downloadUpdate(this.cancellationToken);
+    this.updater.downloadUpdate();
   }
 
   stopDownload() {
-    this.cancellationToken.cancel();
+    this.updater.stopDownload();
   }
 
   quitAndInstall() {
@@ -48,14 +43,22 @@ export class IDEUpdaterCommands implements CommandContribution {
 export namespace IDEUpdaterCommands {
   export const CHECK_FOR_UPDATES: Command = {
     id: 'arduino-ide-check-for-updates',
+    category: 'Arduino',
+    label: 'Check for Arduino IDE updates',
   };
   export const DOWNLOAD_UPDATE: Command = {
     id: 'arduino-ide-download-update',
+    category: 'Arduino',
+    label: 'Download Arduino IDE updates',
   };
   export const STOP_DOWNLOAD: Command = {
     id: 'arduino-ide-stop-download',
+    category: 'Arduino',
+    label: 'Stop download of Arduino IDE updates',
   };
   export const INSTALL_UPDATE: Command = {
     id: 'arduino-ide-install-update',
+    category: 'Arduino',
+    label: 'Install Arduino IDE updates',
   };
 }

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

@@ -0,0 +1,40 @@
+import { Emitter } from '@theia/core';
+import { injectable } from '@theia/core/shared/inversify';
+import { UpdateInfo, ProgressInfo } from 'electron-updater';
+import { IDEUpdaterServiceClient } from '../../common/protocol/ide-updater-service';
+
+@injectable()
+export class IDEUpdaterServiceClientImpl implements IDEUpdaterServiceClient {
+  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>();
+
+  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;
+
+  notifyError(message: Error): void {
+    this.onErrorEmitter.fire(message);
+  }
+  notifyCheckingForUpdate(message: void): void {
+    this.onCheckingForUpdateEmitter.fire(message);
+  }
+  notifyUpdateAvailable(message: UpdateInfo): void {
+    this.onUpdateAvailableEmitter.fire(message);
+  }
+  notifyUpdateNotAvailable(message: UpdateInfo): void {
+    this.onUpdateNotAvailableEmitter.fire(message);
+  }
+  notifyDownloadProgressChanged(message: ProgressInfo): void {
+    this.onDownloadProgressEmitter.fire(message);
+  }
+  notifyDownloadFinished(message: UpdateInfo): void {
+    this.onDownloadFinishedEmitter.fire(message);
+  }
+}

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

@@ -0,0 +1,61 @@
+import { JsonRpcServer } from '@theia/core/lib/common/messaging/proxy-factory';
+import { Event } from '@theia/core/lib/common/event';
+
+export interface ProgressInfo {
+  total: number;
+  delta: number;
+  transferred: number;
+  percent: number;
+  bytesPerSecond: number;
+}
+
+export interface ReleaseNoteInfo {
+  readonly version: string;
+  readonly note: string | null;
+}
+
+export interface BlockMapDataHolder {
+  size?: number;
+  blockMapSize?: number;
+  readonly sha512: string;
+  readonly isAdminRightsRequired?: boolean;
+}
+
+export interface UpdateFileInfo extends BlockMapDataHolder {
+  url: string;
+}
+
+export type UpdateInfo = {
+  readonly version: string;
+  readonly files: Array<UpdateFileInfo>;
+  releaseName?: string | null;
+  releaseNotes?: string | Array<ReleaseNoteInfo> | null;
+  releaseDate: string;
+  readonly stagingPercentage?: number;
+};
+
+export const IDEUpdaterServicePath = '/services/ide-updater';
+export const IDEUpdaterService = Symbol('IDEUpdaterService');
+export interface IDEUpdaterService
+  extends JsonRpcServer<IDEUpdaterServiceClient> {
+  checkForUpdates(): Promise<UpdateInfo>;
+  downloadUpdate(): Promise<void>;
+  quitAndInstall(): void;
+  stopDownload(): void;
+}
+
+export const IDEUpdaterServiceClient = Symbol('IDEUpdaterServiceClient');
+export interface IDEUpdaterServiceClient {
+  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;
+  notifyDownloadProgressChanged(message: ProgressInfo): void;
+  notifyDownloadFinished(message: UpdateInfo): void;
+}

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

@@ -92,6 +92,12 @@ import { ArduinoFirmwareUploaderImpl } from './arduino-firmware-uploader-impl';
 import { PlotterBackendContribution } from './plotter/plotter-backend-contribution';
 import WebSocketServiceImpl from './web-socket/web-socket-service-impl';
 import { WebSocketService } from './web-socket/web-socket-service';
+import { IDEUpdaterServiceImpl } from './ide-updater/ide-updater-service-impl';
+import {
+  IDEUpdaterService,
+  IDEUpdaterServiceClient,
+  IDEUpdaterServicePath,
+} from '../common/protocol/ide-updater-service';
 
 export default new ContainerModule((bind, unbind, isBound, rebind) => {
   bind(BackendApplication).toSelf().inSingletonScope();
@@ -343,4 +349,21 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
 
   bind(PlotterBackendContribution).toSelf().inSingletonScope();
   bind(BackendApplicationContribution).toService(PlotterBackendContribution);
+
+  // IDE updater bindings
+  bind(ConnectionContainerModule).toConstantValue(
+    ConnectionContainerModule.create(({ bind, bindBackendService }) => {
+      bind(IDEUpdaterServiceImpl).toSelf().inSingletonScope();
+      bind(IDEUpdaterService).toService(IDEUpdaterServiceImpl);
+      bindBackendService<IDEUpdaterService, IDEUpdaterServiceClient>(
+        IDEUpdaterServicePath,
+        IDEUpdaterService,
+        (service, client) => {
+          service.setClient(client);
+          client.onDidCloseConnection(() => service.dispose());
+          return service;
+        }
+      );
+    })
+  );
 });