@theia/remote 1.52.0 → 1.53.0-next.55

package/README.md

@@ -1,61 +1,61 @@
-<div align='center'>
-
-<br />
-
-<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
-
-<h2>ECLIPSE THEIA - REMOTE EXTENSION</h2>
-
-<hr />
-
-</div>
-
-## Description
-
-This package implements functionality to connect to remote systems using Theia.
-This facilitates features similar to the features offered by Microsoft's popular `Remote-SSH`, `Dev Containers` or `WSL` extensions for VSCode.
-
-## Package Architecture
-
-The following explains the basic flow of any remote connection. It will be exemplified using the remote SSH feature:
-
-1. When the user runs the `SSH: Connect to Host...` command, we send the host info to the local backend.
-The corresponding `RemoteSSHConnectionProvider` is scoped to the current connection and can request additional information from the user, such as SSH key passphrases.
-2. Once the `RemoteSSHConnectionProvider` has every information it needs, it creates a SSH connection and registers this connection to the general `RemoteConnectionService`.
-Every `RemoteConnection` type implements an interface that is able to handle 3 kinds of messages to the remote system:
-    1. Executing commands in the shell of the remote system
-    2. Copying data to the remote
-3. Once the connection has been established, a setup process takes place on the remote system:
-    1. Identifying the remote platform (i.e. Windows, MacOS or Linux). This information is needed for all the following steps.
-    2. Setting up various directories for storing the application and its dependencies.
-    3. Download and install the correct Node.js version for the remote platform.
-    4. Packaging, copying, and unpackaging the local backend to the remote backend.
-        1. Every Theia extension can register `RemoteCopyContribution` binding to copy certain files from the current system.
-        This contribution point is used for files that are used in all operating systems.
-        2. They can also register `RemoteNativeDependencyContribution` bindings to download and copy native dependencies for the remote system.
-        The downloaded files are on a per-platform basis.
-    5. Using the node version that was installed in step 3, we now start the `main.js` of the backend application.
-    We start the backend with `--port=0`, so that it searches for any available port. It will print the port to the console.
-    The setup either returns with a setup error or the port of the remote server on the remote system.
-4. With the remote server/port in place, the backend sets up a local proxy server on a random port.
-It instructs the `RemoteConnection` object to forward any HTTP request to this proxy server to the remote server.
-5. The backend will return from the initial request from (1) with a new local proxy port. The frontend sets this port in the url and reload itself.
-6. The frontend is now connected to the remote backend by connecting to the local proxy port.
-7. The frontend now performs its normal messaging lifecycle, establishing connections to backend services.
-Although these backend services live on a different remote system, the frontend handles them as if they belong to the local backend.
-
-## Additional Information
-
-- [API documentation for `@theia/remote`](https://eclipse-theia.github.io/theia/docs/next/modules/remote.html)
-- [Theia - GitHub](https://github.com/eclipse-theia/theia)
-- [Theia - Website](https://theia-ide.org/)
-
-## License
-
-- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
-- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
-
-## Trademark
-
-"Theia" is a trademark of the Eclipse Foundation
-https://www.eclipse.org/theia
+<div align='center'>
+
+<br />
+
+<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
+
+<h2>ECLIPSE THEIA - REMOTE EXTENSION</h2>
+
+<hr />
+
+</div>
+
+## Description
+
+This package implements functionality to connect to remote systems using Theia.
+This facilitates features similar to the features offered by Microsoft's popular `Remote-SSH`, `Dev Containers` or `WSL` extensions for VSCode.
+
+## Package Architecture
+
+The following explains the basic flow of any remote connection. It will be exemplified using the remote SSH feature:
+
+1. When the user runs the `SSH: Connect to Host...` command, we send the host info to the local backend.
+The corresponding `RemoteSSHConnectionProvider` is scoped to the current connection and can request additional information from the user, such as SSH key passphrases.
+2. Once the `RemoteSSHConnectionProvider` has every information it needs, it creates a SSH connection and registers this connection to the general `RemoteConnectionService`.
+Every `RemoteConnection` type implements an interface that is able to handle 3 kinds of messages to the remote system:
+    1. Executing commands in the shell of the remote system
+    2. Copying data to the remote
+3. Once the connection has been established, a setup process takes place on the remote system:
+    1. Identifying the remote platform (i.e. Windows, MacOS or Linux). This information is needed for all the following steps.
+    2. Setting up various directories for storing the application and its dependencies.
+    3. Download and install the correct Node.js version for the remote platform.
+    4. Packaging, copying, and unpackaging the local backend to the remote backend.
+        1. Every Theia extension can register `RemoteCopyContribution` binding to copy certain files from the current system.
+        This contribution point is used for files that are used in all operating systems.
+        2. They can also register `RemoteNativeDependencyContribution` bindings to download and copy native dependencies for the remote system.
+        The downloaded files are on a per-platform basis.
+    5. Using the node version that was installed in step 3, we now start the `main.js` of the backend application.
+    We start the backend with `--port=0`, so that it searches for any available port. It will print the port to the console.
+    The setup either returns with a setup error or the port of the remote server on the remote system.
+4. With the remote server/port in place, the backend sets up a local proxy server on a random port.
+It instructs the `RemoteConnection` object to forward any HTTP request to this proxy server to the remote server.
+5. The backend will return from the initial request from (1) with a new local proxy port. The frontend sets this port in the url and reload itself.
+6. The frontend is now connected to the remote backend by connecting to the local proxy port.
+7. The frontend now performs its normal messaging lifecycle, establishing connections to backend services.
+Although these backend services live on a different remote system, the frontend handles them as if they belong to the local backend.
+
+## Additional Information
+
+- [API documentation for `@theia/remote`](https://eclipse-theia.github.io/theia/docs/next/modules/remote.html)
+- [Theia - GitHub](https://github.com/eclipse-theia/theia)
+- [Theia - Website](https://theia-ide.org/)
+
+## License
+
+- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+
+## Trademark
+
+"Theia" is a trademark of the Eclipse Foundation
+https://www.eclipse.org/theia

package/lib/electron-node/setup/remote-setup-script-service.js

@@ -54,17 +54,17 @@ let RemotePosixScriptStrategy = class RemotePosixScriptStrategy {
         return 'sh -c';
     }
     downloadFile(url, output) {
-        return `
-if [ "$(command -v wget)" ]; then
-    echo "Downloading using wget"
-    wget -O "${output}" "${url}"
-elif [ "$(command -v curl)" ]; then
-    echo "Downloading using curl"
-    curl "${url}" --output "${output}"
-else
-    echo "Failed to find wget or curl."
-    exit 1
-fi
+        return `
+if [ "$(command -v wget)" ]; then
+    echo "Downloading using wget"
+    wget -O "${output}" "${url}"
+elif [ "$(command -v curl)" ]; then
+    echo "Downloading using curl"
+    curl "${url}" --output "${output}"
+else
+    echo "Failed to find wget or curl."
+    exit 1
+fi
 `.trim();
     }
     unzip(file, directory) {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@theia/remote",
-  "version": "1.52.0",
+  "version": "1.53.0-next.55+d1a989a68c",
   "description": "Theia - Remote",
   "dependencies": {
-    "@theia/core": "1.52.0",
-    "@theia/filesystem": "1.52.0",
+    "@theia/core": "1.53.0-next.55+d1a989a68c",
+    "@theia/filesystem": "1.53.0-next.55+d1a989a68c",
     "archiver": "^5.3.1",
     "decompress": "^4.2.1",
     "decompress-tar": "^4.0.0",
@@ -52,7 +52,7 @@
     "watch": "theiaext watch"
   },
   "devDependencies": {
-    "@theia/ext-scripts": "1.52.0",
+    "@theia/ext-scripts": "1.53.0",
     "@types/archiver": "^5.3.2",
     "@types/decompress": "^4.2.4",
     "@types/express-http-proxy": "^1.6.3",
@@ -63,5 +63,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "40ceebcd4ee75f13ec16b9dc7314e9384493c1ac"
+  "gitHead": "d1a989a68c1b5ec1f9098e9126653c6346844769"
 }

package/src/electron-browser/port-forwarding/port-forwading-contribution.ts

@@ -1,33 +1,33 @@
-// *****************************************************************************
-// 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 { nls } from '@theia/core';
-import { AbstractViewContribution } from '@theia/core/lib/browser';
-import { injectable } from '@theia/core/shared/inversify';
-import { PortForwardingWidget, PORT_FORWARDING_WIDGET_ID } from './port-forwarding-widget';
-
-@injectable()
-export class PortForwardingContribution extends AbstractViewContribution<PortForwardingWidget> {
-    constructor() {
-        super({
-            widgetId: PORT_FORWARDING_WIDGET_ID,
-            widgetName: nls.localizeByDefault('Ports'),
-            defaultWidgetOptions: {
-                area: 'bottom'
-            }
-        });
-    }
-}
+// *****************************************************************************
+// 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 { nls } from '@theia/core';
+import { AbstractViewContribution } from '@theia/core/lib/browser';
+import { injectable } from '@theia/core/shared/inversify';
+import { PortForwardingWidget, PORT_FORWARDING_WIDGET_ID } from './port-forwarding-widget';
+
+@injectable()
+export class PortForwardingContribution extends AbstractViewContribution<PortForwardingWidget> {
+    constructor() {
+        super({
+            widgetId: PORT_FORWARDING_WIDGET_ID,
+            widgetName: nls.localizeByDefault('Ports'),
+            defaultWidgetOptions: {
+                area: 'bottom'
+            }
+        });
+    }
+}

package/src/electron-browser/port-forwarding/port-forwarding-service.ts

@@ -1,92 +1,92 @@
-// *****************************************************************************
-// 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 { Emitter } from '@theia/core';
-import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
-import { RemotePortForwardingProvider } from '../../electron-common/remote-port-forwarding-provider';
-
-export interface ForwardedPort {
-    localPort?: number;
-    address?: string;
-    origin?: string;
-    editing: boolean;
-}
-
-@injectable()
-export class PortForwardingService {
-
-    @inject(RemotePortForwardingProvider)
-    readonly provider: RemotePortForwardingProvider;
-
-    protected readonly onDidChangePortsEmitter = new Emitter<void>();
-    readonly onDidChangePorts = this.onDidChangePortsEmitter.event;
-
-    forwardedPorts: ForwardedPort[] = [];
-
-    @postConstruct()
-    init(): void {
-        this.provider.getForwardedPorts().then(ports => {
-            this.forwardedPorts = ports.map(p => ({ address: p.address, localPort: p.port, editing: false }));
-            this.onDidChangePortsEmitter.fire();
-        });
-    }
-
-    forwardNewPort(origin?: string): ForwardedPort {
-        const index = this.forwardedPorts.push({ editing: true, origin });
-        return this.forwardedPorts[index - 1];
-    }
-
-    updatePort(port: ForwardedPort, newAdress: string): void {
-        const connectionPort = new URLSearchParams(location.search).get('port');
-        if (!connectionPort) {
-            // if there is no open remote connection we can't forward a port
-            return;
-        }
-
-        const parts = newAdress.split(':');
-        if (parts.length === 2) {
-            port.address = parts[0];
-            port.localPort = parseInt(parts[1]);
-        } else {
-            port.localPort = parseInt(parts[0]);
-        }
-
-        port.editing = false;
-
-        this.provider.forwardPort(parseInt(connectionPort), { port: port.localPort!, address: port.address });
-        this.onDidChangePortsEmitter.fire();
-    }
-
-    removePort(port: ForwardedPort): void {
-        const index = this.forwardedPorts.indexOf(port);
-        if (index !== -1) {
-            this.forwardedPorts.splice(index, 1);
-            this.provider.portRemoved({ port: port.localPort! });
-            this.onDidChangePortsEmitter.fire();
-        }
-    }
-
-    isValidAddress(address: string): boolean {
-        const match = address.match(/^(.*:)?\d+$/);
-        if (!match) {
-            return false;
-        }
-
-        const port = parseInt(address.includes(':') ? address.split(':')[1] : address);
-
-        return !this.forwardedPorts.some(p => p.localPort === port);
-    }
-}
+// *****************************************************************************
+// 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 { Emitter } from '@theia/core';
+import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
+import { RemotePortForwardingProvider } from '../../electron-common/remote-port-forwarding-provider';
+
+export interface ForwardedPort {
+    localPort?: number;
+    address?: string;
+    origin?: string;
+    editing: boolean;
+}
+
+@injectable()
+export class PortForwardingService {
+
+    @inject(RemotePortForwardingProvider)
+    readonly provider: RemotePortForwardingProvider;
+
+    protected readonly onDidChangePortsEmitter = new Emitter<void>();
+    readonly onDidChangePorts = this.onDidChangePortsEmitter.event;
+
+    forwardedPorts: ForwardedPort[] = [];
+
+    @postConstruct()
+    init(): void {
+        this.provider.getForwardedPorts().then(ports => {
+            this.forwardedPorts = ports.map(p => ({ address: p.address, localPort: p.port, editing: false }));
+            this.onDidChangePortsEmitter.fire();
+        });
+    }
+
+    forwardNewPort(origin?: string): ForwardedPort {
+        const index = this.forwardedPorts.push({ editing: true, origin });
+        return this.forwardedPorts[index - 1];
+    }
+
+    updatePort(port: ForwardedPort, newAdress: string): void {
+        const connectionPort = new URLSearchParams(location.search).get('port');
+        if (!connectionPort) {
+            // if there is no open remote connection we can't forward a port
+            return;
+        }
+
+        const parts = newAdress.split(':');
+        if (parts.length === 2) {
+            port.address = parts[0];
+            port.localPort = parseInt(parts[1]);
+        } else {
+            port.localPort = parseInt(parts[0]);
+        }
+
+        port.editing = false;
+
+        this.provider.forwardPort(parseInt(connectionPort), { port: port.localPort!, address: port.address });
+        this.onDidChangePortsEmitter.fire();
+    }
+
+    removePort(port: ForwardedPort): void {
+        const index = this.forwardedPorts.indexOf(port);
+        if (index !== -1) {
+            this.forwardedPorts.splice(index, 1);
+            this.provider.portRemoved({ port: port.localPort! });
+            this.onDidChangePortsEmitter.fire();
+        }
+    }
+
+    isValidAddress(address: string): boolean {
+        const match = address.match(/^(.*:)?\d+$/);
+        if (!match) {
+            return false;
+        }
+
+        const port = parseInt(address.includes(':') ? address.split(':')[1] : address);
+
+        return !this.forwardedPorts.some(p => p.localPort === port);
+    }
+}