Introduce Plug-in System

.travis.yml

@@ -34,6 +34,8 @@ cache:
   - packages/navigator/node_modules
   - packages/outline-view/node_modules
   - packages/output/node_modules
+  - packages/plugin/node_modules
+  - packages/plugin-ext/node_modules
   - packages/preferences/node_modules
   - packages/preview/node_modules
   - packages/process/node_modules

dev-packages/application-manager/package.json

@@ -45,7 +45,8 @@
     "umd-compat-loader": "^2.1.1",
     "url-loader": "^1.0.1",
     "webpack": "^4.0.0",
-    "webpack-cli": "2.0.12"
+    "webpack-cli": "2.0.12",
+    "worker-loader": "^1.1.1"
   },
   "devDependencies": {
     "@theia/ext-scripts": "^0.3.11"

dev-packages/application-manager/src/generator/webpack-generator.ts

@@ -62,6 +62,13 @@ module.exports = {
     },
     module: {
         rules: [
+            {
+                test: /worker-main\\.js$/,
+                loader: 'worker-loader',
+                options: {
+                    name: 'worker-ext.[hash].js'
+                }
+            },
             {
                 test: /\\.css$/,
                 exclude: /\\.useable\\.css$/,

examples/browser/package.json

@@ -24,6 +24,8 @@
     "@theia/navigator": "^0.3.11",
     "@theia/outline-view": "^0.3.11",
     "@theia/output": "^0.3.11",
+    "@theia/plugin-ext": "^0.3.11",
+    "@theia/plugin-ext-vscode": "^0.3.11",
     "@theia/preferences": "^0.3.11",
     "@theia/preview": "^0.3.11",
     "@theia/process": "^0.3.11",

examples/electron/package.json

@@ -27,6 +27,8 @@
     "@theia/navigator": "^0.3.11",
     "@theia/outline-view": "^0.3.11",
     "@theia/output": "^0.3.11",
+    "@theia/plugin-ext": "^0.3.11",
+    "@theia/plugin-ext-vscode": "^0.3.11",
     "@theia/preferences": "^0.3.11",
     "@theia/preview": "^0.3.11",
     "@theia/process": "^0.3.11",

packages/core/src/browser/preferences/preference-service.ts

@@ -133,6 +133,10 @@ export class PreferenceServiceImpl implements PreferenceService, FrontendApplica
         }
     }
 
+    getPreferences(): { [key: string]: any } {
+        return this.preferences;
+    }
+
     has(preferenceName: string): boolean {
         return this.preferences[preferenceName] !== undefined;
     }

packages/plugin-ext-vscode/compile.tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../configs/base.tsconfig",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "lib",
+    "lib": [
+      "es6",
+      "dom",
+      "webworker"
+    ]
+  },
+  "include": [
+    "src"
+  ]
+}
+

packages/plugin-ext-vscode/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@theia/plugin-ext-vscode",
+  "version": "0.3.11",
+  "description": "Theia - Plugin Extension for VsCode",
+  "dependencies": {
+    "@theia/plugin-ext": "^0.3.11"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "theiaExtensions": [
+    {
+      "backend": "lib/node/plugin-vscode-backend-module"
+    }
+  ],
+  "keywords": [
+    "theia-extension"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/theia-ide/theia.git"
+  },
+  "bugs": {
+    "url": "https://github.com/theia-ide/theia/issues"
+  },
+  "homepage": "https://github.com/theia-ide/theia",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "scripts": {
+    "prepare": "yarn run clean && yarn run build",
+    "clean": "theiaext clean",
+    "build": "theiaext build",
+    "watch": "theiaext watch",
+    "test": "theiaext test",
+    "docs": "theiaext docs"
+  },
+  "devDependencies": {
+    "@theia/ext-scripts": "^0.3.11"
+  },
+  "nyc": {
+    "extends": "../../configs/nyc.json"
+  }
+}

packages/plugin-ext-vscode/src/node/package.spec.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright (C) 2018 Red Hat, Inc. and others.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ */
+
+/* note: this bogus test file is required so that
+   we are able to run mocha unit tests on this
+   package, without having any actual unit tests in it.
+   This way a coverage report will be generated,
+   showing 0% coverage, instead of no report.
+   This file can be removed once we have real unit
+   tests in place. */
+
+describe("plugin-ext-vscode package", () => {
+
+    it("support code coverage statistics", () =>
+        true);
+});

packages/plugin-ext-vscode/src/node/plugin-vscode-backend-module.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright (C) 2018 Red Hat, Inc. and others.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ */
+
+import { ContainerModule } from 'inversify';
+import { PluginDeployerFileHandler, PluginDeployerDirectoryHandler, PluginScanner, PluginDeployerResolver } from "@theia/plugin-ext";
+import { PluginVsCodeFileHandler } from "./plugin-vscode-file-handler";
+import { PluginVsCodeDirectoryHandler } from "./plugin-vscode-directory-handler";
+import { VsCodePluginScanner } from "./scanner-vscode";
+import { VsCodePluginDeployerResolver } from './plugin-vscode-resolver';
+
+export default new ContainerModule(bind => {
+    bind(PluginDeployerFileHandler).to(PluginVsCodeFileHandler).inSingletonScope();
+    bind(PluginDeployerDirectoryHandler).to(PluginVsCodeDirectoryHandler).inSingletonScope();
+    bind(PluginScanner).to(VsCodePluginScanner).inSingletonScope();
+    bind(PluginDeployerResolver).to(VsCodePluginDeployerResolver).inSingletonScope();
+}
+);

packages/plugin-ext-vscode/src/node/plugin-vscode-directory-handler.ts

@@ -0,0 +1,79 @@
+/*
+ * Copyright (C) 2018 Red Hat, Inc. and others.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ */
+
+import {
+    PluginDeployerDirectoryHandler,
+    PluginDeployerEntry, PluginPackage, PluginDeployerDirectoryHandlerContext,
+    PluginDeployerEntryType
+} from "@theia/plugin-ext";
+import { injectable } from "inversify";
+import * as fs from "fs";
+import * as path from "path";
+
+@injectable()
+export class PluginVsCodeDirectoryHandler implements PluginDeployerDirectoryHandler {
+
+    accept(resolvedPlugin: PluginDeployerEntry): boolean {
+
+        console.log('PluginTheiaDirectoryHandler: accepting plugin with path', resolvedPlugin.path());
+
+        // handle only directories
+        if (resolvedPlugin.isFile()) {
+            return false;
+        }
+
+        // is there a extension.vsixmanifest and extension folder
+        const extensionVsixManifestPath = path.resolve(resolvedPlugin.path(), 'extension.vsixmanifest');
+        const existsExtensionVsixManifest: boolean = fs.existsSync(extensionVsixManifestPath);
+        if (!existsExtensionVsixManifest) {
+            return false;
+        }
+
+        const extensionPath = path.resolve(resolvedPlugin.path(), 'extension');
+        const existsExtension: boolean = fs.existsSync(extensionPath);
+        if (!existsExtension) {
+            return false;
+        }
+
+        // is there a package.json ?
+        const packageJsonPath = path.resolve(extensionPath, 'package.json');
+        const existsPackageJson: boolean = fs.existsSync(packageJsonPath);
+        if (!existsPackageJson) {
+            return false;
+        }
+
+        let packageJson: PluginPackage = resolvedPlugin.getValue('package.json');
+        if (!packageJson) {
+            packageJson = require(packageJsonPath);
+            resolvedPlugin.storeValue('package.json', packageJson);
+        }
+
+        if (!packageJson.engines) {
+            return false;
+        }
+
+        if (packageJson.engines && packageJson.engines.vscode) {
+            console.log("accepting packagejson with engines", packageJson.engines);
+            return true;
+        }
+
+        return false;
+
+    }
+
+    handle(context: PluginDeployerDirectoryHandlerContext): Promise<any> {
+        const packageJson: PluginPackage = context.pluginEntry().getValue('package.json');
+        if (packageJson.main) {
+            context.pluginEntry().accept(PluginDeployerEntryType.BACKEND);
+        }
+
+        const extensionPath = path.resolve(context.pluginEntry().path(), 'extension');
+        context.pluginEntry().updatePath(extensionPath);
+
+        return Promise.resolve(true);
+    }
+}

packages/plugin-ext-vscode/src/node/plugin-vscode-file-handler.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2018 Red Hat, Inc. and others.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ */
+
+import { PluginDeployerFileHandler, PluginDeployerEntry, PluginDeployerFileHandlerContext } from "@theia/plugin-ext";
+import { injectable } from "inversify";
+import * as os from "os";
+import * as path from "path";
+
+@injectable()
+export class PluginVsCodeFileHandler implements PluginDeployerFileHandler {
+
+    private unpackedFolder: string;
+    constructor() {
+        this.unpackedFolder = path.resolve(os.tmpdir(), 'vscode-unpacked');
+    }
+
+    accept(resolvedPlugin: PluginDeployerEntry): boolean {
+        return resolvedPlugin.isFile() && resolvedPlugin.path() !== null && resolvedPlugin.path().endsWith(".vsix");
+    }
+
+    async handle(context: PluginDeployerFileHandlerContext): Promise<void> {
+        // need to unzip
+        console.log('unzipping the plugin', context.pluginEntry());
+
+        const unpackedPath = path.resolve(this.unpackedFolder, path.basename(context.pluginEntry().path()));
+        await context.unzip(context.pluginEntry().path(), unpackedPath);
+
+        context.pluginEntry().updatePath(unpackedPath);
+        return Promise.resolve();
+    }
+}

packages/plugin-ext-vscode/src/node/plugin-vscode-init.ts

@@ -0,0 +1,58 @@
+/*
+ * Copyright (C) 2018 Red Hat, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+
+import { BackendInitializationFn, createAPI, PluginMetadata } from '@theia/plugin-ext';
+
+export const doInitialization: BackendInitializationFn = (rpc: any, pluginMetadata: PluginMetadata) => {
+    const module = require('module');
+    const vscodeModuleName = 'vscode';
+    const vscode = createAPI(rpc);
+
+    // register the commands that are in the package.json file
+    const contributes: any = pluginMetadata.source.contributes;
+    if (contributes && contributes.commands) {
+        contributes.commands.forEach((commandItem: any) => {
+            vscode.commands.registerCommand({ id: commandItem.command, label: commandItem.title });
+        });
+    }
+
+    // replace command API as it will send only the ID as a string parameter
+    vscode.commands.registerCommand = function registerCommand(command: any, handler?: <T>(...args: any[]) => T | Thenable<T>): any {
+        // use of the ID when registering commands
+        if (typeof command === 'string' && handler) {
+            return vscode.commands.registerHandler(command, handler);
+        }
+    };
+
+    // add theia into global goal as 'vscode'
+    const g = global as any;
+    g[vscodeModuleName] = vscode;
+
+    // add vscode object as module into npm cache
+    require.cache[vscodeModuleName] = {
+        id: vscodeModuleName,
+        filename: vscodeModuleName,
+        loaded: true,
+        exports: g[vscodeModuleName]
+    };
+
+    // save original resolve method
+    const internalResolve = module._resolveFilename;
+
+    // if we try to resolve vscode module, return the filename entry to use cache.
+    module._resolveFilename = (request: string, parent: {}) => {
+        if (vscodeModuleName === request) {
+            return request;
+        }
+        const retVal = internalResolve(request, parent);
+        return retVal;
+    };
+};