Check for IDE update at startup (arduino#797)

* Remove check for updates on startup setting * Remove useless exported function * Update template-package.json used to package IDE * Add function to get channel file during packaging step * Add updates check * move ide updater on backend * configure updater options * add auto update preferences * TMP check updates on start and download * index on check-update-startup: fcb8f6e TMP check updates on start and download * set version to skip on local storage * add IDE setting to toggle update check on start-up * comment out check for updates on startup and auto update settings * Update Theia to 1.22.1 * updated CI * download changelog and show it in IDE updater dialog * remove useless file * remove useless code * add i18n to updater dialog * fix i18n * refactor UpdateInfo typing * add macos zip to artifacts * Simply use `--ignore-engines` * Use correct --ignore-engines * Fix semver#valid call * Use C++17 * updated documentation * add update channel preference * update updater url * updated documentation * Fix the C++ version * Build flag for cpp * add disclaimer with correct node version * Update `electron-builder` * Fix `Electron.Menu` issue * Skip electron rebuild * Rebuild native dependencies beforehand * Use resolutions section * Update template-package.json as well * move ide-updater to electron application * refactor ide-updater service * update yarn.lock * update i18n * Revert "Add gRPC user agent (arduino#834)" This reverts commit 5ab3a74. * fix ide download url * update latest file in CI * fix i18n check Co-authored-by: Silvano Cerza <silvanocerza@gmail.com> Co-authored-by: Francesco Stasi <f.stasi@me.com> Co-authored-by: Mark Sujew <msujew@yahoo.de>

Author: 4 people

.github/workflows/build.yml

@@ -60,7 +60,9 @@ jobs:
  if [ $IS_FORK = true ]; then
  echo "Skipping the app signing: building from a fork."
  else
+ export BUILD_SUFFIX="linux";
  if [ "${{ runner.OS }}" = "macOS" ]; then
+ export BUILD_SUFFIX="mac";
  export CSC_LINK="${{ runner.temp }}/signing_certificate.p12"
  # APPLE_SIGNING_CERTIFICATE_P12 secret was produced by following the procedure from:
  # https://www.kencochrane.com/2020/08/01/build-and-sign-golang-binaries-for-macos-with-github-actions/#exporting-the-developer-certificate
@@ -69,6 +71,7 @@ jobs:
  export CSC_KEY_PASSWORD="${{ secrets.KEYCHAIN_PASSWORD }}"
 
  elif [ "${{ runner.OS }}" = "Windows" ]; then
+ export BUILD_SUFFIX="";
  export CSC_LINK="${{ runner.temp }}/signing_certificate.pfx"
  npm config set msvs_version 2017 --global
  echo "${{ secrets.WINDOWS_SIGNING_CERTIFICATE_PFX }}" | base64 --decode > "$CSC_LINK"
@@ -78,7 +81,15 @@ jobs:
  fi
 
  yarn --cwd ./electron/packager/
- yarn --cwd ./electron/packager/ package
+ yarn --cwd ./electron/packager/ package 
+
+ export BUILD_PREFIX="stable"
+ if [ "$IS_NIGHTLY" = true ]; then
+ export BUILD_PREFIX="nightly"
+ fi
+
+ mv electron/build/dist/latest-$BUILD_SUFFIX.yml electron/build/dist/$BUILD_PREFIX-$BUILD_SUFFIX.yml
+ rm electron/build/dist/alpha* electron/build/dist/beta*
 
  - name: Upload [GitHub Actions]
  uses: actions/upload-artifact@v2
@@ -98,7 +109,9 @@ jobs:
  - path: '*Linux_64bit.zip'
  name: Linux_X86-64
  - path: '*macOS_64bit.dmg'
- name: macOS
+ name: macOS_dmg
+ - path: '*macOS_64bit.zip'
+ name: macOS_zip
  - path: '*Windows_64bit.exe'
  name: Windows_X86-64_interactive_installer
  - path: '*Windows_64bit.msi'

arduino-ide-extension/package.json

@@ -65,6 +65,7 @@
  "css-element-queries": "^1.2.0",
  "dateformat": "^3.0.3",
  "deepmerge": "2.0.1",
+ "electron-updater": "^4.6.5",
  "fuzzy": "^0.1.3",
  "glob": "^7.1.6",
  "google-protobuf": "^3.11.4",
@@ -82,6 +83,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 { IDEUpdaterDialog } from './dialogs/ide-updater/ide-updater-dialog';
+import { IDEUpdater } from '../common/protocol/ide-updater';
 
 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(IDEUpdaterDialog)
+ protected readonly updaterDialog: IDEUpdaterDialog;
+
+ @inject(IDEUpdater)
+ protected readonly updaterService: IDEUpdater;
+
  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,19 @@ export class ArduinoFrontendContribution
  viewContribution.initializeLayout(app);
  }
  }
+
+ this.updaterService.init(
+ this.arduinoPreferences.get('arduino.ide.updateChannel')
+ );
+ this.updater.checkForUpdates().then(async (updateInfo) => {
+ if (!updateInfo) return;
+ const versionToSkip = await this.localStorageService.getData<string>(
+ SKIP_IDE_VERSION
+ );
+ if (versionToSkip === updateInfo.version) return;
+ this.updaterDialog.open(updateInfo);
+ });
+
  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,19 @@ 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 {
+ IDEUpdater,
+ IDEUpdaterClient,
+ IDEUpdaterPath,
+} from '../common/protocol/ide-updater';
+import { IDEUpdaterClientImpl } from './ide-updater/ide-updater-client-impl';
+import {
+ IDEUpdaterDialog,
+ IDEUpdaterDialogProps,
+ IDEUpdaterDialogWidget,
+} from './dialogs/ide-updater/ide-updater-dialog';
+import { ElectronIpcConnectionProvider } from '@theia/core/lib/electron-browser/messaging/electron-ipc-connection-provider';
 
 const ElementQueries = require('css-element-queries/src/ElementQueries');
 
@@ -407,8 +420,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 +486,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);
@@ -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(IDEUpdaterClientImpl).toSelf().inSingletonScope();
+ bind(IDEUpdaterClient).toService(IDEUpdaterClientImpl);
+ bind(IDEUpdater)
+ .toDynamicValue((context) => {
+ const client = context.container.get(IDEUpdaterClientImpl);
+ return ElectronIpcConnectionProvider.createProxy(
+ context.container,
+ IDEUpdaterPath,
+ client
+ );
+ })
+ .inSingletonScope();
 });