Remote: still use settings and configuration from the local user dir

Signed-off-by: Jonah Iden <[email protected]>

packages/remote/package.json

@@ -5,6 +5,7 @@
   "dependencies": {
     "@theia/core": "1.55.0",
     "@theia/filesystem": "1.55.0",
+    "@theia/userstorage": "1.55.0",
     "archiver": "^5.3.1",
     "decompress": "^4.2.1",
     "decompress-tar": "^4.0.0",

packages/remote/src/electron-browser/local-backend-services.ts

@@ -0,0 +1,31 @@
+// *****************************************************************************
+// Copyright (C) 2024 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 { RpcProxy } from '@theia/core';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { RemoteFileSystemProvider, RemoteFileSystemServer } from '@theia/filesystem/lib/common/remote-file-system-provider';
+
+export const LocalEnvVariablesServer = Symbol('LocalEnviromentVariableServer');
+export const LocalRemoteFileSytemServer = Symbol('LocalRemoteFileSytemServer');
+
+/**
+ * provide file access to local files while connected to a remote workspace or dev container.
+ */
+@injectable()
+export class LocalRemoteFileSystemProvider extends RemoteFileSystemProvider {
+    @inject(LocalRemoteFileSytemServer)
+    protected override readonly server: RpcProxy<RemoteFileSystemServer>;
+}

packages/remote/src/electron-browser/remote-frontend-module.ts

@@ -32,6 +32,11 @@ import { PortForwardingService } from './port-forwarding/port-forwarding-service
 import { RemotePortForwardingProvider, RemoteRemotePortForwardingProviderPath } from '../electron-common/remote-port-forwarding-provider';
 import { ServiceConnectionProvider } from '@theia/core/lib/browser/messaging/service-connection-provider';
 import '../../src/electron-browser/style/port-forwarding-widget.css';
+import { UserStorageContribution } from '@theia/userstorage/lib/browser/user-storage-contribution';
+import { RemoteUserStorageContribution } from './remote-user-storage-provider';
+import { remoteFileSystemPath, RemoteFileSystemProxyFactory, RemoteFileSystemServer } from '@theia/filesystem/lib/common/remote-file-system-provider';
+import { LocalEnvVariablesServer, LocalRemoteFileSystemProvider, LocalRemoteFileSytemServer } from './local-backend-services';
+import { envVariablesPath, EnvVariablesServer } from '@theia/core/lib/common/env-variables';
 
 export default new ContainerModule((bind, _, __, rebind) => {
     bind(RemoteFrontendContribution).toSelf().inSingletonScope();
@@ -65,4 +70,19 @@ export default new ContainerModule((bind, _, __, rebind) => {
     bind(RemotePortForwardingProvider).toDynamicValue(ctx =>
         ServiceConnectionProvider.createLocalProxy<RemotePortForwardingProvider>(ctx.container, RemoteRemotePortForwardingProviderPath)).inSingletonScope();
 
+    bind(LocalRemoteFileSytemServer).toDynamicValue(ctx =>
+        isRemoteConnection() ?
+            ServiceConnectionProvider.createLocalProxy(ctx.container, remoteFileSystemPath, new RemoteFileSystemProxyFactory()) :
+            ctx.container.get(RemoteFileSystemServer));
+    bind(LocalEnvVariablesServer).toDynamicValue(ctx =>
+        isRemoteConnection() ?
+            ServiceConnectionProvider.createLocalProxy<EnvVariablesServer>(ctx.container, envVariablesPath) :
+            ctx.container.get(EnvVariablesServer));
+    bind(LocalRemoteFileSystemProvider).toSelf().inSingletonScope();
+    rebind(UserStorageContribution).to(RemoteUserStorageContribution);
+
 });
+
+function isRemoteConnection(): boolean {
+    return !!new URLSearchParams(window.location.search).get('localPort');
+}

packages/remote/src/electron-browser/remote-user-storage-provider.ts

@@ -0,0 +1,63 @@
+// *****************************************************************************
+// Copyright (C) 2024 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 { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
+import { FileService } from '@theia/filesystem/lib/browser/file-service';
+import { FileSystemProvider } from '@theia/filesystem/lib/common/files';
+import { UserStorageContribution } from '@theia/userstorage/lib/browser/user-storage-contribution';
+import { RemoteStatusService } from '../electron-common/remote-status-service';
+import { LocalEnvVariablesServer, LocalRemoteFileSystemProvider } from './local-backend-services';
+import { Deferred } from '@theia/core/lib/common/promise-util';
+import { URI } from '@theia/core';
+import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
+
+/**
+ * This overide is to have remote connections still use settings, keymaps, etc. from the local machine.
+ */
+@injectable()
+export class RemoteUserStorageContribution extends UserStorageContribution {
+    @inject(RemoteStatusService)
+    protected readonly remoteStatusService: RemoteStatusService;
+
+    @inject(LocalRemoteFileSystemProvider)
+    protected readonly localRemoteFileSystemProvider: LocalRemoteFileSystemProvider;
+
+    @inject(LocalEnvVariablesServer)
+    protected readonly localEnvironments: EnvVariablesServer;
+
+    isRemoteConnection: Deferred<boolean> = new Deferred();
+
+    @postConstruct()
+    protected init(): void {
+        const port = new URLSearchParams(location.search).get('port');
+        if (port) {
+            this.remoteStatusService.getStatus(Number(port)).then(status => this.isRemoteConnection.resolve(status.alive));
+        }
+    }
+
+    protected override async getDelegate(service: FileService): Promise<FileSystemProvider> {
+        return await this.isRemoteConnection.promise ?
+            this.localRemoteFileSystemProvider
+            : service.activateProvider('file');
+    }
+
+    protected override async getCongigDirUri(): Promise<URI> {
+        return await this.isRemoteConnection.promise ?
+            new URI(await this.localEnvironments.getConfigDirUri())
+            : super.getCongigDirUri();
+    }
+
+}

packages/remote/tsconfig.json

@@ -14,6 +14,9 @@
     },
     {
       "path": "../filesystem"
+    },
+    {
+      "path": "../userstorage"
     }
   ]
 }

packages/userstorage/src/browser/user-storage-contribution.ts

@@ -22,6 +22,7 @@ import { FileSystemProvider } from '@theia/filesystem/lib/common/files';
 import { FileService, FileServiceContribution } from '@theia/filesystem/lib/browser/file-service';
 import { DelegatingFileSystemProvider } from '@theia/filesystem/lib/common/delegating-file-system-provider';
 import { UserStorageUri } from './user-storage-uri';
+import { MaybePromise } from '@theia/core';
 
 @injectable()
 export class UserStorageContribution implements FileServiceContribution {
@@ -40,9 +41,17 @@ export class UserStorageContribution implements FileServiceContribution {
         });
     }
 
+    protected getDelegate(service: FileService): MaybePromise<FileSystemProvider> {
+        return service.activateProvider('file');
+    }
+
+    protected async getCongigDirUri(): Promise<URI> {
+        return new URI(await this.environments.getConfigDirUri());
+    }
+
     protected async createProvider(service: FileService): Promise<FileSystemProvider> {
-        const delegate = await service.activateProvider('file');
-        const configDirUri = new URI(await this.environments.getConfigDirUri());
+        const delegate = await this.getDelegate(service);
+        const configDirUri = await this.getCongigDirUri();
         return new DelegatingFileSystemProvider(delegate, {
             uriConverter: {
                 to: resource => {