Merge pull request #58 from bcmi-labs/use-sketch-as-ws

Use sketch folder as workspace

Author: jbicker

.gitignore

@@ -6,7 +6,8 @@ build/
 downloads/
 !electron/build/
 src-gen/
-arduino-ide-*/webpack.config.js
+browser-app/webpack.config.js
+electron-app/webpack.config.js
 .DS_Store
 /workspace/static
 # switching from `electron` to `browser` in dev mode.

.gitpod.yml

@@ -8,7 +8,7 @@ ports:
 tasks:
   - init: >
       yarn &&
-      yarn --cwd ./arduino-ide-browser start
+      yarn --cwd ./browser-app start
 
 github:
   prebuilds:

.vscode/launch.json

@@ -14,7 +14,7 @@
             "type": "node",
             "request": "launch",
             "name": "Launch Backend",
-            "program": "${workspaceRoot}/arduino-ide-browser/src-gen/backend/main.js",
+            "program": "${workspaceRoot}/browser-app/src-gen/backend/main.js",
             "args": [
                 "--hostname=0.0.0.0",
                 "--port=3000",
@@ -26,8 +26,8 @@
             },
             "sourceMaps": true,
             "outFiles": [
-                "${workspaceRoot}/arduino-ide-browser/src-gen/backend/*.js",
-                "${workspaceRoot}/arduino-ide-browser/lib/**/*.js",
+                "${workspaceRoot}/browser-app/src-gen/backend/*.js",
+                "${workspaceRoot}/browser-app/lib/**/*.js",
                 "${workspaceRoot}/arduino-ide-extension/*/lib/**/*.js"
             ],
             "smartStep": true,

.vscode/tasks.json

@@ -4,9 +4,9 @@
     "version": "2.0.0",
     "tasks": [
         {
-            "label": "Arduino-PoC - Start Browser Example",
+            "label": "Arduino Editor - Start Browser Example",
             "type": "shell",
-            "command": "yarn --cwd ./arduino-ide-browser start",
+            "command": "yarn --cwd ./browser-app start",
             "group": "build",
             "presentation": {
                 "reveal": "always",
@@ -15,7 +15,7 @@
             }
         },
         {
-            "label": "Arduino-PoC - Watch Theia Extension",
+            "label": "Arduino Editor - Watch Theia Extension",
             "type": "shell",
             "command": "yarn --cwd ./arduino-ide-extension watch",
             "group": "build",
@@ -26,9 +26,9 @@
             }
         },
         {
-            "label": "Arduino-PoC - Watch Browser Example",
+            "label": "Arduino Editor - Watch Browser Example",
             "type": "shell",
-            "command": "yarn --cwd ./arduino-ide-browser watch",
+            "command": "yarn --cwd ./browser-app watch",
             "group": "build",
             "presentation": {
                 "reveal": "always",
@@ -37,11 +37,11 @@
             }
         },
         {
-            "label": "Arduino-PoC - Watch All",
+            "label": "Arduino Editor - Watch All",
             "type": "shell",
             "dependsOn": [
-                "Arduino-PoC - Watch Theia Extension",
-                "Arduino-PoC - Watch Browser Example"
+                "Arduino Editor - Watch Theia Extension",
+                "Arduino Editor - Watch Browser Example"
             ]
         }
     ]

README.md

@@ -17,7 +17,7 @@ git clone https://github.com/bcmi-labs/arduino-editor
 cd arduino-editor
 yarn
 yarn rebuild:electron
-yarn --cwd arduino-ide-electron start
+yarn --cwd electron-app start
 ```
 
 If you want to switch back to the browser-based example, execute the following in the repository root
@@ -26,7 +26,7 @@ yarn rebuild:browser
 ```
 Then you can start the browser example again:
 ```
-yarn --cwd arduino-ide-browser start
+yarn --cwd browser-app start
 ```
 
 ## Arduino-PoC Electron Application

arduino-ide-extension/package.json

@@ -12,14 +12,14 @@
     "@theia/core": "next",
     "@theia/editor": "next",
     "@theia/filesystem": "next",
+    "@theia/git": "next",
     "@theia/languages": "next",
     "@theia/markers": "next",
     "@theia/monaco": "next",
     "@theia/outline-view": "next",
     "@theia/workspace": "next",
     "@theia/navigator": "next",
     "@theia/terminal": "next",
-    "@theia/git": "next",
     "@theia/search-in-workspace": "next",
     "@types/ps-tree": "^1.1.0",
     "@types/which": "^1.3.1",
@@ -40,11 +40,12 @@
   },
   "devDependencies": {
     "decompress": "^4.2.0",
-    "decompress-tarbz2": "^4.1.1",
+    "decompress-targz": "^4.1.1",
     "decompress-unzip": "^4.0.1",
     "download": "^7.1.0",
     "grpc-tools": "^1.7.3",
     "grpc_tools_node_protoc_ts": "^2.5.0",
+    "moment": "^2.24.0",
     "ncp": "^2.0.0",
     "rimraf": "^2.6.1",
     "shelljs": "^0.8.3",

arduino-ide-extension/scripts/download-cli.js

@@ -1,11 +1,16 @@
 // @ts-check
-// The links to the downloads as of today (11.08.) are the followings:
-// - https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli-nightly-latest-${FILE_NAME}
-// - https://downloads.arduino.cc/arduino-cli/arduino-cli-latest-${FILE_NAME}
+// The links to the downloads as of today (02.09.) are the followings:
+// In order to get the latest nightly build for your platform use the following links replacing <DATE> with the current date, using the format YYYYMMDD (i.e for 2019/Aug/06 use 20190806 )
+// Linux 64 bit: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-<DATE>_Linux_64bit.tar.gz
+// Linux ARM 64 bit: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-<DATE>_Linux_ARM64.tar.gz
+// Windows 64 bit: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-<DATE>_Windows_64bit.zip
+// Mac OSX: https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-<DATE>_macOS_64bit.tar.gz
+// [...]
+// redirecting to latest generated builds by replacing latest with the latest available build date, using the format YYYYMMDD (i.e for 2019/Aug/06 latest is replaced with 20190806 
 
 (async () => {
 
-    const DEFAULT_VERSION = 'nightly';
+    const DEFAULT_VERSION = 'latest'; // require('moment')().format('YYYYMMDD');
 
     const os = require('os');
     const fs = require('fs');
@@ -14,7 +19,7 @@
     const download = require('download');
     const decompress = require('decompress');
     const unzip = require('decompress-unzip');
-    const untarbz = require('decompress-tarbz2');
+    const untargz = require('decompress-targz');
 
     process.on('unhandledRejection', (reason, _) => {
         shell.echo(String(reason));
@@ -31,11 +36,7 @@
         .option('cli-version', {
             alias: 'cv',
             default: DEFAULT_VERSION,
-            choices: [
-                // 'latest', // TODO: How do we get the source for `latest`. Currently, `latest` is the `0.3.7-alpha.preview`.
-                'nightly'
-            ],
-            describe: `The version of the 'arduino-cli' to download. Defaults to ${DEFAULT_VERSION}.`
+            describe: `The version of the 'arduino-cli' to download with the YYYYMMDD format, or 'latest'. Defaults to ${DEFAULT_VERSION}.`
         })
         .option('force-download', {
             alias: 'fd',
@@ -68,13 +69,12 @@
 
     const suffix = (() => {
         switch (platform) {
-            case 'darwin': return 'macosx.zip';
-            case 'win32': return 'windows.zip';
+            case 'darwin': return 'macOS_64bit.tar.gz';
+            case 'win32': return 'Windows_64bit.zip';
             case 'linux': {
                 switch (arch) {
-                    case 'arm64': return 'linuxarm.tar.bz2';
-                    case 'x32': return 'linux32.tar.bz2';
-                    case 'x64': return 'linux64.tar.bz2';
+                    case 'arm64': return 'Linux_ARM64.tar.gz';
+                    case 'x64': return 'Linux_64bit.tar.gz';
                     default: return undefined;
                 }
             }
@@ -86,24 +86,29 @@
         shell.exit(1);
     }
 
-    const url = `https://downloads.arduino.cc/arduino-cli/${version === 'nightly' ? 'nightly/' : ''}arduino-cli-${version}-latest-${suffix}`;
+    const url = `https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-${version}_${suffix}`;
     shell.echo(`>>> Downloading 'arduino-cli' from '${url}'...`);
     const data = await download(url);
     shell.echo(`<<< Download succeeded.`);
     shell.echo('>>> Decompressing CLI...');
     const files = await decompress(data, downloads, {
         plugins: [
             unzip(),
-            untarbz()
+            untargz()
         ]
     });
-    shell.echo('<<< Decompressing succeeded.');
-
-    if (files.length !== 1) {
+    if (files.length === 0) {
         shell.echo('Error ocurred when decompressing the CLI.');
         shell.exit(1);
     }
-    if (shell.mv('-f', path.join(downloads, files[0].path), cli).code !== 0) {
+    const cliIndex = files.findIndex(f => f.path.startsWith('arduino-cli'));
+    if (cliIndex === -1) {
+        shell.echo('The downloaded artifact does not contains the CLI.');
+        shell.exit(1);
+    }
+    shell.echo('<<< Decompressing succeeded.');
+
+    if (shell.mv('-f', path.join(downloads, files[cliIndex].path), cli).code !== 0) {
         shell.echo(`Could not move file to ${cli}.`);
         shell.exit(1);
     }

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

@@ -46,6 +46,7 @@ import { BoardsConfigDialog } from './boards/boards-config-dialog';
 import { BoardsToolBarItem } from './boards/boards-toolbar-item';
 import { BoardsConfig } from './boards/boards-config';
 import { MonitorService } from '../common/protocol/monitor-service';
+import { ConfigService } from '../common/protocol/config-service';
 
 export namespace ArduinoMenus {
     export const SKETCH = [...MAIN_MENU_BAR, '3_sketch'];
@@ -133,21 +134,19 @@ export class ArduinoFrontendContribution implements TabBarToolbarContribution, C
 
     @inject(LabelProvider)
     protected readonly labelProvider: LabelProvider;
-    
+
     @inject(QuickOpenService)
     protected readonly quickOpenService: QuickOpenService;
 
+    @inject(WorkspaceService) 
+    protected readonly workspaceService: WorkspaceService;
+
+    @inject(ConfigService)
+    protected readonly configService: ConfigService;
+
     protected boardsToolbarItem: BoardsToolBarItem | null;
     protected wsSketchCount: number = 0;
 
-    constructor(@inject(WorkspaceService) protected readonly workspaceService: WorkspaceService) {
-        this.workspaceService.onWorkspaceChanged(() => {
-            if (this.workspaceService.workspace) {
-                this.registerSketchesInMenu(this.menuRegistry);
-            }
-        })
-    }
-
     @postConstruct()
     protected async init(): Promise<void> {
         // This is a hack. Otherwise, the backend services won't bind.
@@ -161,6 +160,8 @@ export class ArduinoFrontendContribution implements TabBarToolbarContribution, C
         }
         this.boardsServiceClient.onBoardsConfigChanged(updateStatusBar);
         updateStatusBar(this.boardsServiceClient.boardsConfig);
+
+        this.registerSketchesInMenu(this.menuRegistry);
     }
 
     registerToolbarItems(registry: TabBarToolbarRegistry): void {
@@ -453,21 +454,32 @@ export class ArduinoFrontendContribution implements TabBarToolbarContribution, C
     }
 
     protected async getWorkspaceSketches(): Promise<Sketch[]> {
-        const sketches = this.sketches.getSketches(this.workspaceService.workspace);
+
+        let sketches: Sketch[] = [];
+        const config = await this.configService.getConfiguration();
+        const stat = await this.fileSystem.getFileStat(config.sketchDirUri);
+        if (!!stat) {
+            sketches = await this.sketches.getSketches(stat);
+        }
         return sketches;
     }
 
     protected async openSketchFilesInNewWindow(uri: string) {
         const url = new URL(window.location.href);
         const currentSketch = url.searchParams.get('sketch');
         // Nothing to do if we want to open the same sketch which is already opened.
-        if (!!currentSketch && new URI(currentSketch).toString() === new URI(uri).toString()) {
-            this.messageService.info(`The '${this.labelProvider.getLongName(new URI(uri))}' is already opened.`);
+        const sketchUri = new URI(uri);
+        if (!!currentSketch && new URI(currentSketch).toString() === sketchUri.toString()) {
+            this.messageService.info(`The '${this.labelProvider.getLongName(sketchUri)}' is already opened.`);
             // NOOP.
             return;
         }
         // Preserve the current window if the `sketch` is not in the `searchParams`.
         url.searchParams.set('sketch', uri);
+        const hash = await this.fileSystem.getFsPath(sketchUri.toString());
+        if (hash) {
+            url.hash = hash;
+        }
         if (!currentSketch) {
             setTimeout(() => window.location.href = url.toString(), 100);
             return;
@@ -543,25 +555,6 @@ export class ArduinoFrontendContribution implements TabBarToolbarContribution, C
         return undefined;
     }
 
-    // private async onNoBoardsInstalled() {
-    //     const action = await this.messageService.info("You have no boards installed. Use the boards manager to install one.", "Open Boards Manager");
-    //     if (!action) {
-    //         return;
-    //     }
-
-    //     this.boardsListWidgetFrontendContribution.openView({ reveal: true });
-    // }
-
-    // private async onUnknownBoard() {
-    //     const action = await this.messageService.warn("There's a board connected for which you need to install software." +
-    //         " If this were not a PoC we would offer you the right package now.", "Open Boards Manager");
-    //     if (!action) {
-    //         return;
-    //     }
-
-    //     this.boardsListWidgetFrontendContribution.openView({ reveal: true });
-    // }
-
     private isArduinoToolbar(maybeToolbarWidget: any): boolean {
         if (maybeToolbarWidget instanceof ArduinoToolbar) {
             return true;

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

@@ -56,6 +56,7 @@ import { LibraryItemRenderer } from './library/library-item-renderer';
 import { BoardItemRenderer } from './boards/boards-item-renderer';
 import { MonitorServiceClientImpl } from './monitor/monitor-service-client-impl';
 import { MonitorServicePath, MonitorService, MonitorServiceClient } from '../common/protocol/monitor-service';
+import { ConfigService, ConfigServicePath } from '../common/protocol/config-service';
 const ElementQueries = require('css-element-queries/src/ElementQueries');
 
 if (!ARDUINO_PRO_MODE) {
@@ -96,6 +97,9 @@ export default new ContainerModule((bind: interfaces.Bind, unbind: interfaces.Un
     // Sketch list service
     bind(SketchesService).toDynamicValue(context => WebSocketConnectionProvider.createProxy(context.container, SketchesServicePath)).inSingletonScope();
 
+    // Config service
+    bind(ConfigService).toDynamicValue(context => WebSocketConnectionProvider.createProxy(context.container, ConfigServicePath)).inSingletonScope();
+
     // Boards service
     bind(BoardsService).toDynamicValue(context => {
         const connection = context.container.get(WebSocketConnectionProvider);

arduino-ide-extension/src/browser/arduino-workspace-service.ts

@@ -4,6 +4,7 @@ import { WorkspaceServer } from "@theia/workspace/lib/common";
 import { FileSystem, FileStat } from "@theia/filesystem/lib/common";
 import URI from "@theia/core/lib/common/uri";
 import { SketchFactory } from "./sketch-factory";
+import { ConfigService } from "../common/protocol/config-service";
 
 /**
  * This is workaround to have custom frontend binding for the default workspace, although we
@@ -21,16 +22,14 @@ export class AWorkspaceService  extends WorkspaceService {
     @inject(SketchFactory)
     protected readonly sketchFactory: SketchFactory;
 
+    @inject(ConfigService)
+    protected readonly configService: ConfigService;
+
     protected async getDefaultWorkspacePath(): Promise<string | undefined> {
         let result = await super.getDefaultWorkspacePath();
         if (!result) {
-            const userHome = await this.fileSystem.getCurrentUserHome();
-            if (!userHome) {
-                return;
-            }
-
-            // The backend has created this location if it was missing.
-            result = new URI(userHome.uri).resolve('Arduino-PoC').resolve('Sketches').toString();
+            const config = await this.configService.getConfiguration();
+            result = config.sketchDirUri;
         }
 
         const stat = await this.fileSystem.getFileStat(result);