IDE updater assorted bugfix

- add linux AppImage target
- fix hardcoded if condition that causes to always show the update dialog
- fix redundant test build version
- recalculate sha512 after notarization on macOS

Author: Alberto Iannaccone

Diff for: .github/workflows/build.yml

@@ -96,7 +96,9 @@ jobs:
       matrix:
         artifact:
           - path: '*Linux_64bit.zip'
-            name: Linux_X86-64
+            name: Linux_X86-64_zip
+          - path: '*Linux_64bit.AppImage'
+            name: Linux_X86-64_app_image
           - path: '*macOS_64bit.dmg'
             name: macOS_dmg
           - path: '*macOS_64bit.zip'

Diff for: arduino-ide-extension/src/node/ide-updater/ide-updater-impl.ts

@@ -58,10 +58,7 @@ export class IDEUpdaterImpl implements IDEUpdater {
     } = await this.updater.checkForUpdates();
 
     this.cancellationToken = cancellationToken;
-    if (
-      this.updater.currentVersion.compare(updateInfo.version) === -1 ||
-      true
-    ) {
+    if (this.updater.currentVersion.compare(updateInfo.version) === -1) {
       /*
         'latest.txt' points to the latest changelog that has been generated by the CI,
         so we need to make a first GET request to get the filename of the changelog

Diff for: electron/build/scripts/hash.js

@@ -0,0 +1,31 @@
+const fs = require('fs');
+const crypto = require('crypto');
+
+async function hashFile(
+  file,
+  algorithm = 'sha512',
+  encoding = 'base64',
+  options
+) {
+  return await new Promise((resolve, reject) => {
+    const hash = crypto.createHash(algorithm);
+    hash.on('error', reject).setEncoding(encoding);
+    fs.createReadStream(
+      file,
+      Object.assign({}, options, {
+        highWaterMark: 1024 * 1024,
+        /* better to use more memory but hash faster */
+      })
+    )
+      .on('error', reject)
+      .on('end', () => {
+        hash.end();
+        resolve(hash.read());
+      })
+      .pipe(hash, {
+        end: false,
+      });
+  });
+}
+
+module.exports = { hashFile };

Diff for: electron/build/scripts/notarize.js

@@ -1,28 +1,65 @@
+const fs = require('fs');
 const isCI = require('is-ci');
 const { notarize } = require('electron-notarize');
+const utils = require('../../packager/utils');
+const { getChannelFile } = utils;
+const join = require('path').join;
+const { hashFile } = require('./hash');
 
 exports.default = async function notarizing(context) {
-    if (!isCI) {
-        console.log('Skipping notarization: not on CI.');
-        return;
-    }
-    if (process.env.IS_FORK === 'true') {
-        console.log('Skipping the app notarization: building from a fork.');
-        return;
-    }
-    const { electronPlatformName, appOutDir } = context;
-    if (electronPlatformName !== 'darwin') {
-        return;
-    }
+  if (!isCI) {
+    console.log('Skipping notarization: not on CI.');
+    return;
+  }
+  if (process.env.IS_FORK === 'true') {
+    console.log('Skipping the app notarization: building from a fork.');
+    return;
+  }
+  const { electronPlatformName, appOutDir } = context;
+  if (electronPlatformName !== 'darwin') {
+    return;
+  }
 
-    const appName = context.packager.appInfo.productFilename;
-    const appBundleId = context.packager.config.appId;
-    console.log(`>>> Notarizing ${appBundleId} at ${appOutDir}/${appName}.app...`);
+  const appName = context.packager.appInfo.productFilename;
+  const appBundleId = context.packager.config.appId;
+  console.log(
+    `>>> Notarizing ${appBundleId} at ${appOutDir}/${appName}.app...`
+  );
 
-    return await notarize({
-        appBundleId,
-        appPath: `${appOutDir}/${appName}.app`,
-        appleId: process.env.AC_USERNAME,
-        appleIdPassword: process.env.AC_PASSWORD,
-    });
+  await notarize({
+    appBundleId,
+    appPath: `${appOutDir}/${appName}.app`,
+    appleId: process.env.AC_USERNAME,
+    appleIdPassword: process.env.AC_PASSWORD,
+  });
+  return await recalculateHash();
 };
+
+async function recalculateHash() {
+  const { platform } = process;
+  const cwd = join(__dirname, '..', 'build', 'dist');
+  const channelFilePath = join(cwd, getChannelFile(platform));
+  const yaml = require('yaml');
+
+  try {
+    let fileContents = fs.readFileSync(channelFilePath, 'utf8');
+    const newChannelFile = yaml.parse(fileContents);
+    const { files, path } = newChannelFile;
+    const newSha512 = await hashFile(join(cwd, path));
+    newChannelFile.sha512 = newSha512;
+    if (!!files) {
+      const newFiles = [];
+      for (let file of files) {
+        const { url } = file;
+        const { size } = fs.statSync(join(cwd, url));
+        const newSha512 = await hashFile(join(cwd, url));
+        newFiles.push({ ...file, sha512: newSha512, size });
+      }
+      newChannelFile.files = newFiles;
+    }
+    console.log(channelFilePath);
+    fs.writeFileSync(channelFilePath, yaml.stringify(newChannelFile));
+  } catch (e) {
+    console.log(e);
+  }
+}

Diff for: electron/build/template-package.json

@@ -17,7 +17,9 @@
     "electron-notarize": "^0.3.0",
     "is-ci": "^2.0.0",
     "ncp": "^2.0.0",
-    "shelljs": "^0.8.3"
+    "shelljs": "^0.8.3",
+    "crypto": "^1.0.1",
+    "yaml": "^1.10.2"
   },
   "scripts": {
     "build": "yarn download:plugins && theia build --mode development && yarn patch",
@@ -92,19 +94,12 @@
       "gatekeeperAssess": false,
       "entitlements": "resources/entitlements.mac.plist",
       "entitlementsInherit": "resources/entitlements.mac.plist",
-      "target": [
-        "dmg",
-        "zip"
-      ]
+      "target": "default"
     },
     "linux": {
       "target": [
-        {
-          "target": "zip"
-        },
-        {
-          "target": "AppImage"
-        }
+        "zip",
+        "AppImage"
       ],
       "category": "Development",
       "icon": "resources/icons"

Diff for: electron/packager/config.js

@@ -80,19 +80,12 @@ function getVersion() {
   }
   if (!isRelease) {
     if (isNightly) {
-      version = `${version}-nightly.${timestamp()}`;
+      version = `${version}-nightly-${timestamp()}`;
     } else {
-      version = `${version}-snapshot.${currentCommitish()}`;
+      version = `${version}-snapshot-${currentCommitish()}`;
     }
-    if (!isRelease) {
-      if (isNightly) {
-        version = `${version}-nightly-${timestamp()}`;
-      } else {
-        version = `${version}-snapshot-${currentCommitish()}`;
-      }
-      if (!semver.valid(version)) {
-        throw new Error(`Invalid patched version: '${version}'.`);
-      }
+    if (!semver.valid(version)) {
+      throw new Error(`Invalid patched version: '${version}'.`);
     }
   }
   return version;

Diff for: electron/packager/package.json

@@ -13,9 +13,9 @@
   "author": "Arduino SA",
   "license": "AGPL-3.0-or-later",
   "dependencies": {
+    "7zip-min": "^1.1.1",
     "@types/file-type": "^10.9.1",
     "@types/temp": "^0.8.32",
-    "7zip-min": "^1.1.1",
     "chai": "^4.2.0",
     "dateformat": "^3.0.3",
     "deepmerge": "2.01",
@@ -25,8 +25,8 @@
     "is-ci": "^2.0.0",
     "mocha": "^7.1.1",
     "semver": "^7.3.2",
-    "sinon": "^9.0.1",
     "shelljs": "^0.8.3",
+    "sinon": "^9.0.1",
     "temp": "^0.9.1",
     "yargs": "^12.0.5"
   },
@@ -39,4 +39,4 @@
     "watch-extensions": "js",
     "timeout": 10000
   }
-}
+}

Diff for: electron/packager/yarn.lock

@@ -1679,4 +1679,4 @@ yargs@^15.0.2:
     string-width "^4.2.0"
     which-module "^2.0.0"
     y18n "^4.0.0"
-    yargs-parser "^18.1.1"
+    yargs-parser "^18.1.1"