[ci]: Made various changes for the electron app:

 - Support for multiple electron targe per platform.
 - Removed packager CLI. Changed the logic we calculate the app name.
 - Fixed various OS-specific tests: stubbed `os`.
 - Restructured the final ZIP formats for Windows and Linux.
 - Added packager tests.
 - Switched from `@grpc/grpc-js` to native `grpc`.
 - Updated the version from 0.0.5 to 0.0.6.

Signed-off-by: Akos Kitta <kittaakos@typefox.io>

Author: Akos Kitta

arduino-debugger-extension/package.json

@@ -1,14 +1,14 @@
 {
   "name": "arduino-debugger-extension",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "An extension for debugging Arduino programs",
   "license": "MIT",
   "engines": {
-    "node": ">=10.10.0"
+    "node": ">=10.11.0 <12"
   },
   "dependencies": {
     "@theia/debug": "next",
-    "arduino-ide-extension": "0.0.5",
+    "arduino-ide-extension": "0.0.6",
     "cdt-gdb-adapter": "^0.0.14",
     "vscode-debugadapter": "^1.26.0",
     "vscode-debugprotocol": "^1.26.0"

arduino-ide-extension/package.json

@@ -1,10 +1,10 @@
 {
   "name": "arduino-ide-extension",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "An extension for Theia building the Arduino IDE",
   "license": "MIT",
   "engines": {
-    "node": ">=10.10.0"
+    "node": ">=10.11.0 <12"
   },
   "scripts": {
     "prepare": "yarn download-cli && yarn generate-protocol && yarn download-ls && yarn run clean && yarn run build",
@@ -19,7 +19,6 @@
     "test:watch": "mocha --watch --watch-files lib \"./lib/test/**/*.test.js\""
   },
   "dependencies": {
-    "@grpc/grpc-js": "^0.6.18",
     "@theia/application-package": "next",
     "@theia/core": "next",
     "@theia/cpp": "next",
@@ -37,19 +36,21 @@
     "@types/dateformat": "^3.0.1",
     "@types/deepmerge": "^2.2.0",
     "@types/glob": "^5.0.35",
-    "@types/google-protobuf": "^3.7.1",
+    "@types/google-protobuf": "^3.7.2",
     "@types/js-yaml": "^3.12.2",
     "@types/lodash.debounce": "^4.0.6",
     "@types/ps-tree": "^1.1.0",
     "@types/react-select": "^3.0.0",
+    "@types/sinon": "^7.5.2",
     "@types/which": "^1.3.1",
     "ajv": "^6.5.3",
     "css-element-queries": "^1.2.0",
     "dateformat": "^3.0.3",
     "deepmerge": "^4.2.2",
     "fuzzy": "^0.1.3",
     "glob": "^7.1.6",
-    "google-protobuf": "^3.11.0",
+    "google-protobuf": "^3.11.4",
+    "grpc": "^1.24.2",
     "lodash.debounce": "^4.0.8",
     "js-yaml": "^3.13.1",
     "p-queue": "^5.0.0",
@@ -79,6 +80,7 @@
     "ncp": "^2.0.0",
     "protoc": "1.0.4",
     "shelljs": "^0.8.3",
+    "sinon": "^9.0.1",
     "temp": "^0.9.1",
     "uuid": "^3.2.1",
     "yargs": "^11.1.0"

arduino-ide-extension/scripts/generate-protocol.js

@@ -86,8 +86,6 @@ ${protos.join(' ')}`).code !== 0) {
         shell.exit(1);
     }
 
-    const { patch } = require('./patch-grpc-js');
-    patch([out])
     shell.echo('Done.');
 
 })();

arduino-ide-extension/scripts/patch-grpc-js.js

@@ -1,6 +1,6 @@
 import * as path from 'path';
 import * as yaml from 'js-yaml';
-import * as grpc from '@grpc/grpc-js';
+import * as grpc from 'grpc';
 import * as deepmerge from 'deepmerge';
 import { injectable, inject, named } from 'inversify';
 import URI from '@theia/core/lib/common/uri';

arduino-ide-extension/src/node/config-service-impl.ts

@@ -1,4 +1,4 @@
-import * as grpc from '@grpc/grpc-js';
+import * as grpc from 'grpc';
 import { inject, injectable } from 'inversify';
 import { ToolOutputServiceServer } from '../common/protocol';
 import { GrpcClientProvider } from './grpc-client-provider';
@@ -35,7 +35,7 @@ export class CoreClientProvider extends GrpcClientProvider<CoreClientProvider.Cl
     }
 
     protected async createClient(port: string | number): Promise<CoreClientProvider.Client> {
-        const client = new ArduinoCoreClient(`localhost:${port}`, grpc.credentials.createInsecure());
+        const client = new ArduinoCoreClient(`localhost:${port}`, grpc.credentials.createInsecure(), this.channelOptions);
         const initReq = new InitReq();
         initReq.setLibraryManagerOnly(false);
         const initResp = await new Promise<InitResp>(resolve => {

arduino-ide-extension/src/node/core-client-provider.ts

@@ -1,3 +1,4 @@
+import * as grpc from 'grpc';
 import { inject, injectable, postConstruct } from 'inversify';
 import { ILogger } from '@theia/core/lib/common/logger';
 import { MaybePromise } from '@theia/core/lib/common/types';
@@ -68,4 +69,11 @@ export abstract class GrpcClientProvider<C> {
 
     protected abstract close(client: C): void;
 
+    protected get channelOptions(): grpc.CallOptions {
+        return {
+            'grpc.max_send_message_length': 512 * 1024 * 1024,
+            'grpc.max_receive_message_length': 512 * 1024 * 1024
+        };
+    }
+
 }

arduino-ide-extension/src/node/grpc-client-provider.ts

@@ -1,4 +1,4 @@
-import * as grpc from '@grpc/grpc-js';
+import * as grpc from 'grpc';
 import { injectable } from 'inversify';
 import { MonitorClient } from '../cli-protocol/monitor/monitor_grpc_pb';
 import { GrpcClientProvider } from '../grpc-client-provider';
@@ -7,7 +7,7 @@ import { GrpcClientProvider } from '../grpc-client-provider';
 export class MonitorClientProvider extends GrpcClientProvider<MonitorClient> {
 
     createClient(port: string | number): MonitorClient {
-        return new MonitorClient(`localhost:${port}`, grpc.credentials.createInsecure());
+        return new MonitorClient(`localhost:${port}`, grpc.credentials.createInsecure(), this.channelOptions);
     }
 
     close(client: MonitorClient): void {

arduino-ide-extension/src/node/monitor/monitor-client-provider.ts

@@ -1,4 +1,4 @@
-import { ClientDuplexStream } from '@grpc/grpc-js';
+import { ClientDuplexStream } from 'grpc';
 import { TextDecoder, TextEncoder } from 'util';
 import { injectable, inject, named } from 'inversify';
 import { Struct } from 'google-protobuf/google/protobuf/struct_pb';

arduino-ide-extension/src/node/monitor/monitor-service-impl.ts

@@ -1,4 +1,6 @@
 import { expect } from 'chai';
+import * as sinon from 'sinon';
+import * as os from '@theia/core/lib/common/os';
 import { Container, injectable } from 'inversify';
 import { Event } from '@theia/core/lib/common/event';
 import { ILogger } from '@theia/core/lib/common/logger';
@@ -26,18 +28,23 @@ describe('boards-service-client-impl', () => {
         const guessed = AvailableBoard.State.guessed;
         const incomplete = AvailableBoard.State.incomplete;
 
+        let stub: sinon.SinonStub;
+
         let server: MockBoardsService;
         let client: BoardsServiceClientImpl;
-        // let storage: MockStorageService;
 
         beforeEach(() => {
+            stub = sinon.stub(os, 'isOSX').value(true);
             const container = init();
             server = container.get(MockBoardsService);
             client = container.get(BoardsServiceClientImpl);
-            // storage = container.get(MockStorageService);
             server.setClient(client);
         });
 
+        afterEach(() => {
+            stub.reset();
+        });
+
         it('should have no available boards by default', () => {
             expect(client.availableBoards).to.have.length(0);
         });

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

@@ -45,16 +45,9 @@ jobs:
       RELEASE_TAG: $(Release.Tag)
     condition: or(in(variables['Agent.OS'], 'Windows_NT'), in(variables['Build.Reason'], 'Manual', 'Schedule'))
     displayName: Package
-  - bash: |
-      export ARDUINO_POC_NAME=$(./electron/packager/cli name)
-      echo "##vso[task.setvariable variable=ArduinoPoC.AppName]$ARDUINO_POC_NAME"
-    env:
-      RELEASE_TAG: $(Release.Tag)
-    condition: or(in(variables['Agent.OS'], 'Windows_NT'), in(variables['Build.Reason'], 'Manual', 'Schedule'))
-    displayName: '[Config] Use - ARDUINO_POC_NAME env'
   - task: PublishBuildArtifacts@1
     inputs:
-      pathtoPublish: electron/build/dist/$(ArduinoPoC.AppName)
+      pathtoPublish: electron/build/dist/build-artifacts
       artifactName: 'Arduino Pro IDE - Applications'
     condition: or(in(variables['Agent.OS'], 'Windows_NT'), in(variables['Build.Reason'], 'Manual', 'Schedule'))
     displayName: Publish
@@ -77,7 +70,7 @@ jobs:
       assets: |
         gh-release/Arduino Pro IDE - Applications/*.zip
         gh-release/Arduino Pro IDE - Applications/*.dmg
-        gh-release/Arduino Pro IDE - Applications/*.tar.xz
+        gh-release/Arduino Pro IDE - Applications/*.AppImage
       target: $(Build.SourceVersion)
       action: Edit
       tagSource: auto

azure-pipelines.yml

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "browser-app",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "license": "MIT",
   "dependencies": {
     "@theia/core": "next",
@@ -20,8 +20,8 @@
     "@theia/process": "next",
     "@theia/terminal": "next",
     "@theia/workspace": "next",
-    "arduino-ide-extension": "0.0.5",
-    "arduino-debugger-extension": "0.0.5"
+    "arduino-ide-extension": "0.0.6",
+    "arduino-debugger-extension": "0.0.6"
   },
   "devDependencies": {
     "@theia/cli": "next"

browser-app/package.json

@@ -1,8 +1,9 @@
 {
   "private": true,
   "name": "electron-app",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "license": "MIT",
+  "main": "src-gen/frontend/electron-main.js",
   "dependencies": {
     "@theia/core": "next",
     "@theia/cpp": "next",
@@ -21,8 +22,8 @@
     "@theia/process": "next",
     "@theia/terminal": "next",
     "@theia/workspace": "next",
-    "arduino-ide-extension": "0.0.5",
-    "arduino-debugger-extension": "0.0.5"
+    "arduino-ide-extension": "0.0.6",
+    "arduino-debugger-extension": "0.0.6"
   },
   "devDependencies": {
     "@theia/cli": "next"

electron-app/package.json

@@ -1,6 +1,9 @@
 const os = require('os');
 const path = require('path');
 
+// To be able to propagate the `process.versions.electron` to the backend main, so that we can load natives correctly.
+process.env.THEIA_ELECTRON_VERSION = process.versions.electron;
+
 process.env.THEIA_DEFAULT_PLUGINS = `local-dir:${path.resolve(__dirname, '..', 'plugins')}`;
 process.env.THEIA_PLUGINS = [
     process.env.THEIA_PLUGINS,

electron/build/resources/icons/512x512.png

@@ -0,0 +1,57 @@
+//@ts-check
+// Patches the `src-gen/backend/main.js` so that the forked backend process has the `process.versions.electron` in the bundled electron app.
+// https://github.com/eclipse-theia/theia/issues/7358#issue-583306096
+
+const args = process.argv.slice(2);
+if (!args.length) {
+    console.error(`Expected an argument pointing to the app folder. An app folder is where you have the package.json and src-gen folder.`);
+    process.exit(1);
+}
+if (args.length > 1) {
+    console.error(`Expected exactly one argument pointing to the app folder. Got multiple instead: ${JSON.stringify(args)}`);
+    process.exit(1);
+}
+const arg = args.shift();
+if (!arg) {
+    console.error('App path was not specified.');
+    process.exit(1);
+}
+
+const fs = require('fs');
+const path = require('path');
+const appPath = path.resolve((path.isAbsolute(arg) ? path.join(process.cwd(), arg) : arg));
+if (!fs.existsSync(appPath)) {
+    console.error(`${appPath} does not exist.`);
+    process.exit(1);
+}
+
+if (!fs.lstatSync(appPath).isDirectory()) {
+    console.error(`${appPath} is not a directory.`);
+    process.exit(1);
+}
+
+const patched = path.join(appPath, 'src-gen', 'backend', 'original-main.js');
+if (fs.existsSync(patched)) {
+    console.error(`Already patched. ${patched} already exists.`);
+    process.exit(1);
+}
+
+const toPatch = path.join(appPath, 'src-gen', 'backend', 'main.js');
+if (fs.existsSync(patched)) {
+    console.error(`Cannot patch. ${toPatch} does not exist.`);
+    process.exit(1);
+}
+
+console.log(`⏱️  >>> Patching ${toPatch}...`);
+
+const originalContent = fs.readFileSync(toPatch, { encoding: 'utf8' });
+const patchedContent = `if (typeof process.versions.electron === 'undefined' && typeof process.env.THEIA_ELECTRON_VERSION === 'string') {
+    process.versions.electron = process.env.THEIA_ELECTRON_VERSION;
+}
+require('./original-main');
+`
+
+fs.writeFileSync(patched, originalContent);
+fs.writeFileSync(toPatch, patchedContent);
+
+console.log(`👌 <<< Patched ${toPatch}. Original 'main.js' is now at ${patched}.`);

electron/build/scripts/arduino-pro-ide-electron-main.js

@@ -12,17 +12,17 @@
   },
   "devDependencies": {
     "@theia/cli": "next",
-    "electron-builder": "^21.2.0"
+    "electron-builder": "^22.4.1"
   },
   "scripts": {
-    "build": "yarn download:plugins && theia build --mode development",
-    "build:release": "yarn download:plugins && theia build --mode development",
+    "build": "yarn download:plugins && theia build --mode development && yarn patch:main",
+    "build:release": "yarn download:plugins && theia build --mode production && yarn patch:main",
     "package": "electron-builder --publish=never",
-    "package:preview": "electron-builder --dir",
-    "download:plugins": "theia download:plugins"
+    "download:plugins": "theia download:plugins",
+    "patch:main": "node ./scripts/patch-backend-main ."
   },
   "engines": {
-    "node": ">=10.10.0"
+    "node": ">=10.11.0 <12"
   },
   "repository": {
     "type": "git",
@@ -80,9 +80,17 @@
     },
     "linux": {
       "target": [
-        "zip"
+        {
+          "target": "zip"
+        },
+        {
+          "target": "AppImage",
+          "arch": "armv7l"
+        }
       ],
-      "artifactName": "${productName}-${env.ARDUINO_VERSION}-${os}.${ext}"
+      "category": "Development",
+      "icon": "resources/icons",
+      "artifactName": "${productName}-${env.ARDUINO_VERSION}-${os}-${arch}.${ext}"
     },
     "dmg": {
       "icon": "resources/icon.icns",