[plug-in] implement inspect configuration method

Signed-off-by: Oleksii Kurinnyi <okurinny@redhat.com>

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

@@ -18,6 +18,7 @@ import * as Ajv from 'ajv';
 import { inject, injectable, named, interfaces, postConstruct } from 'inversify';
 import { ContributionProvider, bindContributionProvider } from '../../common';
 import { PreferenceProvider } from './preference-provider';
+import { PreferenceScope } from './preference-service';
 
 // tslint:disable:no-any
 
@@ -59,6 +60,10 @@ export function bindPreferenceSchemaProvider(bind: interfaces.Bind): void {
     bindContributionProvider(bind, PreferenceContribution);
 }
 
+export function bindDefaultPreferenceProvider(bind: interfaces.Bind): void {
+    bind(PreferenceProvider).to(PreferenceSchemaProvider).inSingletonScope().whenTargetNamed(PreferenceScope.Default);
+}
+
 @injectable()
 export class PreferenceSchemaProvider extends PreferenceProvider {
 

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

@@ -25,10 +25,19 @@ import { PreferenceProvider } from './preference-provider';
 import { PreferenceSchemaProvider } from './preference-contribution';
 
 export enum PreferenceScope {
+    Default,
     User,
     Workspace
 }
 
+export namespace PreferenceScope {
+    export function getScopes(): PreferenceScope[] {
+        return Object.keys(PreferenceScope)
+            .filter(k => typeof PreferenceScope[k as any] === 'string')
+            .map(v => <PreferenceScope>Number(v));
+    }
+}
+
 export interface PreferenceChangedEvent {
     changes: PreferenceChange[]
 }

packages/plugin-ext/src/api/plugin-api.ts

@@ -64,13 +64,17 @@ import { SymbolInformation } from 'vscode-languageserver-types';
 
 export interface PluginInitData {
     plugins: PluginMetadata[];
-    preferences: { [key: string]: any };
+    preferences: PreferenceData;
     globalState: KeysToKeysToAnyValue;
     workspaceState: KeysToKeysToAnyValue;
     env: EnvInit;
     extApi?: ExtPluginApi[];
 }
 
+export interface PreferenceData {
+    [scope: number]: any;
+}
+
 export interface Plugin {
     pluginPath: string;
     pluginFolder: string;

packages/plugin-ext/src/common/plugin-protocol.ts

@@ -54,7 +54,7 @@ export interface PluginPackage {
  * This interface describes a package.json contribution section object.
  */
 export interface PluginPackageContribution {
-    configuration: PreferenceSchema;
+    configuration?: PreferenceSchema;
     languages?: PluginPackageLanguageContribution[];
     grammars?: PluginPackageGrammarsContribution[];
     viewsContainers?: { [location: string]: PluginPackageViewContainer[] };

packages/plugin-ext/src/hosted/browser/hosted-plugin.ts

@@ -24,13 +24,14 @@ import { MAIN_RPC_CONTEXT, ConfigStorage, PluginManagerExt } from '../../api/plu
 import { setUpPluginApi } from '../../main/browser/main-context';
 import { RPCProtocol, RPCProtocolImpl } from '../../api/rpc-protocol';
 import { ILogger, ContributionProvider } from '@theia/core';
-import { PreferenceServiceImpl } from '@theia/core/lib/browser';
+import { PreferenceServiceImpl, PreferenceProviderProvider } from '@theia/core/lib/browser';
 import { WorkspaceService } from '@theia/workspace/lib/browser';
 import { PluginContributionHandler } from '../../main/browser/plugin-contribution-handler';
 import { getQueryParameters } from '../../main/browser/env-main';
 import { ExtPluginApi, MainPluginApiProvider } from '../../common/plugin-ext-api-contribution';
 import { PluginPathsService } from '../../main/common/plugin-paths-protocol';
 import { StoragePathService } from '../../main/browser/storage-path-service';
+import { getPreferences } from '../../main/browser/preference-registry-main';
 import { PluginServer } from '../../common/plugin-protocol';
 import { KeysToKeysToAnyValue } from '../../common/types';
 
@@ -60,6 +61,9 @@ export class HostedPluginSupport {
     @inject(WorkspaceService)
     protected readonly workspaceService: WorkspaceService;
 
+    @inject(PreferenceProviderProvider)
+    protected readonly preferenceProviderProvider: PreferenceProviderProvider;
+
     private theiaReadyPromise: Promise<any>;
     private frontendExtManagerProxy: PluginManagerExt;
     private backendExtManagerProxy: PluginManagerExt;
@@ -119,7 +123,7 @@ export class HostedPluginSupport {
                 const hostedExtManager = worker.rpc.getProxy(MAIN_RPC_CONTEXT.HOSTED_PLUGIN_MANAGER_EXT);
                 hostedExtManager.$init({
                     plugins: initData.plugins,
-                    preferences: this.preferenceServiceImpl.getPreferences(),
+                    preferences: getPreferences(this.preferenceProviderProvider),
                     globalState: initData.globalStates,
                     workspaceState: initData.workspaceStates,
                     env: { queryParams: getQueryParameters() },
@@ -153,7 +157,7 @@ export class HostedPluginSupport {
                     const hostedExtManager = rpc.getProxy(MAIN_RPC_CONTEXT.HOSTED_PLUGIN_MANAGER_EXT);
                     hostedExtManager.$init({
                         plugins: plugins,
-                        preferences: this.preferenceServiceImpl.getPreferences(),
+                        preferences: getPreferences(this.preferenceProviderProvider),
                         globalState: initData.globalStates,
                         workspaceState: initData.workspaceStates,
                         env: { queryParams: getQueryParameters() },

packages/plugin-ext/src/hosted/browser/worker/worker-main.ts

@@ -25,6 +25,8 @@ import { EnvExtImpl } from '../../../plugin/env';
 import { PreferenceRegistryExtImpl } from '../../../plugin/preference-registry';
 import { ExtPluginApi } from '../../../common/plugin-ext-api-contribution';
 import { createDebugExtStub } from './debug-stub';
+import { EditorsAndDocumentsExtImpl } from '../../../plugin/editors-and-documents';
+import { WorkspaceExtImpl } from '../../../plugin/workspace';
 
 // tslint:disable-next-line:no-any
 const ctx = self as any;
@@ -47,7 +49,9 @@ function initialize(contextPath: string, pluginMetadata: PluginMetadata): void {
     ctx.importScripts('/context/' + contextPath);
 }
 const envExt = new EnvExtImpl(rpc);
-const preferenceRegistryExt = new PreferenceRegistryExtImpl(rpc);
+const editorsAndDocuments = new EditorsAndDocumentsExtImpl(rpc);
+const workspaceExt = new WorkspaceExtImpl(rpc, editorsAndDocuments);
+const preferenceRegistryExt = new PreferenceRegistryExtImpl(rpc, workspaceExt);
 const debugExt = createDebugExtStub(rpc);
 
 const pluginManager = new PluginManagerExtImpl({
@@ -124,7 +128,10 @@ const apiFactory = createAPIFactory(
     pluginManager,
     envExt,
     debugExt,
-    preferenceRegistryExt);
+    preferenceRegistryExt,
+    editorsAndDocuments,
+    workspaceExt
+);
 let defaultApi: typeof theia;
 
 const handler = {
@@ -147,6 +154,8 @@ const handler = {
 ctx['theia'] = new Proxy(Object.create(null), handler);
 
 rpc.set(MAIN_RPC_CONTEXT.HOSTED_PLUGIN_MANAGER_EXT, pluginManager);
+rpc.set(MAIN_RPC_CONTEXT.EDITORS_AND_DOCUMENTS_EXT, editorsAndDocuments);
+rpc.set(MAIN_RPC_CONTEXT.WORKSPACE_EXT, workspaceExt);
 rpc.set(MAIN_RPC_CONTEXT.PREFERENCE_REGISTRY_EXT, preferenceRegistryExt);
 
 function isElectron() {

packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts

@@ -22,6 +22,8 @@ import { EnvExtImpl } from '../../plugin/env';
 import { PreferenceRegistryExtImpl } from '../../plugin/preference-registry';
 import { ExtPluginApi } from '../../common/plugin-ext-api-contribution';
 import { DebugExtImpl } from '../../plugin/node/debug/debug';
+import { EditorsAndDocumentsExtImpl } from '../../plugin/editors-and-documents';
+import { WorkspaceExtImpl } from '../../plugin/workspace';
 
 /**
  * Handle the RPC calls.
@@ -39,17 +41,24 @@ export class PluginHostRPC {
     initialize() {
         const envExt = new EnvExtImpl(this.rpc);
         const debugExt = new DebugExtImpl(this.rpc);
-        const preferenceRegistryExt = new PreferenceRegistryExtImpl(this.rpc);
+        const editorsAndDocumentsExt = new EditorsAndDocumentsExtImpl(this.rpc);
+        const workspaceExt = new WorkspaceExtImpl(this.rpc, editorsAndDocumentsExt);
+        const preferenceRegistryExt = new PreferenceRegistryExtImpl(this.rpc, workspaceExt);
         this.pluginManager = this.createPluginManager(envExt, preferenceRegistryExt, this.rpc);
         this.rpc.set(MAIN_RPC_CONTEXT.HOSTED_PLUGIN_MANAGER_EXT, this.pluginManager);
+        this.rpc.set(MAIN_RPC_CONTEXT.EDITORS_AND_DOCUMENTS_EXT, editorsAndDocumentsExt);
+        this.rpc.set(MAIN_RPC_CONTEXT.WORKSPACE_EXT, workspaceExt);
         this.rpc.set(MAIN_RPC_CONTEXT.PREFERENCE_REGISTRY_EXT, preferenceRegistryExt);
 
         PluginHostRPC.apiFactory = createAPIFactory(
             this.rpc,
             this.pluginManager,
             envExt,
             debugExt,
-            preferenceRegistryExt);
+            preferenceRegistryExt,
+            editorsAndDocumentsExt,
+            workspaceExt
+        );
     }
 
     // tslint:disable-next-line:no-any

packages/plugin-ext/src/main/browser/plugin-contribution-handler.ts

@@ -14,14 +14,14 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { injectable, inject } from 'inversify';
+import { injectable, inject, named } from 'inversify';
 import { ITokenTypeMap, IEmbeddedLanguagesMap, StandardTokenType } from 'vscode-textmate';
 import { TextmateRegistry, getEncodedLanguageId, MonacoTextmateService } from '@theia/monaco/lib/browser/textmate';
 import { MenusContributionPointHandler } from './menus/menus-contribution-handler';
 import { ViewRegistry } from './view/view-registry';
 import { PluginContribution, IndentationRules, FoldingRules, ScopeMap } from '../../common';
 import { PreferenceSchemaProvider } from '@theia/core/lib/browser';
-import { PreferenceSchema } from '@theia/core/lib/browser/preferences';
+import { PreferenceSchema, PreferenceProvider, PreferenceScope } from '@theia/core/lib/browser/preferences';
 import { KeybindingsContributionPointHandler } from './keybindings/keybindings-contribution-handler';
 import { MonacoSnippetSuggestProvider } from '@theia/monaco/lib/browser/monaco-snippet-suggest-provider';
 
@@ -39,7 +39,7 @@ export class PluginContributionHandler {
     @inject(MenusContributionPointHandler)
     private readonly menusContributionHandler: MenusContributionPointHandler;
 
-    @inject(PreferenceSchemaProvider)
+    @inject(PreferenceProvider) @named(PreferenceScope.Default)
     private readonly preferenceSchemaProvider: PreferenceSchemaProvider;
 
     @inject(MonacoTextmateService)

packages/plugin-ext/src/main/browser/plugin-worker.ts

@@ -23,15 +23,15 @@ export class PluginWorker {
     private worker: Worker;
     public readonly rpc: RPCProtocol;
     constructor() {
-        const emmitter = new Emitter();
+        const emitter = new Emitter();
         this.worker = new (require('../../hosted/browser/worker/worker-main'));
         this.worker.onmessage = message => {
-            emmitter.fire(message.data);
+            emitter.fire(message.data);
         };
         this.worker.onerror = e => console.error(e);
 
         this.rpc = new RPCProtocolImpl({
-            onMessage: emmitter.event,
+            onMessage: emitter.event,
             send: (m: {}) => {
                 this.worker.postMessage(m);
             }

packages/plugin-ext/src/main/browser/preference-registry-main.ts

@@ -17,28 +17,47 @@
 import {
     PreferenceService,
     PreferenceServiceImpl,
-    PreferenceScope
+    PreferenceScope,
+    PreferenceChange,
+    PreferenceProviderProvider
 } from '@theia/core/lib/browser/preferences';
 import { interfaces } from 'inversify';
 import {
     MAIN_RPC_CONTEXT,
     PreferenceRegistryExt,
     PreferenceRegistryMain,
+    PreferenceData,
 } from '../../api/plugin-api';
 import { RPCProtocol } from '../../api/rpc-protocol';
 import { ConfigurationTarget } from '../../plugin/types-impl';
 
+export function getPreferences(preferenceProviderProvider: PreferenceProviderProvider): PreferenceData {
+    return PreferenceScope.getScopes().reduce((result, scope) => {
+        const provider = preferenceProviderProvider(scope);
+        result[scope] = provider.getPreferences();
+        return result;
+    }, {} as PreferenceData);
+}
+
 export class PreferenceRegistryMainImpl implements PreferenceRegistryMain {
     private proxy: PreferenceRegistryExt;
     private preferenceService: PreferenceService;
+    private readonly preferenceProviderProvider: PreferenceProviderProvider;
 
     constructor(prc: RPCProtocol, container: interfaces.Container) {
         this.proxy = prc.getProxy(MAIN_RPC_CONTEXT.PREFERENCE_REGISTRY_EXT);
         this.preferenceService = container.get(PreferenceService);
+        this.preferenceProviderProvider = container.get(PreferenceProviderProvider);
         const preferenceServiceImpl = container.get(PreferenceServiceImpl);
 
         preferenceServiceImpl.onPreferenceChanged(e => {
-            this.proxy.$acceptConfigurationChanged(preferenceServiceImpl.getPreferences(), e);
+            const data = getPreferences(this.preferenceProviderProvider);
+            const eventData: PreferenceChange = {
+                preferenceName: e.preferenceName,
+                newValue: e.newValue,
+                oldValue: e.oldValue
+            };
+            this.proxy.$acceptConfigurationChanged(data, eventData);
         });
     }
 
@@ -61,10 +80,13 @@ export class PreferenceRegistryMainImpl implements PreferenceRegistryMain {
             return arg ? PreferenceScope.User : PreferenceScope.Workspace;
         }
 
-        if (arg === ConfigurationTarget.User) {
-            return PreferenceScope.User;
-        } else {
-            return PreferenceScope.Workspace;
+        switch (arg) {
+            case ConfigurationTarget.Global:
+                return PreferenceScope.User;
+            case ConfigurationTarget.Workspace:
+                return PreferenceScope.Workspace;
+            default:
+                return PreferenceScope.Workspace;
         }
     }
 

packages/plugin-ext/src/plugin/plugin-context.ts

@@ -122,7 +122,10 @@ export function createAPIFactory(
     pluginManager: PluginManager,
     envExt: EnvExtImpl,
     debugExt: DebugExtImpl,
-    preferenceRegistryExt: PreferenceRegistryExtImpl): PluginAPIFactory {
+    preferenceRegistryExt: PreferenceRegistryExtImpl,
+    editorsAndDocumentsExt: EditorsAndDocumentsExtImpl,
+    workspaceExt: WorkspaceExtImpl
+): PluginAPIFactory {
 
     const commandRegistry = rpc.set(MAIN_RPC_CONTEXT.COMMAND_REGISTRY_EXT, new CommandRegistryImpl(rpc));
     const quickOpenExt = rpc.set(MAIN_RPC_CONTEXT.QUICK_OPEN_EXT, new QuickOpenExtImpl(rpc));
@@ -131,10 +134,8 @@ export function createAPIFactory(
     const windowStateExt = rpc.set(MAIN_RPC_CONTEXT.WINDOW_STATE_EXT, new WindowStateExtImpl());
     const notificationExt = rpc.set(MAIN_RPC_CONTEXT.NOTIFICATION_EXT, new NotificationExtImpl(rpc));
     const statusBarExt = new StatusBarExtImpl(rpc);
-    const editorsAndDocuments = rpc.set(MAIN_RPC_CONTEXT.EDITORS_AND_DOCUMENTS_EXT, new EditorsAndDocumentsExtImpl(rpc));
-    const editors = rpc.set(MAIN_RPC_CONTEXT.TEXT_EDITORS_EXT, new TextEditorsExtImpl(rpc, editorsAndDocuments));
-    const documents = rpc.set(MAIN_RPC_CONTEXT.DOCUMENTS_EXT, new DocumentsExtImpl(rpc, editorsAndDocuments));
-    const workspaceExt = rpc.set(MAIN_RPC_CONTEXT.WORKSPACE_EXT, new WorkspaceExtImpl(rpc, editorsAndDocuments));
+    const editors = rpc.set(MAIN_RPC_CONTEXT.TEXT_EDITORS_EXT, new TextEditorsExtImpl(rpc, editorsAndDocumentsExt));
+    const documents = rpc.set(MAIN_RPC_CONTEXT.DOCUMENTS_EXT, new DocumentsExtImpl(rpc, editorsAndDocumentsExt));
     const statusBarMessageRegistryExt = new StatusBarMessageRegistryExt(rpc);
     const terminalExt = rpc.set(MAIN_RPC_CONTEXT.TERMINAL_EXT, new TerminalServiceExtImpl(rpc));
     const outputChannelRegistryExt = new OutputChannelRegistryExt(rpc);
@@ -346,7 +347,7 @@ export function createAPIFactory(
             },
             onWillSaveTextDocument(listener, thisArg?, disposables?) {
                 // TODO to implement
-                return { dispose: () => {}};
+                return { dispose: () => { } };
             },
             onDidSaveTextDocument(listener, thisArg?, disposables?) {
                 return documents.onDidSaveTextDocument(listener, thisArg, disposables);