Support 'logUri' and 'extension' (partially) to PluginContext

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

@@ -0,0 +1,42 @@
+/********************************************************************************
+ * Copyright (C) 2022 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 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import * as theia from '@theia/plugin';
+
+export enum ExtensionKind {
+    UI = 1,
+    Workspace = 2
+}
+
+export interface VsCodeExtension<T> extends theia.Plugin<T> {
+    readonly extensionUri: theia.Uri;
+    readonly extensionPath: string;
+    extensionKind: ExtensionKind;
+}
+
+export interface VsCodeExtensionContext extends theia.PluginContext {
+    readonly extension: VsCodeExtension<any>;
+}
+
+export function asVsCodeExtension<T>(plugin: theia.Plugin<T> | undefined): VsCodeExtension<T> | undefined {
+    return plugin && Object.assign(plugin, {
+        extensionPath: plugin.pluginPath,
+        extensionUri: plugin.pluginUri,
+        extensionKind: ExtensionKind.UI // stub as a local VS Code extension (not running on a remote workspace)
+    });
+}

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

@@ -19,6 +19,7 @@
 import * as theia from '@theia/plugin';
 import { BackendInitializationFn, PluginAPIFactory, Plugin, emptyPlugin } from '@theia/plugin-ext';
 import { VSCODE_DEFAULT_API_VERSION } from '../common/plugin-vscode-types';
+import { asVsCodeExtension, ExtensionKind } from './plugin-vscode-extension';
 
 process.env['VSCODE_PID'] = process.env['THEIA_PARENT_PID'];
 
@@ -28,11 +29,6 @@ let defaultApi: typeof theia;
 let isLoadOverride = false;
 let pluginApiFactory: PluginAPIFactory;
 
-export enum ExtensionKind {
-    UI = 1,
-    Workspace = 2
-}
-
 export const doInitialization: BackendInitializationFn = (apiFactory: PluginAPIFactory, plugin: Plugin) => {
     pluginsApiImpl.set(plugin.model.id, createVSCodeAPI(apiFactory, plugin));
     plugins.push(plugin);
@@ -50,10 +46,10 @@ function createVSCodeAPI(apiFactory: PluginAPIFactory, plugin: Plugin): typeof t
     // use Theia plugin api instead vscode extensions
     (<any>vscode).extensions = {
         get all(): any[] {
-            return vscode.plugins.all.map(p => asExtension(p));
+            return vscode.plugins.all.map(p => asVsCodeExtension(p));
         },
         getExtension(pluginId: string): any | undefined {
-            return asExtension(vscode.plugins.getPlugin(pluginId));
+            return asVsCodeExtension(vscode.plugins.getPlugin(pluginId));
         },
         get onDidChange(): theia.Event<void> {
             return vscode.plugins.onDidChange;
@@ -96,19 +92,3 @@ function overrideInternalLoad(): void {
 function findPlugin(filePath: string): Plugin | undefined {
     return plugins.find(plugin => filePath.startsWith(plugin.pluginFolder));
 }
-
-function asExtension(plugin: any | undefined): any | undefined {
-    if (!plugin) {
-        return plugin;
-    }
-    if (plugin.pluginPath) {
-        plugin.extensionPath = plugin.pluginPath;
-    }
-
-    if (plugin.pluginUri) {
-        plugin.extensionUri = plugin.pluginUri;
-    }
-    // stub as a local VS Code extension (not running on a remote workspace)
-    plugin.extensionKind = ExtensionKind.UI;
-    return plugin;
-}

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

@@ -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 TheiaPlugin(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 TheiaPlugin(pluginManager, plg);
                 }
                 return undefined;
             },
@@ -972,7 +972,7 @@ export function createAPIFactory(
     };
 }
 
-class Plugin<T> implements theia.Plugin<T> {
+export class TheiaPlugin<T> implements theia.Plugin<T> {
     id: string;
     pluginPath: string;
     pluginUri: theia.Uri;

packages/plugin-ext/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 { TheiaPlugin } 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 TheiaPlugin(this, plugin),
+            logUri: Uri.file(logPath)
         };
         this.pluginContextsMap.set(plugin.model.id, pluginContext);
 

packages/plugin/src/theia.d.ts

@@ -3195,6 +3195,19 @@ export module '@theia/plugin' {
          * other extensions in the host run in `ExtensionMode.Release`.
          */
         readonly extensionMode: ExtensionMode;
+
+        /**
+         * The current extension instance.
+         */
+        readonly extension: Plugin<any> | undefined;
+
+        /**
+         * The uri of a directory in which the extension can create log files. The directory might
+         * not exist on disk and creation is up to the extension. However, the parent directory is
+         * guaranteed to be existent.
+         * see - workspace.fs for how to read and write files and folders from an uri.
+         */
+        readonly logUri: Uri;
     }
 
     /**