@theia/plugin-ext 1.45.0 → 1.46.0-next.72

package/src/hosted/node/hosted-plugin.ts

@@ -1,116 +1,116 @@
-// *****************************************************************************
-// Copyright (C) 2018 Red Hat, Inc. 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
-// *****************************************************************************
-
-import { injectable, inject, multiInject, postConstruct, optional } from '@theia/core/shared/inversify';
-import { ILogger, ConnectionErrorHandler } from '@theia/core/lib/common';
-import { HostedPluginClient, PluginModel, ServerPluginRunner, DeployedPlugin, PluginIdentifiers } from '../../common/plugin-protocol';
-import { LogPart } from '../../common/types';
-import { HostedPluginProcess } from './hosted-plugin-process';
-
-export interface IPCConnectionOptions {
-    readonly serverName: string;
-    readonly logger: ILogger;
-    readonly args: string[];
-    readonly errorHandler?: ConnectionErrorHandler;
-}
-
-@injectable()
-export class HostedPluginSupport {
-    private isPluginProcessRunning = false;
-    private client: HostedPluginClient;
-
-    @inject(ILogger)
-    protected readonly logger: ILogger;
-
-    @inject(HostedPluginProcess)
-    protected readonly hostedPluginProcess: HostedPluginProcess;
-
-    /**
-     * Optional runners to delegate some work
-     */
-    @optional()
-    @multiInject(ServerPluginRunner)
-    private readonly pluginRunners: ServerPluginRunner[];
-
-    @postConstruct()
-    protected init(): void {
-        this.pluginRunners.forEach(runner => {
-            runner.setDefault(this.hostedPluginProcess);
-        });
-    }
-
-    setClient(client: HostedPluginClient): void {
-        this.client = client;
-        this.hostedPluginProcess.setClient(client);
-        this.pluginRunners.forEach(runner => runner.setClient(client));
-    }
-
-    clientClosed(): void {
-        this.isPluginProcessRunning = false;
-        this.terminatePluginServer();
-        this.isPluginProcessRunning = false;
-        this.pluginRunners.forEach(runner => runner.clientClosed());
-    }
-
-    runPlugin(plugin: PluginModel): void {
-        if (!plugin.entryPoint.frontend) {
-            this.runPluginServer();
-        }
-    }
-
-    onMessage(pluginHostId: string, message: Uint8Array): void {
-        // need to perform routing
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        if (this.pluginRunners.length > 0) {
-            this.pluginRunners.forEach(runner => {
-                if (runner.acceptMessage(pluginHostId, message)) {
-                    runner.onMessage(pluginHostId, message);
-                }
-            });
-        } else {
-            this.hostedPluginProcess.onMessage(pluginHostId, message);
-        }
-    }
-
-    runPluginServer(): void {
-        if (!this.isPluginProcessRunning) {
-            this.hostedPluginProcess.runPluginServer();
-            this.isPluginProcessRunning = true;
-        }
-    }
-
-    /**
-     * Provides additional plugin ids.
-     */
-    async getExtraDeployedPluginIds(): Promise<PluginIdentifiers.VersionedId[]> {
-        return [].concat.apply([], await Promise.all(this.pluginRunners.map(runner => runner.getExtraDeployedPluginIds())));
-    }
-
-    /**
-     * Provides additional deployed plugins.
-     */
-    async getExtraDeployedPlugins(): Promise<DeployedPlugin[]> {
-        return [].concat.apply([], await Promise.all(this.pluginRunners.map(runner => runner.getExtraDeployedPlugins())));
-    }
-
-    sendLog(logPart: LogPart): void {
-        this.client.log(logPart);
-    }
-
-    private terminatePluginServer(): void {
-        this.hostedPluginProcess.terminatePluginServer();
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 Red Hat, Inc. 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
+// *****************************************************************************
+
+import { injectable, inject, multiInject, postConstruct, optional } from '@theia/core/shared/inversify';
+import { ILogger, ConnectionErrorHandler } from '@theia/core/lib/common';
+import { HostedPluginClient, PluginModel, ServerPluginRunner, DeployedPlugin, PluginIdentifiers } from '../../common/plugin-protocol';
+import { LogPart } from '../../common/types';
+import { HostedPluginProcess } from './hosted-plugin-process';
+
+export interface IPCConnectionOptions {
+    readonly serverName: string;
+    readonly logger: ILogger;
+    readonly args: string[];
+    readonly errorHandler?: ConnectionErrorHandler;
+}
+
+@injectable()
+export class HostedPluginSupport {
+    private isPluginProcessRunning = false;
+    private client: HostedPluginClient;
+
+    @inject(ILogger)
+    protected readonly logger: ILogger;
+
+    @inject(HostedPluginProcess)
+    protected readonly hostedPluginProcess: HostedPluginProcess;
+
+    /**
+     * Optional runners to delegate some work
+     */
+    @optional()
+    @multiInject(ServerPluginRunner)
+    private readonly pluginRunners: ServerPluginRunner[];
+
+    @postConstruct()
+    protected init(): void {
+        this.pluginRunners.forEach(runner => {
+            runner.setDefault(this.hostedPluginProcess);
+        });
+    }
+
+    setClient(client: HostedPluginClient): void {
+        this.client = client;
+        this.hostedPluginProcess.setClient(client);
+        this.pluginRunners.forEach(runner => runner.setClient(client));
+    }
+
+    clientClosed(): void {
+        this.isPluginProcessRunning = false;
+        this.terminatePluginServer();
+        this.isPluginProcessRunning = false;
+        this.pluginRunners.forEach(runner => runner.clientClosed());
+    }
+
+    runPlugin(plugin: PluginModel): void {
+        if (!plugin.entryPoint.frontend) {
+            this.runPluginServer();
+        }
+    }
+
+    onMessage(pluginHostId: string, message: Uint8Array): void {
+        // need to perform routing
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        if (this.pluginRunners.length > 0) {
+            this.pluginRunners.forEach(runner => {
+                if (runner.acceptMessage(pluginHostId, message)) {
+                    runner.onMessage(pluginHostId, message);
+                }
+            });
+        } else {
+            this.hostedPluginProcess.onMessage(pluginHostId, message);
+        }
+    }
+
+    runPluginServer(): void {
+        if (!this.isPluginProcessRunning) {
+            this.hostedPluginProcess.runPluginServer();
+            this.isPluginProcessRunning = true;
+        }
+    }
+
+    /**
+     * Provides additional plugin ids.
+     */
+    async getExtraDeployedPluginIds(): Promise<PluginIdentifiers.VersionedId[]> {
+        return [].concat.apply([], await Promise.all(this.pluginRunners.map(runner => runner.getExtraDeployedPluginIds())));
+    }
+
+    /**
+     * Provides additional deployed plugins.
+     */
+    async getExtraDeployedPlugins(): Promise<DeployedPlugin[]> {
+        return [].concat.apply([], await Promise.all(this.pluginRunners.map(runner => runner.getExtraDeployedPlugins())));
+    }
+
+    sendLog(logPart: LogPart): void {
+        this.client.log(logPart);
+    }
+
+    private terminatePluginServer(): void {
+        this.hostedPluginProcess.terminatePluginServer();
+    }
+}

package/src/hosted/node/metadata-scanner.ts

@@ -1,64 +1,64 @@
-// *****************************************************************************
-// Copyright (C) 2015-2018 Red Hat, Inc.
-//
-// 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
-// *****************************************************************************
-
-import { inject, injectable, multiInject } from '@theia/core/shared/inversify';
-import { PluginPackage, PluginScanner, PluginMetadata, PLUGIN_HOST_BACKEND, PluginIdentifiers } from '../../common/plugin-protocol';
-import { PluginUninstallationManager } from '../../main/node/plugin-uninstallation-manager';
-@injectable()
-export class MetadataScanner {
-    private scanners: Map<string, PluginScanner> = new Map();
-
-    @inject(PluginUninstallationManager) protected readonly uninstallationManager: PluginUninstallationManager;
-
-    constructor(@multiInject(PluginScanner) scanners: PluginScanner[]) {
-        scanners.forEach((scanner: PluginScanner) => {
-            this.scanners.set(scanner.apiType, scanner);
-        });
-    }
-
-    getPluginMetadata(plugin: PluginPackage): PluginMetadata {
-        const scanner = this.getScanner(plugin);
-        return {
-            host: PLUGIN_HOST_BACKEND,
-            model: scanner.getModel(plugin),
-            lifecycle: scanner.getLifecycle(plugin),
-            outOfSync: this.uninstallationManager.isUninstalled(PluginIdentifiers.componentsToVersionedId(plugin)),
-        };
-    }
-
-    /**
-     * Returns the first suitable scanner.
-     *
-     * Throws if no scanner was found.
-     *
-     * @param {PluginPackage} plugin
-     * @returns {PluginScanner}
-     */
-    getScanner(plugin: PluginPackage): PluginScanner {
-        let scanner: PluginScanner | undefined;
-        if (plugin && plugin.engines) {
-            const scanners = Object.keys(plugin.engines)
-                .filter(engineName => this.scanners.has(engineName))
-                .map(engineName => this.scanners.get(engineName)!);
-            // get the first suitable scanner from the list
-            scanner = scanners[0];
-        }
-        if (!scanner) {
-            throw new Error('There is no suitable scanner found for ' + plugin.name);
-        }
-        return scanner;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2015-2018 Red Hat, Inc.
+//
+// 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
+// *****************************************************************************
+
+import { inject, injectable, multiInject } from '@theia/core/shared/inversify';
+import { PluginPackage, PluginScanner, PluginMetadata, PLUGIN_HOST_BACKEND, PluginIdentifiers } from '../../common/plugin-protocol';
+import { PluginUninstallationManager } from '../../main/node/plugin-uninstallation-manager';
+@injectable()
+export class MetadataScanner {
+    private scanners: Map<string, PluginScanner> = new Map();
+
+    @inject(PluginUninstallationManager) protected readonly uninstallationManager: PluginUninstallationManager;
+
+    constructor(@multiInject(PluginScanner) scanners: PluginScanner[]) {
+        scanners.forEach((scanner: PluginScanner) => {
+            this.scanners.set(scanner.apiType, scanner);
+        });
+    }
+
+    getPluginMetadata(plugin: PluginPackage): PluginMetadata {
+        const scanner = this.getScanner(plugin);
+        return {
+            host: PLUGIN_HOST_BACKEND,
+            model: scanner.getModel(plugin),
+            lifecycle: scanner.getLifecycle(plugin),
+            outOfSync: this.uninstallationManager.isUninstalled(PluginIdentifiers.componentsToVersionedId(plugin)),
+        };
+    }
+
+    /**
+     * Returns the first suitable scanner.
+     *
+     * Throws if no scanner was found.
+     *
+     * @param {PluginPackage} plugin
+     * @returns {PluginScanner}
+     */
+    getScanner(plugin: PluginPackage): PluginScanner {
+        let scanner: PluginScanner | undefined;
+        if (plugin && plugin.engines) {
+            const scanners = Object.keys(plugin.engines)
+                .filter(engineName => this.scanners.has(engineName))
+                .map(engineName => this.scanners.get(engineName)!);
+            // get the first suitable scanner from the list
+            scanner = scanners[0];
+        }
+        if (!scanner) {
+            throw new Error('There is no suitable scanner found for ' + plugin.name);
+        }
+        return scanner;
+    }
+}

package/src/hosted/node/plugin-activation-events.ts

@@ -1,112 +1,112 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox 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
-// *****************************************************************************
-
-import { flatten } from '../../common/arrays';
-import { isStringArray, isObject } from '@theia/core/lib/common/types';
-import {
-    PluginPackage,
-    PluginPackageAuthenticationProvider,
-    PluginPackageCommand,
-    PluginPackageContribution,
-    PluginPackageCustomEditor,
-    PluginPackageLanguageContribution,
-    PluginPackageNotebook,
-    PluginPackageView
-} from '../../common/plugin-protocol';
-
-/**
- * Most activation events can be automatically deduced from the package manifest.
- * This function will update the manifest based on the plugin contributions.
- */
-export function updateActivationEvents(manifest: PluginPackage): void {
-    if (!isObject<PluginPackage>(manifest) || !isObject<PluginPackageContribution>(manifest.contributes) || !manifest.contributes) {
-        return;
-    }
-
-    const activationEvents = new Set(isStringArray(manifest.activationEvents) ? manifest.activationEvents : []);
-
-    if (manifest.contributes.commands) {
-        const value = manifest.contributes.commands;
-        const commands = Array.isArray(value) ? value : [value];
-        updateCommandsContributions(commands, activationEvents);
-    }
-    if (isObject(manifest.contributes.views)) {
-        const views = flatten(Object.values(manifest.contributes.views));
-        updateViewsContribution(views, activationEvents);
-    }
-    if (Array.isArray(manifest.contributes.customEditors)) {
-        updateCustomEditorsContribution(manifest.contributes.customEditors, activationEvents);
-    }
-    if (Array.isArray(manifest.contributes.authentication)) {
-        updateAuthenticationProviderContributions(manifest.contributes.authentication, activationEvents);
-    }
-    if (Array.isArray(manifest.contributes.languages)) {
-        updateLanguageContributions(manifest.contributes.languages, activationEvents);
-    }
-    if (Array.isArray(manifest.contributes.notebooks)) {
-        updateNotebookContributions(manifest.contributes.notebooks, activationEvents);
-    }
-
-    manifest.activationEvents = Array.from(activationEvents);
-}
-
-function updateViewsContribution(views: PluginPackageView[], activationEvents: Set<string>): void {
-    for (const view of views) {
-        if (isObject<PluginPackageView>(view) && typeof view.id === 'string') {
-            activationEvents.add(`onView:${view.id}`);
-        }
-    }
-}
-
-function updateCustomEditorsContribution(customEditors: PluginPackageCustomEditor[], activationEvents: Set<string>): void {
-    for (const customEditor of customEditors) {
-        if (isObject<PluginPackageCustomEditor>(customEditor) && typeof customEditor.viewType === 'string') {
-            activationEvents.add(`onCustomEditor:${customEditor.viewType}`);
-        }
-    }
-}
-
-function updateCommandsContributions(commands: PluginPackageCommand[], activationEvents: Set<string>): void {
-    for (const command of commands) {
-        if (isObject<PluginPackageCommand>(command) && typeof command.command === 'string') {
-            activationEvents.add(`onCommand:${command.command}`);
-        }
-    }
-}
-
-function updateAuthenticationProviderContributions(authProviders: PluginPackageAuthenticationProvider[], activationEvents: Set<string>): void {
-    for (const authProvider of authProviders) {
-        if (isObject<PluginPackageAuthenticationProvider>(authProvider) && typeof authProvider.id === 'string') {
-            activationEvents.add(`onAuthenticationRequest:${authProvider.id}`);
-        }
-    }
-}
-
-function updateLanguageContributions(languages: PluginPackageLanguageContribution[], activationEvents: Set<string>): void {
-    for (const language of languages) {
-        if (isObject<PluginPackageLanguageContribution>(language) && typeof language.id === 'string') {
-            activationEvents.add(`onLanguage:${language.id}`);
-        }
-    }
-}
-
-function updateNotebookContributions(notebooks: PluginPackageNotebook[], activationEvents: Set<string>): void {
-    for (const notebook of notebooks) {
-        if (isObject<PluginPackageNotebook>(notebook) && typeof notebook.type === 'string') {
-            activationEvents.add(`onNotebookSerializer:${notebook.type}`);
-        }
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox 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
+// *****************************************************************************
+
+import { flatten } from '../../common/arrays';
+import { isStringArray, isObject } from '@theia/core/lib/common/types';
+import {
+    PluginPackage,
+    PluginPackageAuthenticationProvider,
+    PluginPackageCommand,
+    PluginPackageContribution,
+    PluginPackageCustomEditor,
+    PluginPackageLanguageContribution,
+    PluginPackageNotebook,
+    PluginPackageView
+} from '../../common/plugin-protocol';
+
+/**
+ * Most activation events can be automatically deduced from the package manifest.
+ * This function will update the manifest based on the plugin contributions.
+ */
+export function updateActivationEvents(manifest: PluginPackage): void {
+    if (!isObject<PluginPackage>(manifest) || !isObject<PluginPackageContribution>(manifest.contributes) || !manifest.contributes) {
+        return;
+    }
+
+    const activationEvents = new Set(isStringArray(manifest.activationEvents) ? manifest.activationEvents : []);
+
+    if (manifest.contributes.commands) {
+        const value = manifest.contributes.commands;
+        const commands = Array.isArray(value) ? value : [value];
+        updateCommandsContributions(commands, activationEvents);
+    }
+    if (isObject(manifest.contributes.views)) {
+        const views = flatten(Object.values(manifest.contributes.views));
+        updateViewsContribution(views, activationEvents);
+    }
+    if (Array.isArray(manifest.contributes.customEditors)) {
+        updateCustomEditorsContribution(manifest.contributes.customEditors, activationEvents);
+    }
+    if (Array.isArray(manifest.contributes.authentication)) {
+        updateAuthenticationProviderContributions(manifest.contributes.authentication, activationEvents);
+    }
+    if (Array.isArray(manifest.contributes.languages)) {
+        updateLanguageContributions(manifest.contributes.languages, activationEvents);
+    }
+    if (Array.isArray(manifest.contributes.notebooks)) {
+        updateNotebookContributions(manifest.contributes.notebooks, activationEvents);
+    }
+
+    manifest.activationEvents = Array.from(activationEvents);
+}
+
+function updateViewsContribution(views: PluginPackageView[], activationEvents: Set<string>): void {
+    for (const view of views) {
+        if (isObject<PluginPackageView>(view) && typeof view.id === 'string') {
+            activationEvents.add(`onView:${view.id}`);
+        }
+    }
+}
+
+function updateCustomEditorsContribution(customEditors: PluginPackageCustomEditor[], activationEvents: Set<string>): void {
+    for (const customEditor of customEditors) {
+        if (isObject<PluginPackageCustomEditor>(customEditor) && typeof customEditor.viewType === 'string') {
+            activationEvents.add(`onCustomEditor:${customEditor.viewType}`);
+        }
+    }
+}
+
+function updateCommandsContributions(commands: PluginPackageCommand[], activationEvents: Set<string>): void {
+    for (const command of commands) {
+        if (isObject<PluginPackageCommand>(command) && typeof command.command === 'string') {
+            activationEvents.add(`onCommand:${command.command}`);
+        }
+    }
+}
+
+function updateAuthenticationProviderContributions(authProviders: PluginPackageAuthenticationProvider[], activationEvents: Set<string>): void {
+    for (const authProvider of authProviders) {
+        if (isObject<PluginPackageAuthenticationProvider>(authProvider) && typeof authProvider.id === 'string') {
+            activationEvents.add(`onAuthenticationRequest:${authProvider.id}`);
+        }
+    }
+}
+
+function updateLanguageContributions(languages: PluginPackageLanguageContribution[], activationEvents: Set<string>): void {
+    for (const language of languages) {
+        if (isObject<PluginPackageLanguageContribution>(language) && typeof language.id === 'string') {
+            activationEvents.add(`onLanguage:${language.id}`);
+        }
+    }
+}
+
+function updateNotebookContributions(notebooks: PluginPackageNotebook[], activationEvents: Set<string>): void {
+    for (const notebook of notebooks) {
+        if (isObject<PluginPackageNotebook>(notebook) && typeof notebook.type === 'string') {
+            activationEvents.add(`onNotebookSerializer:${notebook.type}`);
+        }
+    }
+}