@theia/plugin-ext 1.45.1 → 1.46.0

package/src/hosted/browser/worker/worker-main.ts

@@ -15,13 +15,12 @@
 // *****************************************************************************
 // eslint-disable-next-line import/no-extraneous-dependencies
 import 'reflect-metadata';
-import { BasicChannel } from '@theia/core/lib/common/message-rpc/channel';
-import { Uint8ArrayReadBuffer, Uint8ArrayWriteBuffer } from '@theia/core/lib/common/message-rpc/uint8-array-message-buffer';
+import { Container } from '@theia/core/shared/inversify';
 import * as theia from '@theia/plugin';
-import { emptyPlugin, MAIN_RPC_CONTEXT, Plugin, TerminalServiceExt } from '../../../common/plugin-api-rpc';
+import { emptyPlugin, MAIN_RPC_CONTEXT, Plugin } from '../../../common/plugin-api-rpc';
 import { ExtPluginApi } from '../../../common/plugin-ext-api-contribution';
 import { getPluginId, PluginMetadata } from '../../../common/plugin-protocol';
-import { RPCProtocolImpl } from '../../../common/rpc-protocol';
+import { RPCProtocol, RPCProtocolImpl } from '../../../common/rpc-protocol';
 import { ClipboardExt } from '../../../plugin/clipboard-ext';
 import { EditorsAndDocumentsExtImpl } from '../../../plugin/editors-and-documents';
 import { MessageRegistryExt } from '../../../plugin/message-registry';
@@ -29,14 +28,13 @@ import { createAPIFactory } from '../../../plugin/plugin-context';
 import { PluginManagerExtImpl } from '../../../plugin/plugin-manager';
 import { KeyValueStorageProxy } from '../../../plugin/plugin-storage';
 import { PreferenceRegistryExtImpl } from '../../../plugin/preference-registry';
-import { SecretsExtImpl } from '../../../plugin/secrets-ext';
-import { TerminalServiceExtImpl } from '../../../plugin/terminal-ext';
 import { WebviewsExtImpl } from '../../../plugin/webviews';
 import { WorkspaceExtImpl } from '../../../plugin/workspace';
-import { createDebugExtStub } from './debug-stub';
 import { loadManifest } from './plugin-manifest-loader';
-import { WorkerEnvExtImpl } from './worker-env-ext';
+import { EnvExtImpl } from '../../../plugin/env';
+import { DebugExtImpl } from '../../../plugin/debug/debug-ext';
 import { LocalizationExtImpl } from '../../../plugin/localization-ext';
+import pluginHostModule from './worker-plugin-module';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const ctx = self as any;
@@ -44,20 +42,6 @@ const ctx = self as any;
 const pluginsApiImpl = new Map<string, typeof theia>();
 const pluginsModulesNames = new Map<string, Plugin>();
 
-const channel = new BasicChannel(() => {
-    const writeBuffer = new Uint8ArrayWriteBuffer();
-    writeBuffer.onCommit(buffer => {
-        ctx.postMessage(buffer);
-    });
-    return writeBuffer;
-});
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-addEventListener('message', (message: any) => {
-    channel.onMessageEmitter.fire(() => new Uint8ArrayReadBuffer(message.data));
-});
-
-const rpc = new RPCProtocolImpl(channel);
-
 const scripts = new Set<string>();
 
 function initialize(contextPath: string, pluginMetadata: PluginMetadata): void {
@@ -68,112 +52,116 @@ function initialize(contextPath: string, pluginMetadata: PluginMetadata): void {
         scripts.add(path);
     }
 }
-const envExt = new WorkerEnvExtImpl(rpc);
-const storageProxy = new KeyValueStorageProxy(rpc);
-const editorsAndDocuments = new EditorsAndDocumentsExtImpl(rpc);
-const messageRegistryExt = new MessageRegistryExt(rpc);
-const workspaceExt = new WorkspaceExtImpl(rpc, editorsAndDocuments, messageRegistryExt);
-const preferenceRegistryExt = new PreferenceRegistryExtImpl(rpc, workspaceExt);
-const debugExt = createDebugExtStub(rpc);
-const clipboardExt = new ClipboardExt(rpc);
-const webviewExt = new WebviewsExtImpl(rpc, workspaceExt);
-const secretsExt = new SecretsExtImpl(rpc);
-const localizationExt = new LocalizationExtImpl(rpc);
-const terminalService: TerminalServiceExt = new TerminalServiceExtImpl(rpc);
-
-const pluginManager = new PluginManagerExtImpl({
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    loadPlugin(plugin: Plugin): any {
-        if (plugin.pluginPath) {
-            if (isElectron()) {
-                ctx.importScripts(plugin.pluginPath);
-            } else {
-                if (plugin.lifecycle.frontendModuleName) {
-                    // Set current module name being imported
-                    ctx.frontendModuleName = plugin.lifecycle.frontendModuleName;
-                }
 
-                ctx.importScripts('/hostedPlugin/' + getPluginId(plugin.model) + '/' + plugin.pluginPath);
-            }
-        }
+const container = new Container();
+container.load(pluginHostModule);
+
+const rpc: RPCProtocol = container.get(RPCProtocolImpl);
+const pluginManager = container.get(PluginManagerExtImpl);
+pluginManager.setPluginHost({
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        loadPlugin(plugin: Plugin): any {
+            if (plugin.pluginPath) {
+                if (isElectron()) {
+                    ctx.importScripts(plugin.pluginPath);
+                } else {
+                    if (plugin.lifecycle.frontendModuleName) {
+                        // Set current module name being imported
+                        ctx.frontendModuleName = plugin.lifecycle.frontendModuleName;
+                    }
 
-        if (plugin.lifecycle.frontendModuleName) {
-            if (!ctx[plugin.lifecycle.frontendModuleName]) {
-                console.error(`WebWorker: Cannot start plugin "${plugin.model.name}". Frontend plugin not found: "${plugin.lifecycle.frontendModuleName}"`);
-                return;
+                    ctx.importScripts('/hostedPlugin/' + getPluginId(plugin.model) + '/' + plugin.pluginPath);
+                }
             }
-            return ctx[plugin.lifecycle.frontendModuleName];
-        }
-    },
-    async init(rawPluginData: PluginMetadata[]): Promise<[Plugin[], Plugin[]]> {
-        const result: Plugin[] = [];
-        const foreign: Plugin[] = [];
-        // Process the plugins concurrently, making sure to keep the order.
-        const plugins = await Promise.all<{
-            /** Where to push the plugin: `result` or `foreign` */
-            target: Plugin[],
-            plugin: Plugin
-        }>(rawPluginData.map(async plg => {
-            const pluginModel = plg.model;
-            const pluginLifecycle = plg.lifecycle;
-            if (pluginModel.entryPoint!.frontend) {
-                let frontendInitPath = pluginLifecycle.frontendInitPath;
-                if (frontendInitPath) {
-                    initialize(frontendInitPath, plg);
-                } else {
-                    frontendInitPath = '';
+
+            if (plugin.lifecycle.frontendModuleName) {
+                if (!ctx[plugin.lifecycle.frontendModuleName]) {
+                    console.error(`WebWorker: Cannot start plugin "${plugin.model.name}". Frontend plugin not found: "${plugin.lifecycle.frontendModuleName}"`);
+                    return;
                 }
-                const rawModel = await loadManifest(pluginModel);
-                const plugin: Plugin = {
-                    pluginPath: pluginModel.entryPoint.frontend!,
-                    pluginFolder: pluginModel.packagePath,
-                    pluginUri: pluginModel.packageUri,
-                    model: pluginModel,
-                    lifecycle: pluginLifecycle,
-                    rawModel,
-                    isUnderDevelopment: !!plg.isUnderDevelopment
-                };
-                const apiImpl = apiFactory(plugin);
-                pluginsApiImpl.set(plugin.model.id, apiImpl);
-                pluginsModulesNames.set(plugin.lifecycle.frontendModuleName!, plugin);
-                return { target: result, plugin };
-            } else {
-                return {
-                    target: foreign,
-                    plugin: {
-                        pluginPath: pluginModel.entryPoint.backend,
+                return ctx[plugin.lifecycle.frontendModuleName];
+            }
+        },
+        async init(rawPluginData: PluginMetadata[]): Promise<[Plugin[], Plugin[]]> {
+            const result: Plugin[] = [];
+            const foreign: Plugin[] = [];
+            // Process the plugins concurrently, making sure to keep the order.
+            const plugins = await Promise.all<{
+                /** Where to push the plugin: `result` or `foreign` */
+                target: Plugin[],
+                plugin: Plugin
+            }>(rawPluginData.map(async plg => {
+                const pluginModel = plg.model;
+                const pluginLifecycle = plg.lifecycle;
+                if (pluginModel.entryPoint!.frontend) {
+                    let frontendInitPath = pluginLifecycle.frontendInitPath;
+                    if (frontendInitPath) {
+                        initialize(frontendInitPath, plg);
+                    } else {
+                        frontendInitPath = '';
+                    }
+                    const rawModel = await loadManifest(pluginModel);
+                    const plugin: Plugin = {
+                        pluginPath: pluginModel.entryPoint.frontend!,
                         pluginFolder: pluginModel.packagePath,
                         pluginUri: pluginModel.packageUri,
                         model: pluginModel,
                         lifecycle: pluginLifecycle,
-                        get rawModel(): never {
-                            throw new Error('not supported');
-                        },
+                        rawModel,
                         isUnderDevelopment: !!plg.isUnderDevelopment
-                    }
-                };
-            }
-        }));
-        // Collect the ordered plugins and insert them in the target array:
-        for (const { target, plugin } of plugins) {
-            target.push(plugin);
-        }
-        return [result, foreign];
-    },
-    initExtApi(extApi: ExtPluginApi[]): void {
-        for (const api of extApi) {
-            try {
-                if (api.frontendExtApi) {
-                    ctx.importScripts(api.frontendExtApi.initPath);
-                    ctx[api.frontendExtApi.initVariable][api.frontendExtApi.initFunction](rpc, pluginsModulesNames);
+                    };
+                    const apiImpl = apiFactory(plugin);
+                    pluginsApiImpl.set(plugin.model.id, apiImpl);
+                    pluginsModulesNames.set(plugin.lifecycle.frontendModuleName!, plugin);
+                    return { target: result, plugin };
+                } else {
+                    return {
+                        target: foreign,
+                        plugin: {
+                            pluginPath: pluginModel.entryPoint.backend,
+                            pluginFolder: pluginModel.packagePath,
+                            pluginUri: pluginModel.packageUri,
+                            model: pluginModel,
+                            lifecycle: pluginLifecycle,
+                            get rawModel(): never {
+                                throw new Error('not supported');
+                            },
+                            isUnderDevelopment: !!plg.isUnderDevelopment
+                        }
+                    };
                 }
+            }));
+            // Collect the ordered plugins and insert them in the target array:
+            for (const { target, plugin } of plugins) {
+                target.push(plugin);
+            }
+            return [result, foreign];
+        },
+        initExtApi(extApi: ExtPluginApi[]): void {
+            for (const api of extApi) {
+                try {
+                    if (api.frontendExtApi) {
+                        ctx.importScripts(api.frontendExtApi.initPath);
+                        ctx[api.frontendExtApi.initVariable][api.frontendExtApi.initFunction](rpc, pluginsModulesNames);
+                    }
 
-            } catch (e) {
-                console.error(e);
+                } catch (e) {
+                    console.error(e);
+                }
             }
         }
-    }
-}, envExt, terminalService, storageProxy, secretsExt, preferenceRegistryExt, webviewExt, localizationExt, rpc);
+    });
+
+const envExt = container.get(EnvExtImpl);
+const debugExt = container.get(DebugExtImpl);
+const preferenceRegistryExt = container.get(PreferenceRegistryExtImpl);
+const editorsAndDocuments = container.get(EditorsAndDocumentsExtImpl);
+const workspaceExt = container.get(WorkspaceExtImpl);
+const messageRegistryExt = container.get(MessageRegistryExt);
+const clipboardExt = container.get(ClipboardExt);
+const webviewExt = container.get(WebviewsExtImpl);
+const localizationExt = container.get(LocalizationExtImpl);
+const storageProxy = container.get(KeyValueStorageProxy);
 
 const apiFactory = createAPIFactory(
     rpc,

package/src/hosted/browser/worker/worker-plugin-module.ts

@@ -0,0 +1,73 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+// eslint-disable-next-line import/no-extraneous-dependencies
+import 'reflect-metadata';
+import { ContainerModule } from '@theia/core/shared/inversify';
+import { BasicChannel } from '@theia/core/lib/common/message-rpc/channel';
+import { Uint8ArrayReadBuffer, Uint8ArrayWriteBuffer } from '@theia/core/lib/common/message-rpc/uint8-array-message-buffer';
+import { LocalizationExt } from '../../../common/plugin-api-rpc';
+import { RPCProtocol, RPCProtocolImpl } from '../../../common/rpc-protocol';
+import { ClipboardExt } from '../../../plugin/clipboard-ext';
+import { EditorsAndDocumentsExtImpl } from '../../../plugin/editors-and-documents';
+import { MessageRegistryExt } from '../../../plugin/message-registry';
+import { PluginManagerExtImpl } from '../../../plugin/plugin-manager';
+import { KeyValueStorageProxy } from '../../../plugin/plugin-storage';
+import { PreferenceRegistryExtImpl } from '../../../plugin/preference-registry';
+import { SecretsExtImpl } from '../../../plugin/secrets-ext';
+import { TerminalServiceExtImpl } from '../../../plugin/terminal-ext';
+import { WebviewsExtImpl } from '../../../plugin/webviews';
+import { WorkspaceExtImpl } from '../../../plugin/workspace';
+import { createDebugExtStub } from './debug-stub';
+import { EnvExtImpl } from '../../../plugin/env';
+import { WorkerEnvExtImpl } from './worker-env-ext';
+import { DebugExtImpl } from '../../../plugin/debug/debug-ext';
+import { LocalizationExtImpl } from '../../../plugin/localization-ext';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const ctx = self as any;
+
+export default new ContainerModule(bind => {
+    const channel = new BasicChannel(() => {
+        const writeBuffer = new Uint8ArrayWriteBuffer();
+        writeBuffer.onCommit(buffer => {
+            ctx.postMessage(buffer);
+        });
+        return writeBuffer;
+    });
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    addEventListener('message', (message: any) => {
+        channel.onMessageEmitter.fire(() => new Uint8ArrayReadBuffer(message.data));
+    });
+
+    const rpc = new RPCProtocolImpl(channel);
+
+    bind(RPCProtocol).toConstantValue(rpc);
+
+    bind(PluginManagerExtImpl).toSelf().inSingletonScope();
+    bind(EnvExtImpl).to(WorkerEnvExtImpl).inSingletonScope();
+    bind(LocalizationExt).to(LocalizationExtImpl).inSingletonScope();
+    bind(KeyValueStorageProxy).toSelf().inSingletonScope();
+    bind(SecretsExtImpl).toSelf().inSingletonScope();
+    bind(PreferenceRegistryExtImpl).toSelf().inSingletonScope();
+    bind(DebugExtImpl).toDynamicValue(({ container }) => createDebugExtStub(container))
+        .inSingletonScope();
+    bind(EditorsAndDocumentsExtImpl).toSelf().inSingletonScope();
+    bind(WorkspaceExtImpl).toSelf().inSingletonScope();
+    bind(MessageRegistryExt).toSelf().inSingletonScope();
+    bind(ClipboardExt).toSelf().inSingletonScope();
+    bind(WebviewsExtImpl).toSelf().inSingletonScope();
+    bind(TerminalServiceExtImpl).toSelf().inSingletonScope();
+});