Fix vscode.env.appRoot path (#13285)

eclipse-theia · Jan 24, 2024 · 725a7d2 · 725a7d2
1 parent aeee83b
commit 725a7d2
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 13 deletions.
diff --git a/packages/core/src/browser-only/frontend-only-application-module.ts b/packages/core/src/browser-only/frontend-only-application-module.ts
@@ -55,6 +55,7 @@ export const frontendOnlyApplicationModule = new ContainerModule((bind, unbind,
     const mockedApplicationServer: ApplicationServer = {
         getExtensionsInfos: async (): Promise<ExtensionInfo[]> => [],
         getApplicationInfo: async (): Promise<ApplicationInfo | undefined> => undefined,
+        getApplicationRoot: async (): Promise<string> => '',
         getBackendOS: async (): Promise<OS.Type> => OS.Type.Linux
     };
     if (isBound(ApplicationServer)) {

diff --git a/packages/core/src/common/application-protocol.ts b/packages/core/src/common/application-protocol.ts
@@ -23,6 +23,7 @@ export const ApplicationServer = Symbol('ApplicationServer');
 export interface ApplicationServer {
     getExtensionsInfos(): Promise<ExtensionInfo[]>;
     getApplicationInfo(): Promise<ApplicationInfo | undefined>;
+    getApplicationRoot(): Promise<string>;
     /**
      * @deprecated since 1.25.0. Use `OS.backend.type()` instead.
      */

diff --git a/packages/core/src/node/application-server.ts b/packages/core/src/node/application-server.ts
@@ -37,11 +37,18 @@ export class ApplicationServerImpl implements ApplicationServer {
             const name = pck.name;
             const version = pck.version;
 
-            return Promise.resolve({ name, version });
+            return Promise.resolve({
+                name,
+                version
+            });
         }
         return Promise.resolve(undefined);
     }
 
+    getApplicationRoot(): Promise<string> {
+        return Promise.resolve(this.applicationPackage.projectPath);
+    }
+
     async getBackendOS(): Promise<OS.Type> {
         return OS.type();
     }

diff --git a/packages/plugin-ext/src/common/plugin-api-rpc.ts b/packages/plugin-ext/src/common/plugin-api-rpc.ts
@@ -163,9 +163,10 @@ export interface EnvInit {
     queryParams: QueryParameters;
     language: string;
     shell: string;
-    uiKind: UIKind,
+    uiKind: UIKind;
     appName: string;
     appHost: string;
+    appRoot: string;
 }
 
 export interface PluginAPI {

diff --git a/packages/plugin-ext/src/hosted/browser/hosted-plugin.ts b/packages/plugin-ext/src/hosted/browser/hosted-plugin.ts
@@ -66,6 +66,7 @@ import { LanguageService } from '@theia/monaco-editor-core/esm/vs/editor/common/
 import { Uint8ArrayReadBuffer, Uint8ArrayWriteBuffer } from '@theia/core/lib/common/message-rpc/uint8-array-message-buffer';
 import { BasicChannel } from '@theia/core/lib/common/message-rpc/channel';
 import { NotebookTypeRegistry, NotebookService, NotebookRendererMessagingService } from '@theia/notebook/lib/browser';
+import { ApplicationServer } from '@theia/core/lib/common/application-protocol';
 import {
     AbstractHostedPluginSupport, PluginContributions, PluginHost,
     ALL_ACTIVATION_EVENT, isConnectionScopedBackendPlugin
@@ -174,6 +175,9 @@ export class HostedPluginSupport extends AbstractHostedPluginSupport<PluginManag
     @inject(PluginCustomEditorRegistry)
     protected readonly customEditorRegistry: PluginCustomEditorRegistry;
 
+    @inject(ApplicationServer)
+    protected readonly applicationServer: ApplicationServer;
+
     constructor() {
         super(generateUuid());
     }
@@ -302,7 +306,10 @@ export class HostedPluginSupport extends AbstractHostedPluginSupport<PluginManag
             const isElectron = environment.electron.is();
 
             const supportedActivationEvents = [...HostedPluginSupport.BUILTIN_ACTIVATION_EVENTS];
-            const additionalActivationEvents = await this.envServer.getValue(HostedPluginSupport.ADDITIONAL_ACTIVATION_EVENTS_ENV);
+            const [additionalActivationEvents, appRoot] = await Promise.all([
+                this.envServer.getValue(HostedPluginSupport.ADDITIONAL_ACTIVATION_EVENTS_ENV),
+                this.applicationServer.getApplicationRoot()
+            ]);
             if (additionalActivationEvents && additionalActivationEvents.value) {
                 additionalActivationEvents.value.split(',').forEach(event => supportedActivationEvents.push(event));
             }
@@ -317,7 +324,8 @@ export class HostedPluginSupport extends AbstractHostedPluginSupport<PluginManag
                     shell: defaultShell,
                     uiKind: isElectron ? UIKind.Desktop : UIKind.Web,
                     appName: FrontendApplicationConfigProvider.get().applicationName,
-                    appHost: isElectron ? 'desktop' : 'web' // TODO: 'web' could be the embedder's name, e.g. 'github.dev'
+                    appHost: isElectron ? 'desktop' : 'web', // TODO: 'web' could be the embedder's name, e.g. 'github.dev'
+                    appRoot
                 },
                 extApi,
                 webview: {

diff --git a/packages/plugin-ext/src/hosted/browser/worker/worker-env-ext.ts b/packages/plugin-ext/src/hosted/browser/worker/worker-env-ext.ts
@@ -31,7 +31,7 @@ export class WorkerEnvExtImpl extends EnvExtImpl {
     /**
      * Throw error for app-root as there is no filesystem in worker context
      */
-    get appRoot(): string {
+    override get appRoot(): string {
         throw new Error('There is no app root in worker context');
     }
 

diff --git a/packages/plugin-ext/src/plugin/env.ts b/packages/plugin-ext/src/plugin/env.ts
@@ -34,6 +34,7 @@ export abstract class EnvExtImpl {
     private envMachineId: string;
     private envSessionId: string;
     private host: string;
+    private applicationRoot: string;
     private _remoteName: string | undefined;
 
     constructor() {
@@ -84,6 +85,10 @@ export abstract class EnvExtImpl {
         this.host = appHost;
     }
 
+    setAppRoot(appRoot: string): void {
+        this.applicationRoot = appRoot;
+    }
+
     getClientOperatingSystem(): Promise<theia.OperatingSystem> {
         return this.proxy.$getClientOperatingSystem();
     }
@@ -92,7 +97,9 @@ export abstract class EnvExtImpl {
         return this.applicationName;
     }
 
-    abstract get appRoot(): string;
+    get appRoot(): string {
+        return this.applicationRoot;
+    }
 
     abstract get isNewAppInstall(): boolean;
 

diff --git a/packages/plugin-ext/src/plugin/node/env-node-ext.ts b/packages/plugin-ext/src/plugin/node/env-node-ext.ts
@@ -51,13 +51,6 @@ export class EnvNodeExtImpl extends EnvExtImpl {
         return this.macMachineId;
     }
 
-    /**
-     * Provides application root.
-     */
-    get appRoot(): string {
-        return __dirname;
-    }
-
     get isNewAppInstall(): boolean {
         return this._isNewAppInstall;
     }

diff --git a/packages/plugin-ext/src/plugin/plugin-manager.ts b/packages/plugin-ext/src/plugin/plugin-manager.ts
@@ -467,6 +467,7 @@ export class PluginManagerExtImpl extends AbstractPluginManagerExtImpl<PluginMan
         this.terminalService.$setShell(params.env.shell);
         this.envExt.setApplicationName(params.env.appName);
         this.envExt.setAppHost(params.env.appHost);
+        this.envExt.setAppRoot(params.env.appRoot);
 
         this.preferencesManager.init(params.preferences);