Check for IDE update at startup

arduino-ide-extension/package.json

@@ -64,6 +64,7 @@
     "css-element-queries": "^1.2.0",
     "dateformat": "^3.0.3",
     "deepmerge": "2.0.1",
+    "electron-updater": "^4.6.2",
     "fuzzy": "^0.1.3",
     "glob": "^7.1.6",
     "google-protobuf": "^3.11.4",
@@ -81,6 +82,7 @@
     "ps-tree": "^1.2.0",
     "query-string": "^7.0.1",
     "react-disable": "^0.1.0",
+    "react-markdown": "^8.0.0",
     "react-select": "^3.0.4",
     "react-tabs": "^3.1.2",
     "react-window": "^1.8.6",

arduino-ide-extension/scripts/compose-changelog.js

@@ -1,56 +1,61 @@
 // @ts-check
 
-
 (async () => {
   const { Octokit } = require('@octokit/rest');
-  const fs = require("fs");
-  const path = require("path");
+  const fs = require('fs');
+  const path = require('path');
 
   const octokit = new Octokit({
     userAgent: 'Arduino IDE compose-changelog.js',
   });
 
-  const response = await octokit.rest.repos.listReleases({
-    owner: 'arduino',
-    repo: 'arduino-ide',
-  }).catch(err => {
-    console.error(err);
-    process.exit(1);
-  })
+  const response = await octokit.rest.repos
+    .listReleases({
+      owner: 'arduino',
+      repo: 'arduino-ide',
+    })
+    .catch((err) => {
+      console.error(err);
+      process.exit(1);
+    });
 
   const releases = response.data;
 
-  let fullChangelog = releases.reduce((acc, item) => {
+  let fullChangelog = releases.reduce((acc, item, index) => {
     // Process each line separately
-    const body = item.body.split('\n').map(processLine).join('\n')
+    const body = item.body.split('\n').map(processLine).join('\n');
     // item.name is the name of the release changelog
-    return acc + `# ${item.name}\n\n${body}\n\n---\n\n`;
+    return (
+      acc +
+      `## ${item.name}\n\n${body}${
+        index !== releases.length - 1 ? '\n\n---\n\n' : '\n'
+      }`
+    );
   }, '');
 
-  const args = process.argv.slice(2)
+  const args = process.argv.slice(2);
   if (args.length == 0) {
-    console.error("Missing argument to destination file")
-    process.exit(1)
+    console.error('Missing argument to destination file');
+    process.exit(1);
   }
   const changelogFile = path.resolve(args[0]);
 
   await fs.writeFile(
     changelogFile,
     fullChangelog,
     {
-      flag: "w+",
+      flag: 'w+',
     },
-    err => {
+    (err) => {
       if (err) {
         console.error(err);
         process.exit(1);
       }
-      console.log("Changelog written to", changelogFile);
+      console.log('Changelog written to', changelogFile);
     }
-  )
+  );
 })();
 
-
 // processLine applies different substitutions to line string.
 // We're assuming that there are no more than one substitution
 // per line to be applied.
@@ -61,7 +66,8 @@ const processLine = (line) => {
   // * [#123](https://github.com/arduino/arduino-ide/pull/123/)
   // * [#123](https://github.com/arduino/arduino-ide/issues/123/)
   // If it does return the line as is.
-  let r = /(\(|\[)#\d+(\)|\])(\(|\[)https:\/\/github\.com\/arduino\/arduino-ide\/(pull|issues)\/(\d+)\/?(\)|\])/gm;
+  let r =
+    /(\(|\[)#\d+(\)|\])(\(|\[)https:\/\/github\.com\/arduino\/arduino-ide\/(pull|issues)\/(\d+)\/?(\)|\])/gm;
   if (r.test(line)) {
     return line;
   }
@@ -70,9 +76,12 @@ const processLine = (line) => {
   // * #123
   // If it does it's changed to:
   // * [#123](https://github.com/arduino/arduino-ide/pull/123)
-  r = /#(\d+)/gm;
+  r = /(?<![\w\d\/_]{1})#((\d)+)(?![\w\d\/_]{1})/gm;
   if (r.test(line)) {
-    return line.replace(r, `[#$1](https://github.com/arduino/arduino-ide/pull/$1)`)
+    return line.replace(
+      r,
+      `[#$1](https://github.com/arduino/arduino-ide/pull/$1)`
+    );
   }
 
   // Check if a link with one of the following format exists:
@@ -85,7 +94,8 @@ const processLine = (line) => {
   // * [#123](https://github.com/arduino/arduino-ide/issues/123)
   // * [#123](https://github.com/arduino/arduino-ide/pull/123/)
   // * [#123](https://github.com/arduino/arduino-ide/issues/123/)
-  r = /(https:\/\/github\.com\/arduino\/arduino-ide\/(pull|issues)\/(\d+)\/?)/gm;
+  r =
+    /(https:\/\/github\.com\/arduino\/arduino-ide\/(pull|issues)\/(\d+)\/?)/gm;
   if (r.test(line)) {
     return line.replace(r, `[#$3]($1)`);
   }
@@ -95,11 +105,12 @@ const processLine = (line) => {
   // * https://github.com/arduino/arduino-ide/compare/2.0.0-rc2...2.0.0-rc3/
   // If it does it's changed to:
   // * [`2.0.0-rc2...2.0.0-rc3`](https://github.com/arduino/arduino-ide/compare/2.0.0-rc2...2.0.0-rc3)
-  r = /(https:\/\/github\.com\/arduino\/arduino-ide\/compare\/([^\/]*))\/?\s?/gm;
+  r =
+    /(https:\/\/github\.com\/arduino\/arduino-ide\/compare\/([^\/]*))\/?\s?/gm;
   if (r.test(line)) {
-    return line.replace(r, '[`$2`]($1)');;
+    return line.replace(r, '[`$2`]($1)');
   }
 
   // If nothing matches just return the line as is
   return line;
-}
+};

arduino-ide-extension/src/browser/arduino-frontend-contribution.tsx

@@ -68,8 +68,12 @@ import { ArduinoPreferences } from './arduino-preferences';
 import { SketchesServiceClientImpl } from '../common/protocol/sketches-service-client-impl';
 import { SaveAsSketch } from './contributions/save-as-sketch';
 import { SketchbookWidgetContribution } from './widgets/sketchbook/sketchbook-widget-contribution';
+import { IDEUpdaterCommands } from './ide-updater/ide-updater-commands';
+import { IDEUpdaterServiceClient } from '../common/protocol/ide-updater-service';
+import { IDEUpdaterDialog } from './dialogs/ide-updater/ide-updater-dialog';
 
 const INIT_LIBS_AND_PACKAGES = 'initializedLibsAndPackages';
+export const SKIP_IDE_VERSION = 'skipIDEVersion';
 
 @injectable()
 export class ArduinoFrontendContribution
@@ -78,8 +82,7 @@ export class ArduinoFrontendContribution
     TabBarToolbarContribution,
     CommandContribution,
     MenuContribution,
-    ColorContribution
-{
+    ColorContribution {
   @inject(ILogger)
   protected logger: ILogger;
 
@@ -157,6 +160,15 @@ export class ArduinoFrontendContribution
   @inject(LocalStorageService)
   protected readonly localStorageService: LocalStorageService;
 
+  @inject(IDEUpdaterCommands)
+  protected readonly updater: IDEUpdaterCommands;
+
+  @inject(IDEUpdaterServiceClient)
+  protected readonly updaterClient: IDEUpdaterServiceClient;
+
+  @inject(IDEUpdaterDialog)
+  protected readonly updaterDialog: IDEUpdaterDialog;
+
   protected invalidConfigPopup:
     | Promise<void | 'No' | 'Yes' | undefined>
     | undefined;
@@ -251,7 +263,7 @@ export class ArduinoFrontendContribution
     });
   }
 
-  onStart(app: FrontendApplication): void {
+  async onStart(app: FrontendApplication): Promise<void> {
     // Initialize all `pro-mode` widgets. This is a NOOP if in normal mode.
     for (const viewContribution of [
       this.fileNavigatorContributions,
@@ -266,6 +278,40 @@ export class ArduinoFrontendContribution
         viewContribution.initializeLayout(app);
       }
     }
+
+    this.updaterClient.onError((e) => {
+      console.log('onError', e);
+    });
+    this.updaterClient.onCheckingForUpdate((e) => {
+      console.log('onCheckingForUpdate', e);
+    });
+    this.updaterClient.onUpdateAvailable((e) => {
+      console.log('onUpdateAvailable', e);
+    });
+    this.updaterClient.onUpdateNotAvailable((e) => {
+      console.log('onUpdateNotAvailable', e);
+    });
+    this.updaterClient.onDownloadProgressChanged((e) => {
+      console.log('onDownloadProgressChanged', e);
+    });
+    this.updaterClient.onDownloadFinished((e) => {
+      console.log('onDownloadFinished', e);
+    });
+
+    this.updater.checkForUpdates().then(async (updateInfo) => {
+      if (!updateInfo) return;
+      const versionToSkip = await this.localStorageService.getData<string>(
+        SKIP_IDE_VERSION
+      );
+      if (versionToSkip === updateInfo.version) return;
+      const { version, releaseNotes: changelog } = updateInfo;
+
+      this.updaterDialog.open({
+        version,
+        changelog,
+      });
+    });
+
     const start = async ({ selectedBoard }: BoardsConfig.Config) => {
       if (selectedBoard) {
         const { name, fqbn } = selectedBoard;

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

@@ -262,6 +262,18 @@ 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';
+import {
+  IDEUpdaterDialog,
+  IDEUpdaterDialogProps,
+  IDEUpdaterDialogWidget,
+} from './dialogs/ide-updater/ide-updater-dialog';
 
 const ElementQueries = require('css-element-queries/src/ElementQueries');
 
@@ -407,8 +419,9 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   bind(SerialService)
     .toDynamicValue((context) => {
       const connection = context.container.get(WebSocketConnectionProvider);
-      const client =
-        context.container.get<SerialServiceClient>(SerialServiceClient);
+      const client = context.container.get<SerialServiceClient>(
+        SerialServiceClient
+      );
       return connection.createProxy(SerialServicePath, client);
     })
     .inSingletonScope();
@@ -472,12 +485,11 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
     .inSingletonScope();
   rebind(TheiaEditorWidgetFactory).to(EditorWidgetFactory).inSingletonScope();
   rebind(TabBarToolbarFactory).toFactory(
-    ({ container: parentContainer }) =>
-      () => {
-        const container = parentContainer.createChild();
-        container.bind(TabBarToolbar).toSelf().inSingletonScope();
-        return container.get(TabBarToolbar);
-      }
+    ({ container: parentContainer }) => () => {
+      const container = parentContainer.createChild();
+      container.bind(TabBarToolbar).toSelf().inSingletonScope();
+      return container.get(TabBarToolbar);
+    }
   );
   bind(OutputWidget).toSelf().inSingletonScope();
   rebind(TheiaOutputWidget).toService(OutputWidget);
@@ -605,6 +617,7 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
   Contribution.configure(bind, Debug);
   Contribution.configure(bind, Sketchbook);
   Contribution.configure(bind, UploadFirmware);
+  // Contribution.configure(bind, IDEUpdater);
   Contribution.configure(bind, UploadCertificate);
   Contribution.configure(bind, BoardSelection);
   Contribution.configure(bind, OpenRecentSketch);
@@ -642,13 +655,15 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
 
   // Enable the dirty indicator on uncloseable widgets.
   rebind(TabBarRendererFactory).toFactory((context) => () => {
-    const contextMenuRenderer =
-      context.container.get<ContextMenuRenderer>(ContextMenuRenderer);
+    const contextMenuRenderer = context.container.get<ContextMenuRenderer>(
+      ContextMenuRenderer
+    );
     const decoratorService = context.container.get<TabBarDecoratorService>(
       TabBarDecoratorService
     );
-    const iconThemeService =
-      context.container.get<IconThemeService>(IconThemeService);
+    const iconThemeService = context.container.get<IconThemeService>(
+      IconThemeService
+    );
     return new TabBarRenderer(
       contextMenuRenderer,
       decoratorService,
@@ -756,9 +771,32 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
     title: 'UploadCertificate',
   });
 
+  bind(IDEUpdaterDialogWidget).toSelf().inSingletonScope();
+  bind(IDEUpdaterDialog).toSelf().inSingletonScope();
+  bind(IDEUpdaterDialogProps).toConstantValue({
+    title: 'IDEUpdater',
+  });
+
   bind(UserFieldsDialogWidget).toSelf().inSingletonScope();
   bind(UserFieldsDialog).toSelf().inSingletonScope();
   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();
 });