Added support for 3rd party core settings.

Closes arduino/arduino-pro-ide#10.

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

Author: Akos Kitta

.vscode/launch.json

@@ -83,6 +83,27 @@
       "smartStep": true,
       "internalConsoleOptions": "openOnSessionStart",
       "outputCapture": "std"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "protocol": "inspector",
+      "name": "Run Test [current]",
+      "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+      "args": [
+        "--require",
+        "reflect-metadata/Reflect",
+        "--no-timeouts",
+        "--colors",
+        "**/${fileBasenameNoExtension}.js"
+      ],
+      "env": {
+        "TS_NODE_PROJECT": "${workspaceRoot}/tsconfig.json"
+      },
+      "sourceMaps": true,
+      "smartStep": true,
+      "internalConsoleOptions": "openOnSessionStart",
+      "outputCapture": "std"
     }
   ]
 }

arduino-debugger-extension/package.json

@@ -26,8 +26,8 @@
   ],
   "theiaExtensions": [
     {
-      "backend": "lib/node/backend-module",
-      "frontend": "lib/browser/frontend-module"
+      "backend": "lib/node/arduino-debug-backend-module",
+      "frontend": "lib/browser/arduino-debug-frontend-module"
     }
   ]
 }

arduino-debugger-extension/src/browser/frontend-module.ts renamed to arduino-debugger-extension/src/browser/arduino-debug-frontend-module.ts

@@ -10,7 +10,6 @@ import { ArduinoDebugSessionManager } from './arduino-debug-session-manager';
 
 import '../../src/browser/style/index.css';
 
-
 export default new ContainerModule((bind, unbind, isBound, rebind) => {
     bind(ArduinoVariableResolver).toSelf().inSingletonScope();
     bind(VariableContribution).toService(ArduinoVariableResolver);

arduino-debugger-extension/src/node/backend-module.ts renamed to arduino-debugger-extension/src/node/arduino-debug-backend-module.ts

@@ -110,5 +110,8 @@
       "additionalProperties": false
     }
   },
+  "// TODOs": [
+    "additionalProperties should be true. See the new telemetry entry"
+  ],
   "additionalProperties": false
 }

arduino-ide-extension/data/cli/schema/arduino-cli.schema.json

@@ -15,8 +15,8 @@
     "lint": "tslint -c ./tslint.json --project ./tsconfig.json",
     "build": "tsc && ncp ./src/node/cli-protocol/ ./lib/node/cli-protocol/ && yarn lint",
     "watch": "tsc -w",
-    "test": "mocha \"./src/test/**/*.test.ts\"",
-    "test:watch": "mocha --watch --watch-files src \"./src/test/**/*.test.ts\""
+    "test": "mocha \"./lib/test/**/*.test.js\"",
+    "test:watch": "mocha --watch --watch-files lib \"./lib/test/**/*.test.js\""
   },
   "dependencies": {
     "@grpc/grpc-js": "^0.6.18",
@@ -79,18 +79,16 @@
     "protoc": "1.0.4",
     "shelljs": "^0.8.3",
     "temp": "^0.9.1",
-    "ts-node": "^8.6.2",
     "uuid": "^3.2.1",
     "yargs": "^11.1.0"
   },
   "mocha": {
     "require": [
-      "ts-node/register",
       "reflect-metadata/Reflect"
     ],
     "reporter": "spec",
     "colors": true,
-    "watch-extensions": "ts,tsx",
+    "watch-extensions": "js",
     "timeout": 10000
   },
   "files": [
@@ -101,12 +99,12 @@
   ],
   "theiaExtensions": [
     {
-      "backend": "lib/node/arduino-backend-module",
-      "frontend": "lib/browser/arduino-frontend-module"
+      "backend": "lib/node/arduino-ide-backend-module",
+      "frontend": "lib/browser/arduino-ide-frontend-module"
     },
     {
       "frontend": "lib/browser/menu/browser-arduino-menu-module",
-      "frontendElectron": "lib/electron-browser/electron-arduino-menu-module"
+      "frontendElectron": "lib/electron-browser/menu/electron-arduino-menu-module"
     }
   ]
 }

arduino-ide-extension/package.json

@@ -2,7 +2,7 @@ import { injectable, inject } from 'inversify';
 import { ILogger } from '@theia/core/lib/common/logger';
 import { Event, Emitter } from '@theia/core/lib/common/event';
 import { MessageService } from '@theia/core/lib/common/message-service';
-import { ArduinoDaemonClient } from '../common/protocol/arduino-daemon';
+import { ArduinoDaemonClient } from '../common/protocol';
 
 @injectable()
 export class ArduinoDaemonClientImpl implements ArduinoDaemonClient {

arduino-ide-extension/src/browser/arduino-daemon-client-impl.ts

@@ -5,9 +5,8 @@ import { EditorWidget } from '@theia/editor/lib/browser/editor-widget';
 import { MessageService } from '@theia/core/lib/common/message-service';
 import { CommandContribution, CommandRegistry, Command, CommandHandler } from '@theia/core/lib/common/command';
 import { TabBarToolbarContribution, TabBarToolbarRegistry } from '@theia/core/lib/browser/shell/tab-bar-toolbar';
-import { BoardsService } from '../common/protocol/boards-service';
+import { BoardsService, BoardsServiceClient, CoreService, Sketch, SketchesService, ToolOutputServiceClient } from '../common/protocol';
 import { ArduinoCommands } from './arduino-commands';
-import { CoreService } from '../common/protocol/core-service';
 import { BoardsServiceClientImpl } from './boards/boards-service-client-impl';
 import { WorkspaceRootUriAwareCommandHandler, WorkspaceCommands } from '@theia/workspace/lib/browser/workspace-commands';
 import { SelectionService, MenuContribution, MenuModelRegistry, MAIN_MENU_BAR, MenuPath } from '@theia/core';
@@ -19,8 +18,6 @@ import {
 } from '@theia/core/lib/browser';
 import { OpenFileDialogProps, FileDialogService } from '@theia/filesystem/lib/browser/file-dialog';
 import { FileSystem, FileStat } from '@theia/filesystem/lib/common';
-import { Sketch, SketchesService } from '../common/protocol/sketches-service';
-import { ToolOutputServiceClient } from '../common/protocol/tool-output-service';
 import { CommonCommands, CommonMenus } from '@theia/core/lib/browser/common-frontend-contribution';
 import { FileSystemCommands } from '@theia/filesystem/lib/browser/filesystem-frontend-contribution';
 import { FileDownloadCommands } from '@theia/filesystem/lib/browser/download/file-download-command-contribution';
@@ -45,6 +42,8 @@ import { ColorContribution } from '@theia/core/lib/browser/color-application-con
 import { ColorRegistry } from '@theia/core/lib/browser/color-registry';
 import { ArduinoDaemon } from '../common/protocol/arduino-daemon';
 import { ConfigService } from '../common/protocol/config-service';
+import { BoardsConfigStore } from './boards/boards-config-store';
+import { MainMenuManager } from './menu/main-menu-manager';
 
 export namespace ArduinoMenus {
     export const SKETCH = [...MAIN_MENU_BAR, '3_sketch'];
@@ -75,7 +74,11 @@ export class ArduinoFrontendContribution implements FrontendApplicationContribut
     protected readonly toolOutputServiceClient: ToolOutputServiceClient;
 
     @inject(BoardsServiceClientImpl)
-    protected readonly boardsServiceClient: BoardsServiceClientImpl;
+    protected readonly boardsServiceClientImpl: BoardsServiceClientImpl;
+
+    // Unused but do not remove it. It's required by DI, otherwise `init` method is not called.
+    @inject(BoardsServiceClient)
+    protected readonly boardsServiceClient: BoardsServiceClient;
 
     @inject(SelectionService)
     protected readonly selectionService: SelectionService;
@@ -143,6 +146,12 @@ export class ArduinoFrontendContribution implements FrontendApplicationContribut
     @inject(ConfigService)
     protected readonly configService: ConfigService;
 
+    @inject(BoardsConfigStore)
+    protected readonly boardsConfigStore: BoardsConfigStore;
+
+    @inject(MainMenuManager)
+    protected readonly mainMenuManager: MainMenuManager;
+
     protected application: FrontendApplication;
     protected wsSketchCount: number = 0; // TODO: this does not belong here, does it?
 
@@ -154,15 +163,10 @@ export class ArduinoFrontendContribution implements FrontendApplicationContribut
                 text: BoardsConfig.Config.toString(config)
             });
         }
-        this.boardsServiceClient.onBoardsConfigChanged(updateStatusBar);
-        updateStatusBar(this.boardsServiceClient.boardsConfig);
+        this.boardsServiceClientImpl.onBoardsConfigChanged(updateStatusBar);
+        updateStatusBar(this.boardsServiceClientImpl.boardsConfig);
 
         this.registerSketchesInMenu(this.menuRegistry);
-
-        Promise.all([
-            this.boardsService.getAttachedBoards(),
-            this.boardsService.getAvailablePorts()
-        ]).then(([{ boards }, { ports }]) => this.boardsServiceClient.tryReconnect(boards, ports));
     }
 
     onStart(app: FrontendApplication): void {
@@ -210,8 +214,7 @@ export class ArduinoFrontendContribution implements FrontendApplicationContribut
             render: () => <BoardsToolBarItem
                 key='boardsToolbarItem'
                 commands={this.commandRegistry}
-                boardsServiceClient={this.boardsServiceClient}
-                boardService={this.boardsService} />,
+                boardsServiceClient={this.boardsServiceClientImpl} />,
             isVisible: widget => ArduinoToolbar.is(widget) && widget.side === 'left',
             priority: 2
         });
@@ -276,10 +279,7 @@ export class ArduinoFrontendContribution implements FrontendApplicationContribut
         });
 
         registry.registerCommand(ArduinoCommands.TOGGLE_COMPILE_FOR_DEBUG, {
-            execute: () => {
-                this.editorMode.toggleCompileForDebug();
-                this.editorMode.menuContentChanged.fire();
-            },
+            execute: () => this.editorMode.toggleCompileForDebug(),
             isToggled: () => this.editorMode.compileForDebug
         });
 
@@ -345,7 +345,7 @@ export class ArduinoFrontendContribution implements FrontendApplicationContribut
             execute: async () => {
                 const boardsConfig = await this.boardsConfigDialog.open();
                 if (boardsConfig) {
-                    this.boardsServiceClient.boardsConfig = boardsConfig;
+                    this.boardsServiceClientImpl.boardsConfig = boardsConfig;
                 }
             }
         });
@@ -377,18 +377,18 @@ export class ArduinoFrontendContribution implements FrontendApplicationContribut
         }
 
         try {
-            const { boardsConfig } = this.boardsServiceClient;
+            const { boardsConfig } = this.boardsServiceClientImpl;
             if (!boardsConfig || !boardsConfig.selectedBoard) {
                 throw new Error('No boards selected. Please select a board.');
             }
             if (!boardsConfig.selectedBoard.fqbn) {
-                throw new Error(`No core is installed for ${boardsConfig.selectedBoard.name}. Please install the board.`);
+                throw new Error(`No core is installed for the '${boardsConfig.selectedBoard.name}' board. Please install the core.`);
             }
-            // Reveal the Output view asynchronously (don't await it)
+            const fqbn = await this.boardsConfigStore.appendConfigToFqbn(boardsConfig.selectedBoard.fqbn);
             this.outputContribution.openView({ reveal: true });
             await this.coreService.compile({
-                uri: uri.toString(),
-                board: boardsConfig.selectedBoard,
+                sketchUri: uri.toString(),
+                fqbn,
                 optimizeForDebug: this.editorMode.compileForDebug
             });
         } catch (e) {
@@ -413,19 +413,22 @@ export class ArduinoFrontendContribution implements FrontendApplicationContribut
         }
 
         try {
-            const { boardsConfig } = this.boardsServiceClient;
+            const { boardsConfig } = this.boardsServiceClientImpl;
             if (!boardsConfig || !boardsConfig.selectedBoard) {
                 throw new Error('No boards selected. Please select a board.');
             }
             const { selectedPort } = boardsConfig;
             if (!selectedPort) {
                 throw new Error('No ports selected. Please select a port.');
             }
-            // Reveal the Output view asynchronously (don't await it)
+            if (!boardsConfig.selectedBoard.fqbn) {
+                throw new Error(`No core is installed for the '${boardsConfig.selectedBoard.name}' board. Please install the core.`);
+            }
             this.outputContribution.openView({ reveal: true });
+            const fqbn = await this.boardsConfigStore.appendConfigToFqbn(boardsConfig.selectedBoard.fqbn);
             await this.coreService.upload({
-                uri: uri.toString(),
-                board: boardsConfig.selectedBoard,
+                sketchUri: uri.toString(),
+                fqbn,
                 port: selectedPort.address,
                 optimizeForDebug: this.editorMode.compileForDebug
             });

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

@@ -75,6 +75,9 @@ import { ArduinoFrontendConnectionStatusService, ArduinoApplicationConnectionSta
 import { FrontendConnectionStatusService, ApplicationConnectionStatusContribution } from '@theia/core/lib/browser/connection-status-service';
 import { ConfigServiceClientImpl } from './config-service-client-impl';
 import { CoreServiceClientImpl } from './core-service-client-impl';
+import { BoardsDetailsMenuUpdater } from './boards/boards-details-menu-updater';
+import { BoardsConfigStore } from './boards/boards-config-store';
+import { ILogger } from '@theia/core';
 
 const ElementQueries = require('css-element-queries/src/ElementQueries');
 
@@ -144,12 +147,28 @@ export default new ContainerModule((bind: interfaces.Bind, unbind: interfaces.Un
     // Boards service client to receive and delegate notifications from the backend.
     bind(BoardsServiceClientImpl).toSelf().inSingletonScope();
     bind(FrontendApplicationContribution).toService(BoardsServiceClientImpl);
-    bind(BoardsServiceClient).toDynamicValue(context => {
+    bind(BoardsServiceClient).toDynamicValue(async context => {
         const client = context.container.get(BoardsServiceClientImpl);
+        const service = context.container.get<BoardsService>(BoardsService);
+        const [attachedBoards, availablePorts] = await Promise.all([
+            service.getAttachedBoards(),
+            service.getAvailablePorts()
+        ]);
+        client.init({ attachedBoards, availablePorts });
         WebSocketConnectionProvider.createProxy(context.container, BoardsServicePath, client);
         return client;
     }).inSingletonScope();
 
+    // To be able to track, and update the menu based on the core settings (aka. board details) of the currently selected board.
+    bind(FrontendApplicationContribution).to(BoardsDetailsMenuUpdater).inSingletonScope();
+    bind(BoardsConfigStore).toSelf().inSingletonScope();
+    bind(FrontendApplicationContribution).toService(BoardsConfigStore);
+    // Logger for the Arduino daemon
+    bind(ILogger).toDynamicValue(ctx => {
+        const parentLogger = ctx.container.get<ILogger>(ILogger);
+        return parentLogger.child('store');
+    }).inSingletonScope().whenTargetNamed('store');
+
     // Boards auto-installer
     bind(BoardsAutoInstaller).toSelf().inSingletonScope();
     bind(FrontendApplicationContribution).toService(BoardsAutoInstaller);

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

@@ -35,9 +35,9 @@ export class BoardsAutoInstaller implements FrontendApplicationContribution {
     protected ensureCoreExists(config: BoardsConfig.Config): void {
         const { selectedBoard } = config;
         if (selectedBoard) {
-            this.boardsService.search({}).then(({ items }) => {
-                const candidates = items
-                    .filter(item => item.boards.some(board => Board.sameAs(board, selectedBoard)))
+            this.boardsService.search({}).then(packages => {
+                const candidates = packages
+                    .filter(pkg => pkg.boards.some(board => Board.sameAs(board, selectedBoard)))
                     .filter(({ installable, installedVersion }) => installable && !installedVersion);
                 for (const candidate of candidates) {
                     // tslint:disable-next-line:max-line-length

arduino-ide-extension/src/browser/boards/boards-auto-installer.ts

@@ -0,0 +1,43 @@
+import { inject, injectable } from 'inversify';
+import { QuickOpenItem, QuickOpenModel } from '@theia/core/lib/common/quick-open-model';
+import { QuickOpenService, QuickOpenOptions } from '@theia/core/lib/browser/quick-open/quick-open-service';
+import { BoardsService, BoardsServiceClient } from '../../common/protocol';
+
+@injectable()
+export class BoardsConfigQuickOpenService {
+
+    @inject(QuickOpenService)
+    protected readonly quickOpenService: QuickOpenService;
+
+    @inject(BoardsService)
+    protected readonly boardsService: BoardsService;
+
+    @inject(BoardsServiceClient)
+    protected readonly boardsServiceClient: BoardsServiceClient;
+
+    async selectBoard(): Promise<void> {
+
+    }
+
+    protected open(items: QuickOpenItem | QuickOpenItem[], placeholder: string): void {
+        this.quickOpenService.open(this.getModel(Array.isArray(items) ? items : [items]), this.getOptions(placeholder));
+    }
+
+    protected getOptions(placeholder: string, fuzzyMatchLabel: boolean = true, onClose: (canceled: boolean) => void = () => { }): QuickOpenOptions {
+        return QuickOpenOptions.resolve({
+            placeholder,
+            fuzzyMatchLabel,
+            fuzzySort: false,
+            onClose
+        });
+    }
+
+    protected getModel(items: QuickOpenItem | QuickOpenItem[]): QuickOpenModel {
+        return {
+            onType(_: string, acceptor: (items: QuickOpenItem[]) => void): void {
+                acceptor(Array.isArray(items) ? items : [items]);
+            }
+        };
+    }
+
+}