@theia/plugin-ext 1.22.0-next.9 → 1.22.0

package/src/plugin/plugin-context.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2018 Red Hat, Inc. and others.
+ * Copyright (C) 2018-2022 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
@@ -724,13 +724,13 @@ export function createAPIFactory(
         const plugins: typeof theia.plugins = {
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             get all(): theia.Plugin<any>[] {
-                return pluginManager.getAllPlugins().map(plg => new Plugin(pluginManager, plg));
+                return pluginManager.getAllPlugins().map(plg => new PluginExt(pluginManager, plg));
             },
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             getPlugin(pluginId: string): theia.Plugin<any> | undefined {
                 const plg = pluginManager.getPluginById(pluginId.toLowerCase());
                 if (plg) {
-                    return new Plugin(pluginManager, plg);
+                    return new PluginExt(pluginManager, plg);
                 }
                 return undefined;
             },
@@ -780,9 +780,18 @@ export function createAPIFactory(
             registerDebugAdapterTrackerFactory(debugType: string, factory: theia.DebugAdapterTrackerFactory): Disposable {
                 return debugExt.registerDebugAdapterTrackerFactory(debugType, factory);
             },
-            startDebugging(folder: theia.WorkspaceFolder | undefined, nameOrConfiguration: string | theia.DebugConfiguration, options: theia.DebugSessionOptions):
-                Thenable<boolean> {
-                return debugExt.startDebugging(folder, nameOrConfiguration, options);
+            startDebugging(
+                folder: theia.WorkspaceFolder | undefined,
+                nameOrConfiguration: string | theia.DebugConfiguration,
+                parentSessionOrOptions?: theia.DebugSession | theia.DebugSessionOptions
+            ): Thenable<boolean> {
+                if (!parentSessionOrOptions || (typeof parentSessionOrOptions === 'object' && 'configuration' in parentSessionOrOptions)) {
+                    return debugExt.startDebugging(folder, nameOrConfiguration, { parentSession: parentSessionOrOptions });
+                }
+                return debugExt.startDebugging(folder, nameOrConfiguration, parentSessionOrOptions || {});
+            },
+            stopDebugging(session?: theia.DebugSession): Thenable<void> {
+                return debugExt.stopDebugging(session);
             },
             addBreakpoints(breakpoints: theia.Breakpoint[]): void {
                 debugExt.addBreakpoints(breakpoints);
@@ -969,14 +978,44 @@ export function createAPIFactory(
     };
 }
 
-class Plugin<T> implements theia.Plugin<T> {
+export enum ExtensionKind {
+    UI = 1,
+    Workspace = 2
+}
+
+/**
+ * Represents a Theia plugin as well as a VSCode extension.
+ */
+export interface ExtensionPlugin<T> extends theia.Plugin<T> {
+    /**
+     * The uri of the directory containing the extension. Same as {@linkcode theia.Plugin.pluginUri}.
+     */
+    readonly extensionUri: theia.Uri;
+
+    /**
+     * The absolute file path of the directory containing this extension.
+     * Same as {@linkcode theia.Plugin.pluginPath}.
+     */
+    readonly extensionPath: string;
+
+    /**
+     * The extension kind describes if an extension runs where the UI runs
+     * or if an extension runs where the remote extension host runs. The extension kind
+     * is defined in the `package.json`-file of extensions. When no remote extension host exists,
+     * the value is {@linkcode ExtensionKind.UI}.
+     */
+    extensionKind: ExtensionKind;
+}
+
+export class Plugin<T> implements theia.Plugin<T> {
     id: string;
     pluginPath: string;
     pluginUri: theia.Uri;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     packageJSON: any;
     pluginType: theia.PluginType;
-    constructor(private readonly pluginManager: PluginManager, plugin: InternalPlugin) {
+
+    constructor(protected readonly pluginManager: PluginManager, plugin: InternalPlugin) {
         this.id = plugin.model.id;
         this.pluginPath = plugin.pluginFolder;
         this.pluginUri = URI.parse(plugin.pluginUri);
@@ -996,3 +1035,29 @@ class Plugin<T> implements theia.Plugin<T> {
         return this.pluginManager.activatePlugin(this.id).then(() => this.exports);
     }
 }
+
+export class PluginExt<T> extends Plugin<T> implements ExtensionPlugin<T> {
+    extensionPath: string;
+    extensionUri: theia.Uri;
+    extensionKind: ExtensionKind;
+
+    constructor(protected readonly pluginManager: PluginManager, plugin: InternalPlugin) {
+        super(pluginManager, plugin);
+
+        this.extensionPath = this.pluginPath;
+        this.extensionUri = this.pluginUri;
+        this.extensionKind = ExtensionKind.UI; // stub as a local extension (not running on a remote workspace)
+    }
+
+    get isActive(): boolean {
+        return this.pluginManager.isActive(this.id);
+    }
+
+    get exports(): T {
+        return <T>this.pluginManager.getPluginExport(this.id);
+    }
+
+    activate(): PromiseLike<T> {
+        return this.pluginManager.activatePlugin(this.id).then(() => this.exports);
+    }
+}

package/src/plugin/plugin-manager.ts

@@ -40,6 +40,7 @@ import { Emitter } from '@theia/core/lib/common/event';
 import { WebviewsExtImpl } from './webviews';
 import { URI as Uri } from './types-impl';
 import { SecretsExtImpl, SecretStorageExt } from '../plugin/secrets-ext';
+import { PluginExt } from './plugin-context';
 
 export interface PluginHost {
 
@@ -383,7 +384,9 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
             globalStoragePath: globalStoragePath,
             globalStorageUri: Uri.file(globalStoragePath),
             environmentVariableCollection: this.terminalService.getEnvironmentVariableCollection(plugin.model.id),
-            extensionMode: 1 // @todo: implement proper `extensionMode`.
+            extensionMode: 1, // @todo: implement proper `extensionMode`.
+            extension: new PluginExt(this, plugin),
+            logUri: Uri.file(logPath)
         };
         this.pluginContextsMap.set(plugin.model.id, pluginContext);
 

package/src/plugin/types-impl.spec.ts

@@ -14,13 +14,14 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
+import { isWindows } from '@theia/core';
 import * as assert from 'assert';
 import * as types from './types-impl';
 
 describe('API Type Implementations:', () => {
 
     describe('URI:', () => {
-         it('should convert to string', () => {
+        it('should convert to string', () => {
             const uriString = 'scheme://authority.com/foo/bar/zoz?query#fragment';
             const uri = types.URI.parse(uriString);
             // when
@@ -29,5 +30,40 @@ describe('API Type Implementations:', () => {
             // then
             assert.strictEqual(result, uriString);
         });
+
+        // Issue: #10370
+        it('should returns correct path while using joinPath()', () => {
+            if (isWindows) {
+                assert.strictEqual(types.URI.joinPath(types.URI.file('c:\\foo\\bar'), '/file.js').toString(), 'file:///c%3A/foo/bar/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('c:\\foo\\bar\\'), 'file.js').toString(), 'file:///c%3A/foo/bar/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('c:\\foo\\bar\\'), '/file.js').toString(), 'file:///c%3A/foo/bar/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('c:\\'), '/file.js').toString(), 'file:///c%3A/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('c:\\'), 'bar/file.js').toString(), 'file:///c%3A/bar/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('c:\\foo'), './file.js').toString(), 'file:///c%3A/foo/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('c:\\foo'), '/./file.js').toString(), 'file:///c%3A/foo/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('C:\\foo'), '../file.js').toString(), 'file:///c%3A/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('C:\\foo\\.'), '../file.js').toString(), 'file:///c%3A/file.js');
+            } else {
+                assert.strictEqual(types.URI.joinPath(types.URI.file('/foo/bar'), '/file.js').toString(), 'file:///foo/bar/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('/foo/bar'), 'file.js').toString(), 'file:///foo/bar/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('/foo/bar/'), '/file.js').toString(), 'file:///foo/bar/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('/'), '/file.js').toString(), 'file:///file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('/foo/bar'), './file.js').toString(), 'file:///foo/bar/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('/foo/bar'), '/./file.js').toString(), 'file:///foo/bar/file.js');
+                assert.strictEqual(types.URI.joinPath(types.URI.file('/foo/bar'), '../file.js').toString(), 'file:///foo/file.js');
+            }
+            assert.strictEqual(types.URI.joinPath(types.URI.parse('foo://a/foo/bar')).toString(), 'foo://a/foo/bar');
+            assert.strictEqual(types.URI.joinPath(types.URI.parse('foo://a/foo/bar'), '/file.js').toString(), 'foo://a/foo/bar/file.js');
+            assert.strictEqual(types.URI.joinPath(types.URI.parse('foo://a/foo/bar'), 'file.js').toString(), 'foo://a/foo/bar/file.js');
+            assert.strictEqual(types.URI.joinPath(types.URI.parse('foo://a/foo/bar/'), '/file.js').toString(), 'foo://a/foo/bar/file.js');
+            assert.strictEqual(types.URI.joinPath(types.URI.parse('foo://a/'), '/file.js').toString(), 'foo://a/file.js');
+            assert.strictEqual(types.URI.joinPath(types.URI.parse('foo://a/foo/bar/'), './file.js').toString(), 'foo://a/foo/bar/file.js');
+            assert.strictEqual(types.URI.joinPath(types.URI.parse('foo://a/foo/bar/'), '/./file.js').toString(), 'foo://a/foo/bar/file.js');
+            assert.strictEqual(types.URI.joinPath(types.URI.parse('foo://a/foo/bar/'), '../file.js').toString(), 'foo://a/foo/file.js');
+
+            assert.strictEqual(
+                types.URI.joinPath(types.URI.from({ scheme: 'myScheme', authority: 'authority', path: '/path', query: 'query', fragment: 'fragment' }), '/file.js').toString(),
+                'myScheme://authority/path/file.js?query#fragment');
+        });
     });
 });

package/src/plugin/types-impl.ts

@@ -82,7 +82,7 @@ export class URI extends CodeURI implements theia.Uri {
         if (!uri.path) {
             throw new Error('\'joinPath\' called on URI without path');
         }
-        const newPath = paths.resolve(uri.path, ...pathSegments);
+        const newPath = paths.posix.join(uri.path, ...pathSegments);
         return new URI(uri.scheme, uri.authority, newPath, uri.query, uri.fragment);
     }